Document Classifiers - Build Classifier

Servicio:: Azure AI Services

Versión de la API:: 2024-11-30

Crea un clasificador de documentos personalizado.

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-11-30

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	Punto de conexión del servicio De inteligencia de documentos.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
classifierId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nombre único del clasificador de documentos.
docTypes	True	<string, ClassifierDocumentTypeDetails>	Lista de tipos de documento en los que se va a clasificar.
allowOverwrite		boolean	Permitir sobrescribir un clasificador existente con el mismo nombre.
baseClassifierId		string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	ClassifierId base en la parte superior de la que se va a entrenar el clasificador.
description		string maxLength: 4096	Descripción del clasificador de documentos.

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.

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

Build Document Classifier

Solicitud de ejemplo

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers:build?api-version=2024-11-30

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "docTypes": {
    "formA": {
      "azureBlobSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "prefix": "formADocs/"
      }
    },
    "formB": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "fileList": "formB.jsonl"
      }
    }
  }
}

Respuesta de muestra

status code:: 202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-11-30

Definiciones

Nombre	Description
AzureBlobContentSource	Contenido de Azure Blob Storage.
AzureBlobFileListContentSource	Lista de archivos en Azure Blob Storage.
BuildDocumentClassifierRequest	Cuerpo de la solicitud para crear un nuevo clasificador de documentos personalizado.
ClassifierDocumentTypeDetails	Información del tipo de documento clasificador.
ContentSourceKind	Tipo de origen de contenido.
DocumentIntelligenceError	Objeto de error.
DocumentIntelligenceErrorResponse	Objeto de respuesta de error.
DocumentIntelligenceInnerError	Objeto que contiene información más específica sobre el error.

AzureBlobContentSource

Object

Contenido de Azure Blob Storage.

Nombre	Tipo	Description
containerUrl	string (uri)	Dirección URL del contenedor de Azure Blob Storage.
prefix	string	Prefijo de nombre de blob.

AzureBlobFileListContentSource

Object

Lista de archivos en Azure Blob Storage.

Nombre	Tipo	Description
containerUrl	string (uri)	Dirección URL del contenedor de Azure Blob Storage.
fileList	string	Ruta de acceso a un archivo JSONL dentro del contenedor que especifica un subconjunto de documentos.

BuildDocumentClassifierRequest

Object

Cuerpo de la solicitud para crear un nuevo clasificador de documentos personalizado.

Nombre	Tipo	Valor predeterminado	Description
allowOverwrite	boolean	False	Permitir sobrescribir un clasificador existente con el mismo nombre.
baseClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		ClassifierId base en la parte superior de la que se va a entrenar el clasificador.
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Nombre único del clasificador de documentos.
description	string maxLength: 4096		Descripción del clasificador de documentos.
docTypes	<string, ClassifierDocumentTypeDetails>		Lista de tipos de documento en los que se va a clasificar.

ClassifierDocumentTypeDetails

Object

Información del tipo de documento clasificador.

Nombre	Tipo	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Lista de archivos de Azure Blob Storage que especifica los datos de entrenamiento para un tipo de documento clasificador. Se debe especificar azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Ubicación de Azure Blob Storage que contiene los datos de entrenamiento de un tipo de documento clasificador. Se debe especificar azureBlobSource o azureBlobFileListSource.
sourceKind	ContentSourceKind	Tipo de origen de datos de entrenamiento.

ContentSourceKind

Enumeración

Tipo de origen de contenido.

Valor	Description
url	Contenido en una dirección URL específica.
base64	Contenido representado a través de la codificación Base64.
azureBlob	Archivos en una ruta de acceso dentro de un contenedor de Azure Blob Storage.
azureBlobFileList	Una lista de archivos que especifica archivos individuales en un contenedor de Azure Blob Storage.

DocumentIntelligenceError

Object

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

Object

Objeto de respuesta de error.

Nombre	Tipo	Description
error	DocumentIntelligenceError	Información de error.

DocumentIntelligenceInnerError

Object

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.

Compartir a través de

Document Classifiers - Build Classifier

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

OAuth2Auth

Ámbitos

Ejemplos

Build Document Classifier

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AzureBlobContentSource

AzureBlobFileListContentSource

BuildDocumentClassifierRequest

ClassifierDocumentTypeDetails

ContentSourceKind

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError