Miscellaneous - List Operations

Referência

Serviço:: Azure AI Services

Versão da API:: 2022-08-31

Listas todas as operações.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	Versão da API pedida.

Cabeçalho do Pedido

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

Respostas

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

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

GetOperations

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Name	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	Estado da operação.
OperationSummary	Informações da operação.

ApiVersion

Versão da API.

Name	Tipo	Description
2022-08-31	string

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.

GetOperationsResponse

Objeto de resposta Operações de Lista.

Name	Tipo	Description
nextLink	string	Ligar à página seguinte de operações.
value	OperationSummary[]	Lista de operações.

InnerError

Erro detalhado.

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

OperationKind

Tipo de operação.

Name	Tipo	Description
documentModelBuild	string
documentModelCompose	string
documentModelCopyTo	string

OperationStatus

Estado da operação.

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

OperationSummary

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

Partilhar via