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	SetConcurrency (int value)
	Sets value for concurrency More...
TextAnalyze	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...
TextAnalyze	SetEntityLinkingTasks (TextAnalyzeTask[] value)
	Sets value for entityLinkingTasks More...
TextAnalyze	SetEntityRecognitionPiiTasks (TextAnalyzeTask[] value)
	Sets value for entityRecognitionPiiTasks More...
TextAnalyze	SetEntityRecognitionTasks (TextAnalyzeTask[] value)
	Sets value for entityRecognitionTasks More...
TextAnalyze	SetErrorCol (string value)
	Sets value for errorCol More...
TextAnalyze	SetInitialPollingDelay (int value)
	Sets value for initialPollingDelay More...
TextAnalyze	SetKeyPhraseExtractionTasks (TextAnalyzeTask[] value)
	Sets value for keyPhraseExtractionTasks 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	SetOutputCol (string value)
	Sets value for outputCol More...
TextAnalyze	SetPollingDelay (int value)
	Sets value for pollingDelay More...
TextAnalyze	SetSentimentAnalysisTasks (TextAnalyzeTask[] value)
	Sets value for sentimentAnalysisTasks More...
TextAnalyze	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...
TextAnalyze	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...
TextAnalyze	SetSuppressMaxRetriesExceededException (bool value)
	Sets value for suppressMaxRetriesExceededException 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	GetConcurrency ()
	Gets concurrency value More...
double	GetConcurrentTimeout ()
	Gets concurrentTimeout value More...
TextAnalyzeTask []	GetEntityLinkingTasks ()
	Gets entityLinkingTasks value More...
TextAnalyzeTask []	GetEntityRecognitionPiiTasks ()
	Gets entityRecognitionPiiTasks value More...
TextAnalyzeTask []	GetEntityRecognitionTasks ()
	Gets entityRecognitionTasks value More...
string	GetErrorCol ()
	Gets errorCol value More...
int	GetInitialPollingDelay ()
	Gets initialPollingDelay value More...
TextAnalyzeTask []	GetKeyPhraseExtractionTasks ()
	Gets keyPhraseExtractionTasks value More...
string []	GetLanguage ()
	Gets language value More...
int	GetMaxPollingRetries ()
	Gets maxPollingRetries value More...
string	GetOutputCol ()
	Gets outputCol value More...
int	GetPollingDelay ()
	Gets pollingDelay value More...
TextAnalyzeTask []	GetSentimentAnalysisTasks ()
	Gets sentimentAnalysisTasks value More...
string	GetSubscriptionKey ()
	Gets subscriptionKey value More...
bool	GetSuppressMaxRetriesExceededException ()
	Gets suppressMaxRetriesExceededException 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

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

GetEntityLinkingTasks()

TextAnalyzeTask [] Synapse.ML.Cognitive.TextAnalyze.GetEntityLinkingTasks

(

)

Gets entityLinkingTasks value

Returns

entityLinkingTasks: the entity linking tasks to perform on submitted documents

GetEntityRecognitionPiiTasks()

TextAnalyzeTask [] Synapse.ML.Cognitive.TextAnalyze.GetEntityRecognitionPiiTasks

(

)

Gets entityRecognitionPiiTasks value

Returns

entityRecognitionPiiTasks: the entity recognition pii tasks to perform on submitted documents

GetEntityRecognitionTasks()

TextAnalyzeTask [] Synapse.ML.Cognitive.TextAnalyze.GetEntityRecognitionTasks

(

)

Gets entityRecognitionTasks value

Returns

entityRecognitionTasks: the entity recognition tasks to perform on submitted documents

GetErrorCol()

string Synapse.ML.Cognitive.TextAnalyze.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetInitialPollingDelay()

int Synapse.ML.Cognitive.TextAnalyze.GetInitialPollingDelay

(

)

Gets initialPollingDelay value

Returns

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

GetKeyPhraseExtractionTasks()

TextAnalyzeTask [] Synapse.ML.Cognitive.TextAnalyze.GetKeyPhraseExtractionTasks

(

)

Gets keyPhraseExtractionTasks value

Returns

keyPhraseExtractionTasks: the key phrase extraction tasks to perform on submitted documents

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

GetOutputCol()

string Synapse.ML.Cognitive.TextAnalyze.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetPollingDelay()

int Synapse.ML.Cognitive.TextAnalyze.GetPollingDelay

(

)

Gets pollingDelay value

Returns

pollingDelay: number of milliseconds to wait between polling

GetSentimentAnalysisTasks()

TextAnalyzeTask [] Synapse.ML.Cognitive.TextAnalyze.GetSentimentAnalysisTasks

(

)

Gets sentimentAnalysisTasks value

Returns

sentimentAnalysisTasks: the sentiment analysis tasks to perform on submitted documents

GetSubscriptionKey()

string Synapse.ML.Cognitive.TextAnalyze.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetSuppressMaxRetriesExceededException()

bool Synapse.ML.Cognitive.TextAnalyze.GetSuppressMaxRetriesExceededException

(

)

Gets suppressMaxRetriesExceededException value

Returns

suppressMaxRetriesExceededException: 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

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

SetEntityLinkingTasks()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetEntityLinkingTasks

(

TextAnalyzeTask []

value

)

Sets value for entityLinkingTasks

Parameters

value

the entity linking tasks to perform on submitted documents

Returns

New TextAnalyze object

SetEntityRecognitionPiiTasks()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetEntityRecognitionPiiTasks

(

TextAnalyzeTask []

value

)

Sets value for entityRecognitionPiiTasks

Parameters

value

the entity recognition pii tasks to perform on submitted documents

Returns

New TextAnalyze object

SetEntityRecognitionTasks()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetEntityRecognitionTasks

(

TextAnalyzeTask []

value

)

Sets value for entityRecognitionTasks

Parameters

value

the entity recognition tasks to perform on submitted documents

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

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

SetKeyPhraseExtractionTasks()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetKeyPhraseExtractionTasks

(

TextAnalyzeTask []

value

)

Sets value for keyPhraseExtractionTasks

Parameters

value

the key phrase extraction tasks to perform on submitted documents

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

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

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

SetSentimentAnalysisTasks()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetSentimentAnalysisTasks

(

TextAnalyzeTask []

value

)

Sets value for sentimentAnalysisTasks

Parameters

value

the sentiment analysis tasks to perform on submitted documents

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

SetSuppressMaxRetriesExceededException()

TextAnalyze Synapse.ML.Cognitive.TextAnalyze.SetSuppressMaxRetriesExceededException

(

bool

value

)

Sets value for suppressMaxRetriesExceededException

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