Verwenden von div-Tags der OneNote-API zum Extrahieren von Daten aus ErfassungenUse OneNote API div tags to extract data from captures

Gilt für Heimanwender-Notizbücher in OneDrive | Unternehmensnotizbücher in Office 365Applies to Consumer notebooks on OneDrive | Enterprise notebooks on Office 365

Verwenden Sie die OneNote-API zum Extrahieren von Visitenkartendaten aus einem Bild oder von Rezept- und Produktdaten von einer URL.Use the OneNote API to extract business card data from an image, or recipe and product data from a URL.

ExtraktionsattributeExtraction attributes

Zum Extrahieren und Transformieren von Daten schließen Sie einfach ein div-Tag in die create-page- oder update-page-Anforderung ein, das den Quellinhalt, die Extraktionsmethode sowie ein Ausweichverhalten angibt.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. Die API rendert extrahierte Daten auf der Seite in einem einfach zu lesenden Format.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

Die Inhaltsquelle.The content source. Dies kann ein Bild einer Visitenkarte oder eine absolute URL von zahlreichen beliebten Rezept- oder Produktwebsites sein.This can be an image of a business card or an absolute URL from many popular recipe or product websites. Erforderlich. Required.

Verwenden Sie für optimale Ergebnisse beim Angeben einer URL die kanonische URL, die ggf. im HTML-Code der Quellwebseite definiert ist.For best results when specifying a URL, use the canonical URL defined in the HTML of the source webpage, if one is defined. Eine kanonische URL kann beispielsweise folgendermaßen in der Quellwebseite definiert werden: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

Die auszuführende Extraktionsmethode.The extraction method to run. Erforderlich. Required.

WertValue BeschreibungDescription
extract.businesscardextract.businesscard Extraktionen von Visitenkarten.A business card extraction.
extract.recipeextract.recipe Extraktionen von Rezepten.A recipe extraction.
extract.productextract.product Extraktionen von Produktlisten.A product listing extraction.
extractextract Ein unbekannter Datenextraktionstyp.An unknown extraction type.

Für optimale Ergebnisse geben Sie den Inhaltstyp (extract.businesscard, extract.recipe oder extract.product) an, falls bekannt.For best results, specify the content type (extract.businesscard, extract.recipe, or extract.product) if you know it. Wenn der Typ nicht bekannt ist, verwenden Sie die extract-Methode, und die OneNote-API versucht daraufhin, den Typ automatisch zu ermitteln.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

Das Ausweichverhalten, wenn die Extraktion fehlschlägt.The fallback behavior if the extraction fails. Wenn der Wert weggelassen wird, gilt der Standardwert render.Defaults to render if omitted.

WertValue BeschreibungDescription
render()render Rendert das Quellbild oder eine Momentaufnahme der Rezept- oder Produktwebseite.Renders the source image or a snapshot of the recipe or product webpage.
n/vnone Hat keine Wirkung. Does nothing.

Die Option ist nützlich, wenn Sie zusätzlich zum extrahierten Inhalt immer eine Momentaufnahme der Visitenkarte oder Webseite auf der Seite einschließen möchten.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. Achten Sie darauf, ein separates img-Element in der Anforderung zu senden, wie in den Beispielen dargestellt.Be sure to send a separate img element in the request, as shown in the examples.

Extraktionen von VisitenkartenBusiness card extractions

Die OneNote-API sucht und rendert die folgenden Kontaktinformationen basierend auf dem Bild einer Visitenkarte einer Person oder eines Unternehmens.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.

  • NameName
  • TitelTitle
  • OrganisationOrganization
  • Telefon- und FaxnummerPhone and fax numbers
  • Postanschrift und physische AdressenMailing and physical addresses
  • E-Mail-AdressenEmail addresses
  • WebsitesWebsites
An example business card extraction

Eine vCard (.VCF-Datei) mit den extrahierten Kontaktinformationen wird ebenfalls in die Seite eingebettet. Die vCard-Datei ist eine bequeme Möglichkeit zum Abrufen von Kontaktinformationen beim Abrufen von HTML-Seiteninhalten.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.

Häufige Szenarien für VisitenkartenextraktionenCommon scenarios for business card extractions

Abbildung zum Extrahieren von Visitenkarteninformationen und Rendern der VisitenkarteExtract business card information, and also render the business card image

Geben Sie die extract.businesscard-Methode und das none-Ausweichverhalten an.Specify the extract.businesscard method and the none fallback. Senden Sie auch ein img-Element mit dem src-Attribut, das auch auf das Bild verweist.Also send an img element with the src attribute that also references the image. Wenn die API keinen Inhalt extrahieren kann, wird nur das Bild der Visitenkarte gerendert.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" />

