Synapse.ML.Cognitive.EntityDetectorSDK Class Reference

EntityDetectorSDK implements EntityDetectorSDK More...

Inheritance diagram for Synapse.ML.Cognitive.EntityDetectorSDK:

Collaboration diagram for Synapse.ML.Cognitive.EntityDetectorSDK:

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

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

Detailed Description

EntityDetectorSDK implements EntityDetectorSDK

Constructor & Destructor Documentation

EntityDetectorSDK() [1/2]

Synapse.ML.Cognitive.EntityDetectorSDK.EntityDetectorSDK ( )

inline

Creates a EntityDetectorSDK without any parameters.

EntityDetectorSDK() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetBatchSize()

int Synapse.ML.Cognitive.EntityDetectorSDK.GetBatchSize

(

)

Gets batchSize value

Returns

batchSize: The max size of the buffer

GetConcurrency()

int Synapse.ML.Cognitive.EntityDetectorSDK.GetConcurrency

(

)

Gets concurrency value

Returns

concurrency: max number of concurrent calls

GetConcurrentTimeout()

double Synapse.ML.Cognitive.EntityDetectorSDK.GetConcurrentTimeout

(

)

Gets concurrentTimeout value

Returns

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

GetDisableServiceLogs()

bool Synapse.ML.Cognitive.EntityDetectorSDK.GetDisableServiceLogs

(

)

Gets disableServiceLogs value

Returns

disableServiceLogs: disableServiceLogs option

GetErrorCol()

string Synapse.ML.Cognitive.EntityDetectorSDK.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetIncludeStatistics()

bool Synapse.ML.Cognitive.EntityDetectorSDK.GetIncludeStatistics

(

)

Gets includeStatistics value

Returns

includeStatistics: includeStatistics option

GetLanguage()

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

(

)

Gets language value

Returns

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

GetModelVersion()

string Synapse.ML.Cognitive.EntityDetectorSDK.GetModelVersion

(

)

Gets modelVersion value

Returns

modelVersion: modelVersion option

GetOutputCol()

string Synapse.ML.Cognitive.EntityDetectorSDK.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetSubscriptionKey()

string Synapse.ML.Cognitive.EntityDetectorSDK.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetText()

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

(

)

Gets text value

Returns

text: the text in the request body

GetTimeout()

double Synapse.ML.Cognitive.EntityDetectorSDK.GetTimeout

(

)

Gets timeout value

Returns

timeout: number of seconds to wait before closing the connection

GetUrl()

string Synapse.ML.Cognitive.EntityDetectorSDK.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

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

static

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

Parameters

path	The path the previous EntityDetectorSDK was saved to

Returns

New EntityDetectorSDK object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<EntityDetectorSDK> instance for this ML instance.

Save()

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

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetBatchSize

(

int

value

)

Sets value for batchSize

Parameters

value

The max size of the buffer

Returns

New EntityDetectorSDK object

SetConcurrency()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetConcurrency

(

int

value

)

Sets value for concurrency

Parameters

value

max number of concurrent calls

Returns

New EntityDetectorSDK object

SetConcurrentTimeout()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetConcurrentTimeout

(

double

value

)

Sets value for concurrentTimeout

Parameters

value

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

Returns

New EntityDetectorSDK object

SetDisableServiceLogs()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetDisableServiceLogs

(

bool

value

)

Sets value for disableServiceLogs

Parameters

value

disableServiceLogs option

Returns

New EntityDetectorSDK object

SetDisableServiceLogsCol()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetDisableServiceLogsCol

(

string

value

)

Sets value for disableServiceLogs column

Parameters

value

disableServiceLogs option

Returns

New EntityDetectorSDK object

SetErrorCol()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New EntityDetectorSDK object

SetIncludeStatistics()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetIncludeStatistics

(

bool

value

)

Sets value for includeStatistics

Parameters

value

includeStatistics option

Returns

New EntityDetectorSDK object

SetIncludeStatisticsCol()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetIncludeStatisticsCol

(

string

value

)

Sets value for includeStatistics column

Parameters

value

includeStatistics option

Returns

New EntityDetectorSDK object

SetLanguage()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetLanguage

(

string []

value

)

Sets value for language

Parameters

value

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

Returns

New EntityDetectorSDK object

SetLanguageCol()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetLanguageCol

(

string

value

)

Sets value for language column

Parameters

value

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

Returns

New EntityDetectorSDK object

SetLocation()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New EntityDetectorSDK object

SetModelVersion()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetModelVersion

(

string

value

)

Sets value for modelVersion

Parameters

value

modelVersion option

Returns

New EntityDetectorSDK object

SetModelVersionCol()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetModelVersionCol

(

string

value

)

Sets value for modelVersion column

Parameters

value

modelVersion option

Returns

New EntityDetectorSDK object

SetOutputCol()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New EntityDetectorSDK object

SetSubscriptionKey()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New EntityDetectorSDK object

SetSubscriptionKeyCol()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New EntityDetectorSDK object

SetText()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetText

(

string []

value

)

Sets value for text

Parameters

value

the text in the request body

Returns

New EntityDetectorSDK object

SetTextCol()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetTextCol

(

string

value

)

Sets value for text column

Parameters

value

the text in the request body

Returns

New EntityDetectorSDK object

SetTimeout()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetTimeout

(

double

value

)

Sets value for timeout

Parameters

value

number of seconds to wait before closing the connection

Returns

New EntityDetectorSDK object

SetUrl()

EntityDetectorSDK Synapse.ML.Cognitive.EntityDetectorSDK.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New EntityDetectorSDK object

---

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

• synapse/ml/cognitive/EntityDetectorSDK.cs