Usar las etiquetas div de la API de OneNote para extraer datos de capturasUse OneNote API div tags to extract data from captures

Se aplica a: Blocs de notas para consumidores de OneDrive | Blocs de notas empresariales de Office 365Applies to Consumer notebooks on OneDrive | Enterprise notebooks on Office 365

Use la API de OneNote para extraer datos de tarjetas de presentación de imágenes, o bien datos de recetas y productos de URL.Use the OneNote API to extract business card data from an image, or recipe and product data from a URL.

Atributos de extracciónExtraction attributes

Para extraer y transformar datos, solo tiene que incluir un div que especifique el contenido de origen, el método de extracción y el comportamiento de reserva en la solicitud create-page o update-page.To extract and transform data, simply include a div that specifies the source content, extraction method, and fallback behavior in your create-page or update-page request. La API representa los datos extraídos de la página en un formato de fácil lectura.The API renders extracted data on the page in an easy-to-read format.

<div
  data-render-src="image-or-url"
  data-render-method="extraction-method"
  data-render-fallback="fallback-action">
</div>

data-render-srcdata-render-src

El origen de contenido.The content source. Puede ser una imagen de una tarjeta de presentación, o bien una URL absoluta de sitios web populares de productos o recetas.This can be an image of a business card or an absolute URL from many popular recipe or product websites. Obligatorio.Required.

Para obtener los mejores resultados al especificar una dirección URL, use la URL canónica definida en el HTML de la página web de origen, si se define una.For best results when specifying a URL, use the canonical URL defined in the HTML of the source webpage, if one is defined. Por ejemplo, se puede definir una URL canónica en la página web de origen de esta forma:For example, a canonical URL might be defined in the source webpage like this:

<link rel="canonical" href="www.domainname.com/page/123/size12/type987" />

data-render-methoddata-render-method

El método de extracción que se ejecutará.The extraction method to run. Obligatorio.Required.

ValorValue DescripciónDescription
extract.businesscardextract.businesscard Una extracción de tarjetas de presentación.A business card extraction.
extract.recipeextract.recipe Una extracción de recetas.A recipe extraction.
extract.productextract.product Una extracción de listas de productos.A product listing extraction.
extractextract Un tipo de extracción desconocido.An unknown extraction type.

Para obtener los mejores resultados, especifique el tipo de contenido (extract.businesscard, extract.recipe o extract.product) si lo conoce.For best results, specify the content type (extract.businesscard, extract.recipe, or extract.product) if you know it. Si el tipo es desconocido, use el método extract y la API de OneNote para intentar detectar automáticamente el tipo.If the type is unknown, use the extract method, and the OneNote API will try to auto-detect the type.

data-render-fallbackdata-render-fallback

El comportamiento de reserva si hay un error de extracción.The fallback behavior if the extraction fails. Si se omite, se establece de forma predeterminada como render.Defaults to render if omitted.

ValorValue DescripciónDescription
renderrender Representa la imagen de origen o una instantánea de la página web del producto o la receta.Renders the source image or a snapshot of the recipe or product webpage.
nonenone No realiza ninguna acción.Does nothing.

Esta opción es útil si siempre quiere incluir una instantánea de la tarjeta de presentación o la página web en la página, además del contenido extraído.This option is useful if you want to always include a snapshot of the business card or webpage on the page in addition to any extracted content. Asegúrese de enviar un elemento img separado en la solicitud, como se muestra en los ejemplos.Be sure to send a separate img element in the request, as shown in the examples.

Extracciones de tarjetas de presentaciónBusiness card extractions

La API de OneNote intenta encontrar y presentar la siguiente información de contacto según la imagen de la tarjeta de presentación de una persona o una empresa.The OneNote API tries to find and render the following contact information based on an image of a person's or company's business card.

  • NombreName
  • El títuloTitle
  • OrganizaciónOrganization
  • Números de teléfono y faxPhone and fax numbers
  • Direcciones de correo y físicasMailing and physical addresses
  • Direcciones de correoEmail addresses
  • Sitios webWebsites
