Miscellaneous - List Operations

Layanan:

Azure AI Services

Versi API:

2022-08-31

Lists semua operasi.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	Versi API yang diminta.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string

Respons

Nama	Jenis	Deskripsi
200 OK	GetOperationsResponse	OK.
Other Status Codes	ErrorResponse	Terjadi kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

Contoh

GetOperations

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
ApiVersion	Versi API.
Error	Info kesalahan.
ErrorResponse	Objek respons kesalahan.
GetOperationsResponse	Cantumkan objek respons Operasi.
InnerError	Kesalahan terperinci.
OperationKind	Jenis operasi.
OperationStatus	Status operasi.
OperationSummary	Info operasi.

ApiVersion

Versi API.

Nama	Jenis	Deskripsi
2022-08-31	string

Error

Info kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
details	Error[]	Daftar kesalahan terperinci.
innererror	InnerError	Kesalahan terperinci.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Info kesalahan.

GetOperationsResponse

Cantumkan objek respons Operasi.

Nama	Jenis	Deskripsi
nextLink	string	Tautkan ke halaman operasi berikutnya.
value	OperationSummary[]	Daftar operasi.

InnerError

Kesalahan terperinci.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
innererror	InnerError	Kesalahan terperinci.
message	string	Pesan kesalahan.

OperationKind

Jenis operasi.

Nama	Jenis	Deskripsi
documentModelBuild	string
documentModelCompose	string
documentModelCopyTo	string

OperationStatus

Status operasi.

Nama	Jenis	Deskripsi
canceled	string
failed	string
notStarted	string
running	string
succeeded	string

OperationSummary

Info operasi.

Nama	Jenis	Deskripsi
apiVersion	string	Versi API yang digunakan untuk membuat operasi ini.
createdDateTime	string	Tanggal dan waktu (UTC) saat operasi dibuat.
kind	OperationKind	Jenis operasi.
lastUpdatedDateTime	string	Tanggal dan waktu (UTC) ketika status terakhir diperbarui.
operationId	string	ID Operasi
percentCompleted	integer	Kemajuan operasi (0-100).
resourceLocation	string	URL sumber daya yang ditargetkan oleh operasi ini.
status	OperationStatus	Status operasi.
tags	object	Daftar atribut tag nilai kunci yang terkait dengan model dokumen.