Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Cognitive.BreakSentence Class Reference

BreakSentence implements BreakSentence More...

Inheritance diagram for Synapse.ML.Cognitive.BreakSentence:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Cognitive.BreakSentence:
Collaboration graph
[legend]

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 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...
 
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< BreakSentenceRead ()
 Get the corresponding JavaMLReader instance. 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.Cognitive.BreakSentence.BreakSentence ( )
inline

Creates a BreakSentence without any parameters.

◆ BreakSentence() [2/2]

Synapse.ML.Cognitive.BreakSentence.BreakSentence ( string  uid)
inline

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

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetConcurrency()

int Synapse.ML.Cognitive.BreakSentence.GetConcurrency ( )

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Cognitive.BreakSentence.GetConcurrentTimeout ( )

Gets concurrentTimeout value

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

◆ GetErrorCol()

string Synapse.ML.Cognitive.BreakSentence.GetErrorCol ( )

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetHandler()

object Synapse.ML.Cognitive.BreakSentence.GetHandler ( )

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetLanguage()

string Synapse.ML.Cognitive.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.Cognitive.BreakSentence.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetScript()

string Synapse.ML.Cognitive.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.Cognitive.BreakSentence.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetSubscriptionRegion()

string Synapse.ML.Cognitive.BreakSentence.GetSubscriptionRegion ( )

Gets subscriptionRegion value

Returns
subscriptionRegion: the API region to use

◆ GetText()

string [] Synapse.ML.Cognitive.BreakSentence.GetText ( )

Gets text value

Returns
text: the string to translate

◆ GetTimeout()

double Synapse.ML.Cognitive.BreakSentence.GetTimeout ( )

Gets timeout value

Returns
timeout: number of seconds to wait before closing the connection

◆ GetUrl()

string Synapse.ML.Cognitive.BreakSentence.GetUrl ( )

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

Parameters
pathThe path the previous BreakSentence was saved to
Returns
New BreakSentence object, loaded from path.

◆ Read()

JavaMLReader<BreakSentence> Synapse.ML.Cognitive.BreakSentence.Read ( )

Get the corresponding JavaMLReader instance.

Returns
an JavaMLReader<BreakSentence> instance for this ML instance.

◆ Save()

void Synapse.ML.Cognitive.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
pathThe path to save the object to

◆ SetConcurrency()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetConcurrency ( int  value)

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New BreakSentence object

◆ SetConcurrentTimeout()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetConcurrentTimeout ( double  value)

Sets value for concurrentTimeout

Parameters
valuemax number seconds to wait on futures if concurrency >= 1
Returns
New BreakSentence object

◆ SetErrorCol()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetErrorCol ( string  value)

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New BreakSentence object

◆ SetHandler()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetHandler ( object  value)

Sets value for handler

Parameters
valueWhich strategy to use when handling requests
Returns
New BreakSentence object

◆ SetLanguage()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetLanguage ( string  value)

Sets value for language

Parameters
valueLanguage 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.Cognitive.BreakSentence.SetLanguageCol ( string  value)

Sets value for language column

Parameters
valueLanguage 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.Cognitive.BreakSentence.SetLinkedService ( string  value)

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New BreakSentence object

◆ SetLocation()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetLocation ( string  value)

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New BreakSentence object

◆ SetOutputCol()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New BreakSentence object

◆ SetScript()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetScript ( string  value)

Sets value for script

Parameters
valueScript 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.Cognitive.BreakSentence.SetScriptCol ( string  value)

Sets value for script column

Parameters
valueScript 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.Cognitive.BreakSentence.SetSubscriptionKey ( string  value)

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New BreakSentence object

◆ SetSubscriptionKeyCol()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetSubscriptionKeyCol ( string  value)

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New BreakSentence object

◆ SetSubscriptionRegion()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetSubscriptionRegion ( string  value)

Sets value for subscriptionRegion

Parameters
valuethe API region to use
Returns
New BreakSentence object

◆ SetSubscriptionRegionCol()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetSubscriptionRegionCol ( string  value)

Sets value for subscriptionRegion column

Parameters
valuethe API region to use
Returns
New BreakSentence object

◆ SetText()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetText ( string []  value)

Sets value for text

Parameters
valuethe string to translate
Returns
New BreakSentence object

◆ SetTextCol()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetTextCol ( string  value)

Sets value for text column

Parameters
valuethe string to translate
Returns
New BreakSentence object

◆ SetTimeout()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetTimeout ( double  value)

Sets value for timeout

Parameters
valuenumber of seconds to wait before closing the connection
Returns
New BreakSentence object

◆ SetUrl()

BreakSentence Synapse.ML.Cognitive.BreakSentence.SetUrl ( string  value)

Sets value for url

Parameters
valueUrl of the service
Returns
New BreakSentence object

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