Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

Cria um classificador de documentos personalizado.

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-02-29-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O ponto final do serviço Document Intelligence.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
classifierId	True	string	Nome exclusivo do classificador de documentos.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Lista de tipos de documentos para classificar.
baseClassifierId		string	ClassifierId base sobre o qual preparar o classificador.
description		string	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. Headers Operation-Location: string Retry-After: integer
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

Build Document Classifier

Sample Request

HTTP

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

{
  "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/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-02-29-preview

Definições

Name	Description
AzureBlobContentSource	Armazenamento de Blobs do Azure conteúdo.
AzureBlobFileListContentSource	Lista de ficheiros no Armazenamento de Blobs do Azure.
BuildDocumentClassifierRequest	Peça ao corpo para criar um novo classificador de documento personalizado.
ClassifierDocumentTypeDetails	Informações do tipo de documento do classificador.
ContentSourceKind	Tipo de origem de conteúdo.
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.

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.

BuildDocumentClassifierRequest

Peça ao corpo para criar um novo classificador de documento personalizado.

Name	Tipo	Description
baseClassifierId	string	ClassifierId base sobre o qual preparar o classificador.
classifierId	string	Nome exclusivo do classificador de documentos.
description	string	Descrição do classificador de documentos.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lista de tipos de documentos para classificar.

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. AzureBlobSource ou azureBlobFileListSource têm de ser especificados.
azureBlobSource	AzureBlobContentSource	Armazenamento de Blobs do Azure localização que contém os dados de preparação de um tipo de documento classificador. AzureBlobSource ou azureBlobFileListSource têm de ser especificados.
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 Armazenamento de Blobs do Azure.
base64	string	Conteúdo representado através da codificação Base64.
url	string	Conteúdo num URL específico.

Error

O objeto de erro.

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