Document Classifiers - Classify Document

Service:

Azure AI Services

API-versie:

2024-11-30

Classificeert het document met documentclassificatie.

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-11-30

Met optionele parameters:

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-11-30&stringIndexType={stringIndexType}&split={split}&pages={pages}

URI-parameters

Name	In	Vereist	Type	Description
classifierId	path	True	string	Unieke naam van documentclassificatie. Regex-patroon: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string uri	Het Eindpunt van de Document Intelligence-service.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
pages	query		string	Paginanummers op basis van 1 die moeten worden geanalyseerd. Ex. "1-3,5,7-9" Regex-patroon: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
split	query		SplitMode	De splitsmodus voor documenten.
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 geclassificeerd. UrlSource of base64Source moet worden opgegeven.
urlSource	string	Document-URL die moet worden geclassificeerd. 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	DocumentIntelligenceErrorResponse	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

Classify Document from Url

Voorbeeldaanvraag

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/classifierId:analyze?_overload=classifyDocument&api-version=2024-11-30&stringIndexType=textElements

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

Voorbeeldrespons

Statuscode:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30

Definities

Name	Description
ClassifyDocumentRequest	Parameters voor documentclassificatie.
DocumentIntelligenceError	Het foutobject.
DocumentIntelligenceErrorResponse	Foutantwoordobject.
DocumentIntelligenceInnerError	Een object met meer specifieke informatie over de fout.
SplitMode	Gedrag voor het splitsen van bestanden.
StringIndexType	Methode die wordt gebruikt voor het berekenen van tekenreeksverschil en lengte.

ClassifyDocumentRequest

Parameters voor documentclassificatie.

Name	Type	Description
base64Source	string	Base64-codering van het document dat moet worden geclassificeerd. UrlSource of base64Source moet worden opgegeven.
urlSource	string	Document-URL die moet worden geclassificeerd. UrlSource of base64Source moet worden opgegeven.

DocumentIntelligenceError

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	DocumentIntelligenceError[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Foutantwoordobject.

Name	Type	Description
error	DocumentIntelligenceError	Foutinformatie.

DocumentIntelligenceInnerError

Een object met meer specifieke informatie over de fout.

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

SplitMode

Gedrag voor het splitsen van bestanden.

Name	Type	Description
auto	string	Bestand automatisch splitsen in documenten.
none	string	Het hele bestand behandelen als één document.
perPage	string	Elke pagina in het bestand behandelen als een afzonderlijk document.

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.