Synapse.ML.Services.Translate.BreakSentence Class Reference

BreakSentence implements BreakSentence More...

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

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

Public Member Functions
	BreakSentence ()
	Creates a BreakSentence without any parameters. More...
	BreakSentence (string uid)
	Creates a BreakSentence with a UID that is used to give the BreakSentence a unique ID. More...
BreakSentence	SetAADToken (string value)
	Sets value for AADToken More...
BreakSentence	SetAADTokenCol (string value)
	Sets value for AADToken column More...
BreakSentence	SetCustomAuthHeader (string value)
	Sets value for CustomAuthHeader More...
BreakSentence	SetCustomAuthHeaderCol (string value)
	Sets value for CustomAuthHeader column More...
BreakSentence	SetConcurrency (int value)
	Sets value for concurrency More...
BreakSentence	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...
BreakSentence	SetErrorCol (string value)
	Sets value for errorCol More...
BreakSentence	SetHandler (object value)
	Sets value for handler More...
BreakSentence	SetLanguage (string value)
	Sets value for language More...
BreakSentence	SetLanguageCol (string value)
	Sets value for language column More...
BreakSentence	SetOutputCol (string value)
	Sets value for outputCol More...
BreakSentence	SetScript (string value)
	Sets value for script More...
BreakSentence	SetScriptCol (string value)
	Sets value for script column More...
BreakSentence	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...
BreakSentence	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...
BreakSentence	SetSubscriptionRegion (string value)
	Sets value for subscriptionRegion More...
BreakSentence	SetSubscriptionRegionCol (string value)
	Sets value for subscriptionRegion column More...
BreakSentence	SetText (string[] value)
	Sets value for text More...
BreakSentence	SetTextCol (string value)
	Sets value for text column More...
BreakSentence	SetTimeout (double value)
	Sets value for timeout More...
BreakSentence	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...
object	GetHandler ()
	Gets handler value More...
string	GetLanguage ()
	Gets language value More...
string	GetOutputCol ()
	Gets outputCol value More...
string	GetScript ()
	Gets script 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	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< BreakSentence >	Read ()
	Get the corresponding JavaMLReader instance. More...
BreakSentence	SetCustomServiceName (string value)
	Sets value for service name More...
BreakSentence	SetEndpoint (string value)
	Sets value for endpoint More...
BreakSentence	SetLocation (string value)
	Sets value for location More...
BreakSentence	SetLinkedService (string value)
	Sets value for linkedService More...

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

Detailed Description

BreakSentence implements BreakSentence

Constructor & Destructor Documentation

BreakSentence() [1/2]

Synapse.ML.Services.Translate.BreakSentence.BreakSentence ( )

inline

Creates a BreakSentence without any parameters.

BreakSentence() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetAADToken()

string Synapse.ML.Services.Translate.BreakSentence.GetAADToken

(

)

Gets AADToken value

Returns

AADToken: AAD Token used for authentication

GetConcurrency()

int Synapse.ML.Services.Translate.BreakSentence.GetConcurrency

(

)

Gets concurrency value

Returns

concurrency: max number of concurrent calls

GetConcurrentTimeout()

double Synapse.ML.Services.Translate.BreakSentence.GetConcurrentTimeout

(

)

Gets concurrentTimeout value

Returns

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

GetCustomAuthHeader()

string Synapse.ML.Services.Translate.BreakSentence.GetCustomAuthHeader

(

)

Gets CustomAuthHeader value

Returns

CustomAuthHeader: A Custom Value for Authorization Header

GetErrorCol()

string Synapse.ML.Services.Translate.BreakSentence.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetHandler()

object Synapse.ML.Services.Translate.BreakSentence.GetHandler

(

)

Gets handler value

Returns

handler: Which strategy to use when handling requests

GetLanguage()

string Synapse.ML.Services.Translate.BreakSentence.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.BreakSentence.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetScript()

string Synapse.ML.Services.Translate.BreakSentence.GetScript

(

)

Gets script value

Returns

script: Script tag identifying the script used by the input text. If a script is not specified, the default script of the language will be assumed.

GetSubscriptionKey()

string Synapse.ML.Services.Translate.BreakSentence.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetSubscriptionRegion()

