Document Classifiers - List Classifiers

Referencia

Servicio:: Azure AI Services

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

Enumera todos los clasificadores de documentos.

GET {endpoint}/documentintelligence/documentClassifiers?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	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string uuid	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	PagedDocumentClassifierDetails	La solicitud se ha realizado correctamente. Encabezados x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Una respuesta de error inesperada.

Nombre

Tipo

Description

200 OK

PagedDocumentClassifierDetails

La solicitud se ha realizado correctamente.

Encabezados

x-ms-client-request-id: string

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

Get Document Classifiers

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "classifierId": "classifier1",
      "description": "Classifier1 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-11-30",
      "docTypes": {
        "formA": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formADocs/"
          }
        },
        "formB": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formBDocs/"
          }
        }
      }
    },
    {
      "classifierId": "classifier2",
      "description": "Classifier2 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-11-30",
      "docTypes": {
        "formB": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formBDocs/"
          }
        },
        "formC": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formCDocs/"
          }
        }
      }
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers?nextLink=nextLinkData"
}

Definiciones

Nombre	Description
AzureBlobContentSource	Contenido de Azure Blob Storage.
AzureBlobFileListContentSource	Lista de archivos en Azure Blob Storage.
ClassifierDocumentTypeDetails	Información del tipo de documento clasificador.
ContentSourceKind	Tipo de origen de contenido.
DocumentClassifierDetails	Información del clasificador 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.
DocumentIntelligenceWarning	Objeto de error.
PagedDocumentClassifierDetails	Colección paginada de elementos DocumentClassifierDetails

AzureBlobContentSource

Contenido de Azure Blob Storage.

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

AzureBlobFileListContentSource

Lista de archivos en Azure Blob Storage.

Nombre	Tipo	Description
containerUrl	string	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.

ClassifierDocumentTypeDetails

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

Tipo de origen de contenido.

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

DocumentClassifierDetails

Información del clasificador de documentos.

Nombre	Tipo	Description
apiVersion	string	Versión de API que se usa para crear este clasificador de documentos.
baseClassifierId	string	ClassifierId base sobre el que se entrenó el clasificador.
classifierId	string	Nombre único del clasificador de documentos.
createdDateTime	string	Fecha y hora (UTC) cuando se creó el clasificador de documentos.
description	string	Descripción del clasificador de documentos.
docTypes	<string, ClassifierDocumentTypeDetails>	Lista de tipos de documento en los que se va a clasificar.
expirationDateTime	string	Fecha y hora (UTC) cuando expire el clasificador de documentos.
modifiedDateTime	string	Fecha y hora (UTC) cuando se modificó por última vez el modelo de documento.
warnings	DocumentIntelligenceWarning[]	Lista de advertencias detectadas al compilar el clasificador.

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.

DocumentIntelligenceWarning

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de advertencia.
message	string	Representación legible de la advertencia.
target	string	Destino del error.

PagedDocumentClassifierDetails

Colección paginada de elementos DocumentClassifierDetails

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente de elementos
value	DocumentClassifierDetails[]	Elementos DocumentClassifierDetails de esta página

Compartir a través de

Document Classifiers - List Classifiers

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

OAuth2Auth

Ámbitos

Ejemplos

Get Document Classifiers

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

ContentSourceKind

DocumentClassifierDetails

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

DocumentIntelligenceWarning

PagedDocumentClassifierDetails

Recursos adicionales