Miscellaneous Operations - Get Operation

Serviço:

Azure AI Services

Versão da API:

2024-11-30

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

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getOperation&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.
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	DocumentIntelligenceOperationDetails: DocumentClassifierBuildOperationDetails DocumentClassifierCopyToOperationDetails DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails	O pedido foi bem-sucedido. Cabeçalhos x-ms-client-request-id: string
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

Get Operation

Pedido de amostra

HTTP

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

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": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "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.
ClassifierDocumentTypeDetails	Informações do tipo de documento do classificador.
ContentSourceKind	Tipo de fonte de conteúdo.
DocumentAnalysisFeature	Recursos de análise de documentos para habilitar.
DocumentBuildMode	Modo de construção de modelo de documento personalizado.
DocumentClassifierBuildOperationDetails	Obter objeto de resposta Operation.
DocumentClassifierCopyToOperationDetails	Obter objeto de resposta Operation.
DocumentClassifierDetails	Informações do classificador de documentos.
DocumentFieldSchema	Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON.
DocumentFieldType	Tipo de dados semânticos do valor do campo.
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.
DocumentIntelligenceOperationStatus	Estado da operação.
DocumentIntelligenceWarning	O objeto de erro.
DocumentModelBuildOperationDetails	Obter objeto de resposta Operation.
DocumentModelComposeOperationDetails	Obter objeto de resposta Operation.
DocumentModelCopyToOperationDetails	Obter objeto de resposta Operation.
DocumentModelDetails	Informações do modelo do documento.
DocumentTypeDetails	Informações sobre o tipo de documento.
OperationKind	Tipo de operação.
SplitMode	Comportamento de divisão de ficheiros.

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.

DocumentAnalysisFeature

Recursos de análise de documentos para habilitar.

Name	Tipo	Description
barcodes	string	Habilite a deteção de códigos de barras no documento.
formulas	string	Permitir a deteção de expressões matemáticas no documento.
keyValuePairs	string	Habilite a deteção de pares de valores de chave gerais (campos de formulário) no documento.
languages	string	Habilite a deteção do idioma do conteúdo de texto.
ocrHighResolution	string	Execute OCR em uma resolução mais alta para lidar com documentos com letras miúdas.
queryFields	string	Habilite a extração de campos adicionais por meio do parâmetro de consulta queryFields.
styleFont	string	Permitir o reconhecimento de vários estilos de fonte.

DocumentBuildMode

Modo de construção de modelo de documento personalizado.

Name	Tipo	Description
neural	string	Documentos de suporte com diversos modelos visuais.
template	string	Documentos de destino com modelos visuais semelhantes.

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	DocumentIntelligenceError	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	DocumentIntelligenceOperationStatus	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.

DocumentClassifierCopyToOperationDetails

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	DocumentIntelligenceError	Erro encontrado.
kind	string: documentClassifierCopyTo	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	DocumentIntelligenceOperationStatus	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á.
modifiedDateTime	string	Data e hora (UTC) em que o modelo de documento foi modificado pela última vez.
warnings	DocumentIntelligenceWarning[]	Lista de avisos encontrados durante a criação do classificador.

DocumentFieldSchema

Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON.

Name	Tipo	Description
description	string	Descrição do campo.
example	string	Exemplo de conteúdo do campo.
items	DocumentFieldSchema	Esquema de tipo de campo de cada elemento da matriz.
properties	<string,  DocumentFieldSchema>	Subcampos nomeados do campo de objeto.
type	DocumentFieldType	Tipo de dados semânticos do valor do campo.

DocumentFieldType

Tipo de dados semânticos do valor do campo.

Name	Tipo	Description
address	string	Endereço analisado.
array	string	Lista de subcampos do mesmo tipo.
boolean	string	Valor booleano, normalizado para verdadeiro ou falso.
countryRegion	string	País/região, normalizado para o formato ISO 3166-1 alpha-3 (ex. EUA).
currency	string	Valor da moeda com símbolo e unidade de moeda opcionais.
date	string	Data, normalizada para o formato ISO 8601 (AAAA-MM-DD).
integer	string	Número inteiro, normalizado para inteiro assinado de 64 bits.
number	string	Número de ponto flutuante, normalizado para ponto flutuante de precisão dupla.
object	string	Lista nomeada de subcampos de tipos potencialmente diferentes.
phoneNumber	string	Número de telefone, normalizado para o formato E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Matriz de valores de cadeia de caracteres selecionados.
selectionMark	string	O campo está selecionado?
signature	string	A assinatura está presente?
string	string	Texto simples.
time	string	Tempo, normalizado para o formato ISO 8601 (hh:mm:ss).

