Dapatkan format dokumen yang didukung
Layanan Referensi
: Versi API Terjemahan
Dokumen Azure AI: v1.1
Metode Dapatkan Format Dokumen mengembalikan daftar format dokumen yang didukung oleh layanan Penerjemahan Dokumen. Daftar ini mencakup ekstensi file umum, dan jenis konten jika menggunakan API pengunggahan.
URL Permintaan
Kirim permintaan GET ke:
GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/documents/formats
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.
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. Mengembalikan daftar format file dokumen yang didukung. |
| 500 | Kesalahan Server Internal. |
| Kode Status Lainnya | • Terlalu banyak permintaan • Server sementara tidak tersedia |
Respons format file
Respons fileFormatListResult berhasil
Informasi berikut dikembalikan dalam respons yang berhasil.
| Nama | Tipe | Deskripsi |
|---|---|---|
| value | FileFormat [] | FileFormat[] berisi detail yang tercantum. |
| value.contentTypes | string[] | Jenis Konten yang Didukung untuk format ini. |
| value.defaultVersion | string | Versi default jika tidak ada yang dipilih. |
| value.fileExtensions | string[] | Ekstensi file yang didukung untuk format ini. |
| value.format | string | Nama format. |
| value.versions | string [] | Versi yang didukung. |
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.
Kode Status: 200
{
"value": [
{
"format": "PlainText",
"fileExtensions": [
".txt"
],
"contentTypes": [
"text/plain"
],
"versions": []
},
{
"format": "OpenXmlWord",
"fileExtensions": [
".docx"
],
"contentTypes": [
"application/vnd.openxmlformats-officedocument.wordprocessingml.document"
],
"versions": []
},
{
"format": "OpenXmlPresentation",
"fileExtensions": [
".pptx"
],
"contentTypes": [
"application/vnd.openxmlformats-officedocument.presentationml.presentation"
],
"versions": []
},
{
"format": "OpenXmlSpreadsheet",
"fileExtensions": [
".xlsx"
],
"contentTypes": [
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
],
"versions": []
},
{
"format": "OutlookMailMessage",
"fileExtensions": [
".msg"
],
"contentTypes": [
"application/vnd.ms-outlook"
],
"versions": []
},
{
"format": "HtmlFile",
"fileExtensions": [
".html",
".htm"
],
"contentTypes": [
"text/html"
],
"versions": []
},
{
"format": "PortableDocumentFormat",
"fileExtensions": [
".pdf"
],
"contentTypes": [
"application/pdf"
],
"versions": []
},
{
"format": "XLIFF",
"fileExtensions": [
".xlf"
],
"contentTypes": [
"application/xliff+xml"
],
"versions": [
"1.0",
"1.1",
"1.2"
]
},
{
"format": "TSV",
"fileExtensions": [
".tsv",
".tab"
],
"contentTypes": [
"text/tab-separated-values"
],
"versions": []
},
{
"format": "CSV",
"fileExtensions": [
".csv"
],
"contentTypes": [
"text/csv"
],
"versions": []
},
{
"format": "RichTextFormat",
"fileExtensions": [
".rtf"
],
"contentTypes": [
"application/rtf"
],
"versions": []
},
{
"format": "WordDocument",
"fileExtensions": [
".doc"
],
"contentTypes": [
"application/msword"
],
"versions": []
},
{
"format": "PowerpointPresentation",
"fileExtensions": [
".ppt"
],
"contentTypes": [
"application/vnd.ms-powerpoint"
],
"versions": []
},
{
"format": "ExcelSpreadsheet",
"fileExtensions": [
".xls"
],
"contentTypes": [
"application/vnd.ms-excel"
],
"versions": []
},
{
"format": "OpenDocumentText",
"fileExtensions": [
".odt"
],
"contentTypes": [
"application/vnd.oasis.opendocument.text"
],
"versions": []
},
{
"format": "OpenDocumentPresentation",
"fileExtensions": [
".odp"
],
"contentTypes": [
"application/vnd.oasis.opendocument.presentation"
],
"versions": []
},
{
"format": "OpenDocumentSpreadsheet",
"fileExtensions": [
".ods"
],
"contentTypes": [
"application/vnd.oasis.opendocument.spreadsheet"
],
"versions": []
},
{
"format": "Markdown",
"fileExtensions": [
".markdown",
".mdown",
".mkdn",
".md",
".mkd",
".mdwn",
".mdtxt",
".mdtext",
".rmd"
],
"contentTypes": [
"text/markdown",
"text/x-markdown",
"text/plain"
],
"versions": []
},
{
"format": "Mhtml",
"fileExtensions": [
".mhtml",
".mht"
],
"contentTypes": [
"message/rfc822",
"application/x-mimearchive",
"multipart/related"
],
"versions": []
}
]
}
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",
"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.