@azure-rest/ai-translation-text package
Interfaces
| DetectedLanguageOutput |
An object describing the detected language. |
| ErrorDetailsOutput |
Error details as returned by Translator Service. |
| ErrorResponseOutput |
Representation of the Error Response from Translator Service. |
| GetSupportedLanguages | |
| GetSupportedLanguages200Headers | |
| GetSupportedLanguages200Response |
The request has succeeded. |
| GetSupportedLanguagesDefaultHeaders | |
| GetSupportedLanguagesDefaultResponse | |
| GetSupportedLanguagesHeaderParam | |
| GetSupportedLanguagesHeaders | |
| GetSupportedLanguagesQueryParam | |
| GetSupportedLanguagesQueryParamProperties | |
| GetSupportedLanguagesResultOutput |
Response for the languages API. |
| InputTextItem |
Element containing the text for translation. |
| LanguageScriptOutput |
Common properties of language script |
| ReferenceTextPair |
Reference text pair to generate adaptive customized translation. |
| Routes | |
| Translate | |
| Translate200Headers | |
| Translate200Response |
The request has succeeded. |
| TranslateBody |
Request data for translate. |
| TranslateBodyParam | |
| TranslateDefaultHeaders | |
| TranslateDefaultResponse | |
| TranslateHeaderParam | |
| TranslateHeaders | |
| TranslateInputItem |
Element containing the text for translation. |
| TranslatedTextItemOutput |
Element containing the translated text |
| TranslationLanguageOutput |
The value of the translation property is a dictionary of (key, value) pairs. Each key is a BCP 47 language tag. A key identifies a language for which text can be translated to or translated from. |
| TranslationResultOutput |
Response for the translation API. |
| TranslationTarget |
Target language and translation configuration parameters. |
| TranslationTextOutput |
Translation result |
| TranslatorCredential | |
| TranslatorTokenCredential | |
| TransliterableScriptOutput |
Script definition with list of script into which given script can be translitered. |
| Transliterate | |
| Transliterate200Headers | |
| Transliterate200Response |
The request has succeeded. |
| TransliterateBody |
Request data for transliterate. |
| TransliterateBodyParam | |
| TransliterateDefaultHeaders | |
| TransliterateDefaultResponse | |
| TransliterateHeaderParam | |
| TransliterateHeaders | |
| TransliterateQueryParam | |
| TransliterateQueryParamProperties | |
| TransliterateResultOutput |
Response for the transliteration API. |
| TransliteratedTextOutput |
Transliterated text element. |
| TransliterationLanguageOutput |
The value of the transliteration property is a dictionary of (key, value) pairs. Each key is a BCP 47 language tag. A key identifies a language for which text can be converted from one script to another script. |
Type Aliases
| GetSupportedLanguagesParameters | |
| LanguageDirectionalityOutput |
Language Directionality |
| ProfanityAction |
Translator profanity actions |
| ProfanityMarker |
Translator profanity markers |
| TextTranslationClient | |
| TextType |
Alias for TextType |
| TranslateParameters | |
| TranslationGender |
Alias for TranslationGender |
| TranslationTone |
Alias for TranslationTone |
| TransliterateParameters | |
Functions
| default(Translator |
Initialize a new instance of |
| default(string, Client |
Initialize a new instance of |
| default(string, Translator |
Initialize a new instance of |
| is |
|
| is |
|
| is |
Function Details
default(TranslatorCredential | TranslatorTokenCredential | TokenCredential | KeyCredential, ClientOptions)
Initialize a new instance of TextTranslationClient
function default(credential: TranslatorCredential | TranslatorTokenCredential | TokenCredential | KeyCredential, options?: ClientOptions): TextTranslationClient
Parameters
- credential
-
TranslatorCredential | TranslatorTokenCredential | TokenCredential | KeyCredential
type: TranslatorCredential | TranslatorTokenCredential | KeyCredential |TokenCredential, credentials used to authenticate the service with.
- options
- ClientOptions
type: ClientOptions, the parameter for all optional parameters
Returns
default(string, ClientOptions)
Initialize a new instance of TextTranslationClient
function default(endpoint: string, options?: ClientOptions): TextTranslationClient
Parameters
- endpoint
-
string
type: string, Supported Text Translation endpoints (protocol and hostname, for example: https://api.cognitive.microsofttranslator.com).
- options
- ClientOptions
type: ClientOptions, the parameter for all optional parameters
Returns
default(string, TranslatorCredential | TranslatorTokenCredential | TokenCredential | KeyCredential, ClientOptions)
Initialize a new instance of TextTranslationClient
function default(endpoint: string, credential: TranslatorCredential | TranslatorTokenCredential | TokenCredential | KeyCredential, options?: ClientOptions): TextTranslationClient
Parameters
- endpoint
-
string
type: string, Supported Text Translation endpoints (protocol and hostname, for example: https://api.cognitive.microsofttranslator.com).
- credential
-
TranslatorCredential | TranslatorTokenCredential | TokenCredential | KeyCredential
type: TranslatorCredential | TranslatorTokenCredential | KeyCredential |TokenCredential, credentials used to authenticate the service with.
- options
- ClientOptions
type: ClientOptions, the parameter for all optional parameters
Returns
isUnexpected(GetSupportedLanguages200Response | GetSupportedLanguagesDefaultResponse)
function isUnexpected(response: GetSupportedLanguages200Response | GetSupportedLanguagesDefaultResponse): response
Parameters
Returns
response
isUnexpected(Translate200Response | TranslateDefaultResponse)
function isUnexpected(response: Translate200Response | TranslateDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(Transliterate200Response | TransliterateDefaultResponse)
function isUnexpected(response: Transliterate200Response | TransliterateDefaultResponse): response
Parameters
Returns
response