Synapse.ML.Cognitive.KeyPhraseExtractorSDK Class Reference

KeyPhraseExtractorSDK implements KeyPhraseExtractorSDK More...

Inheritance diagram for Synapse.ML.Cognitive.KeyPhraseExtractorSDK:

Collaboration diagram for Synapse.ML.Cognitive.KeyPhraseExtractorSDK:

Public Member Functions
	KeyPhraseExtractorSDK ()
	Creates a KeyPhraseExtractorSDK without any parameters. More...
	KeyPhraseExtractorSDK (string uid)
	Creates a KeyPhraseExtractorSDK with a UID that is used to give the KeyPhraseExtractorSDK a unique ID. More...
KeyPhraseExtractorSDK	SetBatchSize (int value)
	Sets value for batchSize More...
KeyPhraseExtractorSDK	SetConcurrency (int value)
	Sets value for concurrency More...
KeyPhraseExtractorSDK	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...
KeyPhraseExtractorSDK	SetDisableServiceLogs (bool value)
	Sets value for disableServiceLogs More...
KeyPhraseExtractorSDK	SetDisableServiceLogsCol (string value)
	Sets value for disableServiceLogs column More...
KeyPhraseExtractorSDK	SetErrorCol (string value)
	Sets value for errorCol More...
KeyPhraseExtractorSDK	SetIncludeStatistics (bool value)
	Sets value for includeStatistics More...
KeyPhraseExtractorSDK	SetIncludeStatisticsCol (string value)
	Sets value for includeStatistics column More...
KeyPhraseExtractorSDK	SetLanguage (string[] value)
	Sets value for language More...
KeyPhraseExtractorSDK	SetLanguageCol (string value)
	Sets value for language column More...
KeyPhraseExtractorSDK	SetModelVersion (string value)
	Sets value for modelVersion More...
KeyPhraseExtractorSDK	SetModelVersionCol (string value)
	Sets value for modelVersion column More...
KeyPhraseExtractorSDK	SetOutputCol (string value)
	Sets value for outputCol More...
KeyPhraseExtractorSDK	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...
KeyPhraseExtractorSDK	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...
KeyPhraseExtractorSDK	SetText (string[] value)
	Sets value for text More...
KeyPhraseExtractorSDK	SetTextCol (string value)
	Sets value for text column More...
KeyPhraseExtractorSDK	SetTimeout (double value)
	Sets value for timeout More...
KeyPhraseExtractorSDK	SetUrl (string value)
	Sets value for url 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...
string	GetErrorCol ()
	Gets errorCol value More...
bool	GetIncludeStatistics ()
	Gets includeStatistics value More...
string []	GetLanguage ()
	Gets language value More...
string	GetModelVersion ()
	Gets modelVersion value More...
string	GetOutputCol ()
	Gets outputCol 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< KeyPhraseExtractorSDK >	Read ()
	Get the corresponding JavaMLReader instance. More...
KeyPhraseExtractorSDK	SetLocation (string value)
	Sets value for location More...

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

Detailed Description

KeyPhraseExtractorSDK implements KeyPhraseExtractorSDK

Constructor & Destructor Documentation

KeyPhraseExtractorSDK() [1/2]

Synapse.ML.Cognitive.KeyPhraseExtractorSDK.KeyPhraseExtractorSDK ( )

inline

Creates a KeyPhraseExtractorSDK without any parameters.

KeyPhraseExtractorSDK() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetBatchSize()

int Synapse.ML.Cognitive.KeyPhraseExtractorSDK.GetBatchSize

(

)

Gets batchSize value

Returns

batchSize: The max size of the buffer

GetConcurrency()

int Synapse.ML.Cognitive.KeyPhraseExtractorSDK.GetConcurrency

(

)

Gets concurrency value

Returns

concurrency: max number of concurrent calls

GetConcurrentTimeout()

double Synapse.ML.Cognitive.KeyPhraseExtractorSDK.GetConcurrentTimeout

(

)

Gets concurrentTimeout value

Returns

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

GetDisableServiceLogs()

bool Synapse.ML.Cognitive.KeyPhraseExtractorSDK.GetDisableServiceLogs

(

)

Gets disableServiceLogs value

Returns

disableServiceLogs: disableServiceLogs option

GetErrorCol()

string Synapse.ML.Cognitive.KeyPhraseExtractorSDK.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetIncludeStatistics()

