AnalyzeText implements AnalyzeText More...

Inheritance diagram for Synapse.ML.Services.Language.AnalyzeText:

[legend]

Collaboration diagram for Synapse.ML.Services.Language.AnalyzeText:

[legend]

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

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

AnalyzeText	SetAADToken (string value)
	Sets value for AADToken More...

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

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

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

AnalyzeText	SetApiVersion (string value)
	Sets value for apiVersion More...

AnalyzeText	SetApiVersionCol (string value)
	Sets value for apiVersion column More...

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

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

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

AnalyzeText	SetCountryHint (string[] value)
	Sets value for countryHint More...

AnalyzeText	SetCountryHintCol (string value)
	Sets value for countryHint column More...

AnalyzeText	SetDomain (string value)
	Sets value for domain More...

AnalyzeText	SetDomainCol (string value)
	Sets value for domain column More...

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

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

AnalyzeText	SetKind (string value)
	Sets value for kind More...

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

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

AnalyzeText	SetLoggingOptOut (bool value)
	Sets value for loggingOptOut More...

AnalyzeText	SetLoggingOptOutCol (string value)
	Sets value for loggingOptOut column More...

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

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

AnalyzeText	SetOpinionMining (bool value)
	Sets value for opinionMining More...

AnalyzeText	SetOpinionMiningCol (string value)
	Sets value for opinionMining column More...

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

AnalyzeText	SetPiiCategories (string[] value)
	Sets value for piiCategories More...

AnalyzeText	SetPiiCategoriesCol (string value)
	Sets value for piiCategories column More...

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

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

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

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

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

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

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

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

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

AnalyzeText	SetUrl (string value)
	Sets value for url More...

string	GetAADToken ()
	Gets AADToken value More...

string	GetCustomAuthHeader ()
	Gets CustomAuthHeader value More...

string	GetApiVersion ()
	Gets apiVersion value More...

int	GetBatchSize ()
	Gets batchSize value More...

int	GetConcurrency ()
	Gets concurrency value More...

double	GetConcurrentTimeout ()
	Gets concurrentTimeout value More...

string[]	GetCountryHint ()
	Gets countryHint value More...

string	GetDomain ()
	Gets domain value More...

string	GetErrorCol ()
	Gets errorCol value More...

object	GetHandler ()
	Gets handler value More...

string	GetKind ()
	Gets kind value More...

string[]	GetLanguage ()
	Gets language value More...

bool	GetLoggingOptOut ()
	Gets loggingOptOut value More...

string	GetModelVersion ()
	Gets modelVersion value More...

bool	GetOpinionMining ()
	Gets opinionMining 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< AnalyzeText >	Read ()
	Get the corresponding JavaMLReader instance. More...

AnalyzeText	SetCustomServiceName (string value)
	Sets value for service name More...

AnalyzeText	SetEndpoint (string value)
	Sets value for endpoint More...

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

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

Detailed Description

AnalyzeText implements AnalyzeText

Constructor & Destructor Documentation

◆ AnalyzeText() [1/2]

Synapse.ML.Services.Language.AnalyzeText.AnalyzeText ( )

inline

Creates a AnalyzeText without any parameters.

◆ AnalyzeText() [2/2]

Synapse.ML.Services.Language.AnalyzeText.AnalyzeText ( string uid )

inline

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

Parameters

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

Member Function Documentation

◆ GetAADToken()

string Synapse.ML.Services.Language.AnalyzeText.GetAADToken ( )

Gets AADToken value

Returns: AADToken: AAD Token used for authentication

◆ GetApiVersion()

string Synapse.ML.Services.Language.AnalyzeText.GetApiVersion ( )

Gets apiVersion value

Returns: apiVersion: version of the api

◆ GetBatchSize()

int Synapse.ML.Services.Language.AnalyzeText.GetBatchSize ( )

Gets batchSize value

Returns: batchSize: The max size of the buffer

◆ GetConcurrency()

int Synapse.ML.Services.Language.AnalyzeText.GetConcurrency ( )

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Services.Language.AnalyzeText.GetConcurrentTimeout ( )

Gets concurrentTimeout value

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

◆ GetCountryHint()

string [] Synapse.ML.Services.Language.AnalyzeText.GetCountryHint ( )

Gets countryHint value

Returns: countryHint: the countryHint for language detection

◆ GetCustomAuthHeader()

string Synapse.ML.Services.Language.AnalyzeText.GetCustomAuthHeader ( )

Gets CustomAuthHeader value

Returns: CustomAuthHeader: A Custom Value for Authorization Header

◆ GetDomain()

string Synapse.ML.Services.Language.AnalyzeText.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.Services.Language.AnalyzeText.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetHandler()

object Synapse.ML.Services.Language.AnalyzeText.GetHandler ( )

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetKind()

string Synapse.ML.Services.Language.AnalyzeText.GetKind ( )

Gets kind value

Returns: kind: Enumeration of supported Text Analysis tasks

◆ GetLanguage()

string [] Synapse.ML.Services.Language.AnalyzeText.GetLanguage ( )

Gets language value

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

◆ GetLoggingOptOut()

bool Synapse.ML.Services.Language.AnalyzeText.GetLoggingOptOut ( )

Gets loggingOptOut value

Returns: loggingOptOut: loggingOptOut for task

◆ GetModelVersion()

string Synapse.ML.Services.Language.AnalyzeText.GetModelVersion ( )

Gets modelVersion value

Returns: modelVersion: Version of the model

◆ GetOpinionMining()

bool Synapse.ML.Services.Language.AnalyzeText.GetOpinionMining ( )

Gets opinionMining value

Returns: opinionMining: opinionMining option for SentimentAnalysisTask

◆ GetOutputCol()

string Synapse.ML.Services.Language.AnalyzeText.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetPiiCategories()

string [] Synapse.ML.Services.Language.AnalyzeText.GetPiiCategories ( )

Gets piiCategories value

Returns: piiCategories: describes the PII categories to return

◆ GetShowStats()

bool Synapse.ML.Services.Language.AnalyzeText.GetShowStats ( )

Gets showStats value

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

◆ GetStringIndexType()

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

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetText()

string [] Synapse.ML.Services.Language.AnalyzeText.GetText ( )

Gets text value

Returns: text: the text in the request body

◆ GetTimeout()

double Synapse.ML.Services.Language.AnalyzeText.GetTimeout ( )

Gets timeout value

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

◆ GetUrl()

string Synapse.ML.Services.Language.AnalyzeText.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ Load()

static AnalyzeText Synapse.ML.Services.Language.AnalyzeText.Load ( string path )

static

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

Parameters

path	The path the previous AnalyzeText was saved to

Returns: New AnalyzeText object, loaded from path.

◆ Read()

JavaMLReader<AnalyzeText> Synapse.ML.Services.Language.AnalyzeText.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Services.Language.AnalyzeText.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()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetAADToken ( string value )

Sets value for AADToken

Parameters

value AAD Token used for authentication

Returns: New AnalyzeText object

◆ SetAADTokenCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetAADTokenCol ( string value )

Sets value for AADToken column

Parameters

value AAD Token used for authentication

Returns: New AnalyzeText object

◆ SetApiVersion()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetApiVersion ( string value )

Sets value for apiVersion

Parameters

value version of the api

Returns: New AnalyzeText object

◆ SetApiVersionCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetApiVersionCol ( string value )

Sets value for apiVersion column

Parameters

value version of the api

Returns: New AnalyzeText object

◆ SetBatchSize()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetBatchSize ( int value )

Sets value for batchSize

Parameters

value The max size of the buffer

Returns: New AnalyzeText object

◆ SetConcurrency()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetConcurrency ( int value )

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New AnalyzeText object

◆ SetConcurrentTimeout()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetConcurrentTimeout ( double value )

Sets value for concurrentTimeout

Parameters

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

Returns: New AnalyzeText object

◆ SetCountryHint()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetCountryHint ( string[] value )

Sets value for countryHint

Parameters

value the countryHint for language detection

Returns: New AnalyzeText object

◆ SetCountryHintCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetCountryHintCol ( string value )

Sets value for countryHint column

Parameters

value the countryHint for language detection

Returns: New AnalyzeText object

◆ SetCustomAuthHeader()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetCustomAuthHeader ( string value )

Sets value for CustomAuthHeader

Parameters

value A Custom Value for Authorization Header

Returns: New AnalyzeText object

◆ SetCustomAuthHeaderCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetCustomAuthHeaderCol ( string value )

Sets value for CustomAuthHeader column

Parameters

value A Custom Value for Authorization Header

Returns: New AnalyzeText object

◆ SetCustomServiceName()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetCustomServiceName ( string value )

Sets value for service name

Parameters

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

Returns: New AnalyzeText object

◆ SetDomain()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetDomain ( string value )

Sets value for domain

Parameters

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

Returns: New AnalyzeText object

◆ SetDomainCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetDomainCol ( string value )

Sets value for domain column

Parameters

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

Returns: New AnalyzeText object

◆ SetEndpoint()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetEndpoint ( string value )

Sets value for endpoint

Parameters

value Endpoint of the cognitive service

Returns: New AnalyzeText object

◆ SetErrorCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New AnalyzeText object

◆ SetHandler()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetHandler ( object value )

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New AnalyzeText object

◆ SetKind()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetKind ( string value )

Sets value for kind

Parameters

value Enumeration of supported Text Analysis tasks

Returns: New AnalyzeText object

◆ SetLanguage()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetLanguage ( string[] value )

Sets value for language

Parameters

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

Returns: New AnalyzeText object

◆ SetLanguageCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetLanguageCol ( string value )

Sets value for language column

Parameters

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

Returns: New AnalyzeText object

◆ SetLocation()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetLocation ( string value )

Sets value for location

Parameters

value Location of the cognitive service

Returns: New AnalyzeText object

◆ SetLoggingOptOut()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetLoggingOptOut ( bool value )

Sets value for loggingOptOut

Parameters

value loggingOptOut for task

Returns: New AnalyzeText object

◆ SetLoggingOptOutCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetLoggingOptOutCol ( string value )

Sets value for loggingOptOut column

Parameters

value loggingOptOut for task

Returns: New AnalyzeText object

◆ SetModelVersion()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetModelVersion ( string value )

Sets value for modelVersion

Parameters

value Version of the model

Returns: New AnalyzeText object

◆ SetModelVersionCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetModelVersionCol ( string value )

Sets value for modelVersion column

Parameters

value Version of the model

Returns: New AnalyzeText object

◆ SetOpinionMining()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetOpinionMining ( bool value )

Sets value for opinionMining

Parameters

value opinionMining option for SentimentAnalysisTask

Returns: New AnalyzeText object

◆ SetOpinionMiningCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetOpinionMiningCol ( string value )

Sets value for opinionMining column

Parameters

value opinionMining option for SentimentAnalysisTask

Returns: New AnalyzeText object

◆ SetOutputCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value The name of the output column

Returns: New AnalyzeText object

◆ SetPiiCategories()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetPiiCategories ( string[] value )

Sets value for piiCategories

Parameters

value describes the PII categories to return

Returns: New AnalyzeText object

◆ SetPiiCategoriesCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetPiiCategoriesCol ( string value )

Sets value for piiCategories column

Parameters

value describes the PII categories to return

Returns: New AnalyzeText object

◆ SetShowStats()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetShowStats ( bool value )

Sets value for showStats

Parameters

value Whether to include detailed statistics in the response

Returns: New AnalyzeText object

◆ SetShowStatsCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetShowStatsCol ( string value )

Sets value for showStats column

Parameters

value Whether to include detailed statistics in the response

Returns: New AnalyzeText object

◆ SetStringIndexType()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.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 AnalyzeText object

◆ SetStringIndexTypeCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.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 AnalyzeText object

◆ SetSubscriptionKey()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New AnalyzeText object

◆ SetSubscriptionKeyCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New AnalyzeText object

◆ SetText()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetText ( string[] value )

Sets value for text

Parameters

value the text in the request body

Returns: New AnalyzeText object

◆ SetTextCol()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetTextCol ( string value )

Sets value for text column

Parameters

value the text in the request body

Returns: New AnalyzeText object

◆ SetTimeout()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetTimeout ( double value )

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New AnalyzeText object

◆ SetUrl()

AnalyzeText Synapse.ML.Services.Language.AnalyzeText.SetUrl ( string value )

Sets value for url

Parameters

value Url of the service

Returns: New AnalyzeText object

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

synapse/ml/services/language/AnalyzeText.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AnalyzeText() [1/2]

◆ AnalyzeText() [2/2]

Member Function Documentation

◆ GetAADToken()

◆ GetApiVersion()

◆ GetBatchSize()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetCountryHint()

◆ GetCustomAuthHeader()

◆ GetDomain()

◆ GetErrorCol()

◆ GetHandler()

◆ GetKind()

◆ GetLanguage()

◆ GetLoggingOptOut()

◆ GetModelVersion()

◆ GetOpinionMining()

◆ GetOutputCol()

◆ GetPiiCategories()

◆ GetShowStats()

◆ GetStringIndexType()

◆ GetSubscriptionKey()

◆ GetText()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAADToken()

◆ SetAADTokenCol()

◆ SetApiVersion()

◆ SetApiVersionCol()

◆ SetBatchSize()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetCountryHint()

◆ SetCountryHintCol()

◆ SetCustomAuthHeader()

◆ SetCustomAuthHeaderCol()

◆ SetCustomServiceName()

◆ SetDomain()

◆ SetDomainCol()

◆ SetEndpoint()

◆ SetErrorCol()

◆ SetHandler()

◆ SetKind()

◆ SetLanguage()

◆ SetLanguageCol()

◆ SetLocation()

◆ SetLoggingOptOut()

◆ SetLoggingOptOutCol()

◆ SetModelVersion()

◆ SetModelVersionCol()

◆ SetOpinionMining()

◆ SetOpinionMiningCol()

◆ SetOutputCol()

◆ SetPiiCategories()

◆ SetPiiCategoriesCol()

◆ SetShowStats()

◆ SetShowStatsCol()

◆ SetStringIndexType()

◆ SetStringIndexTypeCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetText()

◆ SetTextCol()

◆ SetTimeout()

◆ SetUrl()