EntityDetector implements EntityDetector More...

Inheritance diagram for Synapse.ML.Cognitive.EntityDetector:

[legend]

Collaboration diagram for Synapse.ML.Cognitive.EntityDetector:

[legend]

Public Member Functions
	EntityDetector ()
	Creates a EntityDetector without any parameters. More...

	EntityDetector (string uid)
	Creates a EntityDetector with a UID that is used to give the EntityDetector a unique ID. More...

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

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

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

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

EntityDetector	SetDisableServiceLogsCol (string value)
	Sets value for disableServiceLogs column More...

EntityDetector	SetErrorCol (string value)
	Sets value for errorCol More...

EntityDetector	SetHandler (object value)
	Sets value for handler More...

EntityDetector	SetLanguage (string[] value)
	Sets value for language More...

EntityDetector	SetLanguageCol (string value)
	Sets value for language column More...

EntityDetector	SetModelVersion (string value)
	Sets value for modelVersion More...

EntityDetector	SetModelVersionCol (string value)
	Sets value for modelVersion column More...

EntityDetector	SetOutputCol (string value)
	Sets value for outputCol More...

EntityDetector	SetShowStats (bool value)
	Sets value for showStats More...

EntityDetector	SetShowStatsCol (string value)
	Sets value for showStats column More...

EntityDetector	SetStringIndexType (string value)
	Sets value for stringIndexType More...

EntityDetector	SetStringIndexTypeCol (string value)
	Sets value for stringIndexType column More...

EntityDetector	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...

EntityDetector	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...

EntityDetector	SetText (string[] value)
	Sets value for text More...

EntityDetector	SetTextCol (string value)
	Sets value for text column More...

EntityDetector	SetTimeout (double value)
	Sets value for timeout More...

EntityDetector	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...

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< EntityDetector >	Read ()
	Get the corresponding JavaMLReader instance. More...

EntityDetector	SetLocation (string value)
	Sets value for location More...

EntityDetector	SetLinkedService (string value)
	Sets value for linkedService More...

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

Detailed Description

EntityDetector implements EntityDetector

Constructor & Destructor Documentation

◆ EntityDetector() [1/2]

Synapse.ML.Cognitive.EntityDetector.EntityDetector ( )

inline

Creates a EntityDetector without any parameters.

◆ EntityDetector() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetBatchSize()

int Synapse.ML.Cognitive.EntityDetector.GetBatchSize ( )

Gets batchSize value

Returns: batchSize: The max size of the buffer

◆ GetConcurrency()

int Synapse.ML.Cognitive.EntityDetector.GetConcurrency ( )

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Cognitive.EntityDetector.GetConcurrentTimeout ( )

Gets concurrentTimeout value

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

◆ GetDisableServiceLogs()

bool Synapse.ML.Cognitive.EntityDetector.GetDisableServiceLogs ( )

Gets disableServiceLogs value

Returns: disableServiceLogs: disableServiceLogs option

◆ GetErrorCol()

string Synapse.ML.Cognitive.EntityDetector.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetHandler()

object Synapse.ML.Cognitive.EntityDetector.GetHandler ( )

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetLanguage()

string [] Synapse.ML.Cognitive.EntityDetector.GetLanguage ( )

Gets language value

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

◆ GetModelVersion()

string Synapse.ML.Cognitive.EntityDetector.GetModelVersion ( )

Gets modelVersion value

Returns: modelVersion: Version of the model

◆ GetOutputCol()

string Synapse.ML.Cognitive.EntityDetector.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetShowStats()

bool Synapse.ML.Cognitive.EntityDetector.GetShowStats ( )

Gets showStats value

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

◆ GetStringIndexType()

string Synapse.ML.Cognitive.EntityDetector.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.EntityDetector.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetText()

string [] Synapse.ML.Cognitive.EntityDetector.GetText ( )

Gets text value

Returns: text: the text in the request body

◆ GetTimeout()

double Synapse.ML.Cognitive.EntityDetector.GetTimeout ( )

Gets timeout value

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

◆ GetUrl()

string Synapse.ML.Cognitive.EntityDetector.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ Load()

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

static

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

Parameters

path	The path the previous EntityDetector was saved to

Returns: New EntityDetector object, loaded from path.

◆ Read()

