Synapse.ML.Cognitive.KeyPhraseExtractor Class Reference

KeyPhraseExtractor implements KeyPhraseExtractor More...

Inheritance diagram for Synapse.ML.Cognitive.KeyPhraseExtractor:

Collaboration diagram for Synapse.ML.Cognitive.KeyPhraseExtractor:

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

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

Detailed Description

KeyPhraseExtractor implements KeyPhraseExtractor

Constructor & Destructor Documentation

KeyPhraseExtractor() [1/2]

Synapse.ML.Cognitive.KeyPhraseExtractor.KeyPhraseExtractor ( )

inline

Creates a KeyPhraseExtractor without any parameters.

KeyPhraseExtractor() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetConcurrency()

int Synapse.ML.Cognitive.KeyPhraseExtractor.GetConcurrency

(

)

Gets concurrency value

Returns

concurrency: max number of concurrent calls

GetConcurrentTimeout()

double Synapse.ML.Cognitive.KeyPhraseExtractor.GetConcurrentTimeout

(

)

Gets concurrentTimeout value

Returns

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

GetErrorCol()

string Synapse.ML.Cognitive.KeyPhraseExtractor.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetHandler()

object Synapse.ML.Cognitive.KeyPhraseExtractor.GetHandler

(

)

Gets handler value

Returns

handler: Which strategy to use when handling requests

GetLanguage()

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

(

)

Gets language value

Returns

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

GetModelVersion()

string Synapse.ML.Cognitive.KeyPhraseExtractor.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.

GetOutputCol()

string Synapse.ML.Cognitive.KeyPhraseExtractor.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetShowStats()

bool Synapse.ML.Cognitive.KeyPhraseExtractor.GetShowStats

(

)

Gets showStats value

Returns

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

GetStringIndexType()

string Synapse.ML.Cognitive.KeyPhraseExtractor.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.KeyPhraseExtractor.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetText()

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

(

)

Gets text value

Returns

text: the text in the request body

GetTimeout()

double Synapse.ML.Cognitive.KeyPhraseExtractor.GetTimeout

(

)

Gets timeout value

Returns

timeout: number of seconds to wait before closing the connection

GetUrl()

string Synapse.ML.Cognitive.KeyPhraseExtractor.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

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

static

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

Parameters

path	The path the previous KeyPhraseExtractor was saved to

Returns

New KeyPhraseExtractor object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<KeyPhraseExtractor> instance for this ML instance.

Save()

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

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetConcurrency

(

int

value

)

Sets value for concurrency

Parameters

value

max number of concurrent calls

Returns

New KeyPhraseExtractor object

SetConcurrentTimeout()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetConcurrentTimeout

(

double

value

)

Sets value for concurrentTimeout

Parameters

value

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

Returns

New KeyPhraseExtractor object

SetErrorCol()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New KeyPhraseExtractor object

SetHandler()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetHandler

(

object

value

)

Sets value for handler

Parameters

value

Which strategy to use when handling requests

Returns

New KeyPhraseExtractor object

SetLanguage()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetLanguage

(

string []

value

)

Sets value for language

Parameters

value

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

Returns

New KeyPhraseExtractor object

SetLanguageCol()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetLanguageCol

(

string

value

)

Sets value for language column

Parameters

value

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

Returns

New KeyPhraseExtractor object

SetLinkedService()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetLinkedService

(

string

value

)

Sets value for linkedService

Parameters

value

linkedService name

Returns

New KeyPhraseExtractor object

SetLocation()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New KeyPhraseExtractor object

SetModelVersion()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetModelVersion

(

string

value

)

Sets value for modelVersion

Parameters

value

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.

Returns

New KeyPhraseExtractor object

SetModelVersionCol()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetModelVersionCol

(

string

value

)

Sets value for modelVersion column

Parameters

value

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.

Returns

New KeyPhraseExtractor object

SetOutputCol()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New KeyPhraseExtractor object

SetShowStats()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetShowStats

(

bool

value

)

Sets value for showStats

Parameters

value

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

Returns

New KeyPhraseExtractor object

SetShowStatsCol()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetShowStatsCol

(

string

value

)

Sets value for showStats column

Parameters

value

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

Returns

New KeyPhraseExtractor object

SetStringIndexType()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetStringIndexType

(

string

value

)

Sets value for stringIndexType

Parameters

value

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

Returns

New KeyPhraseExtractor object

SetStringIndexTypeCol()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetStringIndexTypeCol

(

string

value

)

Sets value for stringIndexType column

Parameters

value

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

Returns

New KeyPhraseExtractor object

SetSubscriptionKey()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New KeyPhraseExtractor object

SetSubscriptionKeyCol()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New KeyPhraseExtractor object

SetText()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetText

(

string []

value

)

Sets value for text

Parameters

value

the text in the request body

Returns

New KeyPhraseExtractor object

SetTextCol()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetTextCol

(

string

value

)

Sets value for text column

Parameters

value

the text in the request body

Returns

New KeyPhraseExtractor object

SetTimeout()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetTimeout

(

double

value

)

Sets value for timeout

Parameters

value

number of seconds to wait before closing the connection

Returns

New KeyPhraseExtractor object

SetUrl()

KeyPhraseExtractor Synapse.ML.Cognitive.KeyPhraseExtractor.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New KeyPhraseExtractor object

---

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

• synapse/ml/cognitive/KeyPhraseExtractor.cs