Synapse.ML.Cognitive.TextAnalyze Class Reference

TextAnalyze implements TextAnalyze More...

Inheritance diagram for Synapse.ML.Cognitive.TextAnalyze:

Collaboration diagram for Synapse.ML.Cognitive.TextAnalyze:

Public Member Functions
	TextAnalyze ()
	Creates a TextAnalyze without any parameters. More...
	TextAnalyze (string uid)
	Creates a TextAnalyze with a UID that is used to give the TextAnalyze a unique ID. More...
TextAnalyze	SetBackoffs (int[] value)
	Sets value for backoffs More...
TextAnalyze	SetBatchSize (int value)
	Sets value for batchSize More...
TextAnalyze	SetConcurrency (int value)
	Sets value for concurrency More...
TextAnalyze	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...
TextAnalyze	SetDisableServiceLogs (bool value)
	Sets value for disableServiceLogs More...
TextAnalyze	SetDisableServiceLogsCol (string value)
	Sets value for disableServiceLogs column More...
TextAnalyze	SetEntityLinkingParams (Dictionary< string, string > value)
	Sets value for entityLinkingParams More...
TextAnalyze	SetEntityRecognitionParams (Dictionary< string, string > value)
	Sets value for entityRecognitionParams More...
TextAnalyze	SetErrorCol (string value)
	Sets value for errorCol More...
TextAnalyze	SetIncludeEntityLinking (bool value)
	Sets value for includeEntityLinking More...
TextAnalyze	SetIncludeEntityRecognition (bool value)
	Sets value for includeEntityRecognition More...
TextAnalyze	SetIncludeKeyPhraseExtraction (bool value)
	Sets value for includeKeyPhraseExtraction More...
TextAnalyze	SetIncludePii (bool value)
	Sets value for includePii More...
TextAnalyze	SetIncludeSentimentAnalysis (bool value)
	Sets value for includeSentimentAnalysis More...
TextAnalyze	SetInitialPollingDelay (int value)
	Sets value for initialPollingDelay More...
TextAnalyze	SetKeyPhraseExtractionParams (Dictionary< string, string > value)
	Sets value for keyPhraseExtractionParams More...
TextAnalyze	SetLanguage (string[] value)
	Sets value for language More...
TextAnalyze	SetLanguageCol (string value)
	Sets value for language column More...
TextAnalyze	SetMaxPollingRetries (int value)
	Sets value for maxPollingRetries More...
TextAnalyze	SetModelVersion (string value)
	Sets value for modelVersion More...
TextAnalyze	SetModelVersionCol (string value)
	Sets value for modelVersion column More...
TextAnalyze	SetOutputCol (string value)
	Sets value for outputCol More...
TextAnalyze	SetPiiParams (Dictionary< string, string > value)
	Sets value for piiParams More...
TextAnalyze	SetPollingDelay (int value)
	Sets value for pollingDelay More...
TextAnalyze	SetSentimentAnalysisParams (Dictionary< string, string > value)
	Sets value for sentimentAnalysisParams More...
TextAnalyze	SetShowStats (bool value)
	Sets value for showStats More...
TextAnalyze	SetShowStatsCol (string value)
	Sets value for showStats column More...
TextAnalyze	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...
TextAnalyze	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...
TextAnalyze	SetSuppressMaxRetriesException (bool value)
	Sets value for suppressMaxRetriesException More...
TextAnalyze	SetText (string[] value)
	Sets value for text More...
TextAnalyze	SetTextCol (string value)
	Sets value for text column More...
TextAnalyze	SetTimeout (double value)
	Sets value for timeout More...
TextAnalyze	SetUrl (string value)
	Sets value for url More...
int[]	GetBackoffs ()
	Gets backoffs value More...
int	GetBatchSize ()
	Gets batchSize value More...
int	GetConcurrency ()
	Gets concurrency value More...
double	GetConcurrentTimeout ()
	Gets concurrentTimeout value More...
bool	GetDisableServiceLogs ()
	Gets disableServiceLogs value More...
Dictionary< string, string >	GetEntityLinkingParams ()
	Gets entityLinkingParams value More...
Dictionary< string, string >	GetEntityRecognitionParams ()
	Gets entityRecognitionParams value More...
string	GetErrorCol ()
	Gets errorCol value More...
bool	GetIncludeEntityLinking ()
	Gets includeEntityLinking value More...
bool	GetIncludeEntityRecognition ()
	Gets includeEntityRecognition value More...
bool	GetIncludeKeyPhraseExtraction ()
	Gets includeKeyPhraseExtraction value More...
bool	GetIncludePii ()
	Gets includePii value More...
bool	GetIncludeSentimentAnalysis ()
	Gets includeSentimentAnalysis value More...
int	GetInitialPollingDelay ()
	Gets initialPollingDelay value More...
Dictionary< string, string >	GetKeyPhraseExtractionParams ()
	Gets keyPhraseExtractionParams value More...
string[]	GetLanguage ()
	Gets language value More...
int	GetMaxPollingRetries ()
	Gets maxPollingRetries value More...
string	GetModelVersion ()
	Gets modelVersion value More...
string	GetOutputCol ()
	Gets outputCol value More...
Dictionary< string, string >	GetPiiParams ()
	Gets piiParams value More...
int	GetPollingDelay ()
	Gets pollingDelay value More...
Dictionary< string, string >	GetSentimentAnalysisParams ()
	Gets sentimentAnalysisParams value More...
bool	GetShowStats ()
	Gets showStats value More...
string	GetSubscriptionKey ()
	Gets subscriptionKey value More...
bool	GetSuppressMaxRetriesException ()
	Gets suppressMaxRetriesException 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< TextAnalyze >	Read ()
	Get the corresponding JavaMLReader instance. More...
TextAnalyze	SetLocation (string value)
	Sets value for location More...
TextAnalyze	SetLinkedService (string value)
	Sets value for linkedService More...

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

Detailed Description

TextAnalyze implements TextAnalyze

Constructor & Destructor Documentation

TextAnalyze() [1/2]

Synapse.ML.Cognitive.TextAnalyze.TextAnalyze ( )

inline

Creates a TextAnalyze without any parameters.

TextAnalyze() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetBackoffs()

int [] Synapse.ML.Cognitive.TextAnalyze.GetBackoffs

(

)

Gets backoffs value

Returns

backoffs: array of backoffs to use in the handler

GetBatchSize()

int Synapse.ML.Cognitive.TextAnalyze.GetBatchSize

(

)

Gets batchSize value

Returns

batchSize: The max size of the buffer

GetConcurrency()

int Synapse.ML.Cognitive.TextAnalyze.GetConcurrency

(

)

Gets concurrency value

Returns

concurrency: max number of concurrent calls

GetConcurrentTimeout()

double Synapse.ML.Cognitive.TextAnalyze.GetConcurrentTimeout

(

)

Gets concurrentTimeout value

Returns

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

GetDisableServiceLogs()

bool Synapse.ML.Cognitive.TextAnalyze.GetDisableServiceLogs

(

)

Gets disableServiceLogs value

Returns

disableServiceLogs: disableServiceLogs option

GetEntityLinkingParams()

Dictionary<string, string> Synapse.ML.Cognitive.TextAnalyze.GetEntityLinkingParams ( )

inline

Gets entityLinkingParams value

Returns

entityLinkingParams: the parameters to pass to the entityLinking model

GetEntityRecognitionParams()

Dictionary<string, string> Synapse.ML.Cognitive.TextAnalyze.GetEntityRecognitionParams ( )

inline

Gets entityRecognitionParams value

Returns

entityRecognitionParams: the parameters to pass to the entity recognition model

GetErrorCol()

string Synapse.ML.Cognitive.TextAnalyze.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetIncludeEntityLinking()

bool Synapse.ML.Cognitive.TextAnalyze.GetIncludeEntityLinking

(

)

Gets includeEntityLinking value

Returns

includeEntityLinking: Whether to perform EntityLinking

GetIncludeEntityRecognition()

bool Synapse.ML.Cognitive.TextAnalyze.GetIncludeEntityRecognition

(

)

Gets includeEntityRecognition value

Returns

includeEntityRecognition: Whether to perform entity recognition

GetIncludeKeyPhraseExtraction()

bool Synapse.ML.Cognitive.TextAnalyze.GetIncludeKeyPhraseExtraction

(

)

Gets includeKeyPhraseExtraction value

Returns

includeKeyPhraseExtraction: Whether to perform EntityLinking

GetIncludePii()

bool Synapse.ML.Cognitive.TextAnalyze.GetIncludePii

(

)

Gets includePii value

Returns

includePii: Whether to perform PII Detection

GetIncludeSentimentAnalysis()

bool Synapse.ML.Cognitive.TextAnalyze.GetIncludeSentimentAnalysis

(

)

Gets includeSentimentAnalysis value

Returns

includeSentimentAnalysis: Whether to perform SentimentAnalysis

GetInitialPollingDelay()

int Synapse.ML.Cognitive.TextAnalyze.GetInitialPollingDelay

(

)

Gets initialPollingDelay value

Returns

initialPollingDelay: number of milliseconds to wait before first poll for result

GetKeyPhraseExtractionParams()

Dictionary<string, string> Synapse.ML.Cognitive.TextAnalyze.GetKeyPhraseExtractionParams ( )

inline

Gets keyPhraseExtractionParams value

Returns

keyPhraseExtractionParams: the parameters to pass to the keyPhraseExtraction model

GetLanguage()

string [] Synapse.ML.Cognitive.TextAnalyze.GetLanguage

(

)

Gets language value

Returns

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

GetMaxPollingRetries()

int Synapse.ML.Cognitive.TextAnalyze.GetMaxPollingRetries

(

)

Gets maxPollingRetries value

Returns

maxPollingRetries: number of times to poll

GetModelVersion()

string Synapse.ML.Cognitive.TextAnalyze.GetModelVersion

(

)

Gets modelVersion value

Returns

modelVersion: Version of the model

GetOutputCol()

string Synapse.ML.Cognitive.TextAnalyze.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetPiiParams()

Dictionary<string, string> Synapse.ML.Cognitive.TextAnalyze.GetPiiParams ( )

inline

Gets piiParams value

Returns

piiParams: the parameters to pass to the PII model

GetPollingDelay()

int Synapse.ML.Cognitive.TextAnalyze.GetPollingDelay

(

)

Gets pollingDelay value

Returns

pollingDelay: number of milliseconds to wait between polling

GetSentimentAnalysisParams()

Dictionary<string, string> Synapse.ML.Cognitive.TextAnalyze.GetSentimentAnalysisParams ( )

inline

Gets sentimentAnalysisParams value

Returns

sentimentAnalysisParams: the parameters to pass to the sentimentAnalysis model

GetShowStats()

bool Synapse.ML.Cognitive.TextAnalyze.GetShowStats

(

)

Gets showStats value

Returns

showStats: Whether to include detailed statistics in the response

GetSubscriptionKey()

string Synapse.ML.Cognitive.TextAnalyze.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetSuppressMaxRetriesException()

bool Synapse.ML.Cognitive.TextAnalyze.GetSuppressMaxRetriesException

(

)

Gets suppressMaxRetriesException value

Returns

suppressMaxRetriesException: set true to suppress the maxumimum retries exception and report in the error column

GetText()

string [] Synapse.ML.Cognitive.TextAnalyze.GetText

(

)

Gets text value

Returns

text: the text in the request body

GetTimeout()

double Synapse.ML.Cognitive.TextAnalyze.GetTimeout

(

)

Gets timeout value

Returns

timeout: number of seconds to wait before closing the connection

GetUrl()

string Synapse.ML.Cognitive.TextAnalyze.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

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

static

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

Parameters

path	The path the previous TextAnalyze was saved to

Returns

New TextAnalyze object, loaded from path.

Read()

JavaMLReader<TextAnalyze> Synapse.ML.Cognitive.TextAnalyze.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<TextAnalyze> instance for this ML instance.

Save()

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

SetBackoffs()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetBackoffs

(

int[]

value

)

Sets value for backoffs

Parameters

value

array of backoffs to use in the handler

Returns

New TextAnalyze object

SetBatchSize()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetBatchSize

(

int

value

)

Sets value for batchSize

Parameters

value

The max size of the buffer

Returns

New TextAnalyze object

SetConcurrency()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetConcurrency

(

int

value

)

Sets value for concurrency

Parameters

value

max number of concurrent calls

Returns

New TextAnalyze object

SetConcurrentTimeout()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetConcurrentTimeout

(

double

value

)

Sets value for concurrentTimeout

Parameters

value

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

Returns

New TextAnalyze object

SetDisableServiceLogs()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetDisableServiceLogs

(

bool

value

)

Sets value for disableServiceLogs

Parameters

value

disableServiceLogs option

Returns

New TextAnalyze object

SetDisableServiceLogsCol()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetDisableServiceLogsCol

(

string

value

)

Sets value for disableServiceLogs column

Parameters

value

disableServiceLogs option

Returns

New TextAnalyze object

SetEntityLinkingParams()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetEntityLinkingParams

(

Dictionary< string, string >

value

)

Sets value for entityLinkingParams

Parameters

value

the parameters to pass to the entityLinking model

Returns

New TextAnalyze object

SetEntityRecognitionParams()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetEntityRecognitionParams

(

Dictionary< string, string >

value

)

Sets value for entityRecognitionParams

Parameters

value

the parameters to pass to the entity recognition model

Returns

New TextAnalyze object

