SpeechToTextSDK implements SpeechToTextSDK More...

Inheritance diagram for Synapse.ML.Cognitive.SpeechToTextSDK:

[legend]

Collaboration diagram for Synapse.ML.Cognitive.SpeechToTextSDK:

[legend]

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

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

SpeechToTextSDK	SetAudioDataCol (string value)
	Sets value for audioDataCol More...

SpeechToTextSDK	SetEndpointId (string value)
	Sets value for endpointId More...

SpeechToTextSDK	SetExtraFfmpegArgs (string[] value)
	Sets value for extraFfmpegArgs More...

SpeechToTextSDK	SetFileType (string value)
	Sets value for fileType More...

SpeechToTextSDK	SetFileTypeCol (string value)
	Sets value for fileType column More...

SpeechToTextSDK	SetFormat (string value)
	Sets value for format More...

SpeechToTextSDK	SetFormatCol (string value)
	Sets value for format column More...

SpeechToTextSDK	SetLanguage (string value)
	Sets value for language More...

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

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

SpeechToTextSDK	SetParticipantsJson (string value)
	Sets value for participantsJson More...

SpeechToTextSDK	SetParticipantsJsonCol (string value)
	Sets value for participantsJson column More...

SpeechToTextSDK	SetProfanity (string value)
	Sets value for profanity More...

SpeechToTextSDK	SetProfanityCol (string value)
	Sets value for profanity column More...

SpeechToTextSDK	SetRecordAudioData (bool value)
	Sets value for recordAudioData More...

SpeechToTextSDK	SetRecordedFileNameCol (string value)
	Sets value for recordedFileNameCol More...

SpeechToTextSDK	SetStreamIntermediateResults (bool value)
	Sets value for streamIntermediateResults More...

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

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

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

string	GetAudioDataCol ()
	Gets audioDataCol value More...

string	GetEndpointId ()
	Gets endpointId value More...

string[]	GetExtraFfmpegArgs ()
	Gets extraFfmpegArgs value More...

string	GetFileType ()
	Gets fileType value More...

string	GetFormat ()
	Gets format value More...

string	GetLanguage ()
	Gets language value More...

string	GetOutputCol ()
	Gets outputCol value More...

string	GetParticipantsJson ()
	Gets participantsJson value More...

string	GetProfanity ()
	Gets profanity value More...

bool	GetRecordAudioData ()
	Gets recordAudioData value More...

string	GetRecordedFileNameCol ()
	Gets recordedFileNameCol value More...

bool	GetStreamIntermediateResults ()
	Gets streamIntermediateResults value More...

string	GetSubscriptionKey ()
	Gets subscriptionKey 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< SpeechToTextSDK >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

SpeechToTextSDK	SetLinkedService (string value)
	Sets value for linkedService More...

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

Detailed Description

SpeechToTextSDK implements SpeechToTextSDK

Constructor & Destructor Documentation

◆ SpeechToTextSDK() [1/2]

Synapse.ML.Cognitive.SpeechToTextSDK.SpeechToTextSDK ( )

inline

Creates a SpeechToTextSDK without any parameters.

◆ SpeechToTextSDK() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetAudioDataCol()

string Synapse.ML.Cognitive.SpeechToTextSDK.GetAudioDataCol ( )

Gets audioDataCol value

Returns: audioDataCol: Column holding audio data, must be either ByteArrays or Strings representing file URIs

◆ GetEndpointId()

string Synapse.ML.Cognitive.SpeechToTextSDK.GetEndpointId ( )

Gets endpointId value

Returns: endpointId: endpoint for custom speech models

◆ GetExtraFfmpegArgs()

string [] Synapse.ML.Cognitive.SpeechToTextSDK.GetExtraFfmpegArgs ( )

Gets extraFfmpegArgs value

Returns: extraFfmpegArgs: extra arguments to for ffmpeg output decoding

◆ GetFileType()

string Synapse.ML.Cognitive.SpeechToTextSDK.GetFileType ( )

Gets fileType value

Returns: fileType: The file type of the sound files, supported types: wav, ogg, mp3

◆ GetFormat()

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

Gets format value

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

◆ GetLanguage()

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

Gets language value

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

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetParticipantsJson()

string Synapse.ML.Cognitive.SpeechToTextSDK.GetParticipantsJson ( )

Gets participantsJson value

Returns: participantsJson: a json representation of a list of conversation participants (email, language, user)

◆ GetProfanity()

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

◆ GetRecordAudioData()

bool Synapse.ML.Cognitive.SpeechToTextSDK.GetRecordAudioData ( )

Gets recordAudioData value

Returns: recordAudioData: Whether to record audio data to a file location, for use only with m3u8 streams

◆ GetRecordedFileNameCol()

string Synapse.ML.Cognitive.SpeechToTextSDK.GetRecordedFileNameCol ( )

Gets recordedFileNameCol value

