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

TextSentiment implements TextSentiment More...

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

Public Member Functions

 TextSentiment ()
 Creates a TextSentiment without any parameters. More...
 
 TextSentiment (string uid)
 Creates a TextSentiment with a UID that is used to give the TextSentiment a unique ID. More...
 
TextSentiment SetConcurrency (int value)
 Sets value for concurrency More...
 
TextSentiment SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
TextSentiment SetErrorCol (string value)
 Sets value for errorCol More...
 
TextSentiment SetHandler (object value)
 Sets value for handler More...
 
TextSentiment SetLanguage (string[] value)
 Sets value for language More...
 
TextSentiment SetLanguageCol (string value)
 Sets value for language column More...
 
TextSentiment SetModelVersion (string value)
 Sets value for modelVersion More...
 
TextSentiment SetModelVersionCol (string value)
 Sets value for modelVersion column More...
 
TextSentiment SetOpinionMining (bool value)
 Sets value for opinionMining More...
 
TextSentiment SetOpinionMiningCol (string value)
 Sets value for opinionMining column More...
 
TextSentiment SetOutputCol (string value)
 Sets value for outputCol More...
 
TextSentiment SetShowStats (bool value)
 Sets value for showStats More...
 
TextSentiment SetShowStatsCol (string value)
 Sets value for showStats column More...
 
TextSentiment SetStringIndexType (string value)
 Sets value for stringIndexType More...
 
TextSentiment SetStringIndexTypeCol (string value)
 Sets value for stringIndexType column More...
 
TextSentiment SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
TextSentiment SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
TextSentiment SetText (string[] value)
 Sets value for text More...
 
TextSentiment SetTextCol (string value)
 Sets value for text column More...
 
TextSentiment SetTimeout (double value)
 Sets value for timeout More...
 
TextSentiment 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 GetModelVersion ()
 Gets modelVersion value More...
 
bool GetOpinionMining ()
 Gets opinionMining value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
bool GetShowStats ()
 Gets showStats value More...
 
string GetStringIndexType ()
 Gets stringIndexType value More...
 
string GetSubscriptionKey ()
 Gets subscriptionKey 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< TextSentimentRead ()
 Get the corresponding JavaMLReader instance. More...
 
TextSentiment SetLocation (string value)
 Sets value for location More...
 
TextSentiment SetLinkedService (string value)
 Sets value for linkedService More...
 

Static Public Member Functions

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

Detailed Description

TextSentiment implements TextSentiment

Constructor & Destructor Documentation

◆ TextSentiment() [1/2]

Synapse.ML.Cognitive.TextSentiment.TextSentiment ( )
inline

Creates a TextSentiment without any parameters.

◆ TextSentiment() [2/2]

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

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

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

Member Function Documentation

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetHandler()

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

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetLanguage()

string [] Synapse.ML.Cognitive.TextSentiment.GetLanguage ( )

Gets language value

Returns
language: the language code of the text (optional for some services)

◆ GetModelVersion()

string Synapse.ML.Cognitive.TextSentiment.GetModelVersion ( )

Gets modelVersion value

Returns
modelVersion: This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.

◆ GetOpinionMining()

bool Synapse.ML.Cognitive.TextSentiment.GetOpinionMining ( )

Gets opinionMining value

Returns
opinionMining: if set to true, response will contain not only sentiment prediction but also opinion mining (aspect-based sentiment analysis) results.

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetShowStats()

bool Synapse.ML.Cognitive.TextSentiment.GetShowStats ( )

Gets showStats value

Returns
showStats: if set to true, response will contain input and document level statistics.

◆ GetStringIndexType()

string Synapse.ML.Cognitive.TextSentiment.GetStringIndexType ( )

Gets stringIndexType value

Returns
stringIndexType: Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetText()

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

Gets text value

Returns
text: the text in the request body

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New TextSentiment object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

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

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New TextSentiment object

◆ SetHandler()

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

Sets value for handler

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

◆ SetLanguage()

TextSentiment Synapse.ML.Cognitive.TextSentiment.SetLanguage ( string []  value)

Sets value for language

Parameters
valuethe language code of the text (optional for some services)
Returns
New TextSentiment object

◆ SetLanguageCol()

TextSentiment Synapse.ML.Cognitive.TextSentiment.SetLanguageCol ( string  value)

Sets value for language column

Parameters
valuethe language code of the text (optional for some services)
Returns
New TextSentiment object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New TextSentiment object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New TextSentiment object

◆ SetModelVersion()

TextSentiment Synapse.ML.Cognitive.TextSentiment.SetModelVersion ( string  value)

Sets value for modelVersion

Parameters
valueThis value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.
Returns
New TextSentiment object

◆ SetModelVersionCol()

TextSentiment Synapse.ML.Cognitive.TextSentiment.SetModelVersionCol ( string  value)

Sets value for modelVersion column

Parameters
valueThis value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.
Returns
New TextSentiment object

◆ SetOpinionMining()

TextSentiment Synapse.ML.Cognitive.TextSentiment.SetOpinionMining ( bool  value)

Sets value for opinionMining

Parameters
valueif set to true, response will contain not only sentiment prediction but also opinion mining (aspect-based sentiment analysis) results.
Returns
New TextSentiment object

◆ SetOpinionMiningCol()

TextSentiment Synapse.ML.Cognitive.TextSentiment.SetOpinionMiningCol ( string  value)

Sets value for opinionMining column

Parameters
valueif set to true, response will contain not only sentiment prediction but also opinion mining (aspect-based sentiment analysis) results.
Returns
New TextSentiment object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New TextSentiment object

◆ SetShowStats()

TextSentiment Synapse.ML.Cognitive.TextSentiment.SetShowStats ( bool  value)

Sets value for showStats

Parameters
valueif set to true, response will contain input and document level statistics.
Returns
New TextSentiment object

◆ SetShowStatsCol()

TextSentiment Synapse.ML.Cognitive.TextSentiment.SetShowStatsCol ( string  value)

Sets value for showStats column

Parameters
valueif set to true, response will contain input and document level statistics.
Returns
New TextSentiment object

◆ SetStringIndexType()

TextSentiment Synapse.ML.Cognitive.TextSentiment.SetStringIndexType ( string  value)

Sets value for stringIndexType

Parameters
valueSpecifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets
Returns
New TextSentiment object

◆ SetStringIndexTypeCol()

TextSentiment Synapse.ML.Cognitive.TextSentiment.SetStringIndexTypeCol ( string  value)

Sets value for stringIndexType column

Parameters
valueSpecifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets
Returns
New TextSentiment object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New TextSentiment object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New TextSentiment object

◆ SetText()

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

Sets value for text

Parameters
valuethe text in the request body
Returns
New TextSentiment object

◆ SetTextCol()

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

Sets value for text column

Parameters
valuethe text in the request body
Returns
New TextSentiment object

◆ SetTimeout()

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

Sets value for timeout

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

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New TextSentiment object

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