Miscellaneous - List Operations

Referensi

Layanan:: Azure AI Services

Versi API:: 2023-07-31

Lists semua operasi.

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

Parameter URI

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

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string	Kunci rahasia untuk langganan Azure Cognitive Services Anda.

Respons

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

Keamanan

Ocp-Apim-Subscription-Key

Kunci rahasia untuk langganan Azure Cognitive Services Anda.

Jenis: apiKey
Dalam: header

Contoh

Get Operations

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 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"
}

Definisi

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

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
documentClassifierBuild	string	Buat model pengklasifikasi kustom baru.
documentModelBuild	string	Buat model dokumen kustom baru.
documentModelCompose	string	Buat model dokumen kustom baru dari model yang sudah ada.
documentModelCopyTo	string	Salin model dokumen yang sudah ada ke sumber daya, wilayah, atau langganan yang berpotensi berbeda.

OperationStatus

Status operasi.

Nama	Jenis	Deskripsi
canceled	string	Operasi telah dibatalkan.
failed	string	Operasi gagal.
notStarted	string	Operasi belum dimulai.
running	string	Operasi sedang berlangsung.
succeeded	string	Operasi berhasil.

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.

Bagikan melalui