Table of contents
TOC
Collapse the table of content
Expand the table of content
Última actualización: 25/07/2018

Extraer datos de capturas

Se aplica a: Blocs de notas de consumidores en OneDrive | Blocs de notas de empresas en Office 365

Use la API de OneNote para extraer datos para tarjeta de presentación de una imagen, o datos de receta y producto de una URL.

Atributos de extracción

Para extraer y transformar datos, simplemente incluya un div que especifique el contenido de la fuente, el método de extracción y el comportamiento de reserva en la solicitud de create-page o update-page. La API representa los datos extraídos en la página en un formato fácil de leer.

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

data-render-src

El origen de contenido. Puede ser una imagen de una tarjeta de presentación o una URL absoluta de muchos sitios web populares de recetas o productos. Obligatorio.

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. Por ejemplo, una URL canónica se puede definir en la página web de origen de esta manera:

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

data-render-method

El método de extracción que se ejecutará. Obligatorio.

ValorDescripción
extract.businesscardUna extracción de tarjeta de presentación.
extract.recipeUna extracción de recetas.
extract.productUna extracción de lista de productos.
extractUn tipo de extracción desconocido.

Para obtener los mejores resultados, especifique el tipo de contenido (extract.businesscard, extract.recipe, o extract.product) si lo conoce. Si el tipo es desconocido, use el método extract y la API de OneNote para intentar detectar automáticamente el tipo.

data-render-fallback

El comportamiento de reserva si hay un error de extracción. Si se omite, se establece de forma predeterminada como render.

ValorDescripción
renderRepresenta la imagen de origen o una instantánea de la página web del producto o la receta.
noneNo realiza ninguna acción.
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. Asegúrese de enviar un elemento img por separado en la solicitud, como se muestra en los ejemplos.

Extracciones de tarjetas de presentación

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.

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.

Escenarios comunes de extracciones de tarjetas de presentación

Extraer información de la tarjeta de presentación, y también representar la imagen de la tarjeta de presentación

Especifique el método extract.businesscard y la reserva none. También envíe un elemento img con el atributo src que también referencia a la imagen. Si la API no puede extraer ningún contenido, solo representa la imagen de la tarjeta de presentación.

<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 la información de la tarjeta de presentación y visualizar la imagen de la tarjeta de presentación solo si la extracción falla

Especifique el método extract.businesscard y use la reserva render predeterminada. Si la API no puede extraer ningún contenido, representa la imagen de la tarjeta de presentación en su lugar.

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

Para las extracciones de tarjetas de presentación, la imagen se envía como una parte nombrada en una solicitud de varias partes. Vea Agregar imágenes y archivos para obtener ejemplos de cómo enviar una imagen en una solicitud.

Extracciones de recetas

La API de OneNote intenta buscar y procesar la siguiente información según la dirección URL de una receta.

La API está optimizada para recetas de sitios populares, como Allrecipes.com, FoodNetwork.com y SeriousEats.com.

Escenarios comunes de extracciones de recetas

Extraer información de recetas, y también representar una instantánea de la página web de recetas

Especifique el método extract.recipe y la reserva none. También envíe un elemento img con el atributo data-render-src establecido en la URL de la receta. Si la API no puede extraer ningún contenido, solo representa una instantánea de la página web de recetas.

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.

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


Extraer información de la receta, y representar una instantánea de la página web de la receta solo si la extracción falla

Especifique el método extract.recipe y use la reserva de representación predeterminada. Si la API no puede extraer ningún contenido, representa una instantánea de la página web de recetas en su lugar.

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


Extraer información de recetas, y también representar un enlace a la receta

Especifique el método extract.recipe y la reserva none. 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). Si la API no puede extraer ningún contenido, solo se representa el vínculo de la receta.

<div
    data-render-src="http://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="http://www.seriouseats.com/recipes/2014/09/diy-spicy-kimchi-beef-instant-noodles-recipe.html">Recipe URL</a>

Extracciones de listas de productos

La API está optimizada para productos de muchos sitios populares como Amazon.com y HomeDepot.com.

Escenarios comunes de extracciones de recetas

Extraer información del producto, y también representar una instantánea de la página web del producto

Especifique el método extract.product y la reserva none. También envíe un elemento img con el atributo data-render-src establecido en la URL del producto. Si la API no puede extraer ningún contenido, solo representa una instantánea de la página web del producto.

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.

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


Extraer información del producto, y representar una instantánea de la página web del producto solo si la extracción falla

Especifique el método extract.product y use la reserva de representación predeterminada. Si la API no puede extraer ningún contenido, representa una instantánea de la página web del producto en su lugar.

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


Extraer información del producto, y también representar un enlace al producto

Especifique el método extract.product y la reserva none. 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). Si la API no puede extraer ningún contenido, solo se representa el vínculo de la página.

<div
    data-render-src="http://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="http://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 desconocido

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. Es posible que desee hacer esto si su aplicación envía diferentes tipos de captura.

Si sabe el tipo de contenido que está enviando, debe usar el método extract.businesscard, extract.recipe, o extract.product. En algunos casos, esto puede ayudar a optimizar los resultados de extracción.

Escenarios comunes para extracciones desconocidas

Enviar una imagen o una URL, y representar la imagen suministrada o una instantánea de la página web si la extracción falla

Especifique el método extract para que la API detecte automáticamente el tipo de contenido y use la reserva de representación predeterminada. Si la API no puede extraer ningún contenido, en su lugar representa la imagen suministrada o la instantánea de la página web.

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

Información de respuesta

Datos de respuestaDescripción
Código correctoUn código de estado HTTP 201 para una solicitud POST correcta y un código de estado HTTP 204 para una solicitud PATCH correcta.
Errores o advertencias

Si se produce un error en la extracción, la API procesa la mayor cantidad posible de la solicitud y devuelve un código de advertencia 20136 en la propiedad @api.diagnostics en el cuerpo de la respuesta. La extracción fallará si:
Faltan los atributos requeridos data-render-src o data-render-method.
- Los valores data-render-src, data-render-method, o data-fallback-method están vacíos o no son válidos.

A veces, la API puede extraer solo una parte del contenido de destino incluso cuando está disponible. En este caso, el servicio procesa la mayor parte posible de la solicitud, pero no devuelve una advertencia.

Encabezado X-CorrelationIdGUID que identifica la solicitud de forma única. Puede usar este valor, además del valor del encabezado de fecha, al trabajar con el soporte técnico de Microsoft para solucionar problemas.

Permisos

Para crear o actualizar páginas OneNote, debe solicitar los permisos adecuados. Elija el nivel más bajo de permisos que necesita la aplicación para hacer su trabajo.

Permisos de páginas POST

PlataformaÁmbito de permisos
Consumidoroffice.onenote_create, office.onenote_update_by_app, office.onenote_update
EmpresaNotes.Create, Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, Notes.ReadWrite.All

Permisos de páginas PATCH

PlataformaÁmbito de permisos
Consumidoroffice.onenote_update_by_app, office.onenote_update
EmpresaNotes.ReadWrite.CreatedByApp, Notes.ReadWrite, Notes.ReadWrite.All

Para obtener más información sobre los ámbitos de permiso y cómo funcionan, consulte los ámbitos de permisos de OneNote.

Recursos adicionales

© 2018 Microsoft