Synapse.ML.Cognitive.Translate Class Reference

Translate implements Translate More...

Inheritance diagram for Synapse.ML.Cognitive.Translate:

Collaboration diagram for Synapse.ML.Cognitive.Translate:

Public Member Functions
	Translate ()
	Creates a Translate without any parameters. More...
	Translate (string uid)
	Creates a Translate with a UID that is used to give the Translate a unique ID. More...
Translate	SetAllowFallback (bool value)
	Sets value for allowFallback More...
Translate	SetAllowFallbackCol (string value)
	Sets value for allowFallback column More...
Translate	SetCategory (string value)
	Sets value for category More...
Translate	SetCategoryCol (string value)
	Sets value for category column More...
Translate	SetConcurrency (int value)
	Sets value for concurrency More...
Translate	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...
Translate	SetErrorCol (string value)
	Sets value for errorCol More...
Translate	SetFromLanguage (string value)
	Sets value for fromLanguage More...
Translate	SetFromLanguageCol (string value)
	Sets value for fromLanguage column More...
Translate	SetFromScript (string value)
	Sets value for fromScript More...
Translate	SetFromScriptCol (string value)
	Sets value for fromScript column More...
Translate	SetHandler (object value)
	Sets value for handler More...
Translate	SetIncludeAlignment (bool value)
	Sets value for includeAlignment More...
Translate	SetIncludeAlignmentCol (string value)
	Sets value for includeAlignment column More...
Translate	SetIncludeSentenceLength (bool value)
	Sets value for includeSentenceLength More...
Translate	SetIncludeSentenceLengthCol (string value)
	Sets value for includeSentenceLength column More...
Translate	SetOutputCol (string value)
	Sets value for outputCol More...
Translate	SetProfanityAction (string value)
	Sets value for profanityAction More...
Translate	SetProfanityActionCol (string value)
	Sets value for profanityAction column More...
Translate	SetProfanityMarker (string value)
	Sets value for profanityMarker More...
Translate	SetProfanityMarkerCol (string value)
	Sets value for profanityMarker column More...
Translate	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...
Translate	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...
Translate	SetSubscriptionRegion (string value)
	Sets value for subscriptionRegion More...
Translate	SetSubscriptionRegionCol (string value)
	Sets value for subscriptionRegion column More...
Translate	SetSuggestedFrom (string value)
	Sets value for suggestedFrom More...
Translate	SetSuggestedFromCol (string value)
	Sets value for suggestedFrom column More...
Translate	SetText (string[] value)
	Sets value for text More...
Translate	SetTextCol (string value)
	Sets value for text column More...
Translate	SetTextType (string value)
	Sets value for textType More...
Translate	SetTextTypeCol (string value)
	Sets value for textType column More...
Translate	SetTimeout (double value)
	Sets value for timeout More...
Translate	SetToLanguage (string[] value)
	Sets value for toLanguage More...
Translate	SetToLanguageCol (string value)
	Sets value for toLanguage column More...
Translate	SetToScript (string value)
	Sets value for toScript More...
Translate	SetToScriptCol (string value)
	Sets value for toScript column More...
Translate	SetUrl (string value)
	Sets value for url More...
bool	GetAllowFallback ()
	Gets allowFallback value More...
string	GetCategory ()
	Gets category value More...
int	GetConcurrency ()
	Gets concurrency value More...
double	GetConcurrentTimeout ()
	Gets concurrentTimeout value More...
string	GetErrorCol ()
	Gets errorCol value More...
string	GetFromLanguage ()
	Gets fromLanguage value More...
string	GetFromScript ()
	Gets fromScript value More...
object	GetHandler ()
	Gets handler value More...
bool	GetIncludeAlignment ()
	Gets includeAlignment value More...
bool	GetIncludeSentenceLength ()
	Gets includeSentenceLength value More...
string	GetOutputCol ()
	Gets outputCol value More...
string	GetProfanityAction ()
	Gets profanityAction value More...
string	GetProfanityMarker ()
	Gets profanityMarker value More...
