Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2023-07-31

Cria um classificador de documento personalizado.

POST {endpoint}/formrecognizer/documentClassifiers:build?api-version=2023-07-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string url	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Versão da API solicitada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	A chave secreta para sua assinatura dos Serviços Cognitivos do Azure.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
classifierId	True	string	Nome exclusivo do classificador de documento.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Lista de tipos de documento com os quais classificar.
description		string	Descrição do classificador de documentos.

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação é enfileirada com êxito. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Erro encontrado.

Segurança

Ocp-Apim-Subscription-Key

A chave secreta para sua assinatura dos Serviços Cognitivos do Azure.

Type: apiKey
In: header

Exemplos

Build Document Classifier

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers:build?api-version=2023-07-31

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

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

Definições

Nome	Description
AzureBlobContentSource	Armazenamento de Blobs do Azure conteúdo.
AzureBlobFileListContentSource	Lista de arquivos em Armazenamento de Blobs do Azure.
BuildDocumentClassifierRequest	Corpo da solicitação para criar um novo classificador de documento personalizado.
ClassifierDocumentTypeDetails	Informações de tipo de documento do classificador.
Error	Informações de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Erro detalhado.

AzureBlobContentSource

Armazenamento de Blobs do Azure conteúdo.

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

AzureBlobFileListContentSource

Lista de arquivos em Armazenamento de Blobs do Azure.

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

BuildDocumentClassifierRequest

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

Nome	Tipo	Description
classifierId	string	Nome exclusivo do classificador de documento.
description	string	Descrição do classificador de documentos.
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	Armazenamento de Blobs do Azure lista de arquivos que especifica os dados de treinamento para um tipo de documento classificador. AzureBlobSource ou azureBlobFileListSource deve ser especificado.
azureBlobSource	AzureBlobContentSource	Armazenamento de Blobs do Azure local que contém os dados de treinamento para um tipo de documento classificador. AzureBlobSource ou azureBlobFileListSource deve ser especificado.

Error

Informações de erro.

Nome	Tipo	Description
code	string	Código do erro.
details	Error[]	Lista de erros detalhados.
innererror	InnerError	Erro detalhado.
message	string	Mensagem de erro.
target	string	Destino do erro.

ErrorResponse

Objeto de resposta de erro.

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

InnerError

Erro detalhado.

Nome	Tipo	Description
code	string	Código do erro.
innererror	InnerError	Erro detalhado.
message	string	Mensagem de erro.