TextTranslationClient.Transliterate Method

Definition

Namespace:: Azure.AI.Translation.Text

Assembly:: Azure.AI.Translation.Text.dll

Package:: Azure.AI.Translation.Text v2.0.0

Package:: Azure.AI.Translation.Text v2.0.0-beta.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name	Description
Transliterate(String, String, String, String, CancellationToken)	Transliterate Text.
Transliterate(String, String, String, RequestContent, String, RequestContext)	[Protocol Method] Transliterate Text This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
Transliterate(String, String, String, IEnumerable<String>, Guid, CancellationToken)	Transliterate Text.

Name

Description

Transliterate(String, String, String, String, CancellationToken)

Transliterate Text.

Transliterate(String, String, String, RequestContent, String, RequestContext)

[Protocol Method] Transliterate Text

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

Transliterate(String, String, String, IEnumerable<String>, Guid, CancellationToken)

Transliterate Text.

Transliterate(String, String, String, String, CancellationToken)

Source:: TextTranslationClient.cs

Source:: TextTranslationClient.cs

Transliterate Text.

public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Text.TransliteratedText>> Transliterate(string language, string fromScript, string toScript, string text, System.Threading.CancellationToken cancellationToken = default);

abstract member Transliterate : string * string * string * string * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Text.TransliteratedText>>
override this.Transliterate : string * string * string * string * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Text.TransliteratedText>>

Public Overridable Function Transliterate (language As String, fromScript As String, toScript As String, text As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of TransliteratedText))

Parameters

language: String

Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages.

fromScript: String

Specifies the script used by the input text. Look up supported languages using the transliteration scope, to find input scripts available for the selected language.

toScript: String

Specifies the output script. Look up supported languages using the transliteration scope, to find output scripts available for the selected combination of input language and input script.

text: String

Text to be transliterated.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<IReadOnlyList<TransliteratedText>>

Exceptions

ArgumentNullException

language, fromScript, toScript or text is null.

Applies to

Transliterate(String, String, String, RequestContent, String, RequestContext)

Source:: TextTranslationClient.cs

Source:: TextTranslationClient.cs

[Protocol Method] Transliterate Text

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Response Transliterate(string language, string fromScript, string toScript, Azure.Core.RequestContent content, string clientTraceId = default, Azure.RequestContext context = default);

abstract member Transliterate : string * string * string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response
override this.Transliterate : string * string * string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response

Public Overridable Function Transliterate (language As String, fromScript As String, toScript As String, content As RequestContent, Optional clientTraceId As String = Nothing, Optional context As RequestContext = Nothing) As Response

Parameters

language: String

Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages.

fromScript: String

Specifies the script used by the input text. Look up supported languages using the transliteration scope, to find input scripts available for the selected language.

toScript: String

Specifies the output script. Look up supported languages using the transliteration scope, to find output scripts available for the selected combination of input language and input script.

content: RequestContent

The content to send as the body of the request.

clientTraceId: String

A client-generated GUID to uniquely identify the request.

context: RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

language, fromScript, toScript or content is null.

ArgumentException

language, fromScript or toScript is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Applies to

Transliterate(String, String, String, IEnumerable<String>, Guid, CancellationToken)

Source:: TextTranslationClient.cs

Source:: TextTranslationClient.cs

Transliterate Text.

public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Text.TransliteratedText>> Transliterate(string language, string fromScript, string toScript, System.Collections.Generic.IEnumerable<string> content, Guid clientTraceId = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Transliterate : string * string * string * seq<string> * Guid * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Text.TransliteratedText>>
override this.Transliterate : string * string * string * seq<string> * Guid * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Text.TransliteratedText>>

Public Overridable Function Transliterate (language As String, fromScript As String, toScript As String, content As IEnumerable(Of String), Optional clientTraceId As Guid = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of TransliteratedText))

Parameters

language: String

Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages.

fromScript: String

Specifies the script used by the input text. Look up supported languages using the transliteration scope, to find input scripts available for the selected language.

toScript: String

Specifies the output script. Look up supported languages using the transliteration scope, to find output scripts available for the selected combination of input language and input script.

content: IEnumerable<String>

Array of the text to be transliterated.

clientTraceId: Guid

A client-generated GUID to uniquely identify the request.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<IReadOnlyList<TransliteratedText>>

Exceptions

ArgumentNullException

language, fromScript, toScript or content is null.

Applies to

Feedback

Was this page helpful?