string	GetSubscriptionKey ()
	Gets subscriptionKey value More...
string	GetSubscriptionRegion ()
	Gets subscriptionRegion value More...
string	GetSuggestedFrom ()
	Gets suggestedFrom value More...
string []	GetText ()
	Gets text value More...
string	GetTextType ()
	Gets textType value More...
double	GetTimeout ()
	Gets timeout value More...
string []	GetToLanguage ()
	Gets toLanguage 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< Translate >	Read ()
	Get the corresponding JavaMLReader instance. More...
Translate	SetLocation (string value)
	Sets value for location More...
Translate	SetLinkedService (string value)
	Sets value for linkedService More...

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

Detailed Description

Translate implements Translate

Constructor & Destructor Documentation

Translate() [1/2]

Synapse.ML.Cognitive.Translate.Translate ( )

inline

Creates a Translate without any parameters.

Translate() [2/2]

Synapse.ML.Cognitive.Translate.Translate ( string  uid )

inline

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

Parameters

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

Member Function Documentation

GetAllowFallback()

bool Synapse.ML.Cognitive.Translate.GetAllowFallback

(

)

Gets allowFallback value

Returns

allowFallback: Specifies that the service is allowed to fall back to a general system when a custom system does not exist.

GetCategory()

string Synapse.ML.Cognitive.Translate.GetCategory

(

)

Gets category value

Returns

category: A string specifying the category (domain) of the translation. This parameter is used to get translations from a customized system built with Custom Translator. Add the Category ID from your Custom Translator project details to this parameter to use your deployed customized system. Default value is: general.

GetConcurrency()

int Synapse.ML.Cognitive.Translate.GetConcurrency

(

)

Gets concurrency value

Returns

concurrency: max number of concurrent calls

GetConcurrentTimeout()

double Synapse.ML.Cognitive.Translate.GetConcurrentTimeout

(

)

Gets concurrentTimeout value

Returns

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

GetErrorCol()

string Synapse.ML.Cognitive.Translate.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetFromLanguage()

string Synapse.ML.Cognitive.Translate.GetFromLanguage

(

)

Gets fromLanguage value

Returns

fromLanguage: Specifies the language of the input text. Find which languages are available to translate from by looking up supported languages using the translation scope. If the from parameter is not specified, automatic language detection is applied to determine the source language. You must use the from parameter rather than autodetection when using the dynamic dictionary feature.

GetFromScript()

string Synapse.ML.Cognitive.Translate.GetFromScript

(

)

Gets fromScript value

Returns

fromScript: Specifies the script of the input text.

GetHandler()

object Synapse.ML.Cognitive.Translate.GetHandler

(

)

Gets handler value

Returns

handler: Which strategy to use when handling requests

GetIncludeAlignment()

bool Synapse.ML.Cognitive.Translate.GetIncludeAlignment

(

)

Gets includeAlignment value

Returns

includeAlignment: Specifies whether to include alignment projection from source text to translated text.

GetIncludeSentenceLength()

bool Synapse.ML.Cognitive.Translate.GetIncludeSentenceLength

(

)

Gets includeSentenceLength value

Returns

includeSentenceLength: Specifies whether to include sentence boundaries for the input text and the translated text.

GetOutputCol()

string Synapse.ML.Cognitive.Translate.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetProfanityAction()

string Synapse.ML.Cognitive.Translate.GetProfanityAction

(

)

Gets profanityAction value

Returns

profanityAction: Specifies how profanities should be treated in translations. Possible values are: NoAction (default), Marked or Deleted.

GetProfanityMarker()

string Synapse.ML.Cognitive.Translate.GetProfanityMarker

(

)

Gets profanityMarker value

Returns

profanityMarker: Specifies how profanities should be marked in translations. Possible values are: Asterisk (default) or Tag.

GetSubscriptionKey()

string Synapse.ML.Cognitive.Translate.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetSubscriptionRegion()

string Synapse.ML.Cognitive.Translate.GetSubscriptionRegion

(

)

Gets subscriptionRegion value

Returns

