你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure-rest/ai-document-translator package

接口

BatchRequest

输入批处理翻译请求的定义

DocumentFilter
DocumentStatusOutput

文档状态响应

DocumentTranslationCancelTranslation200Response

取消当前处理或排队的翻译。 取消当前处理或排队的翻译。 如果翻译已完成或失败或取消,则不会取消翻译。 将返回错误的请求。 完成翻译的所有文档都不会取消,并且将收费。 如果可能,所有挂起的文档都将被取消。

DocumentTranslationCancelTranslation401Response

取消当前处理或排队的翻译。 取消当前处理或排队的翻译。 如果翻译已完成或失败或取消,则不会取消翻译。 将返回错误的请求。 完成翻译的所有文档都不会取消,并且将收费。 如果可能,所有挂起的文档都将被取消。

DocumentTranslationCancelTranslation404Response

取消当前处理或排队的翻译。 取消当前处理或排队的翻译。 如果翻译已完成或失败或取消,则不会取消翻译。 将返回错误的请求。 完成翻译的所有文档都不会取消,并且将收费。 如果可能,所有挂起的文档都将被取消。

DocumentTranslationCancelTranslation429Response

取消当前处理或排队的翻译。 取消当前处理或排队的翻译。 如果翻译已完成或失败或取消,则不会取消翻译。 将返回错误的请求。 完成翻译的所有文档都不会取消,并且将收费。 如果可能,所有挂起的文档都将被取消。

DocumentTranslationCancelTranslation500Response

取消当前处理或排队的翻译。 取消当前处理或排队的翻译。 如果翻译已完成或失败或取消,则不会取消翻译。 将返回错误的请求。 完成翻译的所有文档都不会取消,并且将收费。 如果可能,所有挂起的文档都将被取消。

DocumentTranslationCancelTranslation503Response

取消当前处理或排队的翻译。 取消当前处理或排队的翻译。 如果翻译已完成或失败或取消,则不会取消翻译。 将返回错误的请求。 完成翻译的所有文档都不会取消,并且将收费。 如果可能,所有挂起的文档都将被取消。

DocumentTranslationGetDocumentStatus200Headers
DocumentTranslationGetDocumentStatus200Response

根据请求 ID 和文档 ID 返回特定文档的翻译状态。

DocumentTranslationGetDocumentStatus401Response

根据请求 ID 和文档 ID 返回特定文档的翻译状态。

DocumentTranslationGetDocumentStatus404Response

根据请求 ID 和文档 ID 返回特定文档的翻译状态。

DocumentTranslationGetDocumentStatus429Response

根据请求 ID 和文档 ID 返回特定文档的翻译状态。

DocumentTranslationGetDocumentStatus500Response

根据请求 ID 和文档 ID 返回特定文档的翻译状态。

DocumentTranslationGetDocumentStatus503Response

根据请求 ID 和文档 ID 返回特定文档的翻译状态。

DocumentTranslationGetDocumentsStatus200Headers
DocumentTranslationGetDocumentsStatus200Response

返回批处理文档翻译请求中所有文档的状态。

如果响应中的文档数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从服务器持有的文档状态列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的文档。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetDocumentsStatus400Response

返回批处理文档翻译请求中所有文档的状态。

如果响应中的文档数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从服务器持有的文档状态列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的文档。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetDocumentsStatus401Response

返回批处理文档翻译请求中所有文档的状态。

如果响应中的文档数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从服务器持有的文档状态列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的文档。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetDocumentsStatus404Response

返回批处理文档翻译请求中所有文档的状态。

如果响应中的文档数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从服务器持有的文档状态列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的文档。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetDocumentsStatus429Response

返回批处理文档翻译请求中所有文档的状态。

如果响应中的文档数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从服务器持有的文档状态列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的文档。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetDocumentsStatus500Response

返回批处理文档翻译请求中所有文档的状态。

如果响应中的文档数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从服务器持有的文档状态列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的文档。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetDocumentsStatus503Response

