@azure-rest/ai-translation-document package

Interfaces

BatchRequest	Définition de la demande de traduction par lots d’entrée
CancelTranslation200Response	La demande a réussi.
CancelTranslationDefaultHeaders
CancelTranslationDefaultResponse
DocumentFilter	Filtre de document
DocumentStatusOutput	Réponse de l’état du document
DocumentTranslate
DocumentTranslate200Headers
DocumentTranslate200Response	La demande a réussi.
DocumentTranslateBodyParam
DocumentTranslateContentDocumentPartDescriptor
DocumentTranslateContentGlossaryPartDescriptor
DocumentTranslateDefaultHeaders
DocumentTranslateDefaultResponse
DocumentTranslateHeaderParam
DocumentTranslateHeaders
DocumentTranslateMediaTypesParam
DocumentTranslateQueryParam
DocumentTranslateQueryParamProperties
DocumentTranslationClientOptions	Paramètres facultatifs pour le client
DocumentsStatusOutput	Réponse d’état des documents
FileFormatOutput	Format de fichier
GetDocumentStatus
GetDocumentStatus200Response	La demande a réussi.
GetDocumentStatusDefaultHeaders
GetDocumentStatusDefaultResponse
GetDocumentsStatus
GetDocumentsStatus200Response	La demande a réussi.
GetDocumentsStatusDefaultHeaders
GetDocumentsStatusDefaultResponse
GetDocumentsStatusQueryParam
GetDocumentsStatusQueryParamProperties
GetSupportedFormats
GetSupportedFormats200Response	La demande a réussi.
GetSupportedFormatsDefaultHeaders
GetSupportedFormatsDefaultResponse
GetSupportedFormatsQueryParam
GetSupportedFormatsQueryParamProperties
GetTranslationStatus
GetTranslationStatus200Response	La demande a réussi.
GetTranslationStatusDefaultHeaders
GetTranslationStatusDefaultResponse
GetTranslationsStatus200Response	La demande a réussi.
GetTranslationsStatusDefaultHeaders
GetTranslationsStatusDefaultResponse
GetTranslationsStatusQueryParam
GetTranslationsStatusQueryParamProperties
Glossary	Glossaire / mémoire de traduction pour la requête
InnerTranslationErrorOutput	Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
PagingOptions	Options de l’assistance de pagination
Routes
SimplePollerLike	Un polleur simple qui peut être utilisé pour interroger une opération de longue durée.
SourceInput	Source des documents d’entrée
StartTranslation
StartTranslation202Headers
StartTranslation202Response	La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé.
StartTranslationBodyParam
StartTranslationDefaultHeaders
StartTranslationDefaultResponse
StartTranslationDetails	Requête par lot de soumission de travaux de traduction
StartTranslationLogicalResponse	Réponse finale pour l’opération startTranslation longue
StatusSummaryOutput	Résumé de l’état
SupportedFileFormatsOutput	Liste des formats de fichiers pris en charge
TargetInput	Destination des documents traduits terminés
TranslationErrorOutput	Cela contient une erreur externe avec le code d’erreur, le message, les détails, la cible et une erreur interne avec des détails plus descriptifs.
TranslationStatusOutput	Réponse de l’état du travail de traduction
TranslationsStatusOutput	Réponse de l’état du travail de traduction

Alias de type

CancelTranslationParameters
DocumentTranslateContent	Contenu de la demande de traduction de document
DocumentTranslateParameters
DocumentTranslationClient
FileFormatType	Alias pour FileFormatType
GetArrayType	Type d’assistance pour extraire le type d’un tableau
GetDocumentStatusParameters
GetDocumentsStatusParameters
GetPage	Type d’une fonction personnalisée qui définit comment obtenir une page et un lien vers le suivant, le cas échéant.
GetSupportedFormatsParameters
GetTranslationStatusParameters
GetTranslationsStatusParameters
PaginateReturn	Type d’assistance pour déduire le type des éléments paginés à partir du type de réponse Ce type est généré en fonction des informations swagger pour x-ms-pageable spécifiquement sur la propriété itemName qui indique la propriété de la réponse où les éléments de page sont trouvés. La valeur par défaut est value. Ce type nous permettra de fournir un itérateur fortement typé en fonction de la réponse que nous obtenons en tant que deuxième paramètre
StartTranslationParameters
StatusOutput	Alias pour StatusOutput
StorageInputType	Alias pour StorageInputType
StorageSource	Alias pour StorageSource
TranslationErrorCodeOutput	Alias pour TranslationErrorCodeOutput

