Analyze Documents Cancel Job - Analyze Documents Cancel Job

Layanan:

Azure AI Services

Versi API:

2024-11-15-preview

Batalkan pekerjaan Analisis Teks yang berjalan lama.

POST {Endpoint}/language/analyze-documents/jobs/{jobId}:cancel?api-version=2024-11-15-preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (misalnya, https://< resource-name.api.cognitiveservices.azure.com>).
jobId	path	True	string (uuid)	ID pekerjaan yang akan dibatalkan.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
202 Accepted		Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai. Header Operation-Location: string
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Cakupan

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

SuccessfulAnalyzeDocumentsJobsCancelRequest

Permintaan sampel

HTTP

POST {Endpoint}/language/analyze-documents/jobs/c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18:cancel?api-version=2024-11-15-preview

Respon sampel

Kode status:

202

Operation-Location: {Endpoint}/language/analyze-documents/jobs/{jobId}?api-version=2024-11-15-preview

Definisi

Nama	Deskripsi
Error	Objek respons kesalahan dikembalikan ketika layanan mengalami beberapa kesalahan selama pemrosesan permintaan.
ErrorCode	Kode kesalahan yang dapat dibaca manusia.
ErrorResponse	Respons kesalahan.
InnerErrorCode	Kode kesalahan yang dapat dibaca manusia.
InnerErrorModel	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Error

Objek

Objek respons kesalahan dikembalikan ketika layanan mengalami beberapa kesalahan selama pemrosesan permintaan.

Nama	Jenis	Deskripsi
code	ErrorCode	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

ErrorCode

Enumeration

Kode kesalahan yang dapat dibaca manusia.

Nilai	Deskripsi
InvalidRequest	Kesalahan permintaan tidak valid
InvalidArgument	Kesalahan argumen tidak valid
Unauthorized	Kesalahan akses tidak sah
Forbidden	Kesalahan akses terlarang
NotFound	Kesalahan tidak ditemukan
ProjectNotFound	Kesalahan proyek tidak ditemukan
OperationNotFound	Operasi tidak ditemukan kesalahan
AzureCognitiveSearchNotFound	Kesalahan Azure Cognitive Search tidak ditemukan
AzureCognitiveSearchIndexNotFound	Kesalahan indeks Azure Cognitive Search tidak ditemukan
TooManyRequests	Terlalu banyak kesalahan permintaan
AzureCognitiveSearchThrottling	Kesalahan pembatasan Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Kesalahan tercapainya batas indeks Azure Cognitive Search
InternalServerError	Kesalahan server internal
ServiceUnavailable	Kesalahan layanan tidak tersedia
Timeout	Kesalahan waktu habis
QuotaExceeded	Kesalahan kuota terlampaui
Conflict	Kesalahan konflik
Warning	Kesalahan peringatan

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

InnerErrorCode

Enumeration

Kode kesalahan yang dapat dibaca manusia.

Nilai	Deskripsi
InvalidRequest	Kesalahan permintaan tidak valid
InvalidParameterValue	Kesalahan nilai parameter tidak valid
KnowledgeBaseNotFound	Pangkalan pengetahuan tidak menemukan kesalahan
AzureCognitiveSearchNotFound	Kesalahan Azure Cognitive Search tidak ditemukan
AzureCognitiveSearchThrottling	Kesalahan pembatasan Azure Cognitive Search
ExtractionFailure	Kesalahan kegagalan ekstraksi
InvalidRequestBodyFormat	Kesalahan format isi permintaan tidak valid
EmptyRequest	Kesalahan permintaan kosong
MissingInputDocuments	Kesalahan dokumen input hilang
InvalidDocument	Kesalahan dokumen tidak valid
ModelVersionIncorrect	Kesalahan versi model salah
InvalidDocumentBatch	Kesalahan batch dokumen tidak valid
UnsupportedLanguageCode	Kesalahan kode bahasa yang tidak didukung
InvalidCountryHint	Kesalahan petunjuk negara tidak valid

InnerErrorModel

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nama	Jenis	Deskripsi
code	InnerErrorCode	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	object	Detail kesalahan.
innererror	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.