Table of contents
TOC
Réduire la table des matières
Développer la table des matières
Dernière mise à jour: 25/07/2018

Extraire des données à partir de captures

S’applique à : blocs-notes consommateur sur OneDrive | Blocs-notes d’entreprise sur Office 365

Utilisez l'API OneNote pour extraire des données de carte de visite d'une image, ou une recette et des données sur un produit à partir d'une URL.

Attributs d'extraction

Pour extraire et transformer des données, il suffit d'inclure un 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. L'API restitue les données extraites sur la page dans un format facile à lire.

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

data-render-src

Source du contenu. Cela peut être une image d'une carte de visite ou une URL absolue de nombreux sites de recettes ou de produits populaires. Obligatoire.

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. Par exemple, une URL canonique peut être définie dans la page Web source comme ceci :

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

data-render-method

Méthode d’extraction à exécuter. Obligatoire.

ValeurDescription
extract.businesscardUne extraction de carte de visite.
extract.recipeUne extraction de recette.
extract.productUne extraction de liste de produits.
extraireUn type d'extraction inconnu.

Pour de meilleurs résultats, spécifiez le type de contenu (extract.businesscard, extract.recipe, ou extract.product) si vous le connaissez. Si vous ne connaissez pas le type de contenu, utilisez la méthode extract. L’API OneNote tentera de le détecter automatiquement.

data-render-fallback

Comportement de secours en cas d’échec de l’extraction. Définition par défaut sur render en cas d’oubli.

ValeurDescription
afficherAffiche l’image source ou un instantané de la recette ou de la page web du produit.
aucuneN’effectue aucune action.
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. Assurez-vous d'envoyer un élément séparé img dans la requête, comme indiqué dans les exemples.

Extractions de carte de visite

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é.

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.

Scénarios courants d’extractions de cartes de visite

Extrayez les informations de cartes de visite et restituez également l'image de la carte de visite

Spécifier la méthode extract.businesscard et le secours none. Envoyez également un élément img avec l'attribut src qui référence également l'image. Si l'API ne peut extraire aucun contenu, elle restitue uniquement l'image de la carte de visite.

<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 afficher l'image de la carte de visite uniquement si l'extraction échoue

Spécifier la méthode extract.businesscard et le secours par défaut render. Si l'API ne peut extraire aucun contenu, elle restitue l'image de la carte de visite.

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

Pour les extractions de cartes de visite, l'image est envoyée en tant que pièce nommée dans une requête en plusieurs parties. 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.

Extractions de recette

L’API OneNote tente de trouver et de restituer les informations suivantes à partir de l’URL d’une recette.

L’API est optimisée pour les recettes de nombreux sites populaires comme Allrecipes.com, FoodNetwork.com et SeriousEats.com.

Scénarios courants d’extractions de recettes

Extraire les informations de la recette et restituer également un instantané de la page Web de la recette

Spécifier la méthode extract.recipe et le secours none. Envoyer également un élément img avec l'attribut data-render-src défini selon l'URL de la recette. Si l'API ne parvient pas à extraire le contenu, elle affiche uniquement un instantané de la page Web de la recette.

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.

<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/" />


Extrayez les informations d'une recette et restituez un instantané de la page Web de cette recette uniquement si l'extraction échoue

Spécifier la méthode extract.recipe et utiliser la restitution de secours par défaut. Si l'API ne parvient pas à extraire le contenu, elle affiche uniquement un instantané de la page Web de la recette.

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


Extraire les informations d'une recette et restituer également un lien vers la recette

Spécifier la méthode extract.recipe et le secours none. 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). Si l'API ne peut extraire aucun contenu, seul le lien de la recette est renvoyé.

<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>

Extractions de liste de produits

L’API est optimisée pour les produits de nombreux sites populaires comme Amazon.com et HomeDepot.com.

Scénarios courants d’extractions de recettes

Extrayez des informations sur le produit et affichez également un instantané de la page Web du produit

Spécifier la méthode extract.product et le secours none. Envoyer également un élément img avec l'attribut data-render-src défini selon l'URL de la recette. Si l'API ne parvient pas à extraire le contenu, elle affiche uniquement un instantané de la page Web de la recette.

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.

<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" />


Extrayez les informations sur le produit et restituez un instantané de la page Web du produit uniquement si l'extraction échoue

Spécifier la méthode extract.product et utiliser la restitution de secours par défaut. Si l'API ne parvient pas à extraire le contenu, elle affiche uniquement un instantané de la page Web de la recette.

<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>


Extraire des informations sur le produit et afficher également un lien vers le produit

Spécifier la méthode extract.product et le secours none. 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). Si l'API ne peut extraire aucun contenu, seul le lien de la recette est affiché.

<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>

Extractions de types de contenu inconnus

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. Vous pouvez le faire si votre application envoie différents types de captures.

Si vous connaissez le type de contenu que vous envoyez, vous devez utiliser extract.businesscard, extract.recipe, ou extract.product comme méthode. Dans certains cas, cela peut aider à optimiser les résultats d'extraction.

Scénarios courants d’extractions inconnues

Envoyer une image ou une URL et afficher l'image fournie ou un instantané de la page Web si l'extraction échoue

Spécifier la méthode extract afin que l'API détecte automatiquement le type de contenu et utilise l'affichage de secours par défaut. Si l'API ne peut extraire aucun contenu, elle restitue l'image fournie ou l'instantané de la page Web à la place.

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

Informations de la réponse

Données de réponseDescription
Code de succèsCode d’état HTTP 201 pour une demande POST réussie et code d’état HTTP 204 pour une demande PATCH réussie.
Erreurs ou avertissements

En cas d’échec de l’extraction, l’API traite autant que possible la demande et renvoie un code d’avertissement 20136 dans la propriété @api.diagnostics du corps de la réponse. L'extraction échouera si :
- Les attributs data-render-src ou data-render-method nécessaires sont manquants.
- Les valeurs data-render-src, data-render-method, ou data-fallback-method sont vides ou invalides.

Parfois, l’API peut extraire uniquement une partie du contenu cible même lorsqu’il est disponible. Dans ce cas, le service traite autant que possible la demande, mais ne renvoie pas d’avertissement.

En-tête X-CorrelationIdUn GUID qui identifie la requête de manière unique. Vous pouvez utiliser cette valeur avec la valeur de l'en-tête Date lorsque vous utilisez le support Microsoft pour résoudre les problèmes.

Autorisations

Pour créer ou mettre à jour des pages OneNote, vous devez demander les autorisations appropriées. Choisissez le niveau d’autorisations le plus bas dont votre application a besoin pour faire son travail.

Autorisations pour PUBLIER des pages

PlateformeÉtendue d’autorisation
Grand publicoffice.onenote_create, office.onenote_update_by_app, office.onenote_update
EntrepriseNotes.Create, Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, Notes.ReadWrite.All

Autorisations pour les pages PATCH

PlateformeÉtendue d’autorisation
Grand publicoffice.onenote_update_by_app, office.onenote_update
EntrepriseNotes.ReadWrite.CreatedByApp, Notes.ReadWrite, Notes.ReadWrite.All

Pour en savoir plus sur les étendues d’autorisation et leur fonctionnement, consultez la section relative aux étendues d’autorisation dans OneNote.

Ressources supplémentaires

© 2018 Microsoft