Partilhar via


Miscellaneous - Get Operation

Obtém informações sobre a operação.

GET {endpoint}/formrecognizer/operations/{operationId}?api-version=2023-07-31

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string

url

Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus2.api.cognitive.microsoft.com).

operationId
path True

string

uuid

ID de operação exclusivo.

Padrão Regex: ^[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 pedida.

Cabeçalho do Pedido

Name Necessário Tipo Description
Ocp-Apim-Subscription-Key True

string

A chave secreta da sua subscrição dos Serviços Cognitivos do Azure.

Respostas

Name Tipo Description
200 OK OperationDetails:

OK.

Other Status Codes

ErrorResponse

Erro encontrado.

Segurança

Ocp-Apim-Subscription-Key

A chave secreta da sua subscrição dos Serviços Cognitivos do Azure.

Tipo: apiKey
Em: header

Exemplos

Get Operation

Pedido de amostra

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

Resposta da amostra

{
  "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

Name Description
AzureBlobContentSource

Armazenamento de Blobs do Azure conteúdo.

AzureBlobFileListContentSource

Lista de ficheiros no Armazenamento de Blobs do Azure.

ClassifierDocumentTypeDetails

Informações do tipo de documento do classificador.

DocumentBuildMode

Modo de compilação do modelo de documento personalizado.

DocumentClassifierBuildOperationDetails

Obter o objeto de resposta operação.

DocumentClassifierDetails

Informações do classificador de documentos.

DocumentFieldSchema

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

DocumentFieldType

Tipo de dados semântico do valor do campo.

DocumentModelBuildOperationDetails

Obter o objeto de resposta operação.

DocumentModelComposeOperationDetails

Obter o objeto de resposta operação.

DocumentModelCopyToOperationDetails

Obter o objeto de resposta operação.

DocumentModelDetails

Informações do modelo de documentos.

DocumentTypeDetails

Informações do tipo de documento.

Error

Informações de erro.

ErrorResponse

Objeto de resposta de erro.

InnerError

Erro detalhado.

OperationStatus

Estado da operação.

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 para preparação.

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.

DocumentBuildMode

Modo de compilação do modelo de documento personalizado.

Name Tipo Description
neural

string

Suporte para documentos com diversos modelos visuais.

template

string

Documentos de destino com modelos visuais semelhantes.

DocumentClassifierBuildOperationDetails

Obter o objeto de resposta operação.

Name Tipo Description
apiVersion

string

Versão da API utilizada para criar esta operação.

createdDateTime

string

Data e hora (UTC) em que a operação foi criada.

error

Error

Foi encontrado um erro.

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 êxito.

status

OperationStatus

Estado da operação.

tags

object

Lista de atributos de etiqueta chave-valor associados ao modelo de documento.

DocumentClassifierDetails

Informações do classificador de documentos.

Name Tipo Description
apiVersion

string

Versão da API utilizada para criar este classificador de documentos.

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 para classificar.

expirationDateTime

string

Data e hora (UTC) em que o classificador de documentos irá expirar.

DocumentFieldSchema

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

Name 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>

Sub-campos nomeados do campo do objeto.

type

DocumentFieldType

Tipo de dados semântico do valor do campo.

DocumentFieldType

Tipo de dados semântico 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 como verdadeiro ou falso.

countryRegion

string

País/região, normalizado para o formato ISO 3166-1 alfa-3 (por exemplo, EUA).

currency

string

Montante da moeda com símbolo de moeda e unidade opcionais.

date

string

Data, normalizada para o formato ISO 8601 (YYYY-MM-DD).

integer

string

Número inteiro, normalizado para número inteiro assinado de 64 bits.

number

string

Número de vírgula flutuante, normalizado para vírgula 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 simples.

time

string

Tempo normalizado para o formato ISO 8601 (hh:mm:ss).

DocumentModelBuildOperationDetails

Obter o objeto de resposta operação.

Name Tipo Description
apiVersion

string

Versão da API utilizada para criar esta operação.

createdDateTime

string

Data e hora (UTC) em que a operação foi criada.

error

Error

Foi encontrado um erro.

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 êxito.

status

OperationStatus

Estado da operação.

tags

object

Lista de atributos de etiqueta chave-valor associados ao modelo de documento.

DocumentModelComposeOperationDetails

Obter o objeto de resposta operação.

Name Tipo Description
apiVersion

string

Versão da API utilizada para criar esta operação.

createdDateTime

string

Data e hora (UTC) em que a operação foi criada.

error

Error

Foi encontrado um erro.

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 êxito.

status

OperationStatus

Estado da operação.

tags

object

Lista de atributos de etiqueta chave-valor associados ao modelo de documento.

DocumentModelCopyToOperationDetails

Obter o objeto de resposta operação.

Name Tipo Description
apiVersion

string

Versão da API utilizada para criar esta operação.

createdDateTime

string

Data e hora (UTC) em que a operação foi criada.

error

Error

Foi encontrado um erro.

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 êxito.

status

OperationStatus

Estado da operação.

tags

object

Lista de atributos de etiqueta chave-valor associados ao modelo de documento.

DocumentModelDetails

Informações do modelo de documentos.

Name Tipo Description
apiVersion

string

Versão da API utilizada para criar este modelo de documento.

createdDateTime

string

Data e hora (UTC) em que o modelo de documento foi criado.

description

string

Descrição do modelo de documento.

docTypes

<string,  DocumentTypeDetails>

Tipos de documento suportados.

expirationDateTime

string

Data e hora (UTC) em que o modelo de documento expira.

modelId

string

Nome exclusivo do modelo de documento.

tags

object

Lista de atributos de etiqueta chave-valor associados ao modelo de documento.

DocumentTypeDetails

Informações do tipo de documento.

Name Tipo Description
buildMode

DocumentBuildMode

Modo de compilação 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 com uma sintaxe de estilo de Esquema JSON.

Error

Informações de erro.

Name 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 de resposta de erro.

Name Tipo Description
error

Error

Informações de erro.

InnerError

Erro detalhado.

Name Tipo Description
code

string

Código de erro.

innererror

InnerError

Erro detalhado.

message

string

Mensagem de erro.

OperationStatus

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 foi iniciada.

running

string

A operação está em curso.

succeeded

string

A operação foi efetuada com êxito.