取得所有翻譯作業的狀態

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

  • get translations status使用方法來要求使用者提交之所有翻譯工作的清單和狀態（與資源相關聯）。

  • $top、$skip 和 $maxpagesize 查詢參數可以用來指定要傳回的結果數目，以及集合的位移。

    • $top 表示要跨所有頁面傳回的記錄總數。
    • $skip 根據指定的排序方法，從批次清單中指出要跳過的記錄數目。 根據預設，記錄會依遞減開始時間排序。
    • $maxpagesize 是在頁面中傳回的最大項目數。
    • 如果透過 $top 要求更多項目 (或未指定 $top，且要傳回更多項目)，則 @nextLink 會包含下一個頁面的連結。
    • 伺服器會接受用戶端所指定的值。 不過，客戶端必須準備好處理包含不同頁面大小或包含接續令牌的回應。
    • $top同時包含和 $skip 時，伺服器會先套用 ，然後在$skip集合上套用$top。

注意

如果伺服器無法接受 $top 及/或 $skip，伺服器必須將錯誤傳回給用戶端來進行告知，而不是忽略查詢選項。 此動作可降低客戶端對傳回數據進行假設的風險。

  • $orderBy query 參數可用來排序傳回的清單（例如： $orderBy=createdDateTimeUtc asc 或 $orderBy=createdDateTimeUtc desc）。
    • 默認排序依 createdDateTimeUtc遞減。 某些查詢參數可用來篩選傳回的清單（例如： status=Succeeded,Cancelled）傳回成功和取消的作業。
    • 和 createdDateTimeUtcStartcreatedDateTimeUtcEnd 查詢參數可以合併或分開使用，以指定日期時間範圍來篩選傳回的清單。
    • 支援的篩選查詢參數為 （status、 id、 createdDateTimeUtcStart和 createdDateTimeUtcEnd）。

要求 URL

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

重要

所有對文件轉換功能的 API 請求都需要一個位於 Azure 入口網站資源概覽頁面的自訂網域端點。

要求參數

在查詢字串上傳遞的要求參數如下：

查詢參數 在 必要 類型 描述
$maxpagesize 查詢 否 整數 int32 $maxpagesize 是在頁面中傳回的最大項目數。 如果透過 $top 要求更多項目 (或未指定 $top，且要傳回更多項目)，則 @nextLink 會包含下一個頁面的連結。 用戶端可以藉由指定 $maxpagesize 喜好設定，以特定頁面大小要求伺服器導向的分頁。 如果指定的頁面大小小於伺服器的默認頁面大小，伺服器應該接受此喜好設定。
$orderBy 查詢 否 陣列 集合的排序查詢 (例如：CreatedDateTimeUtc asc、CreatedDateTimeUtc desc)
$skip 查詢 否 整數 int32 $skip 根據指定的排序方法，從伺服器持有的記錄清單中指出要跳過的記錄數目。 根據預設，我們會依遞減開始時間排序。 用戶端可以使用 $top 和 $skip 查詢參數，來指定要傳回的結果數，以及集合中的位移。 當用戶端同時傳回 $top 和 $skip 時，伺服器「應該」先套用 $skip，然後才再集合上套用 $top。注意：如果伺服器無法接受 $top 及/或 $skip，伺服器必須將錯誤傳回給用戶端，來進行告知，而不是忽略查詢選項。
$top 查詢 否 整數 int32 $top 表示使用者想要在所有頁面上傳回的記錄總數。 用戶端可以使用 $top 和 $skip 查詢參數，來指定要傳回的結果數，以及集合中的位移。 當用戶端同時傳回 $top 和 $skip 時，伺服器「應該」先套用 $skip，然後才再集合上套用 $top。注意：如果伺服器無法接受 $top 及/或 $skip，伺服器必須將錯誤傳回給用戶端，來進行告知，而不是忽略查詢選項。
createdDateTimeUtcEnd 查詢 否 字串日期-時間 要取得專案之前的結束日期時間。
createdDateTimeUtcStart 查詢 否 字串日期-時間 要取得項目之後的開始日期時間。
ids 查詢 否 陣列 篩選中使用的識別碼。
statuses 查詢 否 陣列 篩選中使用的狀態。

要求標頭

要求標頭如下：

標題 描述 條件
Ocp-Apim-Subscription-Key 你的 Azure 入口網站的 Translator API 金鑰。 必要
Ocp-Apim-Subscription-Region 資源建立的所在區域。 & 項目符號。
Content-Type 承載的內容類型。 接受的值為 application/json 或 charset=UTF-8。 必要

回應狀態代碼

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

狀態碼 描述
200 還行。 成功要求並傳回所有作業的狀態。 HeadersRetry-After： integerETag： string
400 不正確的要求。 要求無效。 檢查輸入參數。
401 未經授權。 檢查您的認證。
500 內部伺服器錯誤。
其他狀態碼 • 要求太多
• 伺服器暫時無法使用

取得翻譯狀態回應

成功取得翻譯狀態回應

成功回應中會傳回下列資訊。

名稱 類型 描述
@nextLink 字串 下一頁的 URL。 如果沒有其他可用的頁面，則為 Null。
價值 TranslationStatus[] TranslationStatus[] 陣列
value.id 字串 作業的標識碼。
value.createdDateTimeUtc 字串 作業已建立日期時間。
value.lastActionDateTimeUtc 字串 更新作業狀態的日期時間。
value.status 繩子 工作或檔案可能的狀態清單：
• 已取消
•取消
•失敗
• 未開始
•運行
•成功
• 驗證失敗
value.summary StatusSummary[] 包含所列詳細資料的摘要。
value.summary.total 整數 檔總數。
value.summary.failed 整數 檔計數失敗。
value.summary.success 整數 已成功翻譯的檔計數。
value.summary.inProgress 整數 進行中的檔計數。
value.summary.notYetStarted 整數 尚未開始處理的檔計數。
value.summary.cancelled 整數 取消的檔計數。
value.summary.totalCharacterCharged 整數 收費的字元總數。

回覆錯誤

名稱 類型 描述
字碼 字串 包含高階錯誤碼的列舉。 接受的值：
• 內部伺服器錯誤
• 無效論證
• 無效請求
• 請求過高
• 資源未尋獲
• 服務不可用
•未經授權
訊息 字串 取得高階錯誤訊息。
目標 字串 取得錯誤的來源。 例如，如果有無效文件，其會是 documents 或 document id。
內部錯誤 InnerTranslationError 新的內部錯誤格式，符合 Foundry Tools API 指引。 此錯誤訊息包含必要屬性 ErrorCode、訊息和選擇性屬性目標、詳細資料 ( 機碼值組)、內部錯誤 (可為巢狀)。
innerError.code 字串 取得程式代碼錯誤字串。
內部錯誤.訊息 字串 取得高階錯誤訊息。
innerError.target 字串 取得錯誤的來源。 例如，如果有無效文件，其會是 documents 或 document id。

範例

提示

您可以使用這個方法來擷取 get-translation-statusid作業參數。

成功回應的範例

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

{
    "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"
}

範例錯誤回應

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

狀態代碼：500

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

下一步

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

開始使用文件翻譯

  • Last updated on