Document Models - Analyze Document

Service:

Azure AI Services

API-versie:

2024-07-31-preview

Analyseert het document met een documentmodel.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string uri	Het Eindpunt van de Document Intelligence-service.
modelId	path	True	string	Unieke documentmodelnaam. Regex-patroon: ^[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	Hint voor landinstellingen voor tekstherkenning en documentanalyse. De waarde mag alleen de taalcode bevatten (bijvoorbeeld "en", "fr") of BCP 47-taaltag (bijvoorbeeld "en-US").
output	query		AnalyzeOutputOption[]	Aanvullende uitvoer die tijdens de analyse moet worden gegenereerd.
outputContentFormat	query		ContentFormat	Indeling van de inhoud op het hoogste niveau van het analyseresultaat.
pages	query		string	Lijst met op 1 gebaseerde paginanummers die moeten worden geanalyseerd. Ex. "1-3,5,7-9" Regex-patroon: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Lijst met extra velden die moeten worden geëxtraheerd. Ex. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Methode die wordt gebruikt voor het berekenen van tekenreeksverschil 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 die moet worden geanalyseerd. 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. Kopteksten Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Voorbeeldaanvraag

HTTP

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

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Voorbeeldrespons

Statuscode:

202

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

Analyze Document from Url

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:

202

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

Definities

Name	Description
AnalyzeDocumentRequest	Parameters voor documentanalyse.
AnalyzeOutputOption	Aanvullende uitvoer die tijdens de analyse moet worden gegenereerd.
ContentFormat	Indeling van de inhoud in het geanalyseerde resultaat.
DocumentAnalysisFeature	Documentanalysefuncties die u wilt inschakelen.
Error	Het foutobject.
ErrorResponse	Foutantwoordobject.
InnerError	Een object met meer specifieke informatie over de fout.
StringIndexType	Methode die wordt gebruikt voor het berekenen van tekenreeksverschil 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 die moet worden geanalyseerd. UrlSource of base64Source moet worden opgegeven.

AnalyzeOutputOption

Aanvullende uitvoer die tijdens de analyse moet worden gegenereerd.

Name	Type	Description
figures	string	Genereer bijgesneden afbeeldingen van gedetecteerde afbeeldingen.
pdf	string	Doorzoekbare PDF-uitvoer genereren.

ContentFormat

Indeling van de inhoud in het geanalyseerde resultaat.

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

DocumentAnalysisFeature

Documentanalysefuncties die u wilt inschakelen.

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 tekstinhoudstaal in.
ocrHighResolution	string	Voer OCR uit met een hogere resolutie om documenten met een kleine afdruk af te handelen.
queryFields	string	Schakel de extractie van extra velden in via de queryveld-queryparameter.
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 hebben geleid tot deze gemelde fout.
innererror	InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorResponse

Foutantwoordobject.

Name	Type	Description
error	Error	Foutinformatie.

InnerError

Een object met meer specifieke 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 leesbare weergave van de fout.

StringIndexType

Methode die wordt gebruikt voor het berekenen van tekenreeksverschil en lengte.

Name	Type	Description
textElements	string	Door de gebruiker waargenomen weergaveteken of grapheme-cluster, 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 vertegenwoordigd door een 16-bits Unicode-code-eenheid. Wordt gebruikt door JavaScript, Java en .NET.