共用方式為


@azure-rest/ai-document-translator package

介面

BatchRequest

輸入批次轉譯要求的定義

DocumentFilter
DocumentStatusOutput

檔狀態回應

DocumentTranslationCancelTranslation200Response

取消目前處理或已排入佇列的翻譯。 取消目前處理或已排入佇列的翻譯。 如果翻譯已完成或失敗或取消,將不會取消翻譯。 將會傳回不正確的要求。 所有已完成翻譯的檔都不會取消,並需支付費用。 如果可能,所有擱置的文件都會取消。

DocumentTranslationCancelTranslation401Response

取消目前處理或已排入佇列的翻譯。 取消目前處理或已排入佇列的翻譯。 如果翻譯已完成或失敗或取消,將不會取消翻譯。 將會傳回不正確的要求。 所有已完成翻譯的檔都不會取消,並需支付費用。 如果可能,所有擱置的文件都會取消。

DocumentTranslationCancelTranslation404Response

取消目前處理或已排入佇列的翻譯。 取消目前處理或已排入佇列的翻譯。 如果翻譯已完成或失敗或取消,將不會取消翻譯。 將會傳回不正確的要求。 所有已完成翻譯的檔都不會取消,並需支付費用。 如果可能,所有擱置的文件都會取消。

DocumentTranslationCancelTranslation429Response

取消目前處理或已排入佇列的翻譯。 取消目前處理或已排入佇列的翻譯。 如果翻譯已完成或失敗或取消,將不會取消翻譯。 將會傳回不正確的要求。 所有已完成翻譯的檔都不會取消,並需支付費用。 如果可能,所有擱置的文件都會取消。

DocumentTranslationCancelTranslation500Response

取消目前處理或已排入佇列的翻譯。 取消目前處理或已排入佇列的翻譯。 如果翻譯已完成或失敗或取消,將不會取消翻譯。 將會傳回不正確的要求。 所有已完成翻譯的檔都不會取消,並需支付費用。 如果可能,所有擱置的文件都會取消。

DocumentTranslationCancelTranslation503Response

取消目前處理或已排入佇列的翻譯。 取消目前處理或已排入佇列的翻譯。 如果翻譯已完成或失敗或取消,將不會取消翻譯。 將會傳回不正確的要求。 所有已完成翻譯的檔都不會取消,並需支付費用。 如果可能,所有擱置的文件都會取消。

DocumentTranslationGetDocumentStatus200Headers
DocumentTranslationGetDocumentStatus200Response

根據要求標識碼和文件標識碼,傳回特定文件的翻譯狀態。

DocumentTranslationGetDocumentStatus401Response

根據要求標識碼和文件標識碼,傳回特定文件的翻譯狀態。

DocumentTranslationGetDocumentStatus404Response

根據要求標識碼和文件標識碼,傳回特定文件的翻譯狀態。

DocumentTranslationGetDocumentStatus429Response

根據要求標識碼和文件標識碼,傳回特定文件的翻譯狀態。

DocumentTranslationGetDocumentStatus500Response

根據要求標識碼和文件標識碼,傳回特定文件的翻譯狀態。

DocumentTranslationGetDocumentStatus503Response

根據要求標識碼和文件標識碼,傳回特定文件的翻譯狀態。

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、訊息和選擇性屬性目標、details(索引鍵值組)、內部錯誤(這可以是巢狀的)。

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

協助程式類型,從回應類型推斷分頁元素的類型 這個類型是根據 x-ms-pageable 的 Swagger 資訊,特別是 itemName 屬性上的 swagger 資訊,指出找到頁面專案之回應的屬性。 預設值是 value。 此類型可讓我們根據我們取得作為第二個參數的回應,提供強型別反覆運算器

函式

default(string, KeyCredential, DocumentTranslatorClientOptions)

初始化 DocumentTranslatorClient 的新實例

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

建置 Poller 物件的 Helper 函式,以協助輪詢長時間執行的作業。

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 物件的 Helper 函式,以協助輪詢長時間執行的作業。

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

包含專案下一頁和目前頁面的初始回應

options

PagingOptions<TResponse>

傳回

  • PagedAsyncIterableIterator 來反覆運算元素