KeyPhraseExtractor implements KeyPhraseExtractor More...

Inheritance diagram for Synapse.ML.Services.Text.KeyPhraseExtractor:

[legend]

Collaboration diagram for Synapse.ML.Services.Text.KeyPhraseExtractor:

[legend]

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	SetAADToken (string value)
	Sets value for AADToken More...

KeyPhraseExtractor	SetAADTokenCol (string value)
	Sets value for AADToken column More...

KeyPhraseExtractor	SetCustomAuthHeader (string value)
	Sets value for CustomAuthHeader More...

KeyPhraseExtractor	SetCustomAuthHeaderCol (string value)
	Sets value for CustomAuthHeader column More...

KeyPhraseExtractor	SetBatchSize (int value)
	Sets value for batchSize More...

KeyPhraseExtractor	SetConcurrency (int value)
	Sets value for concurrency More...

KeyPhraseExtractor	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...

KeyPhraseExtractor	SetDisableServiceLogs (bool value)
	Sets value for disableServiceLogs More...

KeyPhraseExtractor	SetDisableServiceLogsCol (string value)
	Sets value for disableServiceLogs column 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...

string	GetAADToken ()
	Gets AADToken value More...

string	GetCustomAuthHeader ()
	Gets CustomAuthHeader 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...

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	SetCustomServiceName (string value)
	Sets value for service name More...

KeyPhraseExtractor	SetEndpoint (string value)
	Sets value for endpoint 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.Services.Text.KeyPhraseExtractor.KeyPhraseExtractor ( )

inline

Creates a KeyPhraseExtractor without any parameters.

◆ KeyPhraseExtractor() [2/2]

Synapse.ML.Services.Text.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

◆ GetAADToken()

string Synapse.ML.Services.Text.KeyPhraseExtractor.GetAADToken ( )

Gets AADToken value

Returns: AADToken: AAD Token used for authentication

◆ GetBatchSize()

int Synapse.ML.Services.Text.KeyPhraseExtractor.GetBatchSize ( )

Gets batchSize value

Returns: batchSize: The max size of the buffer

◆ GetConcurrency()

int Synapse.ML.Services.Text.KeyPhraseExtractor.GetConcurrency ( )

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Services.Text.KeyPhraseExtractor.GetConcurrentTimeout ( )

Gets concurrentTimeout value

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

◆ GetCustomAuthHeader()

string Synapse.ML.Services.Text.KeyPhraseExtractor.GetCustomAuthHeader ( )

Gets CustomAuthHeader value

Returns: CustomAuthHeader: A Custom Value for Authorization Header

◆ GetDisableServiceLogs()

bool Synapse.ML.Services.Text.KeyPhraseExtractor.GetDisableServiceLogs ( )

Gets disableServiceLogs value

Returns: disableServiceLogs: disableServiceLogs option

◆ GetErrorCol()

string Synapse.ML.Services.Text.KeyPhraseExtractor.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetHandler()

object Synapse.ML.Services.Text.KeyPhraseExtractor.GetHandler ( )

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetLanguage()

string [] Synapse.ML.Services.Text.KeyPhraseExtractor.GetLanguage ( )

Gets language value

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

◆ GetModelVersion()

string Synapse.ML.Services.Text.KeyPhraseExtractor.GetModelVersion ( )

Gets modelVersion value

Returns: modelVersion: Version of the model

◆ GetOutputCol()

string Synapse.ML.Services.Text.KeyPhraseExtractor.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetShowStats()

bool Synapse.ML.Services.Text.KeyPhraseExtractor.GetShowStats ( )

Gets showStats value

Returns: showStats: Whether to include detailed statistics in the response

◆ GetStringIndexType()

string Synapse.ML.Services.Text.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.Services.Text.KeyPhraseExtractor.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetText()

string [] Synapse.ML.Services.Text.KeyPhraseExtractor.GetText ( )

Gets text value

Returns: text: the text in the request body

◆ GetTimeout()

double Synapse.ML.Services.Text.KeyPhraseExtractor.GetTimeout ( )

Gets timeout value

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

◆ GetUrl()

string Synapse.ML.Services.Text.KeyPhraseExtractor.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ Load()

static KeyPhraseExtractor Synapse.ML.Services.Text.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.Services.Text.KeyPhraseExtractor.Read ( )

Get the corresponding JavaMLReader instance.

Returns: an JavaMLReader<KeyPhraseExtractor> instance for this ML instance.

◆ Save()

void Synapse.ML.Services.Text.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

◆ SetAADToken()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetAADToken ( string value )

Sets value for AADToken

Parameters

value AAD Token used for authentication

Returns: New KeyPhraseExtractor object

◆ SetAADTokenCol()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetAADTokenCol ( string value )

Sets value for AADToken column

Parameters

value AAD Token used for authentication

Returns: New KeyPhraseExtractor object

◆ SetBatchSize()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetBatchSize ( int value )

Sets value for batchSize

Parameters

value The max size of the buffer

Returns: New KeyPhraseExtractor object

◆ SetConcurrency()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetConcurrency ( int value )

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New KeyPhraseExtractor object

◆ SetConcurrentTimeout()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetConcurrentTimeout ( double value )

Sets value for concurrentTimeout

Parameters

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

Returns: New KeyPhraseExtractor object

◆ SetCustomAuthHeader()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetCustomAuthHeader ( string value )

Sets value for CustomAuthHeader

Parameters

value A Custom Value for Authorization Header

Returns: New KeyPhraseExtractor object

◆ SetCustomAuthHeaderCol()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetCustomAuthHeaderCol ( string value )

Sets value for CustomAuthHeader column

Parameters

value A Custom Value for Authorization Header

Returns: New KeyPhraseExtractor object

◆ SetCustomServiceName()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetCustomServiceName ( string value )

Sets value for service name

Parameters

value Service name of the cognitive service if it's custom domain

Returns: New KeyPhraseExtractor object

◆ SetDisableServiceLogs()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetDisableServiceLogs ( bool value )

Sets value for disableServiceLogs

Parameters

value disableServiceLogs option

Returns: New KeyPhraseExtractor object

◆ SetDisableServiceLogsCol()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetDisableServiceLogsCol ( string value )

Sets value for disableServiceLogs column

Parameters

value disableServiceLogs option

Returns: New KeyPhraseExtractor object

◆ SetEndpoint()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetEndpoint ( string value )

Sets value for endpoint

Parameters

value Endpoint of the cognitive service

Returns: New KeyPhraseExtractor object

◆ SetErrorCol()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New KeyPhraseExtractor object

◆ SetHandler()

KeyPhraseExtractor Synapse.ML.Services.Text.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.Services.Text.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.Services.Text.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.Services.Text.KeyPhraseExtractor.SetLinkedService ( string value )

Sets value for linkedService

Parameters

value linkedService name

Returns: New KeyPhraseExtractor object

◆ SetLocation()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetLocation ( string value )

Sets value for location

Parameters

value Location of the cognitive service

Returns: New KeyPhraseExtractor object

◆ SetModelVersion()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetModelVersion ( string value )

Sets value for modelVersion

Parameters

value Version of the model

Returns: New KeyPhraseExtractor object

◆ SetModelVersionCol()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetModelVersionCol ( string value )

Sets value for modelVersion column

Parameters

value Version of the model

Returns: New KeyPhraseExtractor object

◆ SetOutputCol()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value The name of the output column

Returns: New KeyPhraseExtractor object

◆ SetShowStats()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetShowStats ( bool value )

Sets value for showStats

Parameters

value Whether to include detailed statistics in the response

Returns: New KeyPhraseExtractor object

◆ SetShowStatsCol()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetShowStatsCol ( string value )

Sets value for showStats column

Parameters

value Whether to include detailed statistics in the response

Returns: New KeyPhraseExtractor object

◆ SetStringIndexType()

KeyPhraseExtractor Synapse.ML.Services.Text.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.Services.Text.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.Services.Text.KeyPhraseExtractor.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New KeyPhraseExtractor object

◆ SetSubscriptionKeyCol()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New KeyPhraseExtractor object

◆ SetText()

KeyPhraseExtractor Synapse.ML.Services.Text.KeyPhraseExtractor.SetText ( string[] value )

Sets value for text

Parameters

value the text in the request body

Returns: New KeyPhraseExtractor object

◆ SetTextCol()

KeyPhraseExtractor Synapse.ML.Services.Text.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.Services.Text.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.Services.Text.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/services/text/KeyPhraseExtractor.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ KeyPhraseExtractor() [1/2]

◆ KeyPhraseExtractor() [2/2]

Member Function Documentation

◆ GetAADToken()

◆ GetBatchSize()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetCustomAuthHeader()

◆ GetDisableServiceLogs()

◆ GetErrorCol()

◆ GetHandler()

◆ GetLanguage()

◆ GetModelVersion()

◆ GetOutputCol()

◆ GetShowStats()

◆ GetStringIndexType()

◆ GetSubscriptionKey()

◆ GetText()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAADToken()

◆ SetAADTokenCol()

◆ SetBatchSize()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetCustomAuthHeader()

◆ SetCustomAuthHeaderCol()

◆ SetCustomServiceName()

◆ SetDisableServiceLogs()

◆ SetDisableServiceLogsCol()

◆ SetEndpoint()

◆ SetErrorCol()

◆ SetHandler()

◆ SetLanguage()

◆ SetLanguageCol()

◆ SetLinkedService()

◆ SetLocation()

◆ SetModelVersion()

◆ SetModelVersionCol()

◆ SetOutputCol()

◆ SetShowStats()

◆ SetShowStatsCol()

◆ SetStringIndexType()

◆ SetStringIndexTypeCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetText()

◆ SetTextCol()

◆ SetTimeout()

◆ SetUrl()