An example business card extraction

Un archivo vCard (archivo .VCF) con la información extraída del contacto también se inserta en la página. El archivo vCard es una forma cómoda de obtener la información de contacto cuando se recupera el contenido HTML de la página.A vCard (.VCF file) with the extracted contact information is also embedded in the page. The vCard is a convenient way to get the contact information when retrieving page HTML content.

Escenarios comunes de extracciones de tarjetas de presentaciónCommon scenarios for business card extractions

Extraer información de tarjetas de presentación y además representar la imagen de la tarjeta de presentaciónExtract business card information, and also render the business card image

Especifique el método extract.businesscard y la reserva none.Specify the extract.businesscard method and the none fallback. Además, envíe un elemento img con el atributo src que también haga referencia la imagen.Also send an img element with the src attribute that also references the image. Si la API no puede extraer ningún contenido, solo representará la imagen de la tarjeta de presentación.If the API is unable to extract any content, it renders the business card image only.

<div
    data-render-src="name:scanned-card-image"
    data-render-method="extract.businesscard"
    data-render-fallback="none">
</div>
<img src="name:scanned-card-image" />

Extraer información de tarjetas de presentación y solo representar la imagen de la tarjeta de presentación si la extracción produce erroresExtract business card information, and render the business card image only if the extraction fails

Especifique el método extract.businesscard y use la reserva render predeterminada.Specify the extract.businesscard method and use the default render fallback. Si la API no puede extraer ningún contenido, solo representará la imagen de la tarjeta de presentación en su lugar.If the API is unable to extract any content, it renders the business card image instead.

<div
    data-render-src="name:scanned-card-image"
    data-render-method="extract.businesscard">
</div>

Para extracciones de tarjetas de presentación, la imagen se envía como un elemento con nombre en una solicitud de varias partes.For business card extractions, the image is sent as a named part in a multipart request. Vea Agregar imágenes y archivos para obtener ejemplos de cómo enviar una imagen en una solicitud.See Add images and files for examples that show how to send an image in a request.

Extracciones de recetasRecipe extractions

La API de OneNote intenta buscar y procesar la siguiente información según la dirección URL de una receta.The OneNote API tries to find and render the following information based on a recipe's URL.

  • Imagen principalHero image
  • ClasificaciónRating
  • IngredientesIngredients
  • InstruccionesInstructions
  • Preparación, cocción, tiempo totalPrep, cook, and total times
  • RacionesServings
An example recipe extraction

La API está optimizada para recetas de sitios populares, como Allrecipes.com, FoodNetwork.com y SeriousEats.com.The API is optimized for recipes from many popular sites such as Allrecipes.com, FoodNetwork.com, and SeriousEats.com.

Escenarios comunes de extracciones de recetasCommon scenarios for recipe extractions

Extraer información de la receta y además mostrar una instantánea de la página web de la recetaExtract recipe information, and also render a snapshot of the recipe webpage

Especifique el método extract.recipe y la reserva none.Specify the extract.recipe method and the none fallback. Además, envía un elemento img con el atributo data-render-src establecido en la URL de la receta.Also send an img element with the data-render-src attribute set to the recipe URL. Si la API no puede extraer ningún contenido, solo mostrará una instantánea de la página web de la receta.If the API is unable to extract any content, it renders a snapshot of the recipe webpage only.

Este escenario proporciona potencialmente la mayor cantidad de información posible, ya que la página web puede contener información adicional, como sugerencias y opiniones de clientes.This scenario potentially provides the most information because the webpage may include additional information, such as customer reviews and suggestions.

<div
    data-render-src="https://allrecipes.com/recipe/guacamole/"
    data-render-method="extract.recipe"
    data-render-fallback="none">
</div>
<img data-render-src="https://allrecipes.com/recipe/guacamole/" />

