ドキュメント状態の取得

  • [アーティクル]

リファレンス
サービス: Azure AI ドキュメント翻訳
API バージョン: v1.1

ドキュメント状態の取得メソッドでは、特定のドキュメントの状態が返されます。 このメソッドでは、特定のドキュメントの翻訳状態が、要求 ID とドキュメント ID に基づいて返されます。

要求 URL

GET 要求の送信先は次のとおりです。

GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}/documents/{documentId}

カスタム ドメイン名を見つける方法について説明します。

重要

  • ドキュメント翻訳サービスへのすべての API 要求には、カスタム ドメイン エンドポイントが必要です。
  • ドキュメント翻訳への HTTP 要求を行うために、Azure portal リソースの [キーとエンドポイント] ページで見つかるエンドポイントも、グローバル Translator エンドポイント api.cognitive.microsofttranslator.com も使用することはできません。

要求パラメーター

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

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

要求ヘッダー

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

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

応答状態コード

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

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

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

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

名前 種類 説明
path string ドキュメントまたはフォルダーの場所。
sourcePath string ソース ドキュメントの場所。
createdDateTimeUtc string 操作が作成された日時。
lastActionDateTimeUtc string 操作の状態が更新された日時。
status String ジョブまたはドキュメントで使用可能な状態の一覧:
•キャンセル
•キャンセル
•失敗 しました
• NotStarted
•実行
•成功
• ValidationFailed
to string ターゲット言語の 2 文字の言語コード。 言語リストを参照。
progress number 翻訳の進行状況 (利用可能な場合)
id string ドキュメント ID。
characterCharged 整数 (integer) API によって課金される文字数。

エラー応答

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

次のステップ

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

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