すべてのドキュメントの状態を取得する

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

• get documents status メソッドを使用して、翻訳ジョブ内のすべてのドキュメントの状態を要求します。

• $top、$skip、$maxpagesize のクエリ パラメーターを使用して、返される結果の数とコレクションのオフセットを指定できます。

  • $top は、ユーザーがすべてのページで返すレコードの総数を示します。
  • $skip は、指定した並べ替え方法に基づいて、サーバーによって保持されているドキュメントの状態の一覧からスキップするレコードの数を示します。 既定では、レコードは降順の開始時刻で並べ替えられます。
  • $maxpagesize は、1 つのページで返される項目の最大数です。
  • $top 経由でさらに多くの項目が要求された場合 (または $top が指定されておらず、返される項目がさらにある場合)、@nextLink には次のページへのリンクが含まれます。
  • 応答内のドキュメントの数がページング限度を超える場合は、サーバー側のページングが使用されます。
  • ページ分割された応答は結果の一部を示しており、応答の中に継続トークンが含まれています。 継続トークンがない場合は、他にページがないことを意味します。

• $orderBy クエリ パラメーターを使用して、返されたリストを並べ替えることができます (例: $orderBy=createdDateTimeUtc asc または $orderBy=createdDateTimeUtc desc)。
• 既定の並べ替えは、 createdDateTimeUtc降順です。 一部のクエリ パラメーターを使用して、返されたリストをフィルター処理できます (例: status=Succeeded,Cancelled) は、成功したドキュメントと取り消されたドキュメントのみを返します。
• createdDateTimeUtcStartおよびcreatedDateTimeUtcEndクエリ パラメーターを組み合わせて使用するか、個別に使用して、返されるリストをフィルター処理する datetime の範囲を指定できます。
• サポートされているフィルター クエリ パラメーターは (status、 id、 createdDateTimeUtcStart、および createdDateTimeUtcEnd) です。
• $top と $skip の両方が含まれている場合、サーバーはコレクションに最初に $skip を適用し、次に $top を適用する必要があります。

要求 URL

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

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

id 値の検索

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

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

要求パラメーター

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

要求ヘッダー

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

応答状態コード

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

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

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

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

エラー応答

例

成功した応答の例

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

{
  "value": [
    {
      "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
    }
  ],
  "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/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"
    }
  }
}

次のステップ

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