Analyzer - Analyze Id Document

Usługa:

Azure AI Services

Wersja interfejsu API:

2.1

Wyodrębnij tekst pola i wartości semantyczne z danego dokumentu identyfikatora. Dokument wejściowy musi być jednym z obsługiwanych typów zawartości — "application/pdf", "image/jpeg", "image/png", "image/tiff" lub "image/bmp". Alternatywnie użyj typu "application/json", aby określić lokalizację (identyfikator URI) dokumentu do przeanalizowania.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus2.api.cognitive.microsoft.com).
includeTextDetails	query		boolean	Uwzględnij wiersze tekstu i odwołania do elementów w wyniku.
pages	query		string[]	Niestandardowe numery stron dla dokumentów wielostronicowych (PDF/TIFF), wprowadź liczbę stron, które chcesz uzyskać wynik OCR. W przypadku zakresu stron użyj łącznika. Oddziel każdą stronę lub zakres przecinkiem.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Treść żądania

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

Nazwa	Typ	Opis
source	string	Ścieżka źródła pliku.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało pomyślnie w kolejce. Nagłówki Operation-Location: string
Other Status Codes	ErrorResponse	Jednostka odpowiedzi towarzysząca nieudanych odpowiedzi zawierających dodatkowe szczegóły dotyczące błędu.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

Analyze ID

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

202

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

Definicje

Nazwa	Opis
ErrorInformation
ErrorResponse
SourcePath	Identyfikator URI lub ścieżka lokalna do danych źródłowych.

ErrorInformation

Nazwa	Typ	Opis
code	string
message	string

ErrorResponse

Nazwa	Typ	Opis
error	ErrorInformation

SourcePath

Identyfikator URI lub ścieżka lokalna do danych źródłowych.

Nazwa	Typ	Opis
source	string	Ścieżka źródła pliku.