Returns: recordedFileNameCol: Column holding file names to write audio data to if `‘recordAudioData’' is set to true

◆ GetStreamIntermediateResults()

bool Synapse.ML.Cognitive.SpeechToTextSDK.GetStreamIntermediateResults ( )

Gets streamIntermediateResults value

Returns: streamIntermediateResults: Whether or not to immediately return itermediate results, or group in a sequence

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetUrl()

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

Gets url value

Returns: url: Url of the service

◆ Load()

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

static

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

Parameters

path	The path the previous SpeechToTextSDK was saved to

Returns: New SpeechToTextSDK object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetAudioDataCol()

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

Sets value for audioDataCol

Parameters

value Column holding audio data, must be either ByteArrays or Strings representing file URIs

Returns: New SpeechToTextSDK object

◆ SetEndpointId()

SpeechToTextSDK Synapse.ML.Cognitive.SpeechToTextSDK.SetEndpointId ( string value )

Sets value for endpointId

Parameters

value endpoint for custom speech models

Returns: New SpeechToTextSDK object

◆ SetExtraFfmpegArgs()

SpeechToTextSDK Synapse.ML.Cognitive.SpeechToTextSDK.SetExtraFfmpegArgs ( string[] value )

Sets value for extraFfmpegArgs

Parameters

value extra arguments to for ffmpeg output decoding

Returns: New SpeechToTextSDK object

◆ SetFileType()

SpeechToTextSDK Synapse.ML.Cognitive.SpeechToTextSDK.SetFileType ( string value )

Sets value for fileType

Parameters

value The file type of the sound files, supported types: wav, ogg, mp3

Returns: New SpeechToTextSDK object

◆ SetFileTypeCol()

SpeechToTextSDK Synapse.ML.Cognitive.SpeechToTextSDK.SetFileTypeCol ( string value )

Sets value for fileType column

Parameters

value The file type of the sound files, supported types: wav, ogg, mp3

Returns: New SpeechToTextSDK object

◆ SetFormat()

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

Sets value for format

Parameters

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

Returns: New SpeechToTextSDK object

◆ SetFormatCol()

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

Sets value for format column

Parameters

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

Returns: New SpeechToTextSDK object

◆ SetLanguage()

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

Sets value for language

Parameters

value Identifies the spoken language that is being recognized.

Returns: New SpeechToTextSDK object

◆ SetLanguageCol()

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

Sets value for language column

Parameters

value Identifies the spoken language that is being recognized.

Returns: New SpeechToTextSDK object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters

value linkedService name

Returns: New SpeechToTextSDK object

◆ SetLocation()

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

Sets value for location

Parameters

value Location of the cognitive service

Returns: New SpeechToTextSDK object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value The name of the output column

Returns: New SpeechToTextSDK object

◆ SetParticipantsJson()

SpeechToTextSDK Synapse.ML.Cognitive.SpeechToTextSDK.SetParticipantsJson ( string value )

Sets value for participantsJson

Parameters

value a json representation of a list of conversation participants (email, language, user)

Returns: New SpeechToTextSDK object

◆ SetParticipantsJsonCol()

SpeechToTextSDK Synapse.ML.Cognitive.SpeechToTextSDK.SetParticipantsJsonCol ( string value )

Sets value for participantsJson column

Parameters

value a json representation of a list of conversation participants (email, language, user)

Returns: New SpeechToTextSDK object

◆ SetProfanity()

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

Sets value for profanity

Parameters

value 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.

Returns: New SpeechToTextSDK object

◆ SetProfanityCol()

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

Sets value for profanity column

Parameters

value 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.

Returns: New SpeechToTextSDK object

◆ SetRecordAudioData()

SpeechToTextSDK Synapse.ML.Cognitive.SpeechToTextSDK.SetRecordAudioData ( bool value )

Sets value for recordAudioData

Parameters

value Whether to record audio data to a file location, for use only with m3u8 streams

Returns: New SpeechToTextSDK object

◆ SetRecordedFileNameCol()

SpeechToTextSDK Synapse.ML.Cognitive.SpeechToTextSDK.SetRecordedFileNameCol ( string value )

Sets value for recordedFileNameCol

Parameters

value Column holding file names to write audio data to if `‘recordAudioData’' is set to true

Returns: New SpeechToTextSDK object

◆ SetStreamIntermediateResults()

SpeechToTextSDK Synapse.ML.Cognitive.SpeechToTextSDK.SetStreamIntermediateResults ( bool value )

Sets value for streamIntermediateResults

Parameters

value Whether or not to immediately return itermediate results, or group in a sequence

Returns: New SpeechToTextSDK object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New SpeechToTextSDK object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New SpeechToTextSDK object

◆ SetUrl()

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

Sets value for url

Parameters

value Url of the service

Returns: New SpeechToTextSDK object

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

synapse/ml/cognitive/SpeechToTextSDK.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SpeechToTextSDK() [1/2]

◆ SpeechToTextSDK() [2/2]

Member Function Documentation

◆ GetAudioDataCol()

◆ GetEndpointId()

◆ GetExtraFfmpegArgs()

◆ GetFileType()

◆ GetFormat()

◆ GetLanguage()

◆ GetOutputCol()

◆ GetParticipantsJson()

◆ GetProfanity()

◆ GetRecordAudioData()

◆ GetRecordedFileNameCol()

◆ GetStreamIntermediateResults()

◆ GetSubscriptionKey()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAudioDataCol()

◆ SetEndpointId()

◆ SetExtraFfmpegArgs()

◆ SetFileType()

◆ SetFileTypeCol()

◆ SetFormat()

◆ SetFormatCol()

◆ SetLanguage()

◆ SetLanguageCol()

◆ SetLinkedService()

◆ SetLocation()

◆ SetOutputCol()

◆ SetParticipantsJson()

◆ SetParticipantsJsonCol()

◆ SetProfanity()

◆ SetProfanityCol()

◆ SetRecordAudioData()

◆ SetRecordedFileNameCol()

◆ SetStreamIntermediateResults()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetUrl()