Miscellaneous - List Operations

Usługa:

Azure AI Services

Wersja interfejsu API:

2022-08-31

Listy wszystkich operacji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GetOperationsResponse	OK.
Other Status Codes	ErrorResponse	Napotkano błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

GetOperations

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
ApiVersion	Wersja interfejsu API.
Error	Informacje o błędzie.
ErrorResponse	Błąd obiektu odpowiedzi.
GetOperationsResponse	Wyświetl listę obiektów odpowiedzi Operacje.
InnerError	Szczegółowy błąd.
OperationKind	Typ operacji.
OperationStatus	Stan operacji.
OperationSummary	Informacje o operacji.

ApiVersion

Wersja interfejsu API.

Nazwa	Typ	Opis
2022-08-31	string

Error

Informacje o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	Error[]	Lista szczegółowych błędów.
innererror	InnerError	Szczegółowy błąd.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Błąd obiektu odpowiedzi.

Nazwa	Typ	Opis
error	Error	Informacje o błędzie.

GetOperationsResponse

Wyświetl listę obiektów odpowiedzi Operacje.

Nazwa	Typ	Opis
nextLink	string	Link do następnej strony operacji.
value	OperationSummary[]	Lista operacji.

InnerError

Szczegółowy błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	InnerError	Szczegółowy błąd.
message	string	Komunikat o błędzie.

OperationKind

Typ operacji.

Nazwa	Typ	Opis
documentModelBuild	string
documentModelCompose	string
documentModelCopyTo	string

OperationStatus

Stan operacji.

Nazwa	Typ	Opis
canceled	string
failed	string
notStarted	string
running	string
succeeded	string

OperationSummary

Informacje o operacji.

Nazwa	Typ	Opis
apiVersion	string	Wersja interfejsu API używana do utworzenia tej operacji.
createdDateTime	string	Data i godzina (UTC) podczas tworzenia operacji.
kind	OperationKind	Typ operacji.
lastUpdatedDateTime	string	Data i godzina (UTC), kiedy stan został ostatnio zaktualizowany.
operationId	string	Identyfikator operacji
percentCompleted	integer	Postęp operacji (0–100).
resourceLocation	string	Adres URL zasobu objętego tą operacją.
status	OperationStatus	Stan operacji.
tags	object	Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.