返回批处理文档翻译请求中所有文档的状态。

如果响应中的文档数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从服务器持有的文档状态列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的文档。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetDocumentsStatusQueryParam
DocumentTranslationGetDocumentsStatusQueryParamProperties
DocumentTranslationGetSupportedDocumentFormats200Headers
DocumentTranslationGetSupportedDocumentFormats200Response

文档翻译服务支持的文档格式列表。 该列表包括通用文件扩展名,以及内容类型(如果使用上传 API)。

DocumentTranslationGetSupportedDocumentFormats429Response

文档翻译服务支持的文档格式列表。 该列表包括通用文件扩展名,以及内容类型(如果使用上传 API)。

DocumentTranslationGetSupportedDocumentFormats500Response

文档翻译服务支持的文档格式列表。 该列表包括通用文件扩展名,以及内容类型(如果使用上传 API)。

DocumentTranslationGetSupportedDocumentFormats503Response

文档翻译服务支持的文档格式列表。 该列表包括通用文件扩展名,以及内容类型(如果使用上传 API)。

DocumentTranslationGetSupportedGlossaryFormats200Headers
DocumentTranslationGetSupportedGlossaryFormats200Response

文档翻译服务支持的术语表格式列表。 该列表包含使用的通用文件扩展名。

DocumentTranslationGetSupportedGlossaryFormats429Response

文档翻译服务支持的术语表格式列表。 该列表包含使用的通用文件扩展名。

DocumentTranslationGetSupportedGlossaryFormats500Response

文档翻译服务支持的术语表格式列表。 该列表包含使用的通用文件扩展名。

DocumentTranslationGetSupportedGlossaryFormats503Response

文档翻译服务支持的术语表格式列表。 该列表包含使用的通用文件扩展名。

DocumentTranslationGetSupportedStorageSources200Headers
DocumentTranslationGetSupportedStorageSources200Response

返回文档翻译服务支持的存储源/选项列表。

DocumentTranslationGetSupportedStorageSources429Response

返回文档翻译服务支持的存储源/选项列表。

DocumentTranslationGetSupportedStorageSources500Response

返回文档翻译服务支持的存储源/选项列表。

DocumentTranslationGetSupportedStorageSources503Response

返回文档翻译服务支持的存储源/选项列表。

DocumentTranslationGetTranslationStatus200Headers
DocumentTranslationGetTranslationStatus200Response

返回文档翻译请求的状态。 状态包括总体请求状态,以及作为该请求的一部分翻译的文档的状态。

DocumentTranslationGetTranslationStatus401Response

返回文档翻译请求的状态。 状态包括总体请求状态,以及作为该请求的一部分翻译的文档的状态。

DocumentTranslationGetTranslationStatus404Response

返回文档翻译请求的状态。 状态包括总体请求状态,以及作为该请求的一部分翻译的文档的状态。

DocumentTranslationGetTranslationStatus429Response

返回文档翻译请求的状态。 状态包括总体请求状态,以及作为该请求的一部分翻译的文档的状态。

DocumentTranslationGetTranslationStatus500Response

返回文档翻译请求的状态。 状态包括总体请求状态,以及作为该请求的一部分翻译的文档的状态。

DocumentTranslationGetTranslationStatus503Response

返回文档翻译请求的状态。 状态包括总体请求状态,以及作为该请求的一部分翻译的文档的状态。

DocumentTranslationGetTranslationsStatus200Headers
DocumentTranslationGetTranslationsStatus200Response

返回提交的批处理请求列表以及每个请求的状态。 此列表仅包含用户提交的批处理请求(基于资源)。

如果请求数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从批列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的作。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

服务器遵循客户端指定的值。 但是,客户端必须准备好处理包含不同页面大小的响应或包含延续标记的响应。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetTranslationsStatus400Response

返回提交的批处理请求列表以及每个请求的状态。 此列表仅包含用户提交的批处理请求(基于资源)。

如果请求数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从批列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的作。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

