Miscellaneous - Get Operation

Service:

Azure AI Services

API Version:

2023-07-31

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

GET {endpoint}/formrecognizer/operations/{operationId}?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).
operationId	path	True	string uuid	ID de operação exclusiva. Regex pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
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.

Respostas

Nome	Tipo	Description
200 OK	OperationDetails: DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails DocumentClassifierBuildOperationDetails	OK.
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

Get Operation

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "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.
ClassifierDocumentTypeDetails	Informações de tipo de documento do classificador.
DocumentBuildMode	Modo de build do modelo de documento personalizado.
DocumentClassifierBuildOperationDetails	Obter objeto de resposta operação.
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.
DocumentModelBuildOperationDetails	Obter objeto de resposta operação.
DocumentModelComposeOperationDetails	Obter objeto de resposta operação.
DocumentModelCopyToOperationDetails	Obter objeto de resposta operação.
DocumentModelDetails	Informações do modelo de documento.
DocumentTypeDetails	Informações de tipo de documento.
Error	Informações de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Erro detalhado.
OperationStatus	Status da operação.

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 de nome de 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.

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 devem ser especificados.
azureBlobSource	AzureBlobContentSource	Armazenamento de Blobs do Azure local que contém os dados de treinamento para um tipo de documento classificador. AzureBlobSource ou azureBlobFileListSource devem ser especificados.

DocumentBuildMode

Modo de build do modelo de documento personalizado.

Nome	Tipo	Description
neural	string	Suporte a documentos com modelos visuais diversificados.
template	string	Documentos de destino com modelos visuais semelhantes.

DocumentClassifierBuildOperationDetails

Obter objeto de resposta operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string	Data e hora (UTC) quando 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 status foi atualizado pela última vez.
operationId	string	ID da Operação
percentCompleted	integer	Progresso da operação (0 a 100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentClassifierDetails	Resultado da operação após o êxito.
status	OperationStatus	Status da operação.
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentClassifierDetails

Informações do classificador de documentos.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar este classificador de documento.
classifierId	string	Nome do classificador de documento exclusivo.
createdDateTime	string	Data e hora (UTC) quando o classificador de documento foi criado.
description	string	Descrição do classificador de documentos.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lista de tipos de documento com os quais classificar.
expirationDateTime	string	Data e hora (UTC) em que o classificador de documento expirará.

DocumentFieldSchema

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

Nome	Tipo	Description
description	string	Descrição do campo.
example	string	Conteúdo do campo de exemplo.
items	DocumentFieldSchema	Esquema de tipo de campo de cada elemento de 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.

Nome	Tipo	Description
address	string	Endereço analisado.
array	string	Lista de subcampos do mesmo tipo.
boolean	string	Valor booliano, normalizado como true ou false.
countryRegion	string	País/região, normalizado para o formato ISO 3166-1 alfa-3 (por exemplo, EUA).
currency	string	Conversor de Moedas quantidade com o símbolo e a unidade de moeda opcionais.
date	string	Data, normalizada para o formato ISO 8601 (YYY-MM-DD).
integer	string	Número inteiro, normalizado para inteiro com sinal 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}).
selectionMark	string	O campo está selecionado?
signature	string	A assinatura está presente?
string	string	Texto sem formatação.
time	string	Hora, normalizada para o formato ISO 8601 (hh:mm:ss).

DocumentModelBuildOperationDetails

Obter objeto de resposta operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string	Data e hora (UTC) quando a operação foi criada.
error	Error	Erro encontrado.
kind	string: documentModelBuild	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) em que o status foi atualizado pela última vez.
operationId	string	ID da Operação
percentCompleted	integer	Progresso da operação (0 a 100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentModelDetails	Resultado da operação após o êxito.
status	OperationStatus	Status da operação.
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentModelComposeOperationDetails

Obter objeto de resposta operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string	Data e hora (UTC) quando a operação foi criada.
error	Error	Erro encontrado.
kind	string: documentModelCompose	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) em que o status foi atualizado pela última vez.
operationId	string	ID da Operação
percentCompleted	integer	Progresso da operação (0 a 100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentModelDetails	Resultado da operação após o êxito.
status	OperationStatus	Status da operação.
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentModelCopyToOperationDetails

Obter objeto de resposta operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string	Data e hora (UTC) quando a operação foi criada.
error	Error	Erro encontrado.
kind	string: documentModelCopyTo	Tipo de operação.
lastUpdatedDateTime	string	Data e hora (UTC) em que o status foi atualizado pela última vez.
operationId	string	ID da Operação
percentCompleted	integer	Progresso da operação (0 a 100).
resourceLocation	string	URL do recurso direcionado por esta operação.
result	DocumentModelDetails	Resultado da operação após o êxito.
status	OperationStatus	Status da operação.
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentModelDetails

Informações do modelo de documento.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar este modelo de documento.
createdDateTime	string	Data e hora (UTC) quando o modelo de documento foi criado.
description	string	Descrição do modelo de documento.
docTypes	<string,  DocumentTypeDetails>	Tipos de documento com suporte.
expirationDateTime	string	Data e hora (UTC) em que o modelo de documento expirará.
modelId	string	Nome exclusivo do modelo de documento.
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentTypeDetails

Informações de tipo de documento.

Nome	Tipo	Description
buildMode	DocumentBuildMode	Modo de build do modelo de documento personalizado.
description	string	Descrição do modelo de documento.
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.

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.

OperationStatus

Status da operação.

Nome	Tipo	Description
canceled	string	A operação foi cancelada.
failed	string	A operação falhou.
notStarted	string	A operação ainda não foi iniciada.
running	string	A operação está em andamento.
succeeded	string	Êxito na operação.