Analyzer - Analyze Receipt

Service:

Azure AI Services

API Version:

2.1

Extrahiert Feldtext und semantische Werte aus einem bestimmten Belegdokument. Das Eingabedokument muss einen der unterstützten Inhaltstypen aufweisen: "application/pdf", "image/jpeg", "image/png", "image/tiff" oder "image/bmp". Alternativ können Sie den Typ "application/json" verwenden, um den Speicherort (URI) des zu analysierenden Dokuments anzugeben.

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

With optional parameters:

POST {endpoint}/formrecognizer/v2.1/prebuilt/receipt/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	Schließen 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(default).
pages	query		string[]	Benutzerdefinierte Seitenzahlen für mehrseitige Dokumente (PDF/TIFF) geben die Anzahl der Seiten ein, die sie als OCR-Ergebnis abrufen 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	Dateiquellpfad.

Antworten

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

Sicherheit

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Beispiele

Analyze receipt

Sample Request

HTTP

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

Sample Response

Status code:

202

Operation-Location: {endpoint}/formrecognizer/v2.1/prebuilt/receipt/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(default).
SourcePath	URI oder lokaler Pfad zu Quelldaten.

ErrorInformation

Name	Typ	Beschreibung
code	string
message	string

ErrorResponse

Name	Typ	Beschreibung
error	ErrorInformation

Locale

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

Name	Typ	Beschreibung
en-AU	string
en-CA	string
en-GB	string
en-IN	string
en-US	string

SourcePath

URI oder lokaler Pfad zu Quelldaten.

Name	Typ	Beschreibung
source	string	Dateiquellpfad.