bool Synapse.ML.Cognitive.KeyPhraseExtractorSDK.GetIncludeStatistics

(

)

Gets includeStatistics value

Returns

includeStatistics: includeStatistics option

GetLanguage()

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

(

)

Gets language value

Returns

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

GetModelVersion()

string Synapse.ML.Cognitive.KeyPhraseExtractorSDK.GetModelVersion

(

)

Gets modelVersion value

Returns

modelVersion: modelVersion option

GetOutputCol()

string Synapse.ML.Cognitive.KeyPhraseExtractorSDK.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetSubscriptionKey()

string Synapse.ML.Cognitive.KeyPhraseExtractorSDK.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetText()

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

(

)

Gets text value

Returns

text: the text in the request body

GetTimeout()

double Synapse.ML.Cognitive.KeyPhraseExtractorSDK.GetTimeout

(

)

Gets timeout value

Returns

timeout: number of seconds to wait before closing the connection

GetUrl()

string Synapse.ML.Cognitive.KeyPhraseExtractorSDK.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

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

static

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

Parameters

path	The path the previous KeyPhraseExtractorSDK was saved to

Returns

New KeyPhraseExtractorSDK object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<KeyPhraseExtractorSDK> instance for this ML instance.

Save()

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

SetBatchSize()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetBatchSize

(

int

value

)

Sets value for batchSize

Parameters

value

The max size of the buffer

Returns

New KeyPhraseExtractorSDK object

SetConcurrency()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetConcurrency

(

int

value

)

Sets value for concurrency

Parameters

value

max number of concurrent calls

Returns

New KeyPhraseExtractorSDK object

SetConcurrentTimeout()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetConcurrentTimeout

(

double

value

)

Sets value for concurrentTimeout

Parameters

value

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

Returns

New KeyPhraseExtractorSDK object

SetDisableServiceLogs()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetDisableServiceLogs

(

bool

value

)

Sets value for disableServiceLogs

Parameters

value

disableServiceLogs option

Returns

New KeyPhraseExtractorSDK object

SetDisableServiceLogsCol()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetDisableServiceLogsCol

(

string

value

)

Sets value for disableServiceLogs column

Parameters

value

disableServiceLogs option

Returns

New KeyPhraseExtractorSDK object

SetErrorCol()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New KeyPhraseExtractorSDK object

SetIncludeStatistics()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetIncludeStatistics

(

bool

value

)

Sets value for includeStatistics

Parameters

value

includeStatistics option

Returns

New KeyPhraseExtractorSDK object

SetIncludeStatisticsCol()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetIncludeStatisticsCol

(

string

value

)

Sets value for includeStatistics column

Parameters

value

includeStatistics option

Returns

New KeyPhraseExtractorSDK object

SetLanguage()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetLanguage

(

string []

value

)

Sets value for language

Parameters

value

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

Returns

New KeyPhraseExtractorSDK object

SetLanguageCol()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetLanguageCol

(

string

value

)

Sets value for language column

Parameters

value

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

Returns

New KeyPhraseExtractorSDK object

SetLocation()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New KeyPhraseExtractorSDK object

SetModelVersion()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetModelVersion

(

string

value

)

Sets value for modelVersion

Parameters

value

modelVersion option

Returns

New KeyPhraseExtractorSDK object

SetModelVersionCol()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetModelVersionCol

(

string

value

)

Sets value for modelVersion column

Parameters

value

modelVersion option

Returns

New KeyPhraseExtractorSDK object

SetOutputCol()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New KeyPhraseExtractorSDK object

SetSubscriptionKey()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New KeyPhraseExtractorSDK object

SetSubscriptionKeyCol()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New KeyPhraseExtractorSDK object

SetText()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetText

(

string []

value

)

Sets value for text

Parameters

value

the text in the request body

Returns

New KeyPhraseExtractorSDK object

SetTextCol()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetTextCol

(

string

value

)

Sets value for text column

Parameters

value

the text in the request body

Returns

New KeyPhraseExtractorSDK object

SetTimeout()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetTimeout

(

double

value

)

Sets value for timeout

Parameters

value

number of seconds to wait before closing the connection

Returns

New KeyPhraseExtractorSDK object

SetUrl()

KeyPhraseExtractorSDK Synapse.ML.Cognitive.KeyPhraseExtractorSDK.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New KeyPhraseExtractorSDK object

---

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

• synapse/ml/cognitive/KeyPhraseExtractorSDK.cs