Class SpeechSettings

Namespace

Vonage.Voice.Nccos

Assembly

Vonage.dll

Configures automatic speech recognition (ASR) settings for an NCCO Input action.

public class SpeechSettings

Inheritance

object

SpeechSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Context

Array of hints (strings) to improve recognition quality if certain words are expected from the user.

[JsonProperty("context", Order = 3)]
public string[] Context { get; set; }

Property Value

string[]

EndOnSilence

Controls how long the system will wait after user stops speaking to decide the input is completed. The default value is 2 (seconds). The range of possible values is between 1 second and 10 seconds.

[JsonProperty("endOnSilence", Order = 1)]
public int? EndOnSilence { get; set; }

Property Value

int?

Language

Expected language of the user's speech. Format: BCP-47. Default: en-US see list of supported languages: https://developer.nexmo.com/voice/voice-api/guides/asr#language

[JsonProperty("language", Order = 2)]
public string Language { get; set; }

Property Value

string

MaxDuration

Controls maximum speech duration (from the moment user starts speaking). The default value is 60 (seconds). The range of possible values is between 1 and 60 seconds.

[JsonProperty("maxDuration", Order = 5)]
public int? MaxDuration { get; set; }

Property Value

int?

Provider

The speech recognition provider to use (Deepgram or Google). If not specified, the default Vonage ASR engine is used.

[JsonProperty("provider", Order = 6)]
[JsonConverter(typeof(StringEnumConverter))]
public SpeechProvider? Provider { get; set; }

Property Value

SpeechProvider?

ProviderOptions

Provider-specific options as key-value pairs. The available options depend on the selected Provider.

[JsonProperty("providerOptions", Order = 7)]
public Dictionary<string, string> ProviderOptions { get; set; }

Property Value

Dictionary<string, string>

StartTimeout

Controls how long the system will wait for the user to start speaking. The range of possible values is between 1 second and 10 seconds.

[JsonProperty("startTimeout", Order = 4)]
public int? StartTimeout { get; set; }

Property Value

int?

Uuid

The unique ID of the Call leg for the user to capture the speech of.

[JsonProperty("uuid", Order = 0)]
public string[] Uuid { get; set; }

Property Value

string[]