JavaMLReader<EntityDetector> Synapse.ML.Cognitive.EntityDetector.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetBatchSize ( int value )

Sets value for batchSize

Parameters

value The max size of the buffer

Returns: New EntityDetector object

◆ SetConcurrency()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetConcurrency ( int value )

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New EntityDetector object

◆ SetConcurrentTimeout()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetConcurrentTimeout ( double value )

Sets value for concurrentTimeout

Parameters

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

Returns: New EntityDetector object

◆ SetDisableServiceLogs()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetDisableServiceLogs ( bool value )

Sets value for disableServiceLogs

Parameters

value disableServiceLogs option

Returns: New EntityDetector object

◆ SetDisableServiceLogsCol()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetDisableServiceLogsCol ( string value )

Sets value for disableServiceLogs column

Parameters

value disableServiceLogs option

Returns: New EntityDetector object

◆ SetErrorCol()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New EntityDetector object

◆ SetHandler()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetHandler ( object value )

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New EntityDetector object

◆ SetLanguage()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetLanguage ( string[] value )

Sets value for language

Parameters

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

Returns: New EntityDetector object

◆ SetLanguageCol()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetLanguageCol ( string value )

Sets value for language column

Parameters

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

Returns: New EntityDetector object

◆ SetLinkedService()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetLinkedService ( string value )

Sets value for linkedService

Parameters

value linkedService name

Returns: New EntityDetector object

◆ SetLocation()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetLocation ( string value )

Sets value for location

Parameters

value Location of the cognitive service

Returns: New EntityDetector object

◆ SetModelVersion()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetModelVersion ( string value )

Sets value for modelVersion

Parameters

value Version of the model

Returns: New EntityDetector object

◆ SetModelVersionCol()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetModelVersionCol ( string value )

Sets value for modelVersion column

Parameters

value Version of the model

Returns: New EntityDetector object

◆ SetOutputCol()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value The name of the output column

Returns: New EntityDetector object

◆ SetShowStats()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetShowStats ( bool value )

Sets value for showStats

Parameters

value Whether to include detailed statistics in the response

Returns: New EntityDetector object

◆ SetShowStatsCol()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetShowStatsCol ( string value )

Sets value for showStats column

Parameters

value Whether to include detailed statistics in the response

Returns: New EntityDetector object

◆ SetStringIndexType()

EntityDetector Synapse.ML.Cognitive.EntityDetector.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 EntityDetector object

◆ SetStringIndexTypeCol()

EntityDetector Synapse.ML.Cognitive.EntityDetector.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 EntityDetector object

◆ SetSubscriptionKey()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New EntityDetector object

◆ SetSubscriptionKeyCol()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New EntityDetector object

◆ SetText()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetText ( string[] value )

Sets value for text

Parameters

value the text in the request body

Returns: New EntityDetector object

◆ SetTextCol()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetTextCol ( string value )

Sets value for text column

Parameters

value the text in the request body

Returns: New EntityDetector object

◆ SetTimeout()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetTimeout ( double value )

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New EntityDetector object

◆ SetUrl()

EntityDetector Synapse.ML.Cognitive.EntityDetector.SetUrl ( string value )

Sets value for url

Parameters

value Url of the service

Returns: New EntityDetector object

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

synapse/ml/cognitive/EntityDetector.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ EntityDetector() [1/2]

◆ EntityDetector() [2/2]

Member Function Documentation

◆ GetBatchSize()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetDisableServiceLogs()

◆ GetErrorCol()

◆ GetHandler()

◆ GetLanguage()

◆ GetModelVersion()

◆ GetOutputCol()

◆ GetShowStats()

◆ GetStringIndexType()

◆ GetSubscriptionKey()

◆ GetText()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetBatchSize()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetDisableServiceLogs()

◆ SetDisableServiceLogsCol()

◆ SetErrorCol()

◆ SetHandler()

◆ SetLanguage()

◆ SetLanguageCol()

◆ SetLinkedService()

◆ SetLocation()

◆ SetModelVersion()

◆ SetModelVersionCol()

◆ SetOutputCol()

◆ SetShowStats()

◆ SetShowStatsCol()

◆ SetStringIndexType()

◆ SetStringIndexTypeCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetText()

◆ SetTextCol()

◆ SetTimeout()

◆ SetUrl()