Document Classifiers - Classify Document
Hiermee classificeert u het document met documentclassificatie.
POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-02-29-preview
POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-02-29-preview&stringIndexType={stringIndexType}&split={split}
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
classifier
|
path | True |
string |
Unieke naam voor documentclassificatie. Regex-patroon: |
endpoint
|
path | True |
string |
Het eindpunt van de Document Intelligence-service. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
split
|
query |
Modus voor het splitsen van documenten. |
||
string
|
query |
Methode die wordt gebruikt voor het berekenen van tekenreeks offset en lengte. |
Aanvraagbody
Name | Type | Description |
---|---|---|
base64Source |
string |
Base64-codering van het te classificeren document. UrlSource of base64Source moet worden opgegeven. |
urlSource |
string |
Te classificeren document-URL. 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
Classify Document from Url
Voorbeeldaanvraag
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/classifierId:analyze?_overload=classifyDocument&api-version=2024-02-29-preview&stringIndexType=textElements
{
"urlSource": "http://host.com/doc.pdf"
}
Voorbeeldrespons
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview
Definities
Name | Description |
---|---|
Classify |
Parameters voor documentclassificatie. |
Error |
Het foutobject. |
Error |
Foutreactieobject. |
Inner |
Een object met specifiekere informatie over de fout. |
Split |
Modus voor het splitsen van documenten. |
String |
Methode die wordt gebruikt voor het berekenen van tekenreeks offset en lengte. |
ClassifyDocumentRequest
Parameters voor documentclassificatie.
Name | Type | Description |
---|---|---|
base64Source |
string |
Base64-codering van het te classificeren document. UrlSource of base64Source moet worden opgegeven. |
urlSource |
string |
Te classificeren document-URL. UrlSource of base64Source moet worden opgegeven. |
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. |
SplitMode
Modus voor het splitsen van documenten.
Name | Type | Description |
---|---|---|
auto |
string |
Bestand automatisch splitsen in documenten. |
none |
string |
Behandel het hele bestand als één document. |
perPage |
string |
Behandel elke pagina in het bestand als een afzonderlijk document. |
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. |