Functions

default(string, TokenCredential | KeyCredential, DocumentTranslationClientOptions)	Initialiser une nouvelle instance de DocumentTranslationClient
getLongRunningPoller<TResult>(Client, StartTranslationDefaultResponse | StartTranslation202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)	Fonction d’assistance qui génère un objet Poller pour aider à interroger une opération longue.
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>)	Assistance pour paginer les résultats d’une réponse initiale qui suit la spécification de l’extension autorest x-ms-pageable

Informations relatives à la fonction

default(string, TokenCredential | KeyCredential, DocumentTranslationClientOptions)

Initialiser une nouvelle instance de DocumentTranslationClient

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

Paramètres

endpointParam

string

Point de terminaison de traduction de documents pris en charge, protocole et nom d’hôte, par exemple : https://{TranslatorResourceName}.cognitiveservices.azure.com/translator.

credentials

TokenCredential | KeyCredential

identifier de manière unique les informations d’identification du client

options

DocumentTranslationClientOptions

paramètre de tous les paramètres facultatifs

Retours

DocumentTranslationClient

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

Fonction d’assistance qui génère un objet Poller pour aider à interroger une opération longue.

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

Paramètres

client

Client

Client à utiliser pour envoyer la demande pour obtenir des pages supplémentaires.

initialResponse

StartTranslationDefaultResponse | StartTranslation202Response

Réponse initiale.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Options permettant de définir un état de reprise ou un intervalle d’interrogation personnalisé.

Retours

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

• Objet polleur permettant d’interroger les mises à jour de l’état de l’opération et d’obtenir la réponse finale.

isUnexpected(DocumentTranslate200Response | DocumentTranslateDefaultResponse)

function isUnexpected(response: DocumentTranslate200Response | DocumentTranslateDefaultResponse): response

Paramètres

response

DocumentTranslate200Response | DocumentTranslateDefaultResponse

Retours

response

isUnexpected(StartTranslationLogicalResponse | StartTranslationDefaultResponse | StartTranslation202Response)

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

Paramètres

response

StartTranslationLogicalResponse | StartTranslationDefaultResponse | StartTranslation202Response

Retours

response

isUnexpected(GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse)

function isUnexpected(response: GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse): response

Paramètres

response

GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse

Retours

response

isUnexpected(GetDocumentStatus200Response | GetDocumentStatusDefaultResponse)

function isUnexpected(response: GetDocumentStatus200Response | GetDocumentStatusDefaultResponse): response

Paramètres

response

GetDocumentStatus200Response | GetDocumentStatusDefaultResponse

Retours

response

isUnexpected(GetTranslationStatus200Response | GetTranslationStatusDefaultResponse)

function isUnexpected(response: GetTranslationStatus200Response | GetTranslationStatusDefaultResponse): response

Paramètres

response

GetTranslationStatus200Response | GetTranslationStatusDefaultResponse

Retours

response

isUnexpected(CancelTranslation200Response | CancelTranslationDefaultResponse)

function isUnexpected(response: CancelTranslation200Response | CancelTranslationDefaultResponse): response

Paramètres

response

CancelTranslation200Response | CancelTranslationDefaultResponse

Retours

response

isUnexpected(GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse)

function isUnexpected(response: GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse): response

Paramètres

response

GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse

Retours

response

isUnexpected(GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse)

function isUnexpected(response: GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse): response

Paramètres

response

GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse

Retours

response

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

Assistance pour paginer les résultats d’une réponse initiale qui suit la spécification de l’extension autorest x-ms-pageable

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

Paramètres

client

Client

Client à utiliser pour envoyer les demandes de page suivantes

initialResponse

TResponse

Réponse initiale contenant la page nextLink et active des éléments

options

PagingOptions<TResponse>

Retours

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator pour itérer les éléments