Miscellaneous - List Operations

Referência

Service:: Azure AI Services

API Version:: 2022-08-31

Listas todas as operações.

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	Versão da API solicitada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respostas

Nome	Tipo	Description
200 OK	GetOperationsResponse	OK.
Other Status Codes	ErrorResponse	Erro encontrado.

Segurança

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemplos

GetOperations

Sample Request

HTTP

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

Sample Response

Status code:: 200

{
  "value": [
    {
      "operationId": "{operationId}",
      "status": "running",
      "percentCompleted": 0,
      "createdDateTime": "2021-09-23T09:12:57Z",
      "lastUpdatedDateTime": "2021-09-23T09:12:58Z",
      "kind": "documentModelBuild",
      "resourceLocation": "{endpoint}/formrecognizer/documentModels/{modelId}",
      "apiVersion": "2022-08-31"
    }
  ],
  "nextLink": "{nextLinkUrl}"
}

Definições

Nome	Description
ApiVersion	Versão da API.
Error	Informações de erro.
ErrorResponse	Objeto de resposta de erro.
GetOperationsResponse	Objeto de resposta Operações de Lista.
InnerError	Erro detalhado.
OperationKind	Tipo de operação.
OperationStatus	Status da operação.
OperationSummary	Informações da operação.

ApiVersion

Versão da API.

Nome	Tipo	Description
2022-08-31	string

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.

GetOperationsResponse

Objeto de resposta Operações de Lista.

Nome	Tipo	Description
nextLink	string	Link para a próxima página de operações.
value	OperationSummary[]	Lista de operações.

InnerError

Erro detalhado.

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

OperationKind

Tipo de operação.

Nome	Tipo	Description
documentModelBuild	string
documentModelCompose	string
documentModelCopyTo	string

OperationStatus

Status da operação.

Nome	Tipo	Description
canceled	string
failed	string
notStarted	string
running	string
succeeded	string

OperationSummary

Informações da 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.
kind	OperationKind	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.
status	OperationStatus	Status da operação.
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

Compartilhar via