SetErrorCol()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New TextAnalyze object

SetIncludeEntityLinking()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetIncludeEntityLinking

(

bool

value

)

Sets value for includeEntityLinking

Parameters

value

Whether to perform EntityLinking

Returns

New TextAnalyze object

SetIncludeEntityRecognition()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetIncludeEntityRecognition

(

bool

value

)

Sets value for includeEntityRecognition

Parameters

value

Whether to perform entity recognition

Returns

New TextAnalyze object

SetIncludeKeyPhraseExtraction()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetIncludeKeyPhraseExtraction

(

bool

value

)

Sets value for includeKeyPhraseExtraction

Parameters

value

Whether to perform EntityLinking

Returns

New TextAnalyze object

SetIncludePii()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetIncludePii

(

bool

value

)

Sets value for includePii

Parameters

value

Whether to perform PII Detection

Returns

New TextAnalyze object

SetIncludeSentimentAnalysis()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetIncludeSentimentAnalysis

(

bool

value

)

Sets value for includeSentimentAnalysis

Parameters

value

Whether to perform SentimentAnalysis

Returns

New TextAnalyze object

SetInitialPollingDelay()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetInitialPollingDelay

(

int

value

)

Sets value for initialPollingDelay

Parameters

value

number of milliseconds to wait before first poll for result

Returns

New TextAnalyze object

SetKeyPhraseExtractionParams()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetKeyPhraseExtractionParams

(

Dictionary< string, string >

value

)

Sets value for keyPhraseExtractionParams

Parameters

value

the parameters to pass to the keyPhraseExtraction model

Returns

New TextAnalyze object

SetLanguage()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetLanguage

(

string[]

value

)

Sets value for language

Parameters

value

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

Returns

New TextAnalyze object

SetLanguageCol()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetLanguageCol

(

string

value

)

Sets value for language column

Parameters

value

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

Returns

New TextAnalyze object

SetLinkedService()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetLinkedService

(

string

value

)

Sets value for linkedService

Parameters

value

linkedService name

Returns

New TextAnalyze object

SetLocation()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New TextAnalyze object

SetMaxPollingRetries()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetMaxPollingRetries

(

int

value

)

Sets value for maxPollingRetries

Parameters

value

number of times to poll

Returns

New TextAnalyze object

SetModelVersion()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetModelVersion

(

string

value

)

Sets value for modelVersion

Parameters

value

Version of the model

Returns

New TextAnalyze object

SetModelVersionCol()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetModelVersionCol

(

string

value

)

Sets value for modelVersion column

Parameters

value

Version of the model

Returns

New TextAnalyze object

SetOutputCol()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New TextAnalyze object

SetPiiParams()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetPiiParams

(

Dictionary< string, string >

value

)

Sets value for piiParams

Parameters

value

the parameters to pass to the PII model

Returns

New TextAnalyze object

SetPollingDelay()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetPollingDelay

(

int

value

)

Sets value for pollingDelay

Parameters

value

number of milliseconds to wait between polling

Returns

New TextAnalyze object

SetSentimentAnalysisParams()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetSentimentAnalysisParams

(

Dictionary< string, string >

value

)

Sets value for sentimentAnalysisParams

Parameters

value

the parameters to pass to the sentimentAnalysis model

Returns

New TextAnalyze object

SetShowStats()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetShowStats

(

bool

value

)

Sets value for showStats

Parameters

value

Whether to include detailed statistics in the response

Returns

New TextAnalyze object

SetShowStatsCol()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetShowStatsCol

(

string

value

)

Sets value for showStats column

Parameters

value

Whether to include detailed statistics in the response

Returns

New TextAnalyze object

SetSubscriptionKey()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New TextAnalyze object

SetSubscriptionKeyCol()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New TextAnalyze object

SetSuppressMaxRetriesException()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetSuppressMaxRetriesException

(

bool

value

)

Sets value for suppressMaxRetriesException

Parameters

value

set true to suppress the maxumimum retries exception and report in the error column

Returns

New TextAnalyze object

SetText()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetText

(

string[]

value

)

Sets value for text

Parameters

value

the text in the request body

Returns

New TextAnalyze object

SetTextCol()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetTextCol

(

string

value

)

Sets value for text column

Parameters

value

the text in the request body

Returns

New TextAnalyze object

SetTimeout()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetTimeout

(

double

value

)

Sets value for timeout

Parameters

value

number of seconds to wait before closing the connection

Returns

New TextAnalyze object

SetUrl()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New TextAnalyze object

---

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

• synapse/ml/cognitive/TextAnalyze.cs