获取所有文档的状态

参考
功能：Azure AI 翻译 → 文档翻译
API 版本：2024-05-01
HTTP 方法：GET

• 使用 get documents status 方法请求翻译作业中所有文档的状态。

• $top、$skip 和 $maxpagesize 查询参数可用于指定要返回的结果数以及集合的偏移量。

  • $top 指示用户希望在所有页面中返回的记录总数。
  • $skip 指示要根据指定的排序方法从服务器保存的文档状态列表中跳过的记录数。 默认情况下，记录按开始时间以降序方式排序。
  • $maxpagesize 是单个页面中返回的最大项数。
  • 如果通过 $top 请求更多项（或者未指定 $top，但有更多项要返回），@nextLink 会包含指向下一页的链接。
  • 如果响应中的文档数超出了分页限制，则使用服务器端分页。
  • 分页后的响应表示的是部分结果，且响应中包含延续令牌。 如果没有延续令牌，则表示没有其他可用页面。

• $orderBy 查询参数可用于对返回的列表排序（示例：$orderBy=createdDateTimeUtc asc 或 $orderBy=createdDateTimeUtc desc）。
• 默认排序为按 createdDateTimeUtc 以降序方式排序。 一些查询参数可用于筛选返回的列表（示例：status=Succeeded,Cancelled 只返回成功的和取消的文档）。
• createdDateTimeUtcStart 和 createdDateTimeUtcEnd 查询参数可以组合使用或单独使用，以指定日期/时间范围来筛选返回的列表。
• 支持的筛选查询参数为 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 值

• 可以在 POST start-batch-translation方法响应头 Operation-Location URL 值中查找作业 id。 /document/ 参数后面的字母数字字符串是操作的作业 id：

• 还可以使用 get-translations-status 请求来检索翻译作业的列表及其 id。

请求参数

查询字符串上传递的请求参数如下：

请求标头

请求标头为：

响应状态代码

下面是请求可能返回的 HTTP 状态代码。

获取文档状态响应

成功获取文档状态响应

成功的响应中会返回以下信息。

错误响应

示例

成功响应示例

以下 JSON 对象是成功响应的示例。

{
  "value": [
    {
      "path": "https://myblob.blob.core.chinacloudapi.cn/destinationContainer/fr/mydoc.txt",
      "sourcePath": "https://myblob.blob.core.chinacloudapi.cn/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://chinanorth.cognitiveservices.azure.cn/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"
    }
  }
}

后续步骤

遵循快速入门，详细了解如何使用文档翻译和客户端库。