Extraer información de la receta y solo mostrar una instantánea de la página web de la receta si la extracción produce erroresExtract recipe information, and render a snapshot of the recipe webpage only if the extraction fails

Especifique el método extract.recipe y use la reserva de representación predeterminada.Specify the extract.recipe method and use the default render fallback. Si la API no puede extraer ningún contenido, solo mostrará una instantánea de la página web de la receta en su lugar.If the API is unable to extract any content, it renders a snapshot of the recipe webpage instead.

<div
    data-render-src="https://www.foodnetwork.com/recipes/alton-brown/creme-brulee-recipe.html"
    data-render-method="extract.recipe">
</div>

Especifique el método extract.recipe y la reserva none.Specify the extract.recipe method and the none fallback. Además, envía un elemento a con el atributo src establecido en la URL de la receta (o bien, puede enviar cualquier otra información que quiera agregar a la página).Also send an a element with the src attribute set to the recipe URL (or you can send any other information you want to add to the page). Si la API no puede extraer ningún contenido, solo se mostrará el vínculo de la receta.If the API is unable to extract any content, only the recipe link is rendered.

<div
    data-render-src="https://www.seriouseats.com/recipes/2014/09/diy-spicy-kimchi-beef-instant-noodles-recipe.html"
    data-render-method="extract.recipe"
    data-render-fallback="none">
</div>
<a href="https://www.seriouseats.com/recipes/2014/09/diy-spicy-kimchi-beef-instant-noodles-recipe.html">Recipe URL</a>

Extracciones de listas de productosProduct listing extractions

  • El títuloTitle
  • ClasificaciónRating
  • Imagen principalPrimary image
  • DescripciónDescription
  • CaracterísticasFeatures
  • EspecificacionesSpecifications
An example product listing extraction

La API está optimizada para productos de muchos sitios populares como Amazon.com y HomeDepot.com.The API is optimized for products from many popular sites such as Amazon.com and HomeDepot.com.

Escenarios comunes de extracciones de recetasCommon scenarios for recipe extractions

Extraer información de productos y además mostrar una instantánea de la página web del productoExtract product information, and also render a snapshot of the product webpage

Especifique el método extract.product y la reserva none.Specify the extract.product method and the none fallback. Además, envía un elemento img con el atributo data-render-src establecido en la URL del producto.Also send an img element with the data-render-src attribute set to the product URL. Si la API no puede extraer ningún contenido, solo mostrará una instantánea de la página web del producto.If the API is unable to extract any content, it renders a snapshot of the product webpage only.

Este escenario proporciona potencialmente la mayor cantidad de información posible, ya que la página web puede contener información adicional, como sugerencias y opiniones de clientes.This scenario potentially provides the most information because the webpage may include additional information, such as customer reviews and suggestions.

<div
    data-render-src="https://www.amazon.com/Microsoft-Band-Small/dp/B00P2T2WVO"
    data-render-method="extract.product"
    data-render-fallback="none">
</div>
<img data-render-src="https://www.amazon.com/Microsoft-Band-Small/dp/B00P2T2WVO" />

Extraer información del producto y solo mostrar una instantánea de la página web del producto si la extracción produce erroresExtract product information, and render a snapshot of the product webpage only if the extraction fails

Especifique el método extract.product y use la reserva de representación predeterminada.Specify the extract.product method and use the default render fallback. Si la API no puede extraer ningún contenido, solo mostrará una instantánea de la página web del producto en su lugar.If the API is unable to extract any content, it renders a snapshot of the product webpage instead.

<div
    data-render-src="https://www.sears.com/craftsman-19hp-42-8221-turn-tight-174-hydrostatic-yard-tractor/p-07120381000P"
    data-render-method="extract.product">
</div>

