Analyzer - Analyze Id Document

Service:

Azure AI Services

API-versie:

2.1

Veldtekst en semantische waarden extraheren uit een bepaald id-document. Het invoerdocument moet van een van de ondersteunde inhoudstypen zijn: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' of 'image/bmp'. U kunt ook het type toepassing/json gebruiken om de locatie (URI) op te geven van het document dat moet worden geanalyseerd.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus2.api.cognitive.microsoft.com).
includeTextDetails	query		boolean	Neem tekstregels en elementverwijzingen op in het resultaat.
pages	query		string[]	Aangepaste paginanummers voor documenten met meerdere pagina's (PDF/TIFF), voeren het aantal pagina's in dat u ocr-resultaat wilt ophalen. Gebruik een afbreekstreepje voor een reeks pagina's. Scheid elke pagina of elk bereik met een komma.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string

Aanvraagbody

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

Name	Type	Description
source	string	Bestandsbronpad.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is in de wachtrij geplaatst. Kopteksten Operation-Location: string
Other Status Codes	ErrorResponse	Antwoordentiteit bij niet-geslaagde antwoorden met aanvullende informatie over de fout.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

Analyze ID

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

202

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

Definities

Name	Description
ErrorInformation
ErrorResponse
SourcePath	URI of lokaal pad naar brongegevens.

ErrorInformation

Name	Type	Description
code	string
message	string

ErrorResponse

Name	Type	Description
error	ErrorInformation

SourcePath

URI of lokaal pad naar brongegevens.

Name	Type	Description
source	string	Bestandsbronpad.