Custom Models - Analyze Document

Dienst:

Azure AI Services

API-Version:

2.1

Extrahiert Schlüssel-Wert-Paare, Tabellen und semantische Werte aus einem jeweiligen Dokument Das Eingabedokument muss einem der unterstützten Inhaltstypen entsprechen: "application/pdf", "image/jpeg", "image/png", "image/tiff" oder "image/bmp". Alternativ können Sie den Typ "application/json" verwenden, um den Speicherort (Uri oder lokaler Pfad) des zu analysierenden Dokuments anzugeben.

POST {endpoint}/formrecognizer/v2.1/custom/models/{modelId}/analyze

Mit optionalen Parametern:

POST {endpoint}/formrecognizer/v2.1/custom/models/{modelId}/analyze?includeTextDetails={includeTextDetails}&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
modelId	path	True	string uuid	Modellbezeichner.
includeTextDetails	query		boolean	Schließen Sie Textzeilen und Elementverweise in das Ergebnis ein.
pages	query		string[]	Benutzerdefinierte Seitenzahlen für mehrseitige Dokumente (PDF/TIFF), geben Sie die Anzahl der Seiten ein, die Das OCR-Ergebnis erhalten soll. Verwenden Sie für einen Bereich von Seiten 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. Header 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

Typ: apiKey
In: header

Beispiele

Analyze form with custom model

Beispielanforderung

HTTP

POST {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8/analyze

Beispiel für eine Antwort

Statuscode:

202

Operation-Location: {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Definitionen

Name	Beschreibung
ErrorInformation
ErrorResponse
SourcePath	URI oder lokaler Pfad zu Quelldaten.

ErrorInformation

Name	Typ	Beschreibung
code	string
message	string

ErrorResponse

Name	Typ	Beschreibung
error	ErrorInformation

SourcePath

URI oder lokaler Pfad zu Quelldaten.

Name	Typ	Beschreibung
source	string	Dateiquellpfad.