Abbildung zum Extrahieren von Visitenkarteninformationen und Rendern des Bilds der Visitenkarte, wenn die Extraktion fehlschlägtExtract business card information, and render the business card image only if the extraction fails

Geben Sie die extract.businesscard-Methode an, und verwenden Sie das standardmäßige render-Ausweichverhalten.Specify the extract.businesscard method and use the default render fallback. Wenn die API keinen Inhalt extrahieren kann, wird stattdessen das Bild der Visitenkarte gerendert.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>

Bei Visitenkartenextraktionen wird das Bild als benannten Teil in einer mehrteiligen Anforderung gesendet.For business card extractions, the image is sent as a named part in a multipart request. Unter Hinzufügen von Bildern und Dateien finden Sie Beispiele, in denen gezeigt wird, wie ein Bild in einer Anforderung gesendet wird.See Add images and files for examples that show how to send an image in a request.

Extraktionen von RezeptenRecipe extractions

Die OneNote-API sucht und rendert die folgenden Informationen auf der Grundlage einer Rezeptkarten-URL.The OneNote API tries to find and render the following information based on a recipe's URL.

  • Großformatiges HintergrundbildHero image
  • BewertungRating
  • ZutatenIngredients
  • AnweisungenInstructions
  • Vorbereitungs-, Koch- und GesamtzeitenPrep, cook, and total times
  • PortionenServings
An example recipe extraction

Die API ist für Rezepte von vielen beliebten Websites wie Allrecipes.com, FoodNetwork.com und SeriousEats.com optimiert.The API is optimized for recipes from many popular sites such as Allrecipes.com, FoodNetwork.com, and SeriousEats.com.

Häufige Szenarien für RezeptextraktionenCommon scenarios for recipe extractions

Extrahieren von Rezeptinformationen und Rendern eines Snapshots der RezeptwebseiteExtract recipe information, and also render a snapshot of the recipe webpage

Geben Sie die extract.recipe-Methode und das none-Ausweichverhalten an.Specify the extract.recipe method and the none fallback. Senden Sie auch ein img-Element, wobei das data-render-src-Attribut auf die Rezept-URL festgelegt ist.Also send an img element with the data-render-src attribute set to the recipe URL. Wenn die API keinen Inhalt extrahieren kann, wird nur ein Snapshot der Rezeptwebseite gerendert.If the API is unable to extract any content, it renders a snapshot of the recipe webpage only.

Dieses Szenario bietet möglicherweise die meisten Informationen, da die Webseite weitere Informationen, wie z. B. Kundenbewertungen und Vorschläge, enthalten kann.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/" />

Extrahieren von Rezeptinformationen und Rendern eines Snapshots der Rezeptwebseite, wenn die Extraktion fehlschlägtExtract recipe information, and render a snapshot of the recipe webpage only if the extraction fails

Geben Sie die extract.recipe-Methode an, und verwenden Sie das standardmäßige Render-Ausweichverhalten.Specify the extract.recipe method and use the default render fallback. Wenn die API keinen Inhalt extrahieren kann, wird stattdessen ein Snapshot der Rezeptwebseite gerendert.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>

Geben Sie die extract.recipe-Methode und das none-Ausweichverhalten an.Specify the extract.recipe method and the none fallback. Senden Sie auch ein a-Element, wobei das src-Attribut auf die Rezept-URL festgelegt ist (Sie können alternativ auch andere Informationen senden, die Sie der Seite hinzufügen möchten).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). Wenn die API keinen Inhalt extrahieren kann, wird nur der Rezept-Link gerendert.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>

Extraktionen von ProduktlistenProduct listing extractions

  • TitelTitle
  • BewertungRating
  • Primäres BildPrimary image
  • BeschreibungDescription
  • FeaturesFeatures
  • SpezifikationenSpecifications
An example product listing extraction

Die API ist für Produkte von vielen beliebten Websites wie Amazon.com und HomeDepot.com optimiert.The API is optimized for products from many popular sites such as Amazon.com and HomeDepot.com.

Häufige Szenarien für RezeptextraktionenCommon scenarios for recipe extractions

Extrahieren von Produktinformationen und Rendern eines Snapshots der ProduktwebseiteExtract product information, and also render a snapshot of the product webpage

