@azure-rest/ai-translation-document package

Interfaces

BatchRequest	Definição para o pedido de conversão do lote de entrada
CancelTranslation200Response	O pedido foi bem-sucedido.
CancelTranslationDefaultHeaders
CancelTranslationDefaultResponse
DocumentFilter	Filtro de documentos
DocumentStatusOutput	Resposta de status do documento
DocumentTranslate
DocumentTranslate200Headers
DocumentTranslate200Response	O pedido foi bem-sucedido.
DocumentTranslateBodyParam
DocumentTranslateContentDocumentPartDescriptor
DocumentTranslateContentGlossaryPartDescriptor
DocumentTranslateDefaultHeaders
DocumentTranslateDefaultResponse
DocumentTranslateHeaderParam
DocumentTranslateHeaders
DocumentTranslateMediaTypesParam
DocumentTranslateQueryParam
DocumentTranslateQueryParamProperties
DocumentTranslationClientOptions	Os parâmetros opcionais para o cliente
DocumentsStatusOutput	Resposta ao Estado dos Documentos
FileFormatOutput	Formato de arquivo
GetDocumentStatus
GetDocumentStatus200Response	O pedido foi bem-sucedido.
GetDocumentStatusDefaultHeaders
GetDocumentStatusDefaultResponse
GetDocumentsStatus
GetDocumentsStatus200Response	O pedido foi bem-sucedido.
GetDocumentsStatusDefaultHeaders
GetDocumentsStatusDefaultResponse
GetDocumentsStatusQueryParam
GetDocumentsStatusQueryParamProperties
GetSupportedFormats
GetSupportedFormats200Response	O pedido foi bem-sucedido.
GetSupportedFormatsDefaultHeaders
GetSupportedFormatsDefaultResponse
GetSupportedFormatsQueryParam
GetSupportedFormatsQueryParamProperties
GetTranslationStatus
GetTranslationStatus200Response	O pedido foi bem-sucedido.
GetTranslationStatusDefaultHeaders
GetTranslationStatusDefaultResponse
GetTranslationsStatus200Response	O pedido foi bem-sucedido.
GetTranslationsStatusDefaultHeaders
GetTranslationsStatusDefaultResponse
GetTranslationsStatusQueryParam
GetTranslationsStatusQueryParamProperties
Glossary	Glossário / memória de tradução para o pedido
InnerTranslationErrorOutput	Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Isso contém as propriedades necessárias ErrorCode, mensagem e destino de propriedades opcionais, detalhes (par de valores de chave), erro interno (isso pode ser aninhado).
PagingOptions	Opções para o auxiliar de paginação
Routes
SimplePollerLike	Um poller simples que pode ser usado para sondar uma operação de longa duração.
SourceInput	Fonte dos documentos de entrada
StartTranslation
StartTranslation202Headers
StartTranslation202Response	O pedido foi aceite para processamento, mas o processamento ainda não foi concluído.
StartTranslationBodyParam
StartTranslationDefaultHeaders
StartTranslationDefaultResponse
StartTranslationDetails	Solicitação de lote de envio de trabalho de tradução
StartTranslationLogicalResponse	A resposta final para a operação startTranslation de longa duração
StatusSummaryOutput	Resumo do status
SupportedFileFormatsOutput	Lista de formatos de ficheiro suportados
TargetInput	Destino dos documentos traduzidos concluídos
TranslationErrorOutput	Isso contém um erro externo com código de erro, mensagem, detalhes, destino e um erro interno com detalhes mais descritivos.
TranslationStatusOutput	Resposta ao status do trabalho de tradução
TranslationsStatusOutput	Resposta ao status do trabalho de tradução

Aliases de Tipo

CancelTranslationParameters
DocumentTranslateContent	Traduzir Documento Solicitar Conteúdo
DocumentTranslateParameters
DocumentTranslationClient
FileFormatType	Alias para FileFormatType
GetArrayType	Tipo auxiliar para extrair o tipo de uma matriz
GetDocumentStatusParameters
GetDocumentsStatusParameters
GetPage	O tipo de uma função personalizada que define como obter uma página e um link para a próxima, se houver.
GetSupportedFormatsParameters
GetTranslationStatusParameters
GetTranslationsStatusParameters
PaginateReturn	Tipo auxiliar para inferir o Tipo dos elementos paginados do tipo de resposta Esse tipo é gerado com base nas informações do swagger para x-ms-pageable, especificamente na propriedade itemName, que indica a propriedade da resposta onde os itens de página são encontrados. O valor padrão é value. Este tipo nos permitirá fornecer Iterator fortemente tipado com base na resposta que obtemos como segundo parâmetro
StartTranslationParameters
StatusOutput	Alias para StatusOutput
StorageInputType	Alias para StorageInputType
StorageSource	Alias para StorageSource
TranslationErrorCodeOutput	Alias para TranslationErrorCodeOutput