subscriptionRegion: the API region to use

GetSuggestedFrom()

string Synapse.ML.Cognitive.Translate.GetSuggestedFrom

(

)

Gets suggestedFrom value

Returns

suggestedFrom: Specifies a fallback language if the language of the input text can't be identified. Language autodetection is applied when the from parameter is omitted. If detection fails, the suggestedFrom language will be assumed.

GetText()

string [] Synapse.ML.Cognitive.Translate.GetText

(

)

Gets text value

Returns

text: the string to translate

GetTextType()

string Synapse.ML.Cognitive.Translate.GetTextType

(

)

Gets textType value

Returns

textType: Defines whether the text being translated is plain text or HTML text. Any HTML needs to be a well-formed, complete element. Possible values are: plain (default) or html.

GetTimeout()

double Synapse.ML.Cognitive.Translate.GetTimeout

(

)

Gets timeout value

Returns

timeout: number of seconds to wait before closing the connection

GetToLanguage()

string [] Synapse.ML.Cognitive.Translate.GetToLanguage

(

)

Gets toLanguage value

Returns

toLanguage: Specifies the language of the output text. The target language must be one of the supported languages included in the translation scope. For example, use to=de to translate to German. It's possible to translate to multiple languages simultaneously by repeating the parameter in the query string. For example, use to=de and to=it to translate to German and Italian.

GetToScript()

string Synapse.ML.Cognitive.Translate.GetToScript

(

)

Gets toScript value

Returns

toScript: Specifies the script of the translated text.

GetUrl()

string Synapse.ML.Cognitive.Translate.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

static Translate Synapse.ML.Cognitive.Translate.Load ( string  path )

static

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

Parameters

path	The path the previous Translate was saved to

Returns

New Translate object, loaded from path.

Read()

JavaMLReader<Translate> Synapse.ML.Cognitive.Translate.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<Translate> instance for this ML instance.

Save()

void Synapse.ML.Cognitive.Translate.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

SetAllowFallback()

Translate Synapse.ML.Cognitive.Translate.SetAllowFallback

(

bool

value

)

Sets value for allowFallback

Parameters

value

Specifies that the service is allowed to fall back to a general system when a custom system does not exist.

Returns

New Translate object

SetAllowFallbackCol()

Translate Synapse.ML.Cognitive.Translate.SetAllowFallbackCol

(

string

value

)

Sets value for allowFallback column

Parameters

value

Specifies that the service is allowed to fall back to a general system when a custom system does not exist.

Returns

New Translate object

SetCategory()

Translate Synapse.ML.Cognitive.Translate.SetCategory

(

string

value

)

Sets value for category

Parameters

value

A string specifying the category (domain) of the translation. This parameter is used to get translations from a customized system built with Custom Translator. Add the Category ID from your Custom Translator project details to this parameter to use your deployed customized system. Default value is: general.

Returns

New Translate object

SetCategoryCol()

Translate Synapse.ML.Cognitive.Translate.SetCategoryCol

(

string

value

)

Sets value for category column

Parameters

value

A string specifying the category (domain) of the translation. This parameter is used to get translations from a customized system built with Custom Translator. Add the Category ID from your Custom Translator project details to this parameter to use your deployed customized system. Default value is: general.

Returns

New Translate object

SetConcurrency()

Translate Synapse.ML.Cognitive.Translate.SetConcurrency

(

int

value

)

Sets value for concurrency

Parameters

value

max number of concurrent calls

Returns

New Translate object

SetConcurrentTimeout()

Translate Synapse.ML.Cognitive.Translate.SetConcurrentTimeout

(

double

value

)

Sets value for concurrentTimeout

Parameters

value

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

Returns

New Translate object

SetErrorCol()

Translate Synapse.ML.Cognitive.Translate.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New Translate object

SetFromLanguage()

Translate Synapse.ML.Cognitive.Translate.SetFromLanguage

(

string

value

)

Sets value for fromLanguage

Parameters

value

