Utilisation de balises div de l’API OneNote pour extraire les données des capturesUse OneNote API div tags to extract data from captures

**S’applique à **blocs-notes consommateur sur OneDrive | Blocs-notes d’entreprise sur Office 365Applies to Consumer notebooks on OneDrive | Enterprise notebooks on Office 365

Utilisez l’API OneNote pour extraire les données des cartes de visite présentes dans une image ou une recette et les données produit présentes dans une URL.Use the OneNote API to extract business card data from an image, or recipe and product data from a URL.

Attributs d’extractionExtraction attributes

Pour extraire et transformer des données, il vous suffit d’inclure une balise div qui spécifie le contenu source, la méthode d’extraction et le comportement de secours dans votre requête create-page ou 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. L’API restitue les données extraites sur la page dans un format facile à lire.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

Il s’agit de la source du contenu.The content source. Il peut s’agir de l’image d’une carte de visite ou l’URL absolue de plusieurs sites web de produits ou de recettes populaires.This can be an image of a business card or an absolute URL from many popular recipe or product websites. Obligatoire.Required.

Pour obtenir les meilleurs résultats quand vous spécifiez une URL, utilisez l’URL canonique définie dans le code HTML de la page web source, si une URL est définie.For best results when specifying a URL, use the canonical URL defined in the HTML of the source webpage, if one is defined. Par exemple, une URL canonique peut être définie dans la page web source de la manière suivante :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

Méthode d’extraction à exécuter.The extraction method to run. Obligatoire.Required.

ValeurValue DescriptionDescription
extract.businesscardextract.businesscard Extraction d’une carte de visite.A business card extraction.
extract.recipeextract.recipe Extraction d’une recette.A recipe extraction.
extract.productextract.product Extraction d’une liste de produits.A product listing extraction.
extractextract Type d’extraction inconnue.An unknown extraction type.

Pour obtenir de meilleurs résultats, spécifiez le type de contenu (extract.businesscard, extract.recipe ou extract.product) si vous le connaissez.For best results, specify the content type (extract.businesscard, extract.recipe, or extract.product) if you know it. Si vous ne connaissez pas le type de contenu, utilisez la méthode extract. L’API OneNote tentera de le détecter automatiquement.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

Comportement de secours en cas d’échec de l’extraction.The fallback behavior if the extraction fails. Définition par défaut sur render en cas d’oubli.Defaults to render if omitted.

ValeurValue DescriptionDescription
renderrender Affiche l’image source ou un instantané de la recette ou de la page web du produit.Renders the source image or a snapshot of the recipe or product webpage.
aucunenone N’effectue aucune action.Does nothing.

Cette option est utile si vous voulez toujours inclure un instantané de la carte de visite ou de la page web sur la page, en plus du contenu extrait.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. Pensez à envoyer un élément img séparé dans la requête, comme illustré dans les exemples.Be sure to send a separate img element in the request, as shown in the examples.

Extractions de carte de visiteBusiness card extractions

L’API OneNote tente de trouver et de restituer les informations de contact suivantes à partir de l’image de la carte de visite d’une personne ou d’une société.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.

  • NomName
  • TitreTitle
  • OrganisationOrganization
  • Numéros de téléphone et de faxPhone and fax numbers
  • Adresses postale et physiqueMailing and physical addresses
  • Adresses de messagerieEmail addresses
  • Sites webWebsites
An example business card extraction

Une vCard (fichier VCF) contenant les informations de contact extraites est également intégrée dans la page. La vCard est un moyen pratique d’obtenir les informations de contact lors de l’extraction du contenu HTML d’une page.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.

Scénarios courants d’extraction de cartes de visiteCommon scenarios for business card extractions

Extraire les informations de la carte de visite et restituer l’image de la carte de visiteExtract business card information, and also render the business card image

