DictionaryLookup implements DictionaryLookup More...

Inheritance diagram for Synapse.ML.Cognitive.DictionaryLookup:

Collaboration diagram for Synapse.ML.Cognitive.DictionaryLookup:

Public Member Functions
	DictionaryLookup ()
	Creates a DictionaryLookup without any parameters. More...

	DictionaryLookup (string uid)
	Creates a DictionaryLookup with a UID that is used to give the DictionaryLookup a unique ID. More...

DictionaryLookup	SetConcurrency (int value)
	Sets value for concurrency More...

DictionaryLookup	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...

DictionaryLookup	SetErrorCol (string value)
	Sets value for errorCol More...

DictionaryLookup	SetFromLanguage (string value)
	Sets value for fromLanguage More...

DictionaryLookup	SetFromLanguageCol (string value)
	Sets value for fromLanguage column More...

DictionaryLookup	SetHandler (object value)
	Sets value for handler More...

DictionaryLookup	SetOutputCol (string value)
	Sets value for outputCol More...

DictionaryLookup	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...

DictionaryLookup	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...

DictionaryLookup	SetSubscriptionRegion (string value)
	Sets value for subscriptionRegion More...

DictionaryLookup	SetSubscriptionRegionCol (string value)
	Sets value for subscriptionRegion column More...

DictionaryLookup	SetText (string[] value)
	Sets value for text More...

DictionaryLookup	SetTextCol (string value)
	Sets value for text column More...

DictionaryLookup	SetTimeout (double value)
	Sets value for timeout More...

DictionaryLookup	SetToLanguage (string value)
	Sets value for toLanguage More...

DictionaryLookup	SetToLanguageCol (string value)
	Sets value for toLanguage column More...

DictionaryLookup	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...

string []	GetText ()
	Gets text 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< DictionaryLookup >	Read ()
	Get the corresponding JavaMLReader instance. More...

DictionaryLookup	SetLocation (string value)
	Sets value for location More...

DictionaryLookup	SetLinkedService (string value)
	Sets value for linkedService More...

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

Detailed Description

DictionaryLookup implements DictionaryLookup

Constructor & Destructor Documentation

◆ DictionaryLookup() [1/2]

Synapse.ML.Cognitive.DictionaryLookup.DictionaryLookup ( )

inline

Creates a DictionaryLookup without any parameters.

◆ DictionaryLookup() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetConcurrency()

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

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetFromLanguage()

string Synapse.ML.Cognitive.DictionaryLookup.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.DictionaryLookup.GetHandler ( )

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetSubscriptionRegion()

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

Gets subscriptionRegion value

Returns: subscriptionRegion: the API region to use

◆ GetText()

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

Gets text value

Returns: text: the string to translate

◆ GetTimeout()

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

Gets timeout value

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

◆ GetToLanguage()

string Synapse.ML.Cognitive.DictionaryLookup.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.DictionaryLookup.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ Load()

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

static

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

Parameters

path	The path the previous DictionaryLookup was saved to

Returns: New DictionaryLookup object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

Returns: an JavaMLReader<DictionaryLookup> instance for this ML instance.

◆ Save()

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

◆ SetConcurrency()

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

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New DictionaryLookup object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

Parameters

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

Returns: New DictionaryLookup object

◆ SetErrorCol()

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

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New DictionaryLookup object

◆ SetFromLanguage()

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

Sets value for fromLanguage

Parameters

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

Returns: New DictionaryLookup object

◆ SetFromLanguageCol()

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

Sets value for fromLanguage column

Parameters

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

Returns: New DictionaryLookup object

◆ SetHandler()

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

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New DictionaryLookup object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters

value linkedService name

Returns: New DictionaryLookup object

◆ SetLocation()

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

Sets value for location

Parameters

value Location of the cognitive service

Returns: New DictionaryLookup object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value The name of the output column

Returns: New DictionaryLookup object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New DictionaryLookup object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New DictionaryLookup object

◆ SetSubscriptionRegion()

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

Sets value for subscriptionRegion

Parameters

value the API region to use

Returns: New DictionaryLookup object

◆ SetSubscriptionRegionCol()

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

Sets value for subscriptionRegion column

Parameters

value the API region to use

Returns: New DictionaryLookup object

◆ SetText()

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

Sets value for text

Parameters

value the string to translate

Returns: New DictionaryLookup object

◆ SetTextCol()

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

Sets value for text column

Parameters

value the string to translate

Returns: New DictionaryLookup object

◆ SetTimeout()

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

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New DictionaryLookup object

◆ SetToLanguage()

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

Returns: New DictionaryLookup object

◆ SetToLanguageCol()

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

Returns: New DictionaryLookup object

◆ SetUrl()

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

Sets value for url

Parameters

value Url of the service

Returns: New DictionaryLookup object

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

synapse/ml/cognitive/DictionaryLookup.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DictionaryLookup() [1/2]

◆ DictionaryLookup() [2/2]

Member Function Documentation

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetErrorCol()

◆ GetFromLanguage()

◆ GetHandler()

◆ GetOutputCol()

◆ GetSubscriptionKey()

◆ GetSubscriptionRegion()

◆ GetText()

◆ GetTimeout()

◆ GetToLanguage()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetErrorCol()

◆ SetFromLanguage()

◆ SetFromLanguageCol()

◆ SetHandler()

◆ SetLinkedService()

◆ SetLocation()

◆ SetOutputCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetSubscriptionRegion()

◆ SetSubscriptionRegionCol()

◆ SetText()

◆ SetTextCol()

◆ SetTimeout()

◆ SetToLanguage()

◆ SetToLanguageCol()

◆ SetUrl()