@azure-rest/ai-translation-document package

Интерфейсы

BatchRequest	Определение запроса на входной пакетный перевод
CancelTranslation200Response	Запрос выполнен успешно.
CancelTranslationDefaultHeaders
CancelTranslationDefaultResponse
DocumentFilter	Фильтр документов
DocumentStatusOutput	Ответ состояния документа
DocumentTranslate
DocumentTranslate200Headers
DocumentTranslate200Response	Запрос выполнен успешно.
DocumentTranslateBodyParam
DocumentTranslateContentDocumentPartDescriptor
DocumentTranslateContentGlossaryPartDescriptor
DocumentTranslateDefaultHeaders
DocumentTranslateDefaultResponse
DocumentTranslateHeaderParam
DocumentTranslateHeaders
DocumentTranslateMediaTypesParam
DocumentTranslateQueryParam
DocumentTranslateQueryParamProperties
DocumentTranslationClientOptions	Необязательные параметры для клиента
DocumentsStatusOutput	Ответ состояния документов
FileFormatOutput	Формат файла
GetDocumentStatus
GetDocumentStatus200Response	Запрос выполнен успешно.
GetDocumentStatusDefaultHeaders
GetDocumentStatusDefaultResponse
GetDocumentsStatus
GetDocumentsStatus200Response	Запрос выполнен успешно.
GetDocumentsStatusDefaultHeaders
GetDocumentsStatusDefaultResponse
GetDocumentsStatusQueryParam
GetDocumentsStatusQueryParamProperties
GetSupportedFormats
GetSupportedFormats200Response	Запрос выполнен успешно.
GetSupportedFormatsDefaultHeaders
GetSupportedFormatsDefaultResponse
GetSupportedFormatsQueryParam
GetSupportedFormatsQueryParamProperties
GetTranslationStatus
GetTranslationStatus200Response	Запрос выполнен успешно.
GetTranslationStatusDefaultHeaders
GetTranslationStatusDefaultResponse
GetTranslationsStatus200Response	Запрос выполнен успешно.
GetTranslationsStatusDefaultHeaders
GetTranslationsStatusDefaultResponse
GetTranslationsStatusQueryParam
GetTranslationsStatusQueryParamProperties
Glossary	Глоссарий / память перевода для запроса
InnerTranslationErrorOutput	Новый формат внутренней ошибки, соответствующий рекомендациям ПО API Cognitive Services, который доступен в https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Это содержит обязательные свойства ErrorCode, сообщение и необязательные свойства, сведения (пара значений ключа), внутренняя ошибка (это может быть вложено).
PagingOptions	Параметры вспомогательного помощника по страницам
Routes
SimplePollerLike	Простой опросщик, который можно использовать для опроса длительной операции.
SourceInput	Источник входных документов
StartTranslation
StartTranslation202Headers
StartTranslation202Response	Запрос был принят для обработки, но обработка еще не завершена.
StartTranslationBodyParam
StartTranslationDefaultHeaders
StartTranslationDefaultResponse
StartTranslationDetails	Пакетный запрос на отправку задания перевода
StartTranslationLogicalResponse	Окончательный ответ для длительной операции startTranslation
StatusSummaryOutput	Сводка состояния
SupportedFileFormatsOutput	Список поддерживаемых форматов файлов
TargetInput	Назначение для готовых переведенных документов
TranslationErrorOutput	Это содержит внешнюю ошибку с кодом ошибки, сообщением, сведениями, целевой и внутренней ошибкой с более описательными сведениями.
TranslationStatusOutput	Ответ состояния задания перевода
TranslationsStatusOutput	Ответ на состояние задания перевода

Псевдонимы типа

CancelTranslationParameters
DocumentTranslateContent	Содержимое запроса перевода документов
DocumentTranslateParameters
DocumentTranslationClient
FileFormatType	Псевдоним для FileFormatType
GetArrayType	Вспомогательный тип для извлечения типа массива
GetDocumentStatusParameters
GetDocumentsStatusParameters
GetPage	Тип настраиваемой функции, которая определяет, как получить страницу и ссылку на следующую.
GetSupportedFormatsParameters
GetTranslationStatusParameters
GetTranslationsStatusParameters
PaginateReturn	Вспомогательный тип для вывода типа страничных элементов из типа ответа этот тип создается на основе сведений swagger для x-ms-pageable специально в свойстве itemName, которое указывает свойство ответа, в котором находятся элементы страницы. Значение по умолчанию — value. Этот тип позволяет предоставлять строго типизированный итератор на основе ответа, который мы получаем в качестве второго параметра.
StartTranslationParameters
StatusOutput	Псевдоним для StatusOutput
StorageInputType	Псевдоним для StorageInputType
StorageSource	Псевдоним для StorageSource
TranslationErrorCodeOutput	Псевдоним для translationErrorCodeOutput