服务器遵循客户端指定的值。 但是,客户端必须准备好处理包含不同页面大小的响应或包含延续标记的响应。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetTranslationsStatus401Response

返回提交的批处理请求列表以及每个请求的状态。 此列表仅包含用户提交的批处理请求(基于资源)。

如果请求数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从批列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的作。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

服务器遵循客户端指定的值。 但是,客户端必须准备好处理包含不同页面大小的响应或包含延续标记的响应。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetTranslationsStatus429Response

返回提交的批处理请求列表以及每个请求的状态。 此列表仅包含用户提交的批处理请求(基于资源)。

如果请求数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从批列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的作。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

服务器遵循客户端指定的值。 但是,客户端必须准备好处理包含不同页面大小的响应或包含延续标记的响应。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetTranslationsStatus500Response

返回提交的批处理请求列表以及每个请求的状态。 此列表仅包含用户提交的批处理请求(基于资源)。

如果请求数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从批列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的作。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

服务器遵循客户端指定的值。 但是,客户端必须准备好处理包含不同页面大小的响应或包含延续标记的响应。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetTranslationsStatus503Response

返回提交的批处理请求列表以及每个请求的状态。 此列表仅包含用户提交的批处理请求(基于资源)。

如果请求数超过分页限制,则使用服务器端分页。 分页响应指示部分结果,并在响应中包含延续标记。 缺少延续标记意味着没有其他页面可用。

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

$top指示用户希望在所有页面中返回的记录总数。 $skip指示根据指定的排序方法从批列表中跳过的记录数。 默认情况下,我们将按降序开始时间进行排序。 $maxpagesize是页面中返回的最大项。 如果通过$top请求更多项目(或未指定$top,并且返回的项目更多),“@nextLink”将包含指向下一页的链接。

$orderBy查询参数可用于对返回的列表进行排序(例如“$orderBy=createdDateTimeUtc asc”或“$orderBy=createdDateTimeUtc desc”)。 默认排序由 createdDateTimeUtc 降序。 某些查询参数可用于筛选返回的列表(例如:“status=Succeeded,Cancelled”)将仅返回成功和取消的作。 createdDateTimeUtcStart 和 createdDateTimeUtcEnd 可以组合使用,也可以单独指定一系列日期/时间来筛选返回的列表。 支持的筛选查询参数为(status、ids、createdDateTimeUtcStart、createdDateTimeUtcEnd)。

服务器遵循客户端指定的值。 但是,客户端必须准备好处理包含不同页面大小的响应或包含延续标记的响应。

当同时包含$top和$skip时,服务器应首先应用$skip,然后在集合上$top。 注意:如果服务器不能遵循$top和/或$skip,则服务器必须向客户端返回错误,告知它,而不只是忽略查询选项。 这可降低客户端对返回的数据做出假设的风险。

DocumentTranslationGetTranslationsStatusQueryParam
DocumentTranslationGetTranslationsStatusQueryParamProperties
DocumentTranslationStartTranslation202Headers
DocumentTranslationStartTranslation202Response

使用此 API 向文档翻译服务提交批量(批处理)翻译请求。 每个请求可以包含多个文档,并且必须包含每个文档的源和目标容器。

前缀和后缀筛选器(如果已提供)用于筛选文件夹。 前缀在容器名称之后应用于子路径。

术语表/翻译内存可以包含在请求中,并在翻译文档时由服务应用。

如果在翻译期间术语表无效或无法访问,则文档状态中指示错误。 如果目标中已存在同名的文件,则会覆盖该文件。 每个目标语言的 targetUrl 必须是唯一的。

DocumentTranslationStartTranslation400Response

使用此 API 向文档翻译服务提交批量(批处理)翻译请求。 每个请求可以包含多个文档,并且必须包含每个文档的源和目标容器。

前缀和后缀筛选器(如果已提供)用于筛选文件夹。 前缀在容器名称之后应用于子路径。

术语表/翻译内存可以包含在请求中,并在翻译文档时由服务应用。

