Document Classifiers - Classify Document

Service:

Azure AI Services

Version d'API:

2024-11-30

Classifie le document avec le classifieur de document.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
classifierId	path	True	string	Nom de classifieur de document unique. Modèle d’expression régulière: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string uri	Point de terminaison du service Document Intelligence.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.
pages	query		string	Numéros de page basés sur 1 à analyser. Ex. "1-3,5,7-9" Modèle d’expression régulière: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
split	query		SplitMode	Mode de fractionnement de document.
stringIndexType	query		StringIndexType	Méthode utilisée pour calculer le décalage de chaîne et la longueur.

Corps de la demande

Nom	Type	Description
base64Source	string	Encodage base64 du document à classifier. UrlSource ou base64Source doit être spécifié.
urlSource	string	URL du document à classifier. UrlSource ou base64Source doit être spécifié.

Réponses

Nom	Type	Description
202 Accepted		La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé. En-têtes Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Réponse d’erreur inattendue.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

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

Exemples

Classify Document from Url

Exemple de requête

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"
}

Exemple de réponse

Code d’état:

202

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

Définitions

Nom	Description
ClassifyDocumentRequest	Paramètres de classification de documents.
DocumentIntelligenceError	Objet d’erreur.
DocumentIntelligenceErrorResponse	Objet de réponse d’erreur.
DocumentIntelligenceInnerError	Objet contenant des informations plus spécifiques sur l’erreur.
SplitMode	Comportement de fractionnement de fichiers.
StringIndexType	Méthode utilisée pour calculer le décalage de chaîne et la longueur.

ClassifyDocumentRequest

Paramètres de classification de documents.

Nom	Type	Description
base64Source	string	Encodage base64 du document à classifier. UrlSource ou base64Source doit être spécifié.
urlSource	string	URL du document à classifier. UrlSource ou base64Source doit être spécifié.

DocumentIntelligenceError

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	DocumentIntelligenceError[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	DocumentIntelligenceInnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

DocumentIntelligenceErrorResponse

Objet de réponse d’erreur.

Nom	Type	Description
error	DocumentIntelligenceError	Informations d’erreur.

DocumentIntelligenceInnerError

Objet contenant des informations plus spécifiques sur l’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	DocumentIntelligenceInnerError	Erreur interne.
message	string	Représentation lisible par l’homme de l’erreur.

SplitMode

Comportement de fractionnement de fichiers.

Nom	Type	Description
auto	string	Fractionner automatiquement le fichier en documents.
none	string	Traitez l’intégralité du fichier en tant que document unique.
perPage	string	Traitez chaque page du fichier comme un document distinct.

StringIndexType

Méthode utilisée pour calculer le décalage de chaîne et la longueur.

Nom	Type	Description
textElements	string	Caractère d’affichage perçu par l’utilisateur ou cluster grapheme, tel que défini par Unicode 8.0.0.
unicodeCodePoint	string	Unité de caractères représentée par un point de code Unicode unique. Utilisé par Python 3.
utf16CodeUnit	string	Unité de caractères représentée par une unité de code Unicode 16 bits. Utilisé par JavaScript, Java et .NET.