Mendapatkan status untuk dokumen tertentu

Fitur Referensi
: Azure AI Penerjemah → Document Translation
API Version: Metode HTTP 2024-05-01
: GET

Metode ini mengembalikan status untuk dokumen tertentu dalam pekerjaan seperti yang ditunjukkan dalam permintaan oleh id parameter kueri dan documentId .

URL Permintaan

Penting

Semua permintaan API ke fitur Terjemahan Dokumen memerlukan titik akhir domain kustom yang terletak di halaman gambaran umum sumber daya Anda di portal Azure.

  curl -i -X GET "{document-translation-endpoint}/translator/document/batches/{id}/documents/{documentId}?api-version={date}"

Parameter permintaan

Parameter permintaan yang diteruskan pada untai kueri adalah:

Parameter kueri	Wajib	Deskripsi
documentId	Benar	ID Dokumen.
id	Benar	ID batch.

id Menemukan nilai dan documentId

• Anda dapat menemukan pekerjaan id di nilai URL Header Operation-Location respons metode POSTstart-batch-translation. Parameter terakhir dari URL adalah pekerjaan operasi id:

Header respons	URL hasil
Operation-Location	{document-translation-endpoint}/translator/document/batches/{id}?api-version={date}/ 9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec/

• Anda juga dapat menggunakan permintaan status terjemahan GET untuk mengambil parameter pekerjaan id untuk string kueri.

• Anda dapat menemukan documentId parameter dalam respons metode get-documents-status.

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. Permintaan berhasil diterima oleh layanan. Detail operasi adalah returned.HeadersRetry-After: integerETag: string
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

Dapatkan respons status dokumen

Berhasil mendapatkan respons status dokumen

Nama	Tipe	Deskripsi
jalan	string	Lokasi dokumen atau folder.
sourcePath	string	Lokasi dokumen sumber.
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
ke	string	Dua huruf kode bahasa dari Bahasa Tujuan. Lihat daftar bahasa.
kemajuan	number	Kemajuan terjemahan jika tersedia
id	string	ID Dokumen.
characterCharged	Integer	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.
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 untuk dokumen yang tidak valid.

Contoh

Contoh respons berhasil

Objek JSON berikut adalah contoh respons yang berhasil.

{
  "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt",
  "sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Running",
  "to": "fr",
  "progress": 0.1,
  "id": "273622bd-835c-4946-9798-fd8f19f6bbf2",
  "characterCharged": 0
}

Contoh respons kesalahan

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

Kode status: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

Langkah berikutnya

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

Memulai Terjemahan Dokumen