Miscellaneous - Get Operation

Serviço:

Azure AI Services

Versão da API:

2023-07-31

Obtém informações de 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) maxLength: 36 pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$	ID de operação exclusiva.
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	OKEY.
Other Status Codes	ErrorResponse	Erro encontrado.

Segurança

Ocp-Apim-Subscription-Key

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

Tipo: apiKey
Em: header

Exemplos

Get Operation

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

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	Conteúdo do Armazenamento de Blobs do Azure.
AzureBlobFileListContentSource	Lista de arquivos no 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 da Operação.
DocumentClassifierDetails	Informações do classificador de documento.
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 da Operação.
DocumentModelComposeOperationDetails	Obter objeto de resposta da Operação.
DocumentModelCopyToOperationDetails	Obter objeto de resposta da 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

Objeto

Conteúdo do Armazenamento de Blobs do Azure.

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

AzureBlobFileListContentSource

Objeto

Lista de arquivos no Armazenamento de Blobs do Azure.

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

ClassifierDocumentTypeDetails

Objeto

Informações de tipo de documento do classificador.

Nome	Tipo	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Lista de arquivos do Armazenamento de Blobs do Azure especificando os dados de treinamento para um tipo de documento 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 classificador. AzureBlobSource ou azureBlobFileListSource devem ser especificados.

DocumentBuildMode

Enumeração

Modo de build do modelo de documento personalizado.

Valor	Description
neural	Suporte a documentos com modelos visuais diversos.
template	Documentos de destino com modelos visuais semelhantes.

DocumentClassifierBuildOperationDetails

Objeto

Obter objeto de resposta da Operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string (date-time)	Data e hora (UTC) quando a operação foi criada.
error	Error	Erro encontrado.
kind	string: documentClassifierBuild	Tipo de operação.
lastUpdatedDateTime	string (date-time)	Data e hora (UTC) quando o status foi atualizado pela última vez.
operationId	string	ID da operação
percentCompleted	integer (int32) minimum: 0 maximum: 100	Progresso da operação (0-100).
resourceLocation	string (url)	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

Objeto

Informações do classificador de documento.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar este classificador de documento.
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nome do classificador de documento exclusivo.
createdDateTime	string (date-time)	Data e hora (UTC) quando o classificador de documento foi criado.
description	string maxLength: 4096	Descrição do classificador de documento.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lista de tipos de documento com os quais classificar.
expirationDateTime	string (date-time)	Data e hora (UTC) em que o classificador de documento expirará.

DocumentFieldSchema

Objeto

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 de campo de exemplo.
items	DocumentFieldSchema	Esquema de tipo de campo de cada elemento de matriz.
properties	<string,  DocumentFieldSchema>	Sub-campos nomeados do campo de objeto.
type	DocumentFieldType	Tipo de dados semânticos do valor do campo.

DocumentFieldType

Enumeração

Tipo de dados semânticos do valor do campo.

Valor	Description
address	Endereço analisado.
array	Lista de subcampos do mesmo tipo.
boolean	Valor booliano normalizado como verdadeiro ou falso.
countryRegion	País/região, normalizado para o formato alfa-3 ISO 3166-1 (por exemplo, EUA).
currency	Valor de moeda com símbolo e unidade de moeda opcionais.
date	Data, normalizada para o formato ISO 8601 (YYYY-MM-DD).
integer	Número inteiro, normalizado para inteiro com sinal de 64 bits.
number	Número de ponto flutuante normalizado para ponto flutuante de precisão dupla.
object	Lista nomeada de subcampos de tipos potencialmente diferentes.
phoneNumber	Número de telefone normalizado para o formato E.164 (+{CountryCode}{SubscriberNumber}).
selectionMark	O campo está selecionado?
signature	A assinatura está presente?
string	Texto sem formatação.
time	Hora, normalizada para o formato ISO 8601 (hh:mm:ss).

DocumentModelBuildOperationDetails

Objeto

Obter objeto de resposta da Operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string (date-time)	Data e hora (UTC) quando a operação foi criada.
error	Error	Erro encontrado.
kind	string: documentModelBuild	Tipo de operação.
lastUpdatedDateTime	string (date-time)	Data e hora (UTC) quando o status foi atualizado pela última vez.
operationId	string	ID da operação
percentCompleted	integer (int32) minimum: 0 maximum: 100	Progresso da operação (0-100).
resourceLocation	string (url)	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

Objeto

Obter objeto de resposta da Operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string (date-time)	Data e hora (UTC) quando a operação foi criada.
error	Error	Erro encontrado.
kind	string: documentModelCompose	Tipo de operação.
lastUpdatedDateTime	string (date-time)	Data e hora (UTC) quando o status foi atualizado pela última vez.
operationId	string	ID da operação
percentCompleted	integer (int32) minimum: 0 maximum: 100	Progresso da operação (0-100).
resourceLocation	string (url)	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

Objeto

Obter objeto de resposta da Operação.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar essa operação.
createdDateTime	string (date-time)	Data e hora (UTC) quando a operação foi criada.
error	Error	Erro encontrado.
kind	string: documentModelCopyTo	Tipo de operação.
lastUpdatedDateTime	string (date-time)	Data e hora (UTC) quando o status foi atualizado pela última vez.
operationId	string	ID da operação
percentCompleted	integer (int32) minimum: 0 maximum: 100	Progresso da operação (0-100).
resourceLocation	string (url)	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

Objeto

Informações do modelo de documento.

Nome	Tipo	Description
apiVersion	string	Versão da API usada para criar este modelo de documento.
createdDateTime	string (date-time)	Data e hora (UTC) quando o modelo de documento foi criado.
description	string maxLength: 4096	Descrição do modelo de documento.
docTypes	<string,  DocumentTypeDetails>	Tipos de documento com suporte.
expirationDateTime	string (date-time)	Data e hora (UTC) em que o modelo de documento expirará.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nome exclusivo do modelo de documento.
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentTypeDetails

Objeto

Informações de tipo de documento.

Nome	Tipo	Description
buildMode	DocumentBuildMode	Modo de build do modelo de documento personalizado.
description	string maxLength: 4096	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

Objeto

Informações de erro.

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

ErrorResponse

Objeto

Objeto de resposta de erro.

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

InnerError

Objeto

Erro detalhado.

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

OperationStatus

Enumeração

Status da operação.

Valor	Description
canceled	A operação foi cancelada.
failed	A operação falhou.
notStarted	A operação ainda não foi iniciada.
running	A operação está em andamento.
succeeded	A operação foi bem-sucedida.