Especifique el método extract.product y la reserva none.Specify the extract.product method and the none fallback. Además, envía un elemento a con el atributo src establecido en la URL del producto (o bien, puede enviar cualquier otra información que quiera agregar a la página).Also send an a element with the src attribute set to the product URL (or you can send any other information you want to add to the page). Si la API no puede extraer ningún contenido, solo se mostrará el vínculo de la página.If the API is unable to extract any content, only the page link is rendered.

<div
    data-render-src="https://www.homedepot.com/p/Active-Ventilation-5-Watt-Solar-Powered-Exhaust-Attic-Fan-RBSF-8-WT/204203001"
    data-render-method="extract.product"
    data-render-fallback="none">
</div>
<a href="https://www.homedepot.com/p/Active-Ventilation-5-Watt-Solar-Powered-Exhaust-Attic-Fan-RBSF-8-WT/204203001">Product URL</a>

Extracciones de tipo de contenido desconocidoUnknown content type extractions

Si no conoce el tipo de contenido (tarjeta de presentación, receta o producto) que quiere enviar, puede usar el método extract incompleto y dejar que la API de OneNote detecte el tipo automáticamente.If you don't know the content type (business card, recipe, or product) that you're sending, you can use the unqualified extract method and let the OneNote API automatically detect the type. Puede hacer esto si la aplicación envía distintos tipos de captura.You might want to do this if your app sends different capture types.

Nota: Si conoce el tipo de contenido que quiere enviar, necesita usar el método extract.businesscard, extract.recipe o extract.product.Note: If you do know the content type that you're sending, you should use the extract.businesscard, extract.recipe, or extract.product method. En algunos casos, esto puede permitirle optimizar los resultados de la extracción.In some cases, this can help to optimize the extraction results.

Escenarios comunes para extracciones desconocidasCommon scenarios for unknown extractions

Enviar una imagen de una URL y, si la extracción produce errores, representar la imagen proporcionada o una instantánea de la página webSend an image or a URL, and render the supplied image or a snapshot of the webpage if the extraction fails

Especifique el método extract para que la API detecte automáticamente el tipo de contenido y use la reserva de representación predeterminada.Specify the extract method so the API automatically detects the content type, and use the default render fallback. Si la API no puede extraer ningún contenido, en su lugar se mostrará la imagen proporcionada o una instantánea de la página web.If the API is unable to extract any content, it renders the supplied image or snapshot of the webpage instead.

<div
    data-render-src="some image or url"
    data-render-method="extract">
</div>

Información de respuestaResponse information

Datos de respuestaResponse data DescripciónDescription
Código correctoSuccess code Un código de estado HTTP 201 para una solicitud POST correcta y un código de estado HTTP 204 para una solicitud PATCH correcta.A 201 HTTP status code for a successful POST request, and a 204 HTTP status code for a successful PATCH request.
ErroresErrors Lea Códigos de error para API de OneNote de Microsoft Graph para obtener información sobre los errores de OneNote que puede devolver Microsoft Graph.Read Error codes for OneNote APIs in Microsoft Graph to learn about OneNote errors that Microsoft Graph can return.

PermisosPermissions

Para crear o actualizar páginas de OneNote, necesita solicitar los permisos adecuados.To create or update OneNote pages, you'll need to request appropriate permissions. Seleccione el nivel inferior de permisos que necesita la aplicación para funcionar correctamente.Choose the lowest level of permissions that your app needs to do its work.

Permisos para páginas POSTPermissions for POST pages

  • Notes.CreateNotes.Create
  • Notes.ReadWriteNotes.ReadWrite
  • Notes.ReadWrite.AllNotes.ReadWrite.All

Permisos para páginas PATCHPermissions for PATCH pages

  • Notes.ReadWriteNotes.ReadWrite
  • Notes.ReadWrite.AllNotes.ReadWrite.All

Para obtener más información sobre los ámbitos de permiso y cómo funcionan, vea Referencias de permisos de Microsoft Graph.For more information about permission scopes and how they work, see Microsoft Graph permissions reference.

Vea tambiénSee also