次の方法で共有

特定のドキュメントの状態を取得する

リファレンス
機能: Azure Translator → ドキュメント翻訳
API バージョン: 2024-05-01
HTTP メソッド: GET

このメソッドは、 id および documentId クエリ パラメーターによって要求に示されているように、ジョブ内の特定のドキュメントの状態を返します。

要求 URL

重要

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

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

要求パラメーター

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

Query parameter (クエリ パラメーター) 必須 説明
documentId 正しい ドキュメント ID。
id 正しい バッチ ID です。

id値とdocumentId値の検索

  • ジョブ id は、POST start-batch-translation メソッドの応答ヘッダー Operation-Location の URL 値で確認します。 この URL の最後のパラメーターが操作のジョブ id です。
応答ヘッダー 結果の URL
Operation-Location {document-translation-endpoint}/translator/document/batches/{id}?api-version={date}/ 9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec/

要求ヘッダー

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

ヘッダー 説明
Ocp-Apim-Subscription-Key 必要な要求ヘッダー

応答状態コード

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

状態コード 説明
200 OK です。 要求はサービスによって正常に受け付けられました。 操作の詳細が返されます。HeadersRetry-After: integerETag: string
401 権限がありません。 資格情報を確認してください。
404 Not Found. (見つかりませんでした。) リソースが見つかりません。
500 内部サーバー エラー。
その他の状態コード • 要求が多すぎます
• サーバーの一時的な利用不可

ドキュメント状態の取得の応答

成功したドキュメント状態の取得の応答

名前 タイプ 説明
パス 文字列 ドキュメントまたはフォルダーの場所。
ソースパス 文字列 ソース ドキュメントの場所。
createdDateTimeUtc 文字列 操作が作成された日時。
lastActionDateTimeUtc 文字列 操作の状態が更新された日時。
状態 糸 ジョブまたはドキュメントで使用可能な状態の一覧:
•キャンセル
•キャンセル
•失敗 しました
• NotStarted
•ランニング
•成功
• ValidationFailed
送信先 文字列 ターゲット言語の 2 文字の言語コード。 言語リストを参照。
進捗 数 翻訳の進行状況 (利用可能な場合)
id 文字列 ドキュメント ID。
characterCharged 整数 API によって課金される文字数。

エラー応答

名前 タイプ 説明
コード 文字列 高レベルのエラー コードを含む列挙型。 受け入れ可能な値:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•不正
メッセージ 文字列 高レベルのエラー メッセージを取得します。
innerError InnerTranslationError Foundry Tools API ガイドラインに準拠した新しい内部エラー形式。 このエラー メッセージには、必須プロパティ ErrorCode、message、および省略可能なプロパティ ターゲット、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"
    }
  }
}

次のステップ

ドキュメント翻訳とクライアント ライブラリの使用の詳細については、クイック スタートに従ってください。

ドキュメント翻訳の概要

  • Last updated on