如果在翻译期间术语表无效或无法访问,则文档状态中指示错误。 如果目标中已存在同名的文件,则会覆盖该文件。 每个目标语言的 targetUrl 必须是唯一的。

DocumentTranslationStartTranslation401Response

使用此 API 向文档翻译服务提交批量(批处理)翻译请求。 每个请求可以包含多个文档,并且必须包含每个文档的源和目标容器。

前缀和后缀筛选器(如果已提供)用于筛选文件夹。 前缀在容器名称之后应用于子路径。

术语表/翻译内存可以包含在请求中,并在翻译文档时由服务应用。

如果在翻译期间术语表无效或无法访问,则文档状态中指示错误。 如果目标中已存在同名的文件,则会覆盖该文件。 每个目标语言的 targetUrl 必须是唯一的。

DocumentTranslationStartTranslation429Response

使用此 API 向文档翻译服务提交批量(批处理)翻译请求。 每个请求可以包含多个文档,并且必须包含每个文档的源和目标容器。

前缀和后缀筛选器(如果已提供)用于筛选文件夹。 前缀在容器名称之后应用于子路径。

术语表/翻译内存可以包含在请求中,并在翻译文档时由服务应用。

如果在翻译期间术语表无效或无法访问,则文档状态中指示错误。 如果目标中已存在同名的文件,则会覆盖该文件。 每个目标语言的 targetUrl 必须是唯一的。

DocumentTranslationStartTranslation500Response

使用此 API 向文档翻译服务提交批量(批处理)翻译请求。 每个请求可以包含多个文档,并且必须包含每个文档的源和目标容器。

前缀和后缀筛选器(如果已提供)用于筛选文件夹。 前缀在容器名称之后应用于子路径。

术语表/翻译内存可以包含在请求中,并在翻译文档时由服务应用。

如果在翻译期间术语表无效或无法访问,则文档状态中指示错误。 如果目标中已存在同名的文件,则会覆盖该文件。 每个目标语言的 targetUrl 必须是唯一的。

DocumentTranslationStartTranslation503Response

使用此 API 向文档翻译服务提交批量(批处理)翻译请求。 每个请求可以包含多个文档,并且必须包含每个文档的源和目标容器。

前缀和后缀筛选器(如果已提供)用于筛选文件夹。 前缀在容器名称之后应用于子路径。

术语表/翻译内存可以包含在请求中,并在翻译文档时由服务应用。

如果在翻译期间术语表无效或无法访问,则文档状态中指示错误。 如果目标中已存在同名的文件,则会覆盖该文件。 每个目标语言的 targetUrl 必须是唯一的。

DocumentTranslationStartTranslationBodyParam
DocumentTranslationStartTranslationMediaTypesParam
DocumentTranslatorClientOptions

客户端的可选参数

DocumentsStatusOutput

文档状态响应

FileFormatOutput
GetDocumentStatus
GetDocumentsStatus
GetSupportedDocumentFormats
GetSupportedGlossaryFormats
GetSupportedStorageSources
GetTranslationStatus
Glossary

请求的术语表/翻译内存

InnerTranslationErrorOutput

符合认知服务 API 准则的新内部错误格式,可在 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow获取。 这包括必需的属性 ErrorCode、消息和可选属性目标、详细信息(键值对)、内部错误(可嵌套)。

PageSettings

跟踪分页迭代设置的接口

PagedAsyncIterableIterator

允许异步迭代到完成和逐页迭代的接口。

PagingOptions

分页帮助程序的选项

Routes
SimplePollerLike

可用于轮询长时间运行的操作的简单轮询程序。

SourceInput

输入文档的源

StartTranslation
StartTranslationDetails

翻译作业提交批处理请求

StatusSummaryOutput
SupportedFileFormatsOutput

Api 中列表返回的基类型

SupportedStorageSourcesOutput

Api 中列表返回的基类型

TargetInput

已完成翻译的文档的目标

TranslationErrorOutput