Spécifiez la méthode extract.businesscard et le comportement de secours none.Specify the extract.businesscard method and the none fallback. Envoyez aussi un élément img avec l’attribut src qui fait référence à l’image.Also send an img element with the src attribute that also references the image. Si l’API ne parvient pas à extraire du contenu, elle restitue uniquement l’image de la carte de visite.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" />

Extraire les informations de la carte de visite et restituer l’image de la carte de visite en cas d’échec de l’extraction uniquementExtract business card information, and render the business card image only if the extraction fails

Spécifiez la méthode extract.businesscard et utilisez le comportement de secours render par défaut.Specify the extract.businesscard method and use the default render fallback. Si l’API ne parvient pas à extraire du contenu, elle restitue l’image de la carte de visite.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>

Dans le cas d’une extraction de carte de visite, l’image est envoyée sous forme de partie nommée dans une requête en plusieurs parties.For business card extractions, the image is sent as a named part in a multipart request. Reportez-vous à l’article relatif à l’ajout d’images et de fichiers pour consulter des exemples qui montrent comment envoyer une image dans une requête.See Add images and files for examples that show how to send an image in a request.

Extractions de recetteRecipe extractions

L’API OneNote tente de trouver et de restituer les informations suivantes à partir de l’URL d’une recette.The OneNote API tries to find and render the following information based on a recipe's URL.

  • Image de la bannièreHero image
  • RatingRating
  • IngrédientsIngredients
  • InstructionsInstructions
  • Temps de préparation, de cuisson et temps totalPrep, cook, and total times
  • PortionsServings
An example recipe extraction

L’API est optimisée pour les recettes de nombreux sites populaires comme Allrecipes.com, FoodNetwork.com et SeriousEats.com.The API is optimized for recipes from many popular sites such as Allrecipes.com, FoodNetwork.com, and SeriousEats.com.

Scénarios courants d’extractions de recettesCommon scenarios for recipe extractions

Extraire les informations de la recette et restituer un instantané de la page web de la recetteExtract recipe information, and also render a snapshot of the recipe webpage

Spécifiez la méthode extract.recipe et le comportement de secours none.Specify the extract.recipe method and the none fallback. Envoyez également un élément img avec l’attribut data-render-src défini sur l’URL de la recette.Also send an img element with the data-render-src attribute set to the recipe URL. Si l’API ne parvient pas à extraire du contenu, elle restitue uniquement un instantané de la page web de la recette.If the API is unable to extract any content, it renders a snapshot of the recipe webpage only.

Ce scénario fournit probablement le plus d’informations, car la page web peut inclure des informations supplémentaires, telles que les avis des visiteurs et des suggestions.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/" />

Extraire les informations de la recette et restituer un instantané de la page web de la recette en cas d’échec de l’extraction uniquementExtract recipe information, and render a snapshot of the recipe webpage only if the extraction fails

Spécifiez la méthode extract.recipe et utilisez le comportement de secours restitué par défaut.Specify the extract.recipe method and use the default render fallback. Si l’API ne parvient pas à extraire du contenu, elle restitue un instantané de la page web de la recette.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>

Spécifiez la méthode extract.recipe et le comportement de secours none.Specify the extract.recipe method and the none fallback. Envoyez également un élément a avec l’attribut src défini sur l’URL de la recette (ou vous pouvez envoyer d’autres informations à ajouter à la page).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 l’API ne parvient pas à extraire du contenu, seul le lien vers la recette est restitué.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>

Extractions de liste de produitsProduct listing extractions

  • TitreTitle
  • RatingRating
  • Image principalePrimary image
  • DescriptionDescription
  • FonctionnalitésFeatures
  • SpécificationsSpecifications
An example product listing extraction

L’API est optimisée pour les produits de nombreux sites populaires comme Amazon.com et HomeDepot.com.The API is optimized for products from many popular sites such as Amazon.com and HomeDepot.com.

Scénarios courants d’extractions de recettesCommon scenarios for recipe extractions

Extraire les informations du produit et restituer un instantané de la page web du produitExtract product information, and also render a snapshot of the product webpage

