Document Classifiers - Classify Document

Servicio:

Azure AI Services

Versión de la API:

2024-11-30

Clasifica el documento con clasificador de documentos.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
classifierId	path	True	string	Nombre único del clasificador de documentos. Patrón de Regex: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string uri	Punto de conexión del servicio De inteligencia de documentos.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.
pages	query		string	Números de página basados en 1 que se van a analizar. Ex. "1-3,5,7-9" Patrón de Regex: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
split	query		SplitMode	Modo de división de documentos.
stringIndexType	query		StringIndexType	Método usado 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. Encabezados Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Una respuesta de error inesperada.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Ejemplos

Classify Document from Url

Solicitud de ejemplo

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

Respuesta de muestra

status code:

202

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

Definiciones

Nombre	Description
ClassifyDocumentRequest	Parámetros de clasificación de documentos.
DocumentIntelligenceError	Objeto de error.
DocumentIntelligenceErrorResponse	Objeto de respuesta de error.
DocumentIntelligenceInnerError	Objeto que contiene información más específica sobre el error.
SplitMode	Comportamiento de división de archivos.
StringIndexType	Método usado 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.

DocumentIntelligenceError

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	DocumentIntelligenceError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Objeto de respuesta de error.

Nombre	Tipo	Description
error	DocumentIntelligenceError	Información de error.

DocumentIntelligenceInnerError

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

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	DocumentIntelligenceInnerError	Error interno.
message	string	Representación legible del error.

SplitMode

Comportamiento de división de archivos.

Nombre	Tipo	Description
auto	string	Dividir 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 usado para calcular el desplazamiento y la longitud de la cadena.

Nombre	Tipo	Description
textElements	string	Carácter de visualización percibido por el usuario o clúster de grafos, tal 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. Se usa en JavaScript, Java y .NET.