Analyzer - Analyze Id Document

Tjänst:

Azure AI Services

API-version:

2.1

Extrahera fälttext och semantiska värden från ett visst ID-dokument. Indatadokumentet måste ha någon av de innehållstyper som stöds – "application/pdf", "image/jpeg", "image/png", "image/tiff" eller "image/bmp". Du kan också använda typen "application/json" för att ange platsen (Uri) för dokumentet som ska analyseras.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).
includeTextDetails	query		boolean	Inkludera textrader och elementreferenser i resultatet.
pages	query		string[]	Anpassade sidnummer för dokument med flera sidor (PDF/TIFF), anger antalet sidor som du vill få OCR-resultat. Använd ett bindestreck för ett antal sidor. Avgränsa varje sida eller intervall med kommatecken.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Begärandetext

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

Name	Typ	Description
source	string	Sökväg till filkälla.

Svar

Name	Typ	Description
202 Accepted		Begäran har placerats i kö. Sidhuvuden Operation-Location: string
Other Status Codes	ErrorResponse	Svarsentitet som medföljer icke-lyckade svar som innehåller ytterligare information om felet.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Analyze ID

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

202

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

Definitioner

Name	Description
ErrorInformation
ErrorResponse
SourcePath	Uri eller lokal sökväg till källdata.

ErrorInformation

Name	Typ	Description
code	string
message	string

ErrorResponse

Name	Typ	Description
error	ErrorInformation

SourcePath

Uri eller lokal sökväg till källdata.

Name	Typ	Description
source	string	Sökväg till filkälla.