获取所有文档状态

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

Important

所有针对文档翻译功能的 API 请求都需要使用您在 Azure 门户资源概述页面上看到的自定义域终结点。

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

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

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

Note

如果服务器不能服从 $top 和/或 $skip，则服务器必须针对此状况向客户端返回一个错误通知，而不是简单地忽略查询选项。 此作可降低客户端对返回的数据做出假设的风险。

  • $orderBy 查询参数可用于对返回的列表排序（示例：$orderBy=createdDateTimeUtc asc 或 $orderBy=createdDateTimeUtc desc）。
  • 默认排序为按 createdDateTimeUtc 以降序方式排序。 一些查询参数可用于筛选返回的列表（示例：status=Succeeded,Cancelled 只返回成功的和取消的文档）。
  • createdDateTimeUtcStart可以组合和createdDateTimeUtcEnd查询参数，也可以单独用于指定一系列日期/时间以筛选返回的列表。
  • 支持的筛选查询参数为 status、id、createdDateTimeUtcStart 和 createdDateTimeUtcEnd。
  • 同时包括 $top 和 $skip 时，服务器应先在集合上应用 $skip，然后再应用 $top。

请求网址

将 GET 请求发送到：

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

查找 id 值

  • 您可以在 POST id 方法响应头 start-batch-translation 的 URL 值中找到作业 Operation-Location。 /document/ 参数后面的字母数字字符串是操作的作业 id：
响应头 响应网址
操作位置 {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec？api-version=2024-05-01

请求参数

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

查询参数 In Required 类型 说明
id 路径 真实 字符串 操作 ID。
$maxpagesize 查询 假 整数 (int32) $maxpagesize 是单个页面中返回的最大项数。 如果通过 $top 请求更多项（或者未指定 $top，但有更多项要返回），@nextLink 会包含指向下一页的链接。 客户端可以通过指定 $maxpagesize 首选项来请求使用特定页面大小进行的服务器驱动的分页。 如果指定的页面大小小于服务器的默认页面大小，则服务器应遵循此首选项。
$orderBy 查询 假 数组 集合的排序查询（例如：CreatedDateTimeUtc asc、CreatedDateTimeUtc desc）。
$skip 查询 假 整数 (int32) $skip指示根据指定的排序方法从服务器持有的记录列表中跳过的记录数。 默认情况下，我们将按降序开始时间进行排序。 客户端可以使用 $top 和 $skip 查询参数来指定要返回的结果数和集合中的偏移量。 当客户端同时返回 $top 和 $skip 时，服务器应先在集合上应用 $skip，然后再应用 $top。 如果服务器不能遵循 $top 和/或 $skip，则服务器必须向客户端返回错误以通知此情况，而不是简单地忽略查询选项。
$top 查询 假 整数 (int32) $top 指示用户希望在所有页面中返回的记录总数。 客户端可以使用 $top 和 $skip 查询参数来指定要返回的结果数和集合中的偏移量。 当客户端同时返回 $top 和 $skip 时，服务器应先在集合上应用 $skip，然后再应用 $top。 如果服务器不能遵循 $top 和/或 $skip，则服务器必须向客户端返回错误以通知此情况，而不是简单地忽略查询选项。
createdDateTimeUtcEnd 查询 假 字符串（日期时间） 之前获取项的结束日期时间。
createdDateTimeUtcStart 查询 假 字符串（日期时间） 要获取其后的项的开始日期时间。
ids 查询 假 数组 要在筛选中使用的 ID。
statuses 查询 假 数组 筛选中使用的状态。

请求标头

请求标头为：

Headers 说明 条件
Ocp-Apim-Subscription-Key Azure 门户中的翻译 API 密钥。 必需
Ocp-Apim-Subscription-Region 创建资源的区域。 使用区域（地理）资源（如“中国北部”）时为必需
内容类型 有效负载的内容类型。 接受的值为 application/json 或 charset=UTF-8。 必需

响应状态代码

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

状态代码 说明
200 OK. 成功请求并返回文档的状态。 HeadersRetry-After： integerETag： string
400 请求无效。 检查输入参数。
401 未授权。 检查凭据。
404 找不到资源。
500 内部服务器错误。
其他状态代码 • 请求过多
• 服务器暂时不可用

获取文档状态响应

成功获取文档状态响应

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

Name 类型 说明
@nextLink 字符串 下一页的 URL。 如果没有页，则为 NULL。
value DocumentStatus [] 各个文档的详细信息状态列表。
value.path 字符串 文档或文件夹的位置。
value.sourcePath 字符串 源文档的位置。
value.createdDateTimeUtc 字符串 操作创建日期时间。
value.lastActionDateTimeUtc 字符串 操作状态发生更新的日期时间。
value.status 状态 作业或文档的可能状态列表。
• 已取消
• 正在取消
• 失败
• NotStarted
• 正在运行
• 已成功
• ValidationFailed
value.to 字符串 目标语言。
value.progress 数字 翻译进度（如果可用）。
value.id 字符串 文档 ID。
value.characterCharged 整数 由 API 计费的字符。

错误响应

Name 类型 说明
代码 字符串 包含错误代码概要的枚举。 接受的值：
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
• 未授权
消息 字符串 获取概要错误消息。
目标 字符串 获取错误的源。 例如，对于单个文档，它为 documents 或 document id。
innerError InnerTranslationError 符合 Azure AI 服务 API 准则的新的内部错误格式。 此错误消息包含必需的属性 ErrorCode、消息和可选属性目标、详细信息（键值对）、内部错误（可以嵌套）。
innerError.code 字符串 获取代码错误字符串。
innerError.message 字符串 获取概要错误消息。
innerError.target 字符串 获取错误的源。 例如，如果存在无效文档，它为 documents 或 document id。

示例

Tip

使用此方法检索 documentId 查询字符串的 参数。

成功响应示例

以下 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://chinanorth2.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"
    }
  }
}

后续步骤

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

文档翻译入门

  • Last updated on