Geben Sie die extract.product-Methode und das none-Ausweichverhalten an.Specify the extract.product method and the none fallback. Senden Sie auch ein img-Element, wobei das data-render-src-Attribut auf die Produkt-URL festgelegt ist.Also send an img element with the data-render-src attribute set to the product URL. Wenn die API keinen Inhalt extrahieren kann, wird nur ein Snapshot der Produktwebseite gerendert.If the API is unable to extract any content, it renders a snapshot of the product webpage only.

Dieses Szenario bietet möglicherweise die meisten Informationen, da die Webseite weitere Informationen, wie z. B. Kundenbewertungen und Vorschläge, enthalten kann.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" />

Extrahieren von Produktinformationen und Rendern eines Snapshots der Produktwebseite, wenn die Extraktion fehlschlägtExtract product information, and render a snapshot of the product webpage only if the extraction fails

Geben Sie die extract.product-Methode an, und verwenden Sie das standardmäßige Render-Ausweichverhalten.Specify the extract.product method and use the default render fallback. Wenn die API keinen Inhalt extrahieren kann, wird stattdessen ein Snapshot der Produktwebseite gerendert.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>

Geben Sie die extract.product-Methode und das none-Ausweichverhalten an.Specify the extract.product method and the none fallback. Senden Sie auch ein a-Element, wobei das src-Attribut auf die Produkt-URL festgelegt ist (Sie können alternativ auch andere Informationen senden, die Sie der Seite hinzufügen möchten).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). Wenn die API keinen Inhalt extrahieren kann, wird nur der Seitenlink gerendert.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>

Extraktionen unbekannter InhaltstypenUnknown content type extractions

Wenn Sie den Inhaltstyp (Visitenkarte, Rezept oder Produkt), den Sie versenden möchten, nicht kennen, können Sie die unqualifizierte extract-Methode verwenden und die OneNote-API den Typ automatisch erkennen lassen.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. Dies ist möglicherweise sinnvoll, wenn Ihre App andere Erfassungstypen sendet.You might want to do this if your app sends different capture types.

Hinweis: Wenn Sie den Inhaltstyp kennen, den Sie senden, verwenden Sie die Methode extract.businesscard, extract.recipe oder 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. In einigen Fällen kann dies hilfreich sein, um die Extraktionsergebnisse zu optimieren.In some cases, this can help to optimize the extraction results.

Häufige Szenarien für Extraktionen unbekannter InhaltstypenCommon scenarios for unknown extractions

Senden Sie ein Bild oder eine URL, und rendern Sie das bereitgestellte Bild oder einen Snapshot der Webseite, wenn die Extraktion fehlschlägtSend an image or a URL, and render the supplied image or a snapshot of the webpage if the extraction fails

Geben Sie die extract-Methode an, damit die API den Inhaltstyp automatisch erkennen kann und verwenden Sie das standardmäßige render-Ausweichverhalten.Specify the extract method so the API automatically detects the content type, and use the default render fallback. Wenn die API keinen Inhalt extrahieren kann, wird stattdessen das bereitgestellte Bild oder ein Snapshot der Webseite gerendert.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>

Informationen in der AntwortResponse information

AntwortdatenResponse data BeschreibungDescription
ErfolgscodeSuccess code HTTP-Statuscode 201 bei erfolgreich ausgeführter POST-Anforderung, HTTP-Statuscode 204 bei erfolgreich ausgeführter PATCH-AnforderungA 201 HTTP status code for a successful POST request, and a 204 HTTP status code for a successful PATCH request.
FehlerErrors Informationen zu OneNote-Fehlern, die Microsoft Graph zurückgeben kann, finden Sie unter Fehlercodes für OneNote-APIs in Microsoft Graph.Read Error codes for OneNote APIs in Microsoft Graph to learn about OneNote errors that Microsoft Graph can return.

BerechtigungenPermissions

Zum Erstellen oder Aktualisieren von OneNote-Seiten müssen Sie die entsprechenden Berechtigungen anfordern.To create or update OneNote pages, you'll need to request appropriate permissions. Wählen Sie die niedrigste Berechtigungsstufe, die Ihre App zur Erledigung ihrer Aufgaben benötigt.Choose the lowest level of permissions that your app needs to do its work.

Berechtigungen für BEITRAG-SeitenPermissions for POST pages

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

Berechtigungen für PATCH-SeitenPermissions for PATCH pages

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

Weitere Informationen zu Berechtigungsbereichen und deren Funktionsweise finden Sie in der Microsoft Graph-Berechtigungsreferenz.For more information about permission scopes and how they work, see Microsoft Graph permissions reference.

Siehe auchSee also