Document Classifiers - Get Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}?api-version=2024-02-29-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
classifierId	path	True	string	Nome exclusivo do classificador de documentos. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string	O ponto final de serviço do Document Intelligence.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

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

Respostas

Name	Tipo	Description
200 OK	DocumentClassifierDetails	O pedido foi efetuada com êxito. Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Exemplos

Get Document Classifier

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier?api-version=2024-02-29-preview

Sample Response

Status code:

200

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "createdDateTime": "2022-07-30T00:00:00Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-02-29-preview",
  "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

Name	Description
AzureBlobContentSource	Armazenamento de Blobs do Azure conteúdo.
AzureBlobFileListContentSource	Lista de ficheiros no Armazenamento de Blobs do Azure.
ClassifierDocumentTypeDetails	Informações do tipo de documento do classificador.
ContentSourceKind	Tipo de origem de conteúdo.
DocumentClassifierDetails	Informações do classificador de documentos.
Error	O objeto de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Um objeto que contém informações mais específicas sobre o erro.
Warning	O objeto de erro.

AzureBlobContentSource

Armazenamento de Blobs do Azure conteúdo.

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

AzureBlobFileListContentSource

Lista de ficheiros no Armazenamento de Blobs do Azure.

Name	Tipo	Description
containerUrl	string	Armazenamento de Blobs do Azure URL do contentor.
fileList	string	Caminho para um ficheiro JSONL no contentor que especifica um subconjunto de documentos.

ClassifierDocumentTypeDetails

Informações do tipo de documento do classificador.

Name	Tipo	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Armazenamento de Blobs do Azure lista de ficheiros que especifica os dados de preparação para um tipo de documento classificador. Tem de especificar azureBlobSource ou azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Armazenamento de Blobs do Azure localização que contém os dados de preparação de um tipo de documento classificador. Tem de especificar azureBlobSource ou azureBlobFileListSource.
sourceKind	ContentSourceKind	Tipo de origem de dados de preparação.

ContentSourceKind

Tipo de origem de conteúdo.

Name	Tipo	Description
azureBlob	string	Ficheiros num caminho dentro de um contentor de Armazenamento de Blobs do Azure.
azureBlobFileList	string	Uma lista de ficheiros que especifica ficheiros individuais num contentor de Armazenamento de Blobs do Azure.
base64	string	Conteúdo representado através da codificação Base64.
url	string	Conteúdo num URL específico.

DocumentClassifierDetails

Informações do classificador de documentos.

Name	Tipo	Description
apiVersion	string	Versão da API utilizada para criar este classificador de documentos.
baseClassifierId	string	ClassifierId base sobre o qual o classificador foi preparado.
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 para classificar.
expirationDateTime	string	Data e hora (UTC) em que o classificador de documentos irá expirar.
warnings	Warning[]	Lista de avisos encontrados ao criar o classificador.

Error

O objeto de erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
innererror	InnerError	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 destino do erro.

ErrorResponse

Objeto de resposta de erro.

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

InnerError

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

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
innererror	InnerError	Erro interno.
message	string	Uma representação legível por humanos do erro.

Warning

O objeto de erro.

Name	Tipo	Description
code	string	Um dos conjuntos definidos pelo servidor de códigos de aviso.
message	string	Uma representação legível por humanos do aviso.
target	string	O destino do erro.