Miscellaneous - List Operations
Listas todas as operações.
GET {endpoint}/formrecognizer/operations?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). |
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 |
OK. |
|
Other Status Codes |
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 Operations
Solicitação de exemplo
GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?api-version=2023-07-31
Resposta de exemplo
{
"value": [
{
"operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
"status": "running",
"percentCompleted": 0,
"createdDateTime": "2021-09-23T09:12:57Z",
"lastUpdatedDateTime": "2021-09-23T09:12:58Z",
"kind": "documentModelBuild",
"resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
"apiVersion": "2023-07-31"
}
],
"nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?nextLink=nextLinkData"
}
Definições
Nome | Description |
---|---|
Error |
Informações de erro. |
Error |
Objeto de resposta de erro. |
Get |
Objeto de resposta Operações de Lista. |
Inner |
Erro detalhado. |
Operation |
Tipo de operação. |
Operation |
Status da operação. |
Operation |
Informações da operação. |
Error
Informações de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código do erro. |
details |
Error[] |
Lista de erros detalhados. |
innererror |
Erro detalhado. |
|
message |
string |
Mensagem de erro. |
target |
string |
Destino do erro. |
ErrorResponse
Objeto de resposta de erro.
Nome | Tipo | Description |
---|---|---|
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 |
Lista de operações. |
InnerError
Erro detalhado.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código do erro. |
innererror |
Erro detalhado. |
|
message |
string |
Mensagem de erro. |
OperationKind
Tipo de operação.
Nome | Tipo | Description |
---|---|---|
documentClassifierBuild |
string |
Crie um novo modelo de classificador personalizado. |
documentModelBuild |
string |
Crie um novo modelo de documento personalizado. |
documentModelCompose |
string |
Compor um novo modelo de documento personalizado de modelos existentes. |
documentModelCopyTo |
string |
Copie um modelo de documento existente para potencialmente um recurso, uma região ou uma assinatura diferente. |
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. |
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 |
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 |
Status da operação. |
|
tags |
object |
Lista de atributos de marca chave-valor associados ao modelo de documento. |