Specifies the language of the input text. Find which languages are available to translate from by looking up supported languages using the translation scope. If the from parameter is not specified, automatic language detection is applied to determine the source language. You must use the from parameter rather than autodetection when using the dynamic dictionary feature.

Returns

New Translate object

SetFromLanguageCol()

Translate Synapse.ML.Cognitive.Translate.SetFromLanguageCol

(

string

value

)

Sets value for fromLanguage column

Parameters

value

Specifies the language of the input text. Find which languages are available to translate from by looking up supported languages using the translation scope. If the from parameter is not specified, automatic language detection is applied to determine the source language. You must use the from parameter rather than autodetection when using the dynamic dictionary feature.

Returns

New Translate object

SetFromScript()

Translate Synapse.ML.Cognitive.Translate.SetFromScript

(

string

value

)

Sets value for fromScript

Parameters

value

Specifies the script of the input text.

Returns

New Translate object

SetFromScriptCol()

Translate Synapse.ML.Cognitive.Translate.SetFromScriptCol

(

string

value

)

Sets value for fromScript column

Parameters

value

Specifies the script of the input text.

Returns

New Translate object

SetHandler()

Translate Synapse.ML.Cognitive.Translate.SetHandler

(

object

value

)

Sets value for handler

Parameters

value

Which strategy to use when handling requests

Returns

New Translate object

SetIncludeAlignment()

Translate Synapse.ML.Cognitive.Translate.SetIncludeAlignment

(

bool

value

)

Sets value for includeAlignment

Parameters

value

Specifies whether to include alignment projection from source text to translated text.

Returns

New Translate object

SetIncludeAlignmentCol()

Translate Synapse.ML.Cognitive.Translate.SetIncludeAlignmentCol

(

string

value

)

Sets value for includeAlignment column

Parameters

value

Specifies whether to include alignment projection from source text to translated text.

Returns

New Translate object

SetIncludeSentenceLength()

Translate Synapse.ML.Cognitive.Translate.SetIncludeSentenceLength

(

bool

value

)

Sets value for includeSentenceLength

Parameters

value

Specifies whether to include sentence boundaries for the input text and the translated text.

Returns

New Translate object

SetIncludeSentenceLengthCol()

Translate Synapse.ML.Cognitive.Translate.SetIncludeSentenceLengthCol

(

string

value

)

Sets value for includeSentenceLength column

Parameters

value

Specifies whether to include sentence boundaries for the input text and the translated text.

Returns

New Translate object

SetLinkedService()

Translate Synapse.ML.Cognitive.Translate.SetLinkedService

(

string

value

)

Sets value for linkedService

Parameters

value

linkedService name

Returns

New Translate object

SetLocation()

Translate Synapse.ML.Cognitive.Translate.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New Translate object

SetOutputCol()

Translate Synapse.ML.Cognitive.Translate.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New Translate object

SetProfanityAction()

Translate Synapse.ML.Cognitive.Translate.SetProfanityAction

(

string

value

)

Sets value for profanityAction

Parameters

value

Specifies how profanities should be treated in translations. Possible values are: NoAction (default), Marked or Deleted.

Returns

New Translate object

SetProfanityActionCol()

Translate Synapse.ML.Cognitive.Translate.SetProfanityActionCol

(

string

value

)

Sets value for profanityAction column

Parameters

value

Specifies how profanities should be treated in translations. Possible values are: NoAction (default), Marked or Deleted.

Returns

New Translate object

SetProfanityMarker()

Translate Synapse.ML.Cognitive.Translate.SetProfanityMarker

(

string

value

)

Sets value for profanityMarker

Parameters

value

Specifies how profanities should be marked in translations. Possible values are: Asterisk (default) or Tag.

Returns

New Translate object

SetProfanityMarkerCol()

Translate Synapse.ML.Cognitive.Translate.SetProfanityMarkerCol

(

string

value

)

Sets value for profanityMarker column

Parameters

value

Specifies how profanities should be marked in translations. Possible values are: Asterisk (default) or Tag.

Returns

New Translate object

SetSubscriptionKey()