DocumentIntelligenceError

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

Objeto de resposta de erro.

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

DocumentIntelligenceInnerError

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.

DocumentIntelligenceOperationStatus

Estado da operação.

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

DocumentIntelligenceWarning

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.

DocumentModelBuildOperationDetails

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	DocumentIntelligenceError	Erro encontrado.
kind	string: documentModelBuild	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	DocumentModelDetails	Resultado da operação após o sucesso.
status	DocumentIntelligenceOperationStatus	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.

DocumentModelComposeOperationDetails

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	DocumentIntelligenceError	Erro encontrado.
kind	string: documentModelCompose	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	DocumentModelDetails	Resultado da operação após o sucesso.
status	DocumentIntelligenceOperationStatus	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.

DocumentModelCopyToOperationDetails

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	DocumentIntelligenceError	Erro encontrado.
kind	string: documentModelCopyTo	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	DocumentModelDetails	Resultado da operação após o sucesso.
status	DocumentIntelligenceOperationStatus	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.

DocumentModelDetails

Informações do modelo do documento.

Name	Tipo	Default value	Description
apiVersion	string		Versão da API usada para criar este modelo de documento.
azureBlobFileListSource	AzureBlobFileListContentSource		Lista de arquivos do Armazenamento de Blobs do Azure especificando os dados de treinamento. AzureBlobSource ou azureBlobFileListSource devem ser especificados.
azureBlobSource	AzureBlobContentSource		Local do Armazenamento de Blobs do Azure que contém os dados de treinamento. AzureBlobSource ou azureBlobFileListSource devem ser especificados.
buildMode	DocumentBuildMode		Modo de construção de modelo de documento personalizado.
classifierId	string		Para modelos compostos, o classificador personalizado para dividir e classificar o arquivo de entrada.
createdDateTime	string		Data e hora (UTC) em que o modelo de documento foi criado.
description	string		Descrição do modelo do documento.
docTypes	<string,  DocumentTypeDetails>		Tipos de documentos suportados.
expirationDateTime	string		Data e hora (UTC) em que o modelo de documento expirará.
modelId	string		Nome exclusivo do modelo de documento.
modifiedDateTime	string		Data e hora (UTC) em que o modelo de documento foi modificado pela última vez.
split	SplitMode	none	Para modelos compostos, o comportamento de divisão de arquivos.
tags	object		Lista de atributos de tag chave-valor associados ao modelo de documento.
trainingHours	number		Número de horas de GPU equivalente a V100 consumidas para treinamento de modelos.
warnings	DocumentIntelligenceWarning[]		Lista de avisos encontrados durante a criação do modelo.

DocumentTypeDetails

Informações sobre o tipo de documento.

Name	Tipo	Description
buildMode	DocumentBuildMode	Modo de construção de modelo de documento personalizado.
confidenceThreshold	number	Execute a análise apenas se a confiança docType estiver acima do limite.
description	string	Descrição do modelo do documento.
features	DocumentAnalysisFeature[]	Lista de recursos de análise opcionais.
fieldConfidence	object	Confiança estimada para cada campo.
fieldSchema	<string,  DocumentFieldSchema>	Descrição do esquema semântico do documento usando uma sintaxe de estilo de esquema JSON.
maxDocumentsToAnalyze	integer	Número máximo de documentos do tipo especificado para analisar. Padrão = todos.
modelId	string	Modelo de documento a ser usado para analisar documentos com o tipo especificado.
queryFields	string[]	Lista de campos adicionais a extrair. Ex. "NúmerodeConvidados, Número da Loja"

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.

SplitMode

Comportamento de divisão de ficheiros.

Name	Tipo	Description
auto	string	Divida automaticamente o arquivo em documentos.
none	string	Trate todo o arquivo como um único documento.
perPage	string	Trate cada página do arquivo como um documento separado.