这包含一个外部错误,其中包含错误代码、消息、详细信息、目标和内部错误,其中包含更具描述性的详细信息。

TranslationErrorResponseOutput

包含用于跨任何认知服务的 HTTP 响应的统一错误信息。 可以通过 Microsoft.CloudAI.Containers.HttpStatusExceptionV2 或通过直接从控制器返回实例来创建实例。

TranslationStatusOutput

转换作业状态响应

TranslationsStatusOutput

转换作业状态响应

类型别名

DocumentTranslationCancelTranslationParameters
DocumentTranslationGetDocumentStatusParameters
DocumentTranslationGetDocumentsStatusParameters
DocumentTranslationGetSupportedDocumentFormatsParameters
DocumentTranslationGetSupportedGlossaryFormatsParameters
DocumentTranslationGetSupportedStorageSourcesParameters
DocumentTranslationGetTranslationStatusParameters
DocumentTranslationGetTranslationsStatusParameters
DocumentTranslationStartTranslationParameters
DocumentTranslatorClient
GetArrayType

用于提取数组类型的帮助程序类型

GetPage

自定义函数的类型,用于定义如何获取页面和指向下一个页面的链接(如果有)。

PaginateReturn

用于推断响应类型中分页元素的帮助程序类型。此类型基于特定于 itemName 属性的 x-ms-pageable 的 swagger 信息生成,该属性指示在其中找到页面项的响应的属性。 默认值是 value。 此类型将允许我们根据作为第二个参数获取的响应提供强类型迭代器

函数

default(string, KeyCredential, DocumentTranslatorClientOptions)

初始化 DocumentTranslatorClient 的新实例

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

生成 Poller 对象的帮助程序函数,以帮助轮询长时间运行的操作。

isUnexpected(DocumentTranslationStartTranslation202Response | DocumentTranslationStartTranslation400Response | DocumentTranslationStartTranslation401Response | DocumentTranslationStartTranslation429Response | DocumentTranslationStartTranslation500Response | DocumentTranslationStartTranslation503Response)
isUnexpected(DocumentTranslationGetTranslationsStatus200Response | DocumentTranslationGetTranslationsStatus400Response | DocumentTranslationGetTranslationsStatus401Response | DocumentTranslationGetTranslationsStatus429Response | DocumentTranslationGetTranslationsStatus500Response | DocumentTranslationGetTranslationsStatus503Response)
isUnexpected(DocumentTranslationGetDocumentStatus200Response | DocumentTranslationGetDocumentStatus401Response | DocumentTranslationGetDocumentStatus404Response | DocumentTranslationGetDocumentStatus429Response | DocumentTranslationGetDocumentStatus500Response | DocumentTranslationGetDocumentStatus503Response)
isUnexpected(DocumentTranslationGetTranslationStatus200Response | DocumentTranslationGetTranslationStatus401Response | DocumentTranslationGetTranslationStatus404Response | DocumentTranslationGetTranslationStatus429Response | DocumentTranslationGetTranslationStatus500Response | DocumentTranslationGetTranslationStatus503Response)
isUnexpected(DocumentTranslationCancelTranslation200Response | DocumentTranslationCancelTranslation401Response | DocumentTranslationCancelTranslation404Response | DocumentTranslationCancelTranslation429Response | DocumentTranslationCancelTranslation500Response | DocumentTranslationCancelTranslation503Response)
isUnexpected(DocumentTranslationGetDocumentsStatus200Response | DocumentTranslationGetDocumentsStatus400Response | DocumentTranslationGetDocumentsStatus401Response | DocumentTranslationGetDocumentsStatus404Response | DocumentTranslationGetDocumentsStatus429Response | DocumentTranslationGetDocumentsStatus500Response | DocumentTranslationGetDocumentsStatus503Response)
isUnexpected(DocumentTranslationGetSupportedDocumentFormats200Response | DocumentTranslationGetSupportedDocumentFormats429Response | DocumentTranslationGetSupportedDocumentFormats500Response | DocumentTranslationGetSupportedDocumentFormats503Response)
isUnexpected(DocumentTranslationGetSupportedGlossaryFormats200Response | DocumentTranslationGetSupportedGlossaryFormats429Response | DocumentTranslationGetSupportedGlossaryFormats500Response | DocumentTranslationGetSupportedGlossaryFormats503Response)
isUnexpected(DocumentTranslationGetSupportedStorageSources200Response | DocumentTranslationGetSupportedStorageSources429Response | DocumentTranslationGetSupportedStorageSources500Response | DocumentTranslationGetSupportedStorageSources503Response)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

