Miscellaneous - List Operations

Riferimento

Servizio:: Azure AI Services

Versione API:: 2022-08-31

Elenchi tutte le operazioni.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	Versione dell'API richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string

Risposte

Nome	Tipo	Descrizione
200 OK	GetOperationsResponse	OK.
Other Status Codes	ErrorResponse	Errore rilevato.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

Esempio

GetOperations

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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}"
}

Definizioni

Nome	Descrizione
ApiVersion	Versione dell'API.
Error	Informazioni sugli errori.
ErrorResponse	Oggetto risposta di errore.
GetOperationsResponse	Elencare l'oggetto risposta operations.
InnerError	Errore dettagliato.
OperationKind	Tipo di operazione.
OperationStatus	Stato dell'operazione.
OperationSummary	Informazioni sull'operazione.

ApiVersion

Versione dell'API.

Nome	Tipo	Descrizione
2022-08-31	string

Error

Informazioni sugli errori.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	Error[]	Elenco degli errori dettagliati.
innererror	InnerError	Errore dettagliato.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto risposta di errore.

Nome	Tipo	Descrizione
error	Error	Informazioni sugli errori.

GetOperationsResponse

Elencare l'oggetto risposta operations.

Nome	Tipo	Descrizione
nextLink	string	Collegarsi alla pagina successiva delle operazioni.
value	OperationSummary[]	Elenco di operazioni.

InnerError

Errore dettagliato.

Nome	Tipo	Descrizione
code	string	Codice di errore.
innererror	InnerError	Errore dettagliato.
message	string	Messaggio di errore.

OperationKind

Tipo di operazione.

Nome	Tipo	Descrizione
documentModelBuild	string
documentModelCompose	string
documentModelCopyTo	string

OperationStatus

Stato dell'operazione.

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

OperationSummary

Informazioni sull'operazione.

Nome	Tipo	Descrizione
apiVersion	string	Versione dell'API usata per creare questa operazione.
createdDateTime	string	Data e ora (UTC) di creazione dell'operazione.
kind	OperationKind	Tipo di operazione.
lastUpdatedDateTime	string	Data e ora (UTC) dell'ultimo aggiornamento dello stato.
operationId	string	ID operazione
percentCompleted	integer	Stato dell'operazione (0-100).
resourceLocation	string	URL della risorsa di destinazione di questa operazione.
status	OperationStatus	Stato dell'operazione.
tags	object	Elenco degli attributi di tag chiave-valore associati al modello di documento.

Condividi tramite