string Synapse.ML.Services.Translate.BreakSentence.GetSubscriptionRegion

(

)

Gets subscriptionRegion value

Returns

subscriptionRegion: the API region to use

GetText()

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

(

)

Gets text value

Returns

text: the string to translate

GetTimeout()

double Synapse.ML.Services.Translate.BreakSentence.GetTimeout

(

)

Gets timeout value

Returns

timeout: number of seconds to wait before closing the connection

GetUrl()

string Synapse.ML.Services.Translate.BreakSentence.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

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

static

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

Parameters

path	The path the previous BreakSentence was saved to

Returns

New BreakSentence object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<BreakSentence> instance for this ML instance.

Save()

void Synapse.ML.Services.Translate.BreakSentence.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()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetAADToken

(

string

value

)

Sets value for AADToken

Parameters

value

AAD Token used for authentication

Returns

New BreakSentence object

SetAADTokenCol()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetAADTokenCol

(

string

value

)

Sets value for AADToken column

Parameters

value

AAD Token used for authentication

Returns

New BreakSentence object

SetConcurrency()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetConcurrency

(

int

value

)

Sets value for concurrency

Parameters

value

max number of concurrent calls

Returns

New BreakSentence object

SetConcurrentTimeout()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetConcurrentTimeout

(

double

value

)

Sets value for concurrentTimeout

Parameters

value

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

Returns

New BreakSentence object

SetCustomAuthHeader()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetCustomAuthHeader

(

string

value

)

Sets value for CustomAuthHeader

Parameters

value

A Custom Value for Authorization Header

Returns

New BreakSentence object

SetCustomAuthHeaderCol()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetCustomAuthHeaderCol

(

string

value

)

Sets value for CustomAuthHeader column

Parameters

value

A Custom Value for Authorization Header

Returns

New BreakSentence object

SetCustomServiceName()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetCustomServiceName

(

string

value

)

Sets value for service name

Parameters

value

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

Returns

New BreakSentence object

SetEndpoint()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetEndpoint

(

string

value

)

Sets value for endpoint

Parameters

value

Endpoint of the cognitive service

Returns

New BreakSentence object

SetErrorCol()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New BreakSentence object

SetHandler()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetHandler

(

object

value

)

Sets value for handler

Parameters

value

Which strategy to use when handling requests

Returns

New BreakSentence object

SetLanguage()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.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 BreakSentence object

SetLanguageCol()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.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 BreakSentence object

SetLinkedService()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetLinkedService

(

string

value

)

Sets value for linkedService

Parameters

value

linkedService name

Returns

New BreakSentence object

SetLocation()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New BreakSentence object

SetOutputCol()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New BreakSentence object

SetScript()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetScript

(

string

value

)

Sets value for script

Parameters

value

Script tag identifying the script used by the input text. If a script is not specified, the default script of the language will be assumed.

Returns

New BreakSentence object

SetScriptCol()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetScriptCol

(

string

value

)

Sets value for script column

Parameters

value

Script tag identifying the script used by the input text. If a script is not specified, the default script of the language will be assumed.

Returns

New BreakSentence object

SetSubscriptionKey()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New BreakSentence object

SetSubscriptionKeyCol()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New BreakSentence object

SetSubscriptionRegion()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetSubscriptionRegion

(

string

value

)

Sets value for subscriptionRegion

Parameters

value

the API region to use

Returns

New BreakSentence object

SetSubscriptionRegionCol()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetSubscriptionRegionCol

(

string

value

)

Sets value for subscriptionRegion column

Parameters

value

the API region to use

Returns

New BreakSentence object

SetText()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetText

(

string[]

value

)

Sets value for text

Parameters

value

the string to translate

Returns

New BreakSentence object

SetTextCol()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetTextCol

(

string

value

)

Sets value for text column

Parameters

value

the string to translate

Returns

New BreakSentence object

SetTimeout()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetTimeout

(

double

value

)

Sets value for timeout

Parameters

value

number of seconds to wait before closing the connection

Returns

New BreakSentence object

SetUrl()

BreakSentence Synapse.ML.Services.Translate.BreakSentence.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New BreakSentence object

---

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

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