Document Models - Analyze Document
Analyseert document met documentmodel.
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview
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. |
model
|
path | True |
string |
Unieke documentmodelnaam. Regex-patroon: |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
features
|
query |
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'). |
|
output
|
query |
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-patroon: |
|
query
|
query |
string[] |
Lijst met extra velden die moeten worden geëxtraheerd. Bijvoorbeeld "NumberOfGuests,StoreNumber" |
|
string
|
query |
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. Kopteksten
|
|
Other Status Codes |
Een onverwacht foutbericht. |
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
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"
}
Voorbeeldrespons
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
Voorbeeldaanvraag
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"
}
Voorbeeldrespons
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 |
---|---|
Analyze |
Parameters voor documentanalyse. |
Content |
Indeling van de inhoud in geanalyseerd resultaat. |
Document |
Lijst met optionele analysefuncties. |
Error |
Het foutobject. |
Error |
Foutreactieobject. |
Inner |
Een object met specifiekere informatie over de fout. |
String |
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 |
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 |
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 |
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. |