Funções

default(string, TokenCredential | KeyCredential, DocumentTranslationClientOptions)	Inicializar uma nova instância do DocumentTranslationClient
getLongRunningPoller<TResult>(Client, StartTranslationDefaultResponse | StartTranslation202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)	Função auxiliar que cria um objeto Poller para ajudar a sondar uma operação de longa duração.
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>)	O auxiliar para paginar resulta de uma resposta inicial que segue a especificação da extensão Autorest x-ms-pageable

Detalhes de Função

default(string, TokenCredential | KeyCredential, DocumentTranslationClientOptions)

Inicializar uma nova instância do DocumentTranslationClient

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

Parâmetros

endpointParam

string

Ponto de extremidade de tradução de documento suportado, protocolo e nome de host, por exemplo: https://{TranslatorResourceName}.cognitiveservices.azure.com/translator.

credentials

TokenCredential | KeyCredential

identificar exclusivamente a credencial do cliente

options

DocumentTranslationClientOptions

o parâmetro para todos os parâmetros opcionais

Devoluções

DocumentTranslationClient

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

Função auxiliar que cria um objeto Poller para ajudar a sondar uma operação de longa duração.

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

Parâmetros

client

Client

Cliente a utilizar para enviar o pedido para obter páginas adicionais.

initialResponse

StartTranslationDefaultResponse | StartTranslation202Response

A resposta inicial.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Opções para definir um estado de retomada ou intervalo de sondagem personalizado.

Devoluções

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

• Um poller se opõe a pesquisar atualizações de estado da operação e, eventualmente, obter a resposta final.

isUnexpected(DocumentTranslate200Response | DocumentTranslateDefaultResponse)

function isUnexpected(response: DocumentTranslate200Response | DocumentTranslateDefaultResponse): response

Parâmetros

response

DocumentTranslate200Response | DocumentTranslateDefaultResponse

Devoluções

response

isUnexpected(StartTranslationLogicalResponse | StartTranslationDefaultResponse | StartTranslation202Response)

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

Parâmetros

response

StartTranslationLogicalResponse | StartTranslationDefaultResponse | StartTranslation202Response

Devoluções

response

isUnexpected(GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse)

function isUnexpected(response: GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse): response

Parâmetros

response

GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse

Devoluções

response

isUnexpected(GetDocumentStatus200Response | GetDocumentStatusDefaultResponse)

function isUnexpected(response: GetDocumentStatus200Response | GetDocumentStatusDefaultResponse): response

Parâmetros

response

GetDocumentStatus200Response | GetDocumentStatusDefaultResponse

Devoluções

response

isUnexpected(GetTranslationStatus200Response | GetTranslationStatusDefaultResponse)

function isUnexpected(response: GetTranslationStatus200Response | GetTranslationStatusDefaultResponse): response

Parâmetros

response

GetTranslationStatus200Response | GetTranslationStatusDefaultResponse

Devoluções

response

isUnexpected(CancelTranslation200Response | CancelTranslationDefaultResponse)

function isUnexpected(response: CancelTranslation200Response | CancelTranslationDefaultResponse): response

Parâmetros

response

CancelTranslation200Response | CancelTranslationDefaultResponse

Devoluções

response

isUnexpected(GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse)

function isUnexpected(response: GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse): response

Parâmetros

response

GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse

Devoluções

response

isUnexpected(GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse)

function isUnexpected(response: GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse): response

Parâmetros

response

GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse

Devoluções

response

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

O auxiliar para paginar resulta de uma resposta inicial que segue a especificação da extensão Autorest x-ms-pageable

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

Parâmetros

client

Client

Cliente a utilizar para enviar os pedidos da página seguinte

initialResponse

TResponse

Resposta inicial contendo o nextLink e a página atual de elementos

options

PagingOptions<TResponse>

Devoluções

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator para iterar os elementos