Batalkan penerjemahan

  • Artikel

Layanan Referensi
: Versi API Terjemahan
Dokumen Azure AI: v1.1

Batalkan operasi pemrosesan atau antrean saat ini. Operasi tidak dibatalkan jika selesai, gagal, atau dibatalkan. Permintaan buruk dikembalikan. Terjemahan yang selesai tidak dibatalkan dan dikenakan biaya. Semua terjemahan yang tertunda dibatalkan jika memungkinkan.

URL Permintaan

Kirim permintaan DELETE ke:

https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}

Pelajari cara menemukan nama domain kustom Anda.

Penting

  • Semua permintaan API ke layanan Terjemahan Dokumen memerlukan titik akhir domain kustom.
  • Anda tidak dapat menggunakan titik akhir yang ditemukan di halaman Kunci dan Titik Akhir sumber daya portal Azure atau titik akhir penerjemah global— api.cognitive.microsofttranslator.com —untuk membuat permintaan HTTP ke Penerjemahan Dokumen.

Parameter permintaan

Parameter permintaan yang diteruskan pada untai kueri adalah:

Parameter kueri Wajib Deskripsi
id Benar ID operasi.

Header permintaan

Header permintaan adalah:

Header Deskripsi
Ocp-Apim-Subscription-Key Header permintaan yang diperlukan

Kode status respons

Berikut ini adalah kemungkinan kode status HTTP yang dihasilkan oleh permintaan.

Kode status Deskripsi
200 OK. Membatalkan permintaan yang diajukan
401 Tidak Sah. Memeriksa info masuk Anda.
404 Tidak ditemukan. Sumber daya tidak ditemukan.
500 Kesalahan Server Internal.
Kode Status Lainnya • Terlalu banyak permintaan
• Server sementara tidak tersedia

Membatalkan respons terjemahan

Respons berhasil

Informasi berikut dikembalikan dalam respons yang berhasil.

Nama Tipe Deskripsi
id string ID operasi.
createdDateTimeUtc string Tanggal dan waktu pembuatan operasi.
lastActionDateTimeUtc string Waktu tanggal di mana status operasi diperbarui.
status String Daftar kemungkinan status untuk pekerjaan atau dokumen: • Dibatalkan
•Membatalkan
•Gagal
• NotStarted
•Menjalankan
•Berhasil
• ValidationFailed
ringkasan StatusSummary Ringkasan yang berisi daftar detail.
summary.total Integer Penghitungan total dokumen.
summary.failed Integer Penghitungan dokumen gagal.
summary.success Integer Penghitungan dokumen berhasil diterjemahkan.
summary.inProgress Integer Penghitungan dokumen sedang berlangsung.
summary.notYetStarted Integer Penghitungan dokumen belum mulai diproses.
summary.cancelled Integer Jumlah yang dibatalkan.
summary.totalCharacterCharged Integer Total karakter yang dibebankan oleh API.

Respons kesalahan

Nama Tipe Deskripsi
kode string Enum yang berisi kode galat tingkat tinggi. Nilai yang mungkin:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•Sah
pesan string Mendapatkan pesan kesalahan tingkat tinggi.
target string Mendapatkan sumber kesalahan. Misalnya, itu akan menjadi "dokumen" atau document id untuk dokumen yang tidak valid.
innerError InnerTranslationError Format Kesalahan Dalam baru yang sesuai dengan Panduan API layanan Azure AI. Pesan kesalahan ini berisi properti yang diperlukan ErrorCode, pesan, dan target properti opsional, detail (pasangan nilai kunci), kesalahan dalam (dapat ditumpuk).
innerError.code string Mendapatkan untai kesalahan kode.
innerError.message string Mendapatkan pesan kesalahan tingkat tinggi.
innerError.target string Mendapatkan sumber kesalahan. Misalnya, itu akan menjadi documents atau document id jika ada dokumen yang tidak valid.

Contoh

Contoh respons berhasil

Objek JSON berikut adalah contoh respons yang berhasil.

Kode Status: 200

{
  "id": "727bf148-f327-47a0-9481-abae6362f11e",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Succeeded",
  "summary": {
    "total": 10,
    "failed": 1,
    "success": 9,
    "inProgress": 0,
    "notYetStarted": 0,
    "cancelled": 0,
    "totalCharacterCharged": 0
  }
}

Contoh respons kesalahan

Objek JSON berikut adalah contoh respons kesalahan. Skema untuk kode kesalahan lainnya adalah sama.

Kode status: 500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "target": "Operation",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

Langkah berikutnya

Ikuti mulai cepat kami untuk mempelajari lebih lanjut tentang menggunakan Terjemahan Dokumen dan pustaka klien.

Memulai Terjemahan Dokumen