Dapatkan status dokumen

Artikel
02/23/2024

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

Metode Dapatkan status terjemahan menampilkan daftar permintaan batch yang dikirimkan dan status untuk setiap permintaan. Daftar ini hanya berisi permintaan batch yang diajukan oleh pengguna (berdasarkan sumber daya).

Jika jumlah permintaan melebihi batas penomoran halaman kami, penomoran halaman 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 batch 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") mengembalikan operasi 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).

Server mematuhi nilai yang ditentukan oleh klien. Namun, klien harus siap untuk menangani respons yang berisi ukuran halaman yang berbeda atau berisi token kelanjutan.

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

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
`$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 yang akan 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 `$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. Catatan: 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. Catatan: 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 yang berhasil dan menampilkan semua operasi. HeadersRetry-After: integerETag: string
400	Permintaan Buruk. Permintaan tidak valid. Periksa parameter input.
401	Tidak Sah. Memeriksa info masuk Anda.
500	Kesalahan Server Internal.
Kode Status Lainnya	• Terlalu banyak permintaan • Server sementara tidak tersedia

Dapatkan respons status terjemahan

Berhasil mendapatkan respons status terjemahan

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	TranslationStatus[]	TranslationStatus[] Array
value.id	string	ID operasi.
value.createdDateTimeUtc	string	Tanggal dan waktu pembuatan operasi.
value.lastActionDateTimeUtc	string	Waktu tanggal di mana status operasi diperbarui.
value.status	String	Daftar kemungkinan status untuk pekerjaan atau dokumen: •Dibatalkan •Membatalkan •Gagal • NotStarted •Menjalankan •Berhasil • ValidationFailed
value.summary	StatusSummary[]	Ringkasan yang berisi detail yang tercantum.
value.summary.total	Integer	Penghitungan total dokumen.
value.summary.failed	Integer	Penghitungan dokumen gagal.
value.summary.success	Integer	Penghitungan dokumen berhasil diterjemahkan.
value.summary.inProgress	Integer	Penghitungan dokumen sedang berlangsung.
value.summary.notYetStarted	Integer	Penghitungan dokumen belum mulai diproses.
value.summary.cancelled	Integer	Penghitungan dokumen dibatalkan.
value.summary.totalCharacterCharged	Integer	Jumlah total karakter yang dikenai biaya.

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` jika ada 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": [
        {
            "id": "36724748-f7a0-4db7-b7fd-f041ddc75033",
            "createdDateTimeUtc": "2021-06-18T03:35:30.153374Z",
            "lastActionDateTimeUtc": "2021-06-18T03:36:44.6155316Z",
            "status": "Succeeded",
            "summary": {
                "total": 3,
                "failed": 2,
                "success": 1,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "1c7399a7-6913-4f20-bb43-e2fe2ba1a67d",
            "createdDateTimeUtc": "2021-05-24T17:57:43.8356624Z",
            "lastActionDateTimeUtc": "2021-05-24T17:57:47.128391Z",
            "status": "Failed",
            "summary": {
                "total": 1,
                "failed": 1,
                "success": 0,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "daa2a646-4237-4f5f-9a48-d515c2d9af3c",
            "createdDateTimeUtc": "2021-04-14T19:49:26.988272Z",
            "lastActionDateTimeUtc": "2021-04-14T19:49:43.9818634Z",
            "status": "Succeeded",
            "summary": {
                "total": 2,
                "failed": 0,
                "success": 2,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 21899
            }
        }
    ],
    ""@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/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