Document Classifiers - List Classifiers

Serviço:

Azure AI Services

Versão da API:

2024-11-30

Liste todos os classificadores de documentos.

GET {endpoint}/documentintelligence/documentClassifiers?api-version=2024-11-30

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string uri	O ponto de extremidade do serviço de Inteligência de Documentos.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Respostas

Name	Tipo	Description
200 OK	PagedDocumentClassifierDetails	O pedido foi bem-sucedido. Cabeçalhos x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

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

Exemplos

Get Document Classifiers

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
AzureBlobContentSource	Conteúdo do Armazenamento de Blobs do Azure.
AzureBlobFileListContentSource	Lista de ficheiros no Armazenamento de Blobs do Azure.
ClassifierDocumentTypeDetails	Informações do tipo de documento do classificador.
ContentSourceKind	Tipo de fonte de conteúdo.
DocumentClassifierDetails	Informações do classificador de documentos.
DocumentIntelligenceError	O objeto de erro.
DocumentIntelligenceErrorResponse	Objeto de resposta de erro.
DocumentIntelligenceInnerError	Um objeto que contém informações mais específicas sobre o erro.
DocumentIntelligenceWarning	O objeto de erro.
PagedDocumentClassifierDetails	Coleção paginada de itens DocumentClassifierDetails

AzureBlobContentSource

Conteúdo do Armazenamento de Blobs do Azure.

Name	Tipo	Description
containerUrl	string	URL do contêiner de Armazenamento de Blobs do Azure.
prefix	string	Prefixo do nome do blob.

AzureBlobFileListContentSource

Lista de ficheiros no Armazenamento de Blobs do Azure.

Name	Tipo	Description
containerUrl	string	URL do contêiner de Armazenamento de Blobs do Azure.
fileList	string	Caminho para um arquivo JSONL dentro do contêiner especificando um subconjunto de documentos.

ClassifierDocumentTypeDetails

Informações do tipo de documento do classificador.

Name	Tipo	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Lista de arquivos do Armazenamento de Blobs do Azure especificando os dados de treinamento para um tipo de documento de classificador. AzureBlobSource ou azureBlobFileListSource devem ser especificados.
azureBlobSource	AzureBlobContentSource	Local do Armazenamento de Blobs do Azure que contém os dados de treinamento para um tipo de documento de classificador. AzureBlobSource ou azureBlobFileListSource devem ser especificados.
sourceKind	ContentSourceKind	Tipo de fonte de dados de treinamento.

ContentSourceKind

Tipo de fonte de conteúdo.

Name	Tipo	Description
azureBlob	string	Arquivos em um caminho dentro de um contêiner de Armazenamento de Blob do Azure.
azureBlobFileList	string	Uma lista de arquivos especificando arquivos individuais em um contêiner de Armazenamento de Blob do Azure.
base64	string	Conteúdo representado através da codificação Base64.
url	string	Conteúdo em um URL específico.

DocumentClassifierDetails

Informações do classificador de documentos.

Name	Tipo	Description
apiVersion	string	Versão da API usada para criar este classificador de documentos.
baseClassifierId	string	Base classifierId em cima do qual o classificador foi treinado.
classifierId	string	Nome exclusivo do classificador de documentos.
createdDateTime	string	Data e hora (UTC) em que o classificador de documentos foi criado.
description	string	Descrição do classificador de documentos.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lista de tipos de documentos contra os quais classificar.
expirationDateTime	string	Data e hora (UTC) em que o classificador de documentos expirará.
modifiedDateTime	string	Data e hora (UTC) em que o modelo de documento foi modificado pela última vez.
warnings	DocumentIntelligenceWarning[]	Lista de avisos encontrados durante a criação do classificador.

DocumentIntelligenceError

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	DocumentIntelligenceError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	DocumentIntelligenceInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

Name	Tipo	Description
error	DocumentIntelligenceError	Informações de erro.

DocumentIntelligenceInnerError

Um objeto que contém informações mais específicas sobre o erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	DocumentIntelligenceInnerError	Erro interno.
message	string	Uma representação legível por humanos do erro.

DocumentIntelligenceWarning

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de aviso definido pelo servidor.
message	string	Uma representação legível por humanos do aviso.
target	string	O alvo do erro.

PagedDocumentClassifierDetails

Coleção paginada de itens DocumentClassifierDetails

Name	Tipo	Description
nextLink	string	O link para a próxima página de itens
value	DocumentClassifierDetails[]	Os itens DocumentClassifierDetails nesta página