Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Analyseert document met documentmodel.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview

With optional parameters:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Het eindpunt van de Document Intelligence-service.
modelId	path	True	string	Unieke documentmodelnaam. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
features	query		DocumentAnalysisFeature[]	Lijst met optionele analysefuncties.
locale	query		string	Landinstellingenhint voor tekstherkenning en documentanalyse. De waarde mag alleen de taalcode bevatten (bijvoorbeeld 'en', 'fr') of de taalcode BCP 47 (bijvoorbeeld 'en-US').
outputContentFormat	query		ContentFormat	Indeling van de inhoud van het analyseresultaat op het hoogste niveau.
pages	query		string	Lijst met te analyseren paginanummers op basis van 1. Bijvoorbeeld "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Lijst met extra velden die moeten worden geëxtraheerd. Bijvoorbeeld "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Methode die wordt gebruikt voor het berekenen van tekenreeks offset en lengte.

Aanvraagbody

Name	Type	Description
base64Source	string	Base64-codering van het document dat moet worden geanalyseerd. UrlSource of base64Source moet worden opgegeven.
urlSource	string	Document-URL om te analyseren. UrlSource of base64Source moet worden opgegeven.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Een onverwacht foutbericht.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

Name	Description
https://cognitiveservices.azure.com/.default

Voorbeelden

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview

Analyze Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "urlSource": "http://host.com/doc.pdf"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview

Definities

Name	Description
AnalyzeDocumentRequest	Parameters voor documentanalyse.
ContentFormat	Indeling van de inhoud in geanalyseerd resultaat.
DocumentAnalysisFeature	Lijst met optionele analysefuncties.
Error	Het foutobject.
ErrorResponse	Foutreactieobject.
InnerError	Een object met specifiekere informatie over de fout.
StringIndexType	Methode die wordt gebruikt voor het berekenen van tekenreeks offset en lengte.

AnalyzeDocumentRequest

Parameters voor documentanalyse.

Name	Type	Description
base64Source	string	Base64-codering van het document dat moet worden geanalyseerd. UrlSource of base64Source moet worden opgegeven.
urlSource	string	Document-URL om te analyseren. UrlSource of base64Source moet worden opgegeven.

ContentFormat

Indeling van de inhoud in geanalyseerd resultaat.

Name	Type	Description
markdown	string	Markdown-weergave van de documentinhoud met sectiekoppen, tabellen, enzovoort.
text	string	Tekst zonder opmaak weergeven van de documentinhoud zonder opmaak.

DocumentAnalysisFeature

Lijst met optionele analysefuncties.

Name	Type	Description
barcodes	string	Schakel de detectie van streepjescodes in het document in.
formulas	string	Schakel de detectie van wiskundige expressies in het document in.
keyValuePairs	string	Schakel de detectie van algemene sleutelwaardeparen (formuliervelden) in het document in.
languages	string	Schakel de detectie van de taal van de tekstinhoud in.
ocrHighResolution	string	Ocr uitvoeren met een hogere resolutie voor het verwerken van documenten met kleine lettertjes.
queryFields	string	Schakel de extractie van extra velden in via de queryparameter queryFields.
styleFont	string	Schakel de herkenning van verschillende lettertypestijlen in.

Error

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorResponse

Foutreactieobject.

Name	Type	Description
error	Error	Foutinformatie.

InnerError

Een object met specifiekere informatie over de fout.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	InnerError	Interne fout.
message	string	Een door mensen leesbare weergave van de fout.

StringIndexType

Methode die wordt gebruikt voor het berekenen van tekenreeks offset en lengte.

Name	Type	Description
textElements	string	Door de gebruiker waargenomen weergaveteken of grafemecluster, zoals gedefinieerd door Unicode 8.0.0.
unicodeCodePoint	string	Tekeneenheid die wordt vertegenwoordigd door één Unicode-codepunt. Wordt gebruikt door Python 3.
utf16CodeUnit	string	Tekeneenheid die wordt vertegenwoordigd door een 16-bits Unicode-code-eenheid. Wordt gebruikt door JavaScript, Java en .NET.