帮助程序根据 Autorest x-ms-pageable 扩展规范对初始响应的结果进行分页

函数详细信息

default(string, KeyCredential, DocumentTranslatorClientOptions)

初始化 DocumentTranslatorClient 的新实例

function default(endpoint: string, credentials: KeyCredential, options?: DocumentTranslatorClientOptions): DocumentTranslatorClient

参数

endpoint

string

支持的认知服务终结点(协议和主机名,例如:https://westus.api.cognitive.microsoft.com)。

credentials
KeyCredential

唯一标识客户端凭据

options
DocumentTranslatorClientOptions

所有可选参数的参数

返回

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

生成 Poller 对象的帮助程序函数,以帮助轮询长时间运行的操作。

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

参数

client
Client

用于发送请求以获取其他页面的客户端。

initialResponse

TResult

初始响应。

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

设置恢复状态或自定义轮询间隔的选项。

返回

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • 用于轮询操作状态更新的轮询程序对象,并最终获取最终响应。

isUnexpected(DocumentTranslationStartTranslation202Response | DocumentTranslationStartTranslation400Response | DocumentTranslationStartTranslation401Response | DocumentTranslationStartTranslation429Response | DocumentTranslationStartTranslation500Response | DocumentTranslationStartTranslation503Response)

function isUnexpected(response: DocumentTranslationStartTranslation202Response | DocumentTranslationStartTranslation400Response | DocumentTranslationStartTranslation401Response | DocumentTranslationStartTranslation429Response | DocumentTranslationStartTranslation500Response | DocumentTranslationStartTranslation503Response): response

参数

返回

response

isUnexpected(DocumentTranslationGetTranslationsStatus200Response | DocumentTranslationGetTranslationsStatus400Response | DocumentTranslationGetTranslationsStatus401Response | DocumentTranslationGetTranslationsStatus429Response | DocumentTranslationGetTranslationsStatus500Response | DocumentTranslationGetTranslationsStatus503Response)

function isUnexpected(response: DocumentTranslationGetTranslationsStatus200Response | DocumentTranslationGetTranslationsStatus400Response | DocumentTranslationGetTranslationsStatus401Response | DocumentTranslationGetTranslationsStatus429Response | DocumentTranslationGetTranslationsStatus500Response | DocumentTranslationGetTranslationsStatus503Response): response

参数

返回

response

isUnexpected(DocumentTranslationGetDocumentStatus200Response | DocumentTranslationGetDocumentStatus401Response | DocumentTranslationGetDocumentStatus404Response | DocumentTranslationGetDocumentStatus429Response | DocumentTranslationGetDocumentStatus500Response | DocumentTranslationGetDocumentStatus503Response)

function isUnexpected(response: DocumentTranslationGetDocumentStatus200Response | DocumentTranslationGetDocumentStatus401Response | DocumentTranslationGetDocumentStatus404Response | DocumentTranslationGetDocumentStatus429Response | DocumentTranslationGetDocumentStatus500Response | DocumentTranslationGetDocumentStatus503Response): response

参数

返回

response

isUnexpected(DocumentTranslationGetTranslationStatus200Response | DocumentTranslationGetTranslationStatus401Response | DocumentTranslationGetTranslationStatus404Response | DocumentTranslationGetTranslationStatus429Response | DocumentTranslationGetTranslationStatus500Response | DocumentTranslationGetTranslationStatus503Response)

function isUnexpected(response: DocumentTranslationGetTranslationStatus200Response | DocumentTranslationGetTranslationStatus401Response | DocumentTranslationGetTranslationStatus404Response | DocumentTranslationGetTranslationStatus429Response | DocumentTranslationGetTranslationStatus500Response | DocumentTranslationGetTranslationStatus503Response): response

参数

返回

response

isUnexpected(DocumentTranslationCancelTranslation200Response | DocumentTranslationCancelTranslation401Response | DocumentTranslationCancelTranslation404Response | DocumentTranslationCancelTranslation429Response | DocumentTranslationCancelTranslation500Response | DocumentTranslationCancelTranslation503Response)

function isUnexpected(response: DocumentTranslationCancelTranslation200Response | DocumentTranslationCancelTranslation401Response | DocumentTranslationCancelTranslation404Response | DocumentTranslationCancelTranslation429Response | DocumentTranslationCancelTranslation500Response | DocumentTranslationCancelTranslation503Response): response

参数

返回

response

isUnexpected(DocumentTranslationGetDocumentsStatus200Response | DocumentTranslationGetDocumentsStatus400Response | DocumentTranslationGetDocumentsStatus401Response | DocumentTranslationGetDocumentsStatus404Response | DocumentTranslationGetDocumentsStatus429Response | DocumentTranslationGetDocumentsStatus500Response | DocumentTranslationGetDocumentsStatus503Response)

function isUnexpected(response: DocumentTranslationGetDocumentsStatus200Response | DocumentTranslationGetDocumentsStatus400Response | DocumentTranslationGetDocumentsStatus401Response | DocumentTranslationGetDocumentsStatus404Response | DocumentTranslationGetDocumentsStatus429Response | DocumentTranslationGetDocumentsStatus500Response | DocumentTranslationGetDocumentsStatus503Response): response

参数

返回

response

isUnexpected(DocumentTranslationGetSupportedDocumentFormats200Response | DocumentTranslationGetSupportedDocumentFormats429Response | DocumentTranslationGetSupportedDocumentFormats500Response | DocumentTranslationGetSupportedDocumentFormats503Response)

function isUnexpected(response: DocumentTranslationGetSupportedDocumentFormats200Response | DocumentTranslationGetSupportedDocumentFormats429Response | DocumentTranslationGetSupportedDocumentFormats500Response | DocumentTranslationGetSupportedDocumentFormats503Response): response

参数

返回

response

isUnexpected(DocumentTranslationGetSupportedGlossaryFormats200Response | DocumentTranslationGetSupportedGlossaryFormats429Response | DocumentTranslationGetSupportedGlossaryFormats500Response | DocumentTranslationGetSupportedGlossaryFormats503Response)

function isUnexpected(response: DocumentTranslationGetSupportedGlossaryFormats200Response | DocumentTranslationGetSupportedGlossaryFormats429Response | DocumentTranslationGetSupportedGlossaryFormats500Response | DocumentTranslationGetSupportedGlossaryFormats503Response): response

参数

返回

response

isUnexpected(DocumentTranslationGetSupportedStorageSources200Response | DocumentTranslationGetSupportedStorageSources429Response | DocumentTranslationGetSupportedStorageSources500Response | DocumentTranslationGetSupportedStorageSources503Response)

function isUnexpected(response: DocumentTranslationGetSupportedStorageSources200Response | DocumentTranslationGetSupportedStorageSources429Response | DocumentTranslationGetSupportedStorageSources500Response | DocumentTranslationGetSupportedStorageSources503Response): response

参数

返回

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

帮助程序根据 Autorest x-ms-pageable 扩展规范对初始响应的结果进行分页

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

参数

client
Client

用于发送下一页请求的客户端

initialResponse

TResponse

包含 nextLink 和元素当前页的初始响应

options

PagingOptions<TResponse>

返回

  • PagedAsyncIterableIterator 循环访问元素