Translate Synapse.ML.Cognitive.Translate.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New Translate object

SetSubscriptionKeyCol()

Translate Synapse.ML.Cognitive.Translate.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New Translate object

SetSubscriptionRegion()

Translate Synapse.ML.Cognitive.Translate.SetSubscriptionRegion

(

string

value

)

Sets value for subscriptionRegion

Parameters

value

the API region to use

Returns

New Translate object

SetSubscriptionRegionCol()

Translate Synapse.ML.Cognitive.Translate.SetSubscriptionRegionCol

(

string

value

)

Sets value for subscriptionRegion column

Parameters

value

the API region to use

Returns

New Translate object

SetSuggestedFrom()

Translate Synapse.ML.Cognitive.Translate.SetSuggestedFrom

(

string

value

)

Sets value for suggestedFrom

Parameters

value

Specifies a fallback language if the language of the input text can't be identified. Language autodetection is applied when the from parameter is omitted. If detection fails, the suggestedFrom language will be assumed.

Returns

New Translate object

SetSuggestedFromCol()

Translate Synapse.ML.Cognitive.Translate.SetSuggestedFromCol

(

string

value

)

Sets value for suggestedFrom column

Parameters

value

Specifies a fallback language if the language of the input text can't be identified. Language autodetection is applied when the from parameter is omitted. If detection fails, the suggestedFrom language will be assumed.

Returns

New Translate object

SetText()

Translate Synapse.ML.Cognitive.Translate.SetText

(

string []

value

)

Sets value for text

Parameters

value

the string to translate

Returns

New Translate object

SetTextCol()

Translate Synapse.ML.Cognitive.Translate.SetTextCol

(

string

value

)

Sets value for text column

Parameters

value

the string to translate

Returns

New Translate object

SetTextType()

Translate Synapse.ML.Cognitive.Translate.SetTextType

(

string

value

)

Sets value for textType

Parameters

value

Defines whether the text being translated is plain text or HTML text. Any HTML needs to be a well-formed, complete element. Possible values are: plain (default) or html.

Returns

New Translate object

SetTextTypeCol()

Translate Synapse.ML.Cognitive.Translate.SetTextTypeCol

(

string

value

)

Sets value for textType column

Parameters

value

Defines whether the text being translated is plain text or HTML text. Any HTML needs to be a well-formed, complete element. Possible values are: plain (default) or html.

Returns

New Translate object

SetTimeout()

Translate Synapse.ML.Cognitive.Translate.SetTimeout

(

double

value

)

Sets value for timeout

Parameters

value

number of seconds to wait before closing the connection

Returns

New Translate object

SetToLanguage()

Translate Synapse.ML.Cognitive.Translate.SetToLanguage

(

string []

value

)

Sets value for toLanguage

Parameters

value

Specifies the language of the output text. The target language must be one of the supported languages included in the translation scope. For example, use to=de to translate to German. It's possible to translate to multiple languages simultaneously by repeating the parameter in the query string. For example, use to=de and to=it to translate to German and Italian.

Returns

New Translate object

SetToLanguageCol()

Translate Synapse.ML.Cognitive.Translate.SetToLanguageCol

(

string

value

)

Sets value for toLanguage column

Parameters

value

Specifies the language of the output text. The target language must be one of the supported languages included in the translation scope. For example, use to=de to translate to German. It's possible to translate to multiple languages simultaneously by repeating the parameter in the query string. For example, use to=de and to=it to translate to German and Italian.

Returns

New Translate object

SetToScript()

Translate Synapse.ML.Cognitive.Translate.SetToScript

(

string

value

)

Sets value for toScript

Parameters

value

Specifies the script of the translated text.

Returns

New Translate object

SetToScriptCol()

Translate Synapse.ML.Cognitive.Translate.SetToScriptCol

(

string

value

)

Sets value for toScript column

Parameters

value

Specifies the script of the translated text.

Returns

New Translate object

SetUrl()

Translate Synapse.ML.Cognitive.Translate.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New Translate object

---

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

• synapse/ml/cognitive/Translate.cs