Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Cognitive.PII Class Reference

PII implements PII More...

Inheritance diagram for Synapse.ML.Cognitive.PII:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Cognitive.PII:
Collaboration graph
[legend]

Public Member Functions

 PII ()
 Creates a PII without any parameters. More...
 
 PII (string uid)
 Creates a PII with a UID that is used to give the PII a unique ID. More...
 
PII SetConcurrency (int value)
 Sets value for concurrency More...
 
PII SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
PII SetDomain (string value)
 Sets value for domain More...
 
PII SetDomainCol (string value)
 Sets value for domain column More...
 
PII SetErrorCol (string value)
 Sets value for errorCol More...
 
PII SetHandler (object value)
 Sets value for handler More...
 
PII SetLanguage (string[] value)
 Sets value for language More...
 
PII SetLanguageCol (string value)
 Sets value for language column More...
 
PII SetModelVersion (string value)
 Sets value for modelVersion More...
 
PII SetModelVersionCol (string value)
 Sets value for modelVersion column More...
 
PII SetOutputCol (string value)
 Sets value for outputCol More...
 
PII SetPiiCategories (string[] value)
 Sets value for piiCategories More...
 
PII SetPiiCategoriesCol (string value)
 Sets value for piiCategories column More...
 
PII SetShowStats (bool value)
 Sets value for showStats More...
 
PII SetShowStatsCol (string value)
 Sets value for showStats column More...
 
PII SetStringIndexType (string value)
 Sets value for stringIndexType More...
 
PII SetStringIndexTypeCol (string value)
 Sets value for stringIndexType column More...
 
PII SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
PII SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
PII SetText (string[] value)
 Sets value for text More...
 
PII SetTextCol (string value)
 Sets value for text column More...
 
PII SetTimeout (double value)
 Sets value for timeout More...
 
PII SetUrl (string value)
 Sets value for url More...
 
int GetConcurrency ()
 Gets concurrency value More...
 
double GetConcurrentTimeout ()
 Gets concurrentTimeout value More...
 
string GetDomain ()
 Gets domain 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...
 
string [] GetPiiCategories ()
 Gets piiCategories 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< PIIRead ()
 Get the corresponding JavaMLReader instance. More...
 
PII SetLocation (string value)
 Sets value for location More...
 
PII SetLinkedService (string value)
 Sets value for linkedService More...
 

Static Public Member Functions

static PII Load (string path)
 Loads the PII that was previously saved using Save(string). More...
 

Detailed Description

PII implements PII

Constructor & Destructor Documentation

◆ PII() [1/2]

Synapse.ML.Cognitive.PII.PII ( )
inline

Creates a PII without any parameters.

◆ PII() [2/2]

Synapse.ML.Cognitive.PII.PII ( string  uid)
inline

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

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetDomain()

string Synapse.ML.Cognitive.PII.GetDomain ( )

Gets domain value

Returns
domain: if specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'.

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetHandler()

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

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetLanguage()

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

Gets language value

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

◆ GetModelVersion()

string Synapse.ML.Cognitive.PII.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.PII.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetPiiCategories()

string [] Synapse.ML.Cognitive.PII.GetPiiCategories ( )

Gets piiCategories value

Returns
piiCategories: describes the PII categories to return

◆ GetShowStats()

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

Gets showStats value

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

◆ GetStringIndexType()

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

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetText()

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

Gets text value

Returns
text: the text in the request body

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

Parameters
pathThe path the previous PII was saved to
Returns
New PII object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

Returns
an JavaMLReader<PII> instance for this ML instance.

◆ Save()

void Synapse.ML.Cognitive.PII.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
pathThe path to save the object to

◆ SetConcurrency()

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New PII object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

Parameters
valuemax number seconds to wait on futures if concurrency >= 1
Returns
New PII object

◆ SetDomain()

PII Synapse.ML.Cognitive.PII.SetDomain ( string  value)

Sets value for domain

Parameters
valueif specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'.
Returns
New PII object

◆ SetDomainCol()

PII Synapse.ML.Cognitive.PII.SetDomainCol ( string  value)

Sets value for domain column

Parameters
valueif specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'.
Returns
New PII object

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New PII object

◆ SetHandler()

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

Sets value for handler

Parameters
valueWhich strategy to use when handling requests
Returns
New PII object

◆ SetLanguage()

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

Sets value for language

Parameters
valuethe language code of the text (optional for some services)
Returns
New PII object

◆ SetLanguageCol()

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

Sets value for language column

Parameters
valuethe language code of the text (optional for some services)
Returns
New PII object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New PII object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New PII object

◆ SetModelVersion()

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

Sets value for modelVersion

Parameters
valueThis 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 PII object

◆ SetModelVersionCol()

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

Sets value for modelVersion column

Parameters
valueThis 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 PII object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New PII object

◆ SetPiiCategories()

PII Synapse.ML.Cognitive.PII.SetPiiCategories ( string []  value)

Sets value for piiCategories

Parameters
valuedescribes the PII categories to return
Returns
New PII object

◆ SetPiiCategoriesCol()

PII Synapse.ML.Cognitive.PII.SetPiiCategoriesCol ( string  value)

Sets value for piiCategories column

Parameters
valuedescribes the PII categories to return
Returns
New PII object

◆ SetShowStats()

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

Sets value for showStats

Parameters
valueif set to true, response will contain input and document level statistics.
Returns
New PII object

◆ SetShowStatsCol()

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

Sets value for showStats column

Parameters
valueif set to true, response will contain input and document level statistics.
Returns
New PII object

◆ SetStringIndexType()

PII Synapse.ML.Cognitive.PII.SetStringIndexType ( string  value)

Sets value for stringIndexType

Parameters
valueSpecifies 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 PII object

◆ SetStringIndexTypeCol()

PII Synapse.ML.Cognitive.PII.SetStringIndexTypeCol ( string  value)

Sets value for stringIndexType column

Parameters
valueSpecifies 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 PII object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New PII object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New PII object

◆ SetText()

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

Sets value for text

Parameters
valuethe text in the request body
Returns
New PII object

◆ SetTextCol()

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

Sets value for text column

Parameters
valuethe text in the request body
Returns
New PII object

◆ SetTimeout()

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

Sets value for timeout

Parameters
valuenumber of seconds to wait before closing the connection
Returns
New PII object

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New PII object

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