Analyzer - Analyze Invoice

Dienst:

Azure AI Services

API-Version:

2.1

Extrahieren Sie Feldtext und semantische Werte aus einem bestimmten Rechnungsdokument. Das Eingabedokument muss eines der unterstützten Inhaltstypen sein : "application/pdf", "image/jpeg", "image/png", "image/tiff" oder "image/bmp". Verwenden Sie alternativ den Typ "application/json", um den Speicherort (URI) des zu analysierenden Dokuments anzugeben.

POST {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyze

Mit optionalen Parametern:

POST {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyze?includeTextDetails={includeTextDetails}&locale={locale}&pages={pages}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://westus2.api.cognitive.microsoft.com).
includeTextDetails	query		boolean	Fügen Sie Textzeilen und Elementverweise in das Ergebnis ein.
locale	query		Locale	Gebietsschema des Eingabedokuments. Unterstützte Gebietsschemas sind: en-AU, en-CA, en-GB, en-IN, en-US(Standard).
pages	query		string[]	Benutzerdefinierte Seitenzahlen für mehrseitige Dokumente (PDF/TIFF), geben Sie die Anzahl der Seiten ein, die sie zum Abrufen des OCR-Ergebnisses verwenden möchten. Verwenden Sie für einen Seitenbereich einen Bindestrich. Trennen Sie jede Seite oder jeden Bereich durch ein Komma.

Anforderungsheader

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Anforderungstext

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name	Typ	Beschreibung
source	string minLength: 0 maxLength: 2048	Dateiquellpfad.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wird erfolgreich in die Warteschlange gestellt. Header Operation-Location: string
Other Status Codes	ErrorResponse	Antwortentität, die nicht erfolgreiche Antworten mit zusätzlichen Details zum Fehler enthält.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Analyze receipt

Beispielanforderung

HTTP

POST {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyze

Beispiel für eine Antwort

Statuscode:

202

Operation-Location: {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Definitionen

Name	Beschreibung
ErrorInformation
ErrorResponse
Locale	Gebietsschema des Eingabedokuments. Unterstützte Gebietsschemas sind: en-AU, en-CA, en-GB, en-IN, en-US(Standard).
SourcePath	URI oder lokaler Pfad zu Quelldaten.

ErrorInformation

Objekt

Name	Typ	Beschreibung
code	string
message	string

ErrorResponse

Objekt

Name	Typ	Beschreibung
error	ErrorInformation

Locale

Enumeration

Gebietsschema des Eingabedokuments. Unterstützte Gebietsschemas sind: en-AU, en-CA, en-GB, en-IN, en-US(Standard).

Wert	Beschreibung
en-AU
en-CA
en-GB
en-IN
en-US

SourcePath

Objekt

URI oder lokaler Pfad zu Quelldaten.

Name	Typ	Beschreibung
source	string minLength: 0 maxLength: 2048	Dateiquellpfad.