Document Classifiers - Build Classifier

Serviço:

Azure AI Services

Versão da API:

2024-11-30

Cria um classificador de documentos personalizado.

POST {endpoint}/documentintelligence/documentClassifiers:build?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 minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
classifierId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nome exclusivo do classificador de documentos.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Lista de tipos de documentos contra os quais classificar.
allowOverwrite		boolean	Permitir a substituição de um classificador existente com o mesmo nome.
baseClassifierId		string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Base classifierId em cima do qual treinar o classificador.
description		string maxLength: 4096	Descrição do classificador de documentos.

Respostas

Name	Tipo	Description
202 Accepted		O pedido foi aceite para processamento, mas o processamento ainda não foi concluído. Cabeçalhos Operation-Location: string Retry-After: integer
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

Build Document Classifier

Pedido de amostra

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

Resposta da amostra

Código de estado:

202

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

Definições

Name	Description
AzureBlobContentSource	Conteúdo do Armazenamento de Blobs do Azure.
AzureBlobFileListContentSource	Lista de ficheiros no Armazenamento de Blobs do Azure.
BuildDocumentClassifierRequest	Corpo da solicitação para criar um novo classificador de documento personalizado.
ClassifierDocumentTypeDetails	Informações do tipo de documento do classificador.
ContentSourceKind	Tipo de fonte de conteúdo.
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.

AzureBlobContentSource

Object

Conteúdo do Armazenamento de Blobs do Azure.

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

AzureBlobFileListContentSource

Object

Lista de ficheiros no Armazenamento de Blobs do Azure.

Name	Tipo	Description
containerUrl	string (uri)	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.

BuildDocumentClassifierRequest

Object

Corpo da solicitação para criar um novo classificador de documento personalizado.

Name	Tipo	Default value	Description
allowOverwrite	boolean	False	Permitir a substituição de um classificador existente com o mesmo nome.
baseClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Base classifierId em cima do qual treinar o classificador.
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Nome exclusivo do classificador de documentos.
description	string maxLength: 4096		Descrição do classificador de documentos.
docTypes	<string,  ClassifierDocumentTypeDetails>		Lista de tipos de documentos contra os quais classificar.

ClassifierDocumentTypeDetails

Object

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

Enumeração

Tipo de fonte de conteúdo.

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

DocumentIntelligenceError

Object

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

Object

Objeto de resposta de erro.

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

DocumentIntelligenceInnerError

Object

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.