Dapatkan status dokumen

  • Artikel

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

Jika jumlah dokumen dalam respons melebihi batas penomoran kami, penomoran sisi server akan digunakan. Respons bernomor halaman menunjukkan hasil sebagian dan menyertakan token kelanjutan dalam respons. Tidak adanya token kelanjutan berarti tidak ada halaman lain yang tersedia.

$topParameter kueri , $skip, dan $maxpagesize dapat digunakan untuk menentukan jumlah hasil yang akan dikembalikan dan offset untuk koleksi.

$top menunjukkan jumlah total rekaman yang ingin dikembalikan pengguna di semua halaman. $skip menunjukkan jumlah rekaman yang akan dilewati dari daftar status dokumen yang dipegang oleh server berdasarkan metode pengurutan yang ditentukan. Secara default, kami mengurutkan berdasarkan waktu mulai yang menurun. $maxpagesize adalah item maksimum yang dikembalikan dalam halaman. Jika lebih banyak item diminta melalui $top (atau $top tidak ditentukan dan ada lebih banyak item yang akan dikembalikan), @nextLink akan berisi tautan ke halaman berikutnya.

Parameter kueri $orderBy dapat digunakan untuk mengurutkan daftar yang dikembalikan (mis. "$orderBy=createdDateTimeUtc asc" atau "$orderBy=createdDateTimeUtc desc"). Penyortiran default adalah menurun menurut createdDateTimeUtc. Beberapa parameter kueri dapat digunakan untuk memfilter daftar yang dikembalikan (misalnya: "status=Berhasil,Dibatalkan") hanya mengembalikan dokumen yang berhasil dan dibatalkan. createdDateTimeUtcStart dan createdDateTimeUtcEnd dapat digunakan secara gabungan atau terpisah untuk menentukan rentang datetime untuk memfilter daftar yang dikembalikan. Parameter kueri pemfilteran yang didukung adalah (status, ID, CreateDateTimeUtcStart, CreatedDateTimeUtcEnd).

Ketika dan $top$skip disertakan, server harus terlebih dahulu menerapkan $skip dan kemudian $top pada koleksi.

Catatan

Jika server tidak dapat mematuhi $top dan/atau $skip, server harus mengembalikan kesalahan kepada klien yang menginformasikannya alih-alih hanya mengabaikan opsi kueri. Ini mengurangi risiko klien membuat asumsi tentang data yang ditampilkan.

URL Permintaan

Kirim permintaan GET ke:

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

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 Dalam Wajib Tipe Deskripsi
id jalan Benar string ID operasi.
$maxpagesize pertanyaan Salah bilangan bulat int32 $maxpagesize adalah item maksimum yang dikembalikan dalam halaman. Jika lebih banyak item diminta melalui $top (atau $top tidak ditentukan dan ada lebih banyak item yang akan dikembalikan), @nextLink akan berisi tautan ke halaman berikutnya. Klien dapat meminta halaman berbasis server dengan ukuran halaman tertentu dengan menentukan $maxpagesize preferensi. Server SHOULD menghormati preferensi ini jika ukuran halaman yang ditentukan lebih kecil dari ukuran halaman default server.
$orderBy pertanyaan Salah array Kueri pengurutan untuk koleksi (misalnya: CreatedDateTimeUtc asc, CreatedDateTimeUtc desc).
$skip pertanyaan Salah bilangan bulat int32 $skip menunjukkan jumlah rekaman untuk dilewati dari daftar rekaman yang disimpan oleh server berdasarkan metode pengurutan yang ditentukan. Secara default, kami mengurutkan berdasarkan waktu mulai yang menurun. Klien DAPAT menggunakan parameter $top dan $skip kueri untuk menentukan jumlah hasil yang akan dikembalikan dan offset ke dalam koleksi. Ketika klien mengembalikan dan $top$skip, server HARUS terlebih dahulu menerapkan $skip dan kemudian $top pada koleksi. Jika server tidak dapat menghormati $top dan/atau $skip, server HARUS mengembalikan kesalahan kepada klien yang menginformasikannya alih-alih hanya mengabaikan opsi kueri.
$top pertanyaan Salah bilangan bulat int32 $top menunjukkan jumlah total rekaman yang ingin dikembalikan pengguna di semua halaman. Klien dapat menggunakan $top parameter kueri dan $skip untuk menentukan jumlah hasil yang akan dikembalikan dan offset ke dalam koleksi. Ketika klien mengembalikan dan $top$skip, server HARUS terlebih dahulu menerapkan $skip dan kemudian $top pada koleksi. Jika server tidak dapat menghormati $top dan/atau $skip, server HARUS mengembalikan kesalahan kepada klien yang menginformasikannya alih-alih hanya mengabaikan opsi kueri.
createdDateTimeUtcEnd pertanyaan Salah untai tanggal-waktu Tanggal selesai untuk mendapatkan item sebelumnya.
createdDateTimeUtcStart pertanyaan Salah untai tanggal-waktu Tanggal mulai untuk mendapatkan item setelahnya.
ids pertanyaan Salah array ID yang digunakan dalam pemfilteran.
status pertanyaan Salah array Status yang digunakan dalam pemfilteran.

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 dan mengembalikan status dokumen. HeadersRetry-After: integerETag: string
400 Permintaan tidak valid. Periksa parameter input.
401 Tidak Sah. Memeriksa info masuk Anda.
404 Sumber daya tidak ditemukan.
500 Kesalahan Server Internal.
Kode Status Lainnya • Terlalu banyak permintaan
• Server untuk sementara tidak tersedia

Dapatkan respons status dokumen

Berhasil mendapatkan respons status dokumen

Informasi berikut dikembalikan dalam respons yang berhasil.

Nama Tipe Deskripsi
@nextLink string Url untuk halaman berikutnya. Null jika tidak ada lagi halaman yang tersedia.
value DocumentStatus [] Daftar status detail dokumen individual.
value.path string Lokasi dokumen atau folder.
value.sourcePath string Lokasi dokumen sumber.
value.createdDateTimeUtc string Tanggal dan waktu pembuatan operasi.
value.lastActionDateTimeUtc string Waktu tanggal di mana status operasi diperbarui.
value.status status Daftar kemungkinan status untuk pekerjaan atau dokumen.
•Dibatalkan
•Membatalkan
•Gagal
• NotStarted
•Menjalankan
•Berhasil
• ValidationFailed
value.to string Ke bahasa.
value.progress number Kemajuan terjemahan jika tersedia.
value.id string ID Dokumen.
value.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.
target string Mendapatkan sumber kesalahan. Misalnya, itu akan menjadi documents 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.

{
  "value": [
    {
      "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
    }
  ],
  "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=5&$skip=15"
}

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