Функции

default(string, TokenCredential | KeyCredential, DocumentTranslationClientOptions)	Инициализация нового экземпляра DocumentTranslationClient
getLongRunningPoller<TResult>(Client, StartTranslationDefaultResponse | StartTranslation202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)	Вспомогающая функция, которая создает объект Poller, чтобы помочь провести опрос длительной операции.
isUnexpected(DocumentTranslate200Response | DocumentTranslateDefaultResponse)
isUnexpected(StartTranslationLogicalResponse | StartTranslationDefaultResponse | StartTranslation202Response)
isUnexpected(GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse)
isUnexpected(GetDocumentStatus200Response | GetDocumentStatusDefaultResponse)
isUnexpected(GetTranslationStatus200Response | GetTranslationStatusDefaultResponse)
isUnexpected(CancelTranslation200Response | CancelTranslationDefaultResponse)
isUnexpected(GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse)
isUnexpected(GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Вспомогательный элемент для разбивки результатов из первоначального ответа, который соответствует спецификации расширения autorest x-ms-pageable

Сведения о функции

default(string, TokenCredential | KeyCredential, DocumentTranslationClientOptions)

Инициализация нового экземпляра DocumentTranslationClient

function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: DocumentTranslationClientOptions): DocumentTranslationClient

Параметры

endpointParam

string

Поддерживаемая конечная точка перевода документов, протокол и имя узла, например https://{TranslatorResourceName}.cognitiveservices.azure.com/translator.

credentials

TokenCredential | KeyCredential

уникально идентификация учетных данных клиента

options

DocumentTranslationClientOptions

параметр для всех необязательных параметров

Возвращаемое значение

DocumentTranslationClient

getLongRunningPoller<TResult>(Client, StartTranslationDefaultResponse | StartTranslation202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Вспомогающая функция, которая создает объект Poller, чтобы помочь провести опрос длительной операции.

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

Параметры

client

Client

Клиент, используемый для отправки запроса, чтобы получить дополнительные страницы.

initialResponse

StartTranslationDefaultResponse | StartTranslation202Response

Начальный ответ.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Параметры для задания состояния возобновления или настраиваемого интервала опроса.

Возвращаемое значение

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

• Объект опроса для проверки обновлений состояния операции и в конечном итоге получает окончательный ответ.

isUnexpected(DocumentTranslate200Response | DocumentTranslateDefaultResponse)

function isUnexpected(response: DocumentTranslate200Response | DocumentTranslateDefaultResponse): response

Параметры

response

DocumentTranslate200Response | DocumentTranslateDefaultResponse

Возвращаемое значение

response

isUnexpected(StartTranslationLogicalResponse | StartTranslationDefaultResponse | StartTranslation202Response)

function isUnexpected(response: StartTranslationLogicalResponse | StartTranslationDefaultResponse | StartTranslation202Response): response

Параметры

response

StartTranslationLogicalResponse | StartTranslationDefaultResponse | StartTranslation202Response

Возвращаемое значение

response

isUnexpected(GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse)

function isUnexpected(response: GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse): response

Параметры

response

GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse

Возвращаемое значение

response

isUnexpected(GetDocumentStatus200Response | GetDocumentStatusDefaultResponse)

function isUnexpected(response: GetDocumentStatus200Response | GetDocumentStatusDefaultResponse): response

Параметры

response

GetDocumentStatus200Response | GetDocumentStatusDefaultResponse

Возвращаемое значение

response

isUnexpected(GetTranslationStatus200Response | GetTranslationStatusDefaultResponse)

function isUnexpected(response: GetTranslationStatus200Response | GetTranslationStatusDefaultResponse): response

Параметры

response

GetTranslationStatus200Response | GetTranslationStatusDefaultResponse

Возвращаемое значение

response

isUnexpected(CancelTranslation200Response | CancelTranslationDefaultResponse)

function isUnexpected(response: CancelTranslation200Response | CancelTranslationDefaultResponse): response

Параметры

response

CancelTranslation200Response | CancelTranslationDefaultResponse

Возвращаемое значение

response

isUnexpected(GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse)

function isUnexpected(response: GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse): response

Параметры

response

GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse

Возвращаемое значение

response

isUnexpected(GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse)

function isUnexpected(response: GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse): response

Параметры

response

GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse

Возвращаемое значение

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<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator для итерации элементов