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

SpeechToText implements SpeechToText More...

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

Public Member Functions

 SpeechToText ()
 Creates a SpeechToText without any parameters. More...
 
 SpeechToText (string uid)
 Creates a SpeechToText with a UID that is used to give the SpeechToText a unique ID. More...
 
SpeechToText SetAudioData (byte[] value)
 Sets value for audioData More...
 
SpeechToText SetAudioDataCol (string value)
 Sets value for audioData column More...
 
SpeechToText SetConcurrency (int value)
 Sets value for concurrency More...
 
SpeechToText SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
SpeechToText SetErrorCol (string value)
 Sets value for errorCol More...
 
SpeechToText SetFormat (string value)
 Sets value for format More...
 
SpeechToText SetFormatCol (string value)
 Sets value for format column More...
 
SpeechToText SetHandler (object value)
 Sets value for handler More...
 
SpeechToText SetLanguage (string value)
 Sets value for language More...
 
SpeechToText SetLanguageCol (string value)
 Sets value for language column More...
 
SpeechToText SetOutputCol (string value)
 Sets value for outputCol More...
 
SpeechToText SetProfanity (string value)
 Sets value for profanity More...
 
SpeechToText SetProfanityCol (string value)
 Sets value for profanity column More...
 
SpeechToText SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
SpeechToText SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
SpeechToText SetTimeout (double value)
 Sets value for timeout More...
 
SpeechToText SetUrl (string value)
 Sets value for url More...
 
byte[] GetAudioData ()
 Gets audioData value More...
 
int GetConcurrency ()
 Gets concurrency value More...
 
double GetConcurrentTimeout ()
 Gets concurrentTimeout value More...
 
string GetErrorCol ()
 Gets errorCol value More...
 
string GetFormat ()
 Gets format value More...
 
object GetHandler ()
 Gets handler value More...
 
string GetLanguage ()
 Gets language value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
string GetProfanity ()
 Gets profanity value More...
 
string GetSubscriptionKey ()
 Gets subscriptionKey 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< SpeechToTextRead ()
 Get the corresponding JavaMLReader instance. More...
 
SpeechToText SetLocation (string value)
 Sets value for location More...
 
SpeechToText SetLinkedService (string value)
 Sets value for linkedService More...
 

Static Public Member Functions

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

Detailed Description

SpeechToText implements SpeechToText

Constructor & Destructor Documentation

◆ SpeechToText() [1/2]

Synapse.ML.Cognitive.SpeechToText.SpeechToText ( )
inline

Creates a SpeechToText without any parameters.

◆ SpeechToText() [2/2]

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

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

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

Member Function Documentation

◆ GetAudioData()

byte [] Synapse.ML.Cognitive.SpeechToText.GetAudioData ( )

Gets audioData value

Returns
audioData: The data sent to the service must be a .wav files

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetFormat()

string Synapse.ML.Cognitive.SpeechToText.GetFormat ( )

Gets format value

Returns
format: Specifies the result format. Accepted values are simple and detailed. Default is simple.

◆ GetHandler()

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

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetLanguage()

string Synapse.ML.Cognitive.SpeechToText.GetLanguage ( )

Gets language value

Returns
language: Identifies the spoken language that is being recognized.

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetProfanity()

string Synapse.ML.Cognitive.SpeechToText.GetProfanity ( )

Gets profanity value

Returns
profanity: Specifies how to handle profanity in recognition results. Accepted values are masked, which replaces profanity with asterisks, removed, which remove all profanity from the result, or raw, which includes the profanity in the result. The default setting is masked.

◆ GetSubscriptionKey()

string Synapse.ML.Cognitive.SpeechToText.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Cognitive.SpeechToText.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

◆ SetAudioData()

SpeechToText Synapse.ML.Cognitive.SpeechToText.SetAudioData ( byte[]  value)

Sets value for audioData

Parameters
valueThe data sent to the service must be a .wav files
Returns
New SpeechToText object

◆ SetAudioDataCol()

SpeechToText Synapse.ML.Cognitive.SpeechToText.SetAudioDataCol ( string  value)

Sets value for audioData column

Parameters
valueThe data sent to the service must be a .wav files
Returns
New SpeechToText object

◆ SetConcurrency()

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New SpeechToText object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

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

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New SpeechToText object

◆ SetFormat()

SpeechToText Synapse.ML.Cognitive.SpeechToText.SetFormat ( string  value)

Sets value for format

Parameters
valueSpecifies the result format. Accepted values are simple and detailed. Default is simple.
Returns
New SpeechToText object

◆ SetFormatCol()

SpeechToText Synapse.ML.Cognitive.SpeechToText.SetFormatCol ( string  value)

Sets value for format column

Parameters
valueSpecifies the result format. Accepted values are simple and detailed. Default is simple.
Returns
New SpeechToText object

◆ SetHandler()

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

Sets value for handler

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

◆ SetLanguage()

SpeechToText Synapse.ML.Cognitive.SpeechToText.SetLanguage ( string  value)

Sets value for language

Parameters
valueIdentifies the spoken language that is being recognized.
Returns
New SpeechToText object

◆ SetLanguageCol()

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

Sets value for language column

Parameters
valueIdentifies the spoken language that is being recognized.
Returns
New SpeechToText object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New SpeechToText object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New SpeechToText object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New SpeechToText object

◆ SetProfanity()

SpeechToText Synapse.ML.Cognitive.SpeechToText.SetProfanity ( string  value)

Sets value for profanity

Parameters
valueSpecifies how to handle profanity in recognition results. Accepted values are masked, which replaces profanity with asterisks, removed, which remove all profanity from the result, or raw, which includes the profanity in the result. The default setting is masked.
Returns
New SpeechToText object

◆ SetProfanityCol()

SpeechToText Synapse.ML.Cognitive.SpeechToText.SetProfanityCol ( string  value)

Sets value for profanity column

Parameters
valueSpecifies how to handle profanity in recognition results. Accepted values are masked, which replaces profanity with asterisks, removed, which remove all profanity from the result, or raw, which includes the profanity in the result. The default setting is masked.
Returns
New SpeechToText object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New SpeechToText object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New SpeechToText object

◆ SetTimeout()

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

Sets value for timeout

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

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New SpeechToText object

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