Spécifiez la méthode extract.product et le comportement de secours none.Specify the extract.product method and the none fallback. Envoyez également un élément img avec l’attribut data-render-src défini sur l’URL du produit.Also send an img element with the data-render-src attribute set to the product URL. Si l’API ne parvient pas à extraire du contenu, elle restitue uniquement un instantané de la page web du produit.If the API is unable to extract any content, it renders a snapshot of the product webpage only.

Ce scénario fournit probablement le plus d’informations, car la page web peut inclure des informations supplémentaires, telles que les avis des visiteurs et des suggestions.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" />

Extraire les informations du produit et restituer un instantané de la page web du produit en cas d’échec de l’extraction uniquementExtract product information, and render a snapshot of the product webpage only if the extraction fails

Spécifiez la méthode extract.product et utilisez le comportement de secours restitué par défaut.Specify the extract.product method and use the default render fallback. Si l’API ne parvient pas à extraire du contenu, elle restitue un instantané de la page web du produit.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>

Spécifiez la méthode extract.product et le comportement de secours none.Specify the extract.product method and the none fallback. Envoyez également un élément a avec l’attribut src défini sur l’URL du produit (ou vous pouvez envoyer d’autres informations à ajouter à la page).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 l’API ne parvient pas à extraire du contenu, seul le lien vers la page est restitué.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>

Extractions de types de contenu inconnusUnknown content type extractions

Si vous ne connaissez pas le type du contenu (carte de visite, recette ou produit) envoyé, vous pouvez utiliser la méthode extract non qualifiée pour que l’API OneNote détecte automatiquement le type du contenu.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. Nous vous recommandons d’opter pour cette solution si votre application envoie différents types de capture.You might want to do this if your app sends different capture types.

Remarque : si vous ne connaissez pas le type de contenu envoyé, utilisez la méthode extract.businesscard, extract.recipe ou 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. Dans certains cas, cette solution peut optimiser les résultats de l’extraction.In some cases, this can help to optimize the extraction results.

Scénarios courants d’extractions inconnuesCommon scenarios for unknown extractions

Envoyer une image ou une URL et restituer l’image fournie ou un instantané de la page web en cas d’échec de l’extractionSend an image or a URL, and render the supplied image or a snapshot of the webpage if the extraction fails

Spécifiez la méthode extract pour que l’API détecte automatiquement le type de contenu et utilisez le comportement de secours restitué par défaut.Specify the extract method so the API automatically detects the content type, and use the default render fallback. Si l’API ne parvient pas à extraire du contenu, elle restitue l’image ou l’instantané fourni de la page 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>

Informations de la réponseResponse information

Données de réponseResponse data DescriptionDescription
Code de succèsSuccess code Code d’état HTTP 201 pour une requête POST réussie et code d’état HTTP 204 pour une requête PATCH réussie.A 201 HTTP status code for a successful POST request, and a 204 HTTP status code for a successful PATCH request.
ErreursErrors Consultez l’article Codes d’erreur pour les API OneNote dans Microsoft Graph pour en savoir plus sur les erreurs OneNote renvoyées par Microsoft Graph.Read Error codes for OneNote APIs in Microsoft Graph to learn about OneNote errors that Microsoft Graph can return.

AutorisationsPermissions

Pour créer ou mettre à jour des pages OneNote, demandez les autorisations appropriées.To create or update OneNote pages, you'll need to request appropriate permissions. Choisissez le niveau d’autorisation le plus faible requis par votre application pour faire son travail.Choose the lowest level of permissions that your app needs to do its work.

Autorisations pour les pages POSTPermissions for POST pages

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

Autorisations pour les pages PATCHPermissions for PATCH pages

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

Pour en savoir plus sur les étendues d’autorisation et leur fonctionnement, consultez l’article Référence des autorisations de Microsoft Graph.For more information about permission scopes and how they work, see Microsoft Graph permissions reference.

Voir aussiSee also