Miscellaneous Operations - Get Document Classifier Build Operation

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-07-31-preview

Obtém informações da operação.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentClassifierBuildOperation&api-version=2024-07-31-preview

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.
operationId	path	True	string	ID da operação
api-version	query	True	string	A versão da API a ser usada para esta operação.

Cabeçalho do Pedido

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

Respostas

Name	Tipo	Description
200 OK	DocumentClassifierBuildOperationDetails	O pedido foi bem-sucedido. Cabeçalhos x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Name

Tipo

Description

200 OK

DocumentClassifierBuildOperationDetails

O pedido foi bem-sucedido.

Cabeçalhos

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

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

Get Operation - Document Classifier Build

Pedido de amostra

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getDocumentClassifierBuildOperation&api-version=2024-07-31-preview

Resposta da amostra

Código de estado:: 200

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentClassifierBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier",
  "result": {
    "classifierId": "myClassifier",
    "description": "Classifier description",
    "createdDateTime": "2022-07-30T00:00:00Z",
    "expirationDateTime": "2023-01-01T00:00:00Z",
    "apiVersion": "2024-07-31-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	Conteúdo do Armazenamento de Blobs do Azure.
AzureBlobFileListContentSource	Lista de ficheiros no Armazenamento de Blobs do Azure.
ClassifierDocumentTypeDetails	Informações do tipo de documento do classificador.
ContentSourceKind	Tipo de fonte de conteúdo.
DocumentClassifierBuildOperationDetails	Obter objeto de resposta Operation.
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.
OperationKind	Tipo de operação.
OperationStatus	Estado da operação.
Warning	O objeto de erro.

AzureBlobContentSource

Conteúdo do Armazenamento de Blobs do Azure.

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

AzureBlobFileListContentSource

Lista de ficheiros no Armazenamento de Blobs do Azure.

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

ClassifierDocumentTypeDetails

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

Tipo de fonte de conteúdo.

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

DocumentClassifierBuildOperationDetails

Obter objeto de resposta Operation.

Name	Tipo	Description
apiVersion	string	Versão da API usada para criar esta operação.
createdDateTime	string	Data e hora (UTC) em que a operação foi criada.
error	Error	Erro encontrado.
kind	string: documentClassifierBuild	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) em que o estado foi atualizado pela última vez.
operationId	string	ID da operação
percentCompleted	integer	Progresso da operação (0-100).
resourceLocation	string	URL do recurso visado por esta operação.
result	DocumentClassifierDetails	Resultado da operação após o sucesso.
status	OperationStatus	Estado da operação. notIniciado, em execução, concluído ou com falha
tags	object	Lista de atributos de tag chave-valor associados ao modelo de documento.

DocumentClassifierDetails

Informações do classificador de documentos.

Name	Tipo	Description
apiVersion	string	Versão da API usada para criar este classificador de documentos.
baseClassifierId	string	Base classifierId em cima do qual o classificador foi treinado.
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 contra os quais classificar.
expirationDateTime	string	Data e hora (UTC) em que o classificador de documentos expirará.
warnings	Warning[]	Lista de avisos encontrados durante a criação do classificador.

Error

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
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 alvo 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 de um conjunto de códigos de erro definido pelo servidor.
innererror	InnerError	Erro interno.
message	string	Uma representação legível por humanos do erro.

OperationKind

Tipo de operação.

Name	Tipo	Description
documentClassifierBuild	string	Crie um novo modelo de classificador personalizado.
documentClassifierCopyTo	string	Copie um classificador de documentos existente para um recurso, região ou assinatura potencialmente diferente.
documentModelBuild	string	Crie um novo modelo de documento personalizado.
documentModelCompose	string	Componha um novo modelo de documento personalizado a partir de modelos existentes.
documentModelCopyTo	string	Copie um modelo de documento existente para potencialmente um recurso, região ou assinatura diferente.

OperationStatus

Estado da operação.

Name	Tipo	Description
canceled	string	A operação foi cancelada.
completed	string	A operação foi concluída.
failed	string	A operação falhou.
notStarted	string	A operação ainda não começou.
running	string	A operação está em curso.
succeeded	string	A operação foi bem sucedida.

Warning

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de aviso definido pelo servidor.
message	string	Uma representação legível por humanos do aviso.
target	string	O alvo do erro.

Partilhar via

Miscellaneous Operations - Get Document Classifier Build Operation

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Âmbitos

Exemplos

Get Operation - Document Classifier Build

Pedido de amostra

Resposta da amostra

Definições

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

ContentSourceKind

DocumentClassifierBuildOperationDetails

DocumentClassifierDetails

Error

ErrorResponse

InnerError

OperationKind

OperationStatus

Warning

Recursos adicionais