取得支援的詞彙格式

發行項
09/01/2024

參考
功能：Azure AI Translator →文件翻譯
API 版本：2024-05-01
HTTP 方法：GET

此方法會傳回檔翻譯功能所支援的詞彙格式清單。此清單包含一般擴展名。

要求 URL

重要

文件翻譯功能的所有 API 要求都需要自訂網域端點，其位於 Azure 入口網站中的資源概觀頁面上。

curl -i -X GET "{document-translation-endpoint}/translator/document/formats?api-version={date}&type=glossary"

要求標頭

要求標頭如下：

標題	描述	條件
Ocp-Apim-Subscription-Key	來自 Azure 入口網站的翻譯工具服務 API 金鑰。	必要
Ocp-Apim-Subscription-Region	資源建立的所在區域。	使用美國西部等區域（地理）資源時需要。 & 項目符號。
Content-Type	承載的內容類型。接受的值為 application/json 或 charset=UTF-8。	必要

回應狀態代碼

以下是要求傳回的可能 HTTP 狀態碼。

狀態碼	描述
200	OK. 傳回支援的詞彙檔案格式清單。
500	內部伺服器錯誤。
其他狀態碼	• 要求太多 • 伺服器暫時無法使用

取得支援的詞彙格式回應

取得支援的字彙格式 API 中列表傳回的基底類型。

成功取得支援的詞彙格式回應

取得支援的字彙格式 API 中列表傳回的基底類型。

名稱	類型	描述
value	FileFormat []	FileFormat[] 包含列出的詳細資料。
value.contentTypes	string []	此格式支援的內容類型。
value.defaultVersion	字串	如果未指定預設版本
value.fileExtensions	string []	此格式支援的擴展名。
value.format	字串	格式的名稱。
value.versions	string []	支援的版本。

回覆錯誤

名稱	類型	描述
code	字串	包含高階錯誤碼的列舉。可能的值： • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •未經授權
message	字串	取得高階錯誤訊息。
innerError	InnerTranslationError	符合 Azure AI 服務 API 指導方針的新內部錯誤格式。此錯誤訊息包含必要的屬性 ErrorCode、訊息和選擇性屬性目標、details（索引鍵值組）、內部錯誤（可以是巢狀）。
innerError.code	字串	取得程式代碼錯誤字串。
innerError.message	字串	取得高階錯誤訊息。
innerError.target	字串	取得錯誤的來源。例如，如果有不正確的文件，其會是 `documents` 或 `document id`。

範例

成功回應的範例

下列 JSON 對像是成功的回應範例。

{
    "value": [
        {
            "format": "XLIFF",
            "fileExtensions": [
                ".xlf"
            ],
            "contentTypes": [
                "application/xliff+xml"
            ],
            "defaultVersion": "1.2",
            "versions": [
                "1.0",
                "1.1",
                "1.2"
            ]
        },
        {
            "format": "TSV",
            "fileExtensions": [
                ".tsv",
                ".tab"
            ],
            "contentTypes": [
                "text/tab-separated-values"
            ]
        },
        {
            "format": "CSV",
            "fileExtensions": [
                ".csv"
            ],
            "contentTypes": [
                "text/csv"
            ]
        }
    ]
}

範例錯誤回應

下列 JSON 對像是錯誤回應的範例。其他錯誤碼的架構相同。

狀態代碼：500

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

下一步

請遵循我們的快速入門，深入瞭解如何使用文件翻譯和客戶端連結庫。

開始使用文件翻譯

共用方式為