Document Classifiers - Build Classifier

Serviço:

Azure AI Services

Versão da API:

2024-11-30

Cria um classificador de documento personalizado.

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-11-30

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
classifierId	True	string	Nome do classificador de documento exclusivo.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Lista de tipos de documento com os quais classificar.
allowOverwrite		boolean	Permitir a substituição de um classificador existente com o mesmo nome.
baseClassifierId		string	ClassifierId base na parte superior da qual treinar o classificador.
description		string	Descrição do classificador de documento.

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação foi aceita 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
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

Build Document Classifier

Solicitação de exemplo

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 de exemplo

Código de status:

202

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

Definições

Nome	Description
AzureBlobContentSource	Conteúdo do Armazenamento de Blobs do Azure.
AzureBlobFileListContentSource	Lista de arquivos no Armazenamento de Blobs do Azure.
BuildDocumentClassifierRequest	Solicitar corpo para criar um novo classificador de documento personalizado.
ClassifierDocumentTypeDetails	Informações de 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

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.

BuildDocumentClassifierRequest

Solicitar corpo para criar um novo classificador de documento personalizado.

Nome	Tipo	Valor padrão	Description
allowOverwrite	boolean	False	Permitir a substituição de um classificador existente com o mesmo nome.
baseClassifierId	string		ClassifierId base na parte superior da qual treinar o classificador.
classifierId	string		Nome do classificador de documento exclusivo.
description	string		Descrição do classificador de documento.
docTypes	<string,  ClassifierDocumentTypeDetails>		Lista de tipos de documento com os quais classificar.

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.

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.