Synapse.ML.Services.Translate.Transliterate Class Reference

Transliterate implements Transliterate More...

Inheritance diagram for Synapse.ML.Services.Translate.Transliterate:

Collaboration diagram for Synapse.ML.Services.Translate.Transliterate:

Public Member Functions
	Transliterate ()
	Creates a Transliterate without any parameters. More...
	Transliterate (string uid)
	Creates a Transliterate with a UID that is used to give the Transliterate a unique ID. More...
Transliterate	SetAADToken (string value)
	Sets value for AADToken More...
Transliterate	SetAADTokenCol (string value)
	Sets value for AADToken column More...
Transliterate	SetCustomAuthHeader (string value)
	Sets value for CustomAuthHeader More...
Transliterate	SetCustomAuthHeaderCol (string value)
	Sets value for CustomAuthHeader column More...
Transliterate	SetConcurrency (int value)
	Sets value for concurrency More...
Transliterate	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...
Transliterate	SetErrorCol (string value)
	Sets value for errorCol More...
Transliterate	SetFromScript (string value)
	Sets value for fromScript More...
Transliterate	SetFromScriptCol (string value)
	Sets value for fromScript column More...
Transliterate	SetHandler (object value)
	Sets value for handler More...
Transliterate	SetLanguage (string value)
	Sets value for language More...
Transliterate	SetLanguageCol (string value)
	Sets value for language column More...
Transliterate	SetOutputCol (string value)
	Sets value for outputCol More...
Transliterate	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...
Transliterate	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...
Transliterate	SetSubscriptionRegion (string value)
	Sets value for subscriptionRegion More...
Transliterate	SetSubscriptionRegionCol (string value)
	Sets value for subscriptionRegion column More...
Transliterate	SetText (string[] value)
	Sets value for text More...
Transliterate	SetTextCol (string value)
	Sets value for text column More...
Transliterate	SetTimeout (double value)
	Sets value for timeout More...
Transliterate	SetToScript (string value)
	Sets value for toScript More...
Transliterate	SetToScriptCol (string value)
	Sets value for toScript column More...
Transliterate	SetUrl (string value)
	Sets value for url More...
string	GetAADToken ()
	Gets AADToken value More...
string	GetCustomAuthHeader ()
	Gets CustomAuthHeader value More...
int	GetConcurrency ()
	Gets concurrency value More...
double	GetConcurrentTimeout ()
	Gets concurrentTimeout value More...
string	GetErrorCol ()
	Gets errorCol value More...
string	GetFromScript ()
	Gets fromScript value More...
object	GetHandler ()
	Gets handler value More...
string	GetLanguage ()
	Gets language value More...
string	GetOutputCol ()
	Gets outputCol value More...
string	GetSubscriptionKey ()
	Gets subscriptionKey value More...
string	GetSubscriptionRegion ()
	Gets subscriptionRegion value More...
string[]	GetText ()
	Gets text value More...
double	GetTimeout ()
	Gets timeout value More...
string	GetToScript ()
	Gets toScript value More...
string	GetUrl ()
	Gets url value More...
void	Save (string path)
	Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala. More...
JavaMLWriter	Write ()
	Returns a JavaMLWriter instance for this ML instance.
JavaMLReader< Transliterate >	Read ()
	Get the corresponding JavaMLReader instance. More...
Transliterate	SetCustomServiceName (string value)
	Sets value for service name More...
Transliterate	SetEndpoint (string value)
	Sets value for endpoint More...
Transliterate	SetLocation (string value)
	Sets value for location More...
Transliterate	SetLinkedService (string value)
	Sets value for linkedService More...

Static Public Member Functions
static Transliterate	Load (string path)
	Loads the Transliterate that was previously saved using Save(string). More...

Detailed Description

Transliterate implements Transliterate

Constructor & Destructor Documentation

Transliterate() [1/2]

Synapse.ML.Services.Translate.Transliterate.Transliterate ( )

inline

Creates a Transliterate without any parameters.

Transliterate() [2/2]

Synapse.ML.Services.Translate.Transliterate.Transliterate ( string  uid )

inline

Creates a Transliterate with a UID that is used to give the Transliterate a unique ID.

Parameters

uid	An immutable unique ID for the object and its derivatives.

Member Function Documentation

GetAADToken()

string Synapse.ML.Services.Translate.Transliterate.GetAADToken

(

)

Gets AADToken value

Returns

AADToken: AAD Token used for authentication

GetConcurrency()

int Synapse.ML.Services.Translate.Transliterate.GetConcurrency

(

)

Gets concurrency value

Returns

concurrency: max number of concurrent calls

GetConcurrentTimeout()

double Synapse.ML.Services.Translate.Transliterate.GetConcurrentTimeout

(

)

Gets concurrentTimeout value

Returns

concurrentTimeout: max number seconds to wait on futures if concurrency >= 1

GetCustomAuthHeader()

string Synapse.ML.Services.Translate.Transliterate.GetCustomAuthHeader

(

)

Gets CustomAuthHeader value

Returns

CustomAuthHeader: A Custom Value for Authorization Header

GetErrorCol()

string Synapse.ML.Services.Translate.Transliterate.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetFromScript()

string Synapse.ML.Services.Translate.Transliterate.GetFromScript

(

)

Gets fromScript value

Returns

fromScript: Specifies the script of the input text.

GetHandler()

object Synapse.ML.Services.Translate.Transliterate.GetHandler

(

)

Gets handler value

Returns

handler: Which strategy to use when handling requests

GetLanguage()

string Synapse.ML.Services.Translate.Transliterate.GetLanguage

(

)

Gets language value

Returns

language: Language tag identifying the language of the input text. If a code is not specified, automatic language detection will be applied.

GetOutputCol()

string Synapse.ML.Services.Translate.Transliterate.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetSubscriptionKey()

string Synapse.ML.Services.Translate.Transliterate.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetSubscriptionRegion()

string Synapse.ML.Services.Translate.Transliterate.GetSubscriptionRegion

(

)

Gets subscriptionRegion value

Returns

subscriptionRegion: the API region to use

GetText()

string [] Synapse.ML.Services.Translate.Transliterate.GetText

(

)

Gets text value

Returns

text: the string to translate

GetTimeout()

double Synapse.ML.Services.Translate.Transliterate.GetTimeout

(

)

Gets timeout value

Returns

timeout: number of seconds to wait before closing the connection

GetToScript()

string Synapse.ML.Services.Translate.Transliterate.GetToScript

(

)

Gets toScript value

Returns

toScript: Specifies the script of the translated text.

GetUrl()

string Synapse.ML.Services.Translate.Transliterate.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

static Transliterate Synapse.ML.Services.Translate.Transliterate.Load ( string  path )

static

Loads the Transliterate that was previously saved using Save(string).

Parameters

path	The path the previous Transliterate was saved to

Returns

New Transliterate object, loaded from path.

Read()

JavaMLReader<Transliterate> Synapse.ML.Services.Translate.Transliterate.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<Transliterate> instance for this ML instance.

Save()

void Synapse.ML.Services.Translate.Transliterate.Save

(

string

path

)

Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala.

Parameters

path	The path to save the object to

SetAADToken()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetAADToken

(

string

value

)

Sets value for AADToken

Parameters

value

AAD Token used for authentication

Returns

New Transliterate object

SetAADTokenCol()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetAADTokenCol

(

string

value

)

Sets value for AADToken column

Parameters

value

AAD Token used for authentication

Returns

New Transliterate object

SetConcurrency()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetConcurrency

(

int

value

)

Sets value for concurrency

Parameters

value

max number of concurrent calls

Returns

New Transliterate object

SetConcurrentTimeout()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetConcurrentTimeout

(

double

value

)

Sets value for concurrentTimeout

Parameters

value

max number seconds to wait on futures if concurrency >= 1

Returns

New Transliterate object

SetCustomAuthHeader()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetCustomAuthHeader

(

string

value

)

Sets value for CustomAuthHeader

Parameters

value

A Custom Value for Authorization Header

Returns

New Transliterate object

SetCustomAuthHeaderCol()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetCustomAuthHeaderCol

(

string

value

)

Sets value for CustomAuthHeader column

Parameters

value

A Custom Value for Authorization Header

Returns

New Transliterate object

SetCustomServiceName()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetCustomServiceName

(

string

value

)

Sets value for service name

Parameters

value

Service name of the cognitive service if it's custom domain

Returns

New Transliterate object

SetEndpoint()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetEndpoint

(

string

value

)

Sets value for endpoint

Parameters

value

Endpoint of the cognitive service

Returns

New Transliterate object

SetErrorCol()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New Transliterate object

SetFromScript()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetFromScript

(

string

value

)

Sets value for fromScript

Parameters

value

Specifies the script of the input text.

Returns

New Transliterate object

SetFromScriptCol()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetFromScriptCol

(

string

value

)

Sets value for fromScript column

Parameters

value

Specifies the script of the input text.

Returns

New Transliterate object

SetHandler()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetHandler

(

object

value

)

Sets value for handler

Parameters

value

Which strategy to use when handling requests

Returns

New Transliterate object

SetLanguage()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetLanguage

(

string

value

)

Sets value for language

Parameters

value

Language tag identifying the language of the input text. If a code is not specified, automatic language detection will be applied.

Returns

New Transliterate object

SetLanguageCol()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetLanguageCol

(

string

value

)

Sets value for language column

Parameters

value

Language tag identifying the language of the input text. If a code is not specified, automatic language detection will be applied.

Returns

New Transliterate object

SetLinkedService()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetLinkedService

(

string

value

)

Sets value for linkedService

Parameters

value

linkedService name

Returns

New Transliterate object

SetLocation()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New Transliterate object

SetOutputCol()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New Transliterate object

SetSubscriptionKey()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New Transliterate object

SetSubscriptionKeyCol()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New Transliterate object

SetSubscriptionRegion()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetSubscriptionRegion

(

string

value

)

Sets value for subscriptionRegion

Parameters

value

the API region to use

Returns

New Transliterate object

SetSubscriptionRegionCol()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetSubscriptionRegionCol

(

string

value

)

Sets value for subscriptionRegion column

Parameters

value

the API region to use

Returns

New Transliterate object

SetText()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetText

(

string[]

value

)

Sets value for text

Parameters

value

the string to translate

Returns

New Transliterate object

SetTextCol()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetTextCol

(

string

value

)

Sets value for text column

Parameters

value

the string to translate

Returns

New Transliterate object

SetTimeout()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetTimeout

(

double

value

)

Sets value for timeout

Parameters

value

number of seconds to wait before closing the connection

Returns

New Transliterate object

SetToScript()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetToScript

(

string

value

)

Sets value for toScript

Parameters

value

Specifies the script of the translated text.

Returns

New Transliterate object

SetToScriptCol()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetToScriptCol

(

string

value

)

Sets value for toScript column

Parameters

value

Specifies the script of the translated text.

Returns

New Transliterate object

SetUrl()

Transliterate Synapse.ML.Services.Translate.Transliterate.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New Transliterate object

---

The documentation for this class was generated from the following file:

• synapse/ml/services/translate/Transliterate.cs