特定の翻訳ジョブの状態を取得する

リファレンス
機能: Azure AI Translator → Document Translation
API バージョン: 2024-05-01
HTTP メソッド: GET

• get translation statusメソッドを使用して、特定の翻訳ジョブの状態を要求します。 応答には、ジョブ全体の状態と、そのジョブの一部として翻訳されるドキュメントの状態が含まれます。

要求 URL

重要

ドキュメント翻訳機能に対するすべての API 要求に、Azure portal のリソース概要ページにあるカスタム ドメイン エンドポイントが必要です。

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

要求パラメーター

クエリ文字列に渡される要求パラメーターを次に示します。

Query parameter (クエリ パラメーター)	必須	説明
id	True	操作 ID。

id 値の検索

ジョブ id は、POST start-batch-translation メソッドの応答ヘッダー Operation-Location の URL 値で確認します。 /document/ パラメーターの後に続く英数字の文字列は、操作のジョブ id です。

応答ヘッダー	応答 URL
Operation-Location	{document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

• また、get-translations-status 要求を使用して、翻訳 "ジョブ" とその id の一覧を取得することもできます。

要求ヘッダー

要求ヘッダーを次に示します。

ヘッダー	説明	条件
Ocp-Apim-Subscription-Key	Azure portal からの Translator サービス API キー。	必須
Ocp-Apim-Subscription-Region	リソースが作成されたリージョン。	必須 米国. などのリージョン (地理的) リソースを使用する場合> 行頭文字。
Content-Type	ペイロードのコンテンツ タイプ。 許容される値は application/json または charset=UTF-8 です。	必須

応答状態コード

要求によって返される可能性のある HTTP 状態コードを次に示します。

状態コード	説明
200	OK です。 要求が成功して、バッチ翻訳操作の状態を返します。 HeadersRetry-After: integerETag: string
401	権限がありません。 資格情報を確認してください。
404	リソースが見つかりません。
500	内部サーバー エラー。
その他の状態コード	• 要求が多すぎます • サーバーの一時的な利用不可

翻訳状態の取得の応答

翻訳状態の取得の応答に成功

成功した応答では、次の情報が返されます。

名前	種類	説明
id	string	操作の ID。
createdDateTimeUtc	string	操作が作成された日時。
lastActionDateTimeUtc	string	操作の状態が更新された日時。
status	String	ジョブまたはドキュメントで使用可能な状態の一覧: •キャンセル •キャンセル •失敗 しました • NotStarted •ランニング •成功 • ValidationFailed
まとめ	StatusSummary	一覧表示された詳細を含む概要です。
summary.total	整数 (integer)	総数。
summary.failed	整数 (integer)	失敗数
summary.success	整数 (integer)	成功した数。
summary.inProgress	整数 (integer)	進行中の数。
summary.notYetStarted	整数 (integer)	まだ開始されていない数。
summary.cancelled	整数 (integer)	取り消された数。
summary.totalCharacterCharged	整数 (integer)	API によって課金される文字数合計。

エラー応答

名前	種類	説明
code	string	高レベルのエラー コードを含む列挙型。 指定できる値 • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •不正
message	string	高レベルのエラー メッセージを取得します。
ターゲット (target)	string	エラーのソースを取得します。 たとえば、無効なドキュメントの場合には documents か document id になります。
innerError	InnerTranslationError	Azure AI サービス API のガイドラインに準拠した新しい内部エラー形式。 このエラー メッセージには、必須プロパティ ErrorCode、message、および省略可能なプロパティ ターゲット、details(キー値ペア)、内部エラー (入れ子にできます) が含まれています。
innerError.code	string	コード エラー文字列を取得します。
innerError.message	string	高レベルのエラー メッセージを取得します。
innerError.target	string	エラーのソースを取得します。 たとえば、無効なドキュメントの場合には documents か document id になります。

例

成功した応答の例

次の JSON オブジェクトは、成功時の応答の例です。

{
  "id": "727bf148-f327-47a0-9481-abae6362f11e",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Succeeded",
  "summary": {
    "total": 10,
    "failed": 1,
    "success": 9,
    "inProgress": 0,
    "notYetStarted": 0,
    "cancelled": 0,
    "totalCharacterCharged": 0
  }
}

エラー応答の例

次の JSON オブジェクトは、エラー応答の例です。 他のエラー コードのスキーマも同じです。

状態コード: 401

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

次のステップ

クイックスタートに従って、ドキュメント翻訳とクライアント ライブラリの使用について学習します。

ドキュメント変換を使ってみる