Synapse.ML.Cognitive.NER Class Reference

NER implements NER More...

Inheritance diagram for Synapse.ML.Cognitive.NER:

Collaboration diagram for Synapse.ML.Cognitive.NER:

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

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

Detailed Description

NER implements NER

Constructor & Destructor Documentation

NER() [1/2]

Synapse.ML.Cognitive.NER.NER ( )

inline

Creates a NER without any parameters.

NER() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetConcurrency()

int Synapse.ML.Cognitive.NER.GetConcurrency

(

)

Gets concurrency value

Returns

concurrency: max number of concurrent calls

GetConcurrentTimeout()

double Synapse.ML.Cognitive.NER.GetConcurrentTimeout

(

)

Gets concurrentTimeout value

Returns

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

GetErrorCol()

string Synapse.ML.Cognitive.NER.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetHandler()

object Synapse.ML.Cognitive.NER.GetHandler

(

)

Gets handler value

Returns

handler: Which strategy to use when handling requests

GetLanguage()

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

(

)

Gets language value

Returns

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

GetModelVersion()

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

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetShowStats()

bool Synapse.ML.Cognitive.NER.GetShowStats

(

)

Gets showStats value

Returns

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

GetStringIndexType()

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

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetText()

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

(

)

Gets text value

Returns

text: the text in the request body

GetTimeout()

double Synapse.ML.Cognitive.NER.GetTimeout

(

)

Gets timeout value

Returns

timeout: number of seconds to wait before closing the connection

GetUrl()

string Synapse.ML.Cognitive.NER.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

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

static

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

Parameters

path	The path the previous NER was saved to

Returns

New NER object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<NER> instance for this ML instance.

Save()

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

NER Synapse.ML.Cognitive.NER.SetConcurrency

(

int

value

)

Sets value for concurrency

Parameters

value

max number of concurrent calls

Returns

New NER object

SetConcurrentTimeout()

NER Synapse.ML.Cognitive.NER.SetConcurrentTimeout

(

double

value

)

Sets value for concurrentTimeout

Parameters

value

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

Returns

New NER object

SetErrorCol()

NER Synapse.ML.Cognitive.NER.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New NER object

SetHandler()

NER Synapse.ML.Cognitive.NER.SetHandler

(

object

value

)

Sets value for handler

Parameters

value

Which strategy to use when handling requests

Returns

New NER object

SetLanguage()

NER Synapse.ML.Cognitive.NER.SetLanguage

(

string []

value

)

Sets value for language

Parameters

value

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

Returns

New NER object

SetLanguageCol()

NER Synapse.ML.Cognitive.NER.SetLanguageCol

(

string

value

)

Sets value for language column

Parameters

value

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

Returns

New NER object

SetLinkedService()

NER Synapse.ML.Cognitive.NER.SetLinkedService

(

string

value

)

Sets value for linkedService

Parameters

value

linkedService name

Returns

New NER object

SetLocation()

NER Synapse.ML.Cognitive.NER.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New NER object

SetModelVersion()

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

SetModelVersionCol()

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

SetOutputCol()

NER Synapse.ML.Cognitive.NER.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New NER object

SetShowStats()

NER Synapse.ML.Cognitive.NER.SetShowStats

(

bool

value

)

Sets value for showStats

Parameters

value

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

Returns

New NER object

SetShowStatsCol()

NER Synapse.ML.Cognitive.NER.SetShowStatsCol

(

string

value

)

Sets value for showStats column

Parameters

value

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

Returns

New NER object

SetStringIndexType()

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

SetStringIndexTypeCol()

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

SetSubscriptionKey()

NER Synapse.ML.Cognitive.NER.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New NER object

SetSubscriptionKeyCol()

NER Synapse.ML.Cognitive.NER.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New NER object

SetText()

NER Synapse.ML.Cognitive.NER.SetText

(

string []

value

)

Sets value for text

Parameters

value

the text in the request body

Returns

New NER object

SetTextCol()

NER Synapse.ML.Cognitive.NER.SetTextCol

(

string

value

)

Sets value for text column

Parameters

value

the text in the request body

Returns

New NER object

SetTimeout()

NER Synapse.ML.Cognitive.NER.SetTimeout

(

double

value

)

Sets value for timeout

Parameters

value

number of seconds to wait before closing the connection

Returns

New NER object

SetUrl()

NER Synapse.ML.Cognitive.NER.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New NER object

---

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

• synapse/ml/cognitive/NER.cs