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

DictionaryExamples implements DictionaryExamples More...

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

Public Member Functions

 DictionaryExamples ()
 Creates a DictionaryExamples without any parameters. More...
 
 DictionaryExamples (string uid)
 Creates a DictionaryExamples with a UID that is used to give the DictionaryExamples a unique ID. More...
 
DictionaryExamples SetConcurrency (int value)
 Sets value for concurrency More...
 
DictionaryExamples SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
DictionaryExamples SetErrorCol (string value)
 Sets value for errorCol More...
 
DictionaryExamples SetFromLanguage (string value)
 Sets value for fromLanguage More...
 
DictionaryExamples SetFromLanguageCol (string value)
 Sets value for fromLanguage column More...
 
DictionaryExamples SetHandler (object value)
 Sets value for handler More...
 
DictionaryExamples SetOutputCol (string value)
 Sets value for outputCol More...
 
DictionaryExamples SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
DictionaryExamples SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
DictionaryExamples SetSubscriptionRegion (string value)
 Sets value for subscriptionRegion More...
 
DictionaryExamples SetSubscriptionRegionCol (string value)
 Sets value for subscriptionRegion column More...
 
DictionaryExamples SetTextAndTranslation (TextAndTranslation[] value)
 Sets value for textAndTranslation More...
 
DictionaryExamples SetTextAndTranslationCol (string value)
 Sets value for textAndTranslation column More...
 
DictionaryExamples SetTimeout (double value)
 Sets value for timeout More...
 
DictionaryExamples SetToLanguage (string value)
 Sets value for toLanguage More...
 
DictionaryExamples SetToLanguageCol (string value)
 Sets value for toLanguage column More...
 
DictionaryExamples 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...
 
string GetFromLanguage ()
 Gets fromLanguage value More...
 
object GetHandler ()
 Gets handler value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
string GetSubscriptionKey ()
 Gets subscriptionKey value More...
 
string GetSubscriptionRegion ()
 Gets subscriptionRegion value More...
 
TextAndTranslation [] GetTextAndTranslation ()
 Gets textAndTranslation value More...
 
double GetTimeout ()
 Gets timeout value More...
 
string GetToLanguage ()
 Gets toLanguage 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< DictionaryExamplesRead ()
 Get the corresponding JavaMLReader instance. More...
 
DictionaryExamples SetLocation (string value)
 Sets value for location More...
 
DictionaryExamples SetLinkedService (string value)
 Sets value for linkedService More...
 

Static Public Member Functions

static DictionaryExamples Load (string path)
 Loads the DictionaryExamples that was previously saved using Save(string). More...
 

Detailed Description

DictionaryExamples implements DictionaryExamples

Constructor & Destructor Documentation

◆ DictionaryExamples() [1/2]

Synapse.ML.Cognitive.DictionaryExamples.DictionaryExamples ( )
inline

Creates a DictionaryExamples without any parameters.

◆ DictionaryExamples() [2/2]

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

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

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

Member Function Documentation

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetFromLanguage()

string Synapse.ML.Cognitive.DictionaryExamples.GetFromLanguage ( )

Gets fromLanguage value

Returns
fromLanguage: Specifies the language of the input text. The source language must be one of the supported languages included in the dictionary scope.

◆ GetHandler()

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

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetOutputCol()

string Synapse.ML.Cognitive.DictionaryExamples.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetSubscriptionKey()

string Synapse.ML.Cognitive.DictionaryExamples.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetSubscriptionRegion()

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

Gets subscriptionRegion value

Returns
subscriptionRegion: the API region to use

◆ GetTextAndTranslation()

TextAndTranslation [] Synapse.ML.Cognitive.DictionaryExamples.GetTextAndTranslation ( )
inline

Gets textAndTranslation value

Returns
textAndTranslation: A string specifying the translated text previously returned by the Dictionary lookup operation.

◆ GetTimeout()

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

Gets timeout value

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

◆ GetToLanguage()

string Synapse.ML.Cognitive.DictionaryExamples.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 dictionary scope.

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Cognitive.DictionaryExamples.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()

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New DictionaryExamples object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

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

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New DictionaryExamples object

◆ SetFromLanguage()

DictionaryExamples Synapse.ML.Cognitive.DictionaryExamples.SetFromLanguage ( string  value)

Sets value for fromLanguage

Parameters
valueSpecifies the language of the input text. The source language must be one of the supported languages included in the dictionary scope.
Returns
New DictionaryExamples object

◆ SetFromLanguageCol()

DictionaryExamples Synapse.ML.Cognitive.DictionaryExamples.SetFromLanguageCol ( string  value)

Sets value for fromLanguage column

Parameters
valueSpecifies the language of the input text. The source language must be one of the supported languages included in the dictionary scope.
Returns
New DictionaryExamples object

◆ SetHandler()

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

Sets value for handler

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

◆ SetLinkedService()

DictionaryExamples Synapse.ML.Cognitive.DictionaryExamples.SetLinkedService ( string  value)

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New DictionaryExamples object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New DictionaryExamples object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New DictionaryExamples object

◆ SetSubscriptionKey()

DictionaryExamples Synapse.ML.Cognitive.DictionaryExamples.SetSubscriptionKey ( string  value)

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New DictionaryExamples object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New DictionaryExamples object

◆ SetSubscriptionRegion()

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

Sets value for subscriptionRegion

Parameters
valuethe API region to use
Returns
New DictionaryExamples object

◆ SetSubscriptionRegionCol()

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

Sets value for subscriptionRegion column

Parameters
valuethe API region to use
Returns
New DictionaryExamples object

◆ SetTextAndTranslation()

DictionaryExamples Synapse.ML.Cognitive.DictionaryExamples.SetTextAndTranslation ( TextAndTranslation []  value)

Sets value for textAndTranslation

Parameters
valueA string specifying the translated text previously returned by the Dictionary lookup operation.
Returns
New DictionaryExamples object

◆ SetTextAndTranslationCol()

DictionaryExamples Synapse.ML.Cognitive.DictionaryExamples.SetTextAndTranslationCol ( string  value)

Sets value for textAndTranslation column

Parameters
valueA string specifying the translated text previously returned by the Dictionary lookup operation.
Returns
New DictionaryExamples object

◆ SetTimeout()

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

Sets value for timeout

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

◆ SetToLanguage()

DictionaryExamples Synapse.ML.Cognitive.DictionaryExamples.SetToLanguage ( string  value)

Sets value for toLanguage

Parameters
valueSpecifies the language of the output text. The target language must be one of the supported languages included in the dictionary scope.
Returns
New DictionaryExamples object

◆ SetToLanguageCol()

DictionaryExamples Synapse.ML.Cognitive.DictionaryExamples.SetToLanguageCol ( string  value)

Sets value for toLanguage column

Parameters
valueSpecifies the language of the output text. The target language must be one of the supported languages included in the dictionary scope.
Returns
New DictionaryExamples object

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New DictionaryExamples object

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