Document Classifiers - Get Classifier

Serviço:

Azure AI Services

Versão da API:

2024-11-30

Obtém informações detalhadas do classificador de documentos.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
classifierId	path	True	string	Nome do classificador de documento exclusivo. Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string uri	O ponto de extremidade do serviço do Document Intelligence.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigató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

Nome	Tipo	Description
200 OK	DocumentClassifierDetails	A solicitação foi bem-sucedida. 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
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Exemplos

Get Document Classifier

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

{
  "classifierId": "myClassifier",
  "description": "Classifier 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": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
        "fileList": "formB.jsonl"
      }
    }
  }
}

Definições

Nome	Description
AzureBlobContentSource	Conteúdo do Armazenamento de Blobs do Azure.
AzureBlobFileListContentSource	Lista de arquivos no Armazenamento de Blobs do Azure.
ClassifierDocumentTypeDetails	Informações de tipo de documento do classificador.
ContentSourceKind	Tipo de fonte de conteúdo.
DocumentClassifierDetails	Informações do classificador de documento.
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.

AzureBlobContentSource

Conteúdo do Armazenamento de Blobs do Azure.

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

AzureBlobFileListContentSource

Lista de arquivos no Armazenamento de Blobs do Azure.

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

ClassifierDocumentTypeDetails

Informações de tipo de documento do classificador.

Nome	Tipo	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Lista de arquivos do Armazenamento de Blobs do Azure especificando os dados de treinamento para um tipo de documento 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 classificador. AzureBlobSource ou azureBlobFileListSource devem ser especificados.
sourceKind	ContentSourceKind	Tipo de fonte de dados de treinamento.

ContentSourceKind

Tipo de fonte de conteúdo.

Nome	Tipo	Description
azureBlob	string	Arquivos em um caminho dentro de um contêiner do Armazenamento de Blobs do Azure.
azureBlobFileList	string	Uma lista de arquivos que especifica arquivos individuais em um contêiner do Armazenamento de Blobs do Azure.
base64	string	Conteúdo representado por meio da codificação Base64.
url	string	Conteúdo em uma URL específica.

DocumentClassifierDetails

Informações do classificador de documento.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar este classificador de documento.
baseClassifierId	string	ClassifierId base na parte superior da qual o classificador foi treinado.
classifierId	string	Nome do classificador de documento exclusivo.
createdDateTime	string	Data e hora (UTC) quando o classificador de documento foi criado.
description	string	Descrição do classificador de documento.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lista de tipos de documento com os quais classificar.
expirationDateTime	string	Data e hora (UTC) em que o classificador de documento expirará.
modifiedDateTime	string	Data e hora (UTC) quando 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.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
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 pelo ser humano do erro.
target	string	O destino do erro.

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

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

DocumentIntelligenceInnerError

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

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

DocumentIntelligenceWarning

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de aviso.
message	string	Uma representação legível pelo ser humano do aviso.
target	string	O destino do erro.