共用方式為

取得特定文件的狀態

  • 發行項

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

這個方法會傳回作業中特定文件的狀態，如 和 documentId 查詢參數所指示id。

要求 URL

重要

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

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

要求參數

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

查詢參數 必要 描述
documentId True 文件識別碼。
id True 批次標識碼。

尋找 id 和 documentId 值

  • 您會在 POST start-batch-translation 方法回應標頭 Operation-Location URL 值中找到作業 id。 URL 的最後一個參數是作業的工作 id：
回應標頭 結果 URL
Operation-Location {document-translation-endpoint}/translator/document/batches/{id}？api-version={date}/ 9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec/

  • 您也可以使用 GET 翻譯狀態 要求來擷取查詢字串的作業 id 參數。

  • 您可以在 documentId get-documents-status 方法回應中找到 參數。

要求標頭

要求標頭如下：

標題 描述
Ocp-Apim-Subscription-Key 必要要求標頭

回應狀態代碼

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

狀態碼 描述
200 OK. 服務接受的成功要求。 作業詳細數據會傳回。HeadersRetry-After： integerETag： string
401 未經授權。 檢查您的認證。
404 找不到。 找不到資源。
500 內部伺服器錯誤。
其他狀態碼 • 要求太多
• 伺服器暫時無法使用

取得文件狀態回應

成功取得文件狀態回應

名稱 類型​​ 描述
path 字串 檔或資料夾的位置。
sourcePath 字串 源文檔的位置。
createdDateTimeUtc 字串 作業已建立日期時間。
lastActionDateTimeUtc 字串 更新作業狀態的日期時間。
status String 工作或檔案可能的狀態清單：
• 已取消
•取消
•失敗
• NotStarted
•運行
•成功
• ValidationFailed
打給 字串 To Language 的兩個字母語言代碼。 請參閱語言清單。
進度 數值 如果有的話，翻譯的進度
id 字串 文件識別碼。
characterCharged 整數 由 API 收費的字元。

回覆錯誤

名稱 類型​​ 描述
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 對像是成功的回應範例。

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

範例錯誤回應

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

狀態代碼：401

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

下一步

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

開始使用文件翻譯