Document Classifiers - Classify Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Clasifica el documento con clasificador de documentos.

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-02-29-preview

With optional parameters:

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-02-29-preview&stringIndexType={stringIndexType}&split={split}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
classifierId	path	True	string	Nombre único del clasificador de documentos. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string	Punto de conexión del servicio Document Intelligence.
api-version	query	True	string	Versión de API que se usará para la operación.
split	query		SplitMode	Modo de división de documentos.
stringIndexType	query		StringIndexType	Método utilizado para calcular el desplazamiento y la longitud de la cadena.

Cuerpo de la solicitud

Nombre	Tipo	Description
base64Source	string	Codificación base64 del documento que se va a clasificar. Se debe especificar urlSource o base64Source.
urlSource	string	Dirección URL del documento que se va a clasificar. Se debe especificar urlSource o base64Source.

Respuestas

Nombre	Tipo	Description
202 Accepted		La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Respuesta de error inesperada.

Seguridad

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Ejemplos

Classify Document from Url

Sample Request

HTTP

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

Sample Response

Status code:

202

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

Definiciones

Nombre	Description
ClassifyDocumentRequest	Parámetros de clasificación de documentos.
Error	Objeto de error.
ErrorResponse	Objeto de respuesta de error.
InnerError	Objeto que contiene información más específica sobre el error.
SplitMode	Modo de división de documentos.
StringIndexType	Método utilizado para calcular el desplazamiento y la longitud de la cadena.

ClassifyDocumentRequest

Parámetros de clasificación de documentos.

Nombre	Tipo	Description
base64Source	string	Codificación base64 del documento que se va a clasificar. Se debe especificar urlSource o base64Source.
urlSource	string	Dirección URL del documento que se va a clasificar. Se debe especificar urlSource o base64Source.

Error

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorResponse

Objeto de respuesta de error.

Nombre	Tipo	Description
error	Error	Información de error.

InnerError

Objeto que contiene información más específica sobre el error.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
innererror	InnerError	Error interno.
message	string	Representación legible del error.

SplitMode

Modo de división de documentos.

Nombre	Tipo	Description
auto	string	Divida automáticamente el archivo en documentos.
none	string	Trate todo el archivo como un único documento.
perPage	string	Trate cada página del archivo como un documento independiente.

StringIndexType

Método utilizado para calcular el desplazamiento y la longitud de la cadena.

Nombre	Tipo	Description
textElements	string	Carácter de presentación percibido por el usuario o clúster de grafos, tal y como se define en Unicode 8.0.0.
unicodeCodePoint	string	Unidad de caracteres representada por un único punto de código unicode. Usado por Python 3.
utf16CodeUnit	string	Unidad de caracteres representada por una unidad de código Unicode de 16 bits. Usado por JavaScript, Java y .NET.