Miscellaneous - List Operations

Riferimento

Servizio:: Azure AI Services

Versione API:: 2023-07-31

Elenchi tutte le operazioni.

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

Parametri dell'URI

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

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string	Chiave privata per la sottoscrizione di Servizi cognitivi di Azure.

Risposte

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

Sicurezza

Ocp-Apim-Subscription-Key

Chiave privata per la sottoscrizione di Servizi cognitivi di Azure.

Tipo: apiKey
In: header

Esempio

Get Operations

Esempio di richiesta

HTTP

GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?api-version=2023-07-31

Risposta di esempio

Codice di stato:: 200

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

Definizioni

Nome	Descrizione
Error	Informazioni sull'errore.
ErrorResponse	Oggetto risposta errore.
GetOperationsResponse	Elencare l'oggetto risposta Operations.
InnerError	Errore dettagliato.
OperationKind	Tipo di operazione.
OperationStatus	Stato dell'operazione.
OperationSummary	Informazioni sull'operazione.

Error

Informazioni sull'errore.

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 errore.

Nome	Tipo	Descrizione
error	Error	Informazioni sull'errore.

GetOperationsResponse

Elencare l'oggetto risposta Operations.

Nome	Tipo	Descrizione
nextLink	string	Collegare alla pagina successiva delle operazioni.
value	OperationSummary[]	Elenco delle 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
documentClassifierBuild	string	Creare un nuovo modello di classificatore personalizzato.
documentModelBuild	string	Creare un nuovo modello di documento personalizzato.
documentModelCompose	string	Comporre un nuovo modello di documento personalizzato dai modelli esistenti.
documentModelCopyTo	string	Copiare un modello di documento esistente in una risorsa, un'area o una sottoscrizione diverse.

OperationStatus

Stato dell'operazione.

Nome	Tipo	Descrizione
canceled	string	L'operazione è stata annullata.
failed	string	L'operazione non è riuscita.
notStarted	string	L'operazione non è ancora stata avviata.
running	string	L'operazione è in corso.
succeeded	string	L'operazione è stata completata.

OperationSummary

Informazioni sull'operazione.

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

Condividi tramite