Class ServerVad

Inheritance
object
ServerVad
Inherited Members
Namespace: Glitch9.AIDevKit.OpenAI.Realtime
Assembly: Glitch9.AIDevKit.dll
Syntax
public class ServerVad

Properties

| Edit this page View Source

CreateResponse

Optional. Whether or not to automatically generate a response when a VAD stop event occurs. Defaults to true

Declaration
[JsonProperty("create_response")]
public bool? CreateResponse { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IdleTimeoutMs

Optional. Optional timeout after which a model response will be triggered automatically. This is useful for situations in which a long pause from the user is unexpected, such as a phone call. The model will effectively prompt the user to continue the conversation based on the current context.

The timeout value will be applied after the last model response's audio has finished playing, i.e. it's set to the response.done time plus audio playback duration.

An input_audio_buffer.timeout_triggered event (plus events associated with the Response) will be emitted when the timeout is reached. Idle timeout is currently only supported for server_vad mode.

Declaration
[JsonProperty("idle_timeout_ms")]
public int? IdleTimeoutMs { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

InterruptResponse

Optional. Whether or not to automatically interrupt any ongoing response with output to the default conversation (i.e. conversation of auto) when a VAD start event occurs. Defaults to true

Declaration
[JsonProperty("interrupt_response")]
public bool? InterruptResponse { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

PrefixPaddingMs

Optional. Used only for server_vad mode. Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300ms.

Declaration
[JsonProperty("prefix_padding_ms")]
public int? PrefixPaddingMs { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

SilenceDurationMs

Optional. Used only for server_vad mode. Duration of silence to detect speech stop (in milliseconds). Defaults to 500ms. With shorter values the model will respond more quickly, but may jump in on short pauses from the user.

Declaration
[JsonProperty("silence_duration_ms")]
public int? SilenceDurationMs { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Threshold

Optional. Used only for server_vad mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments.

Declaration
[JsonProperty("threshold")]
public float? Threshold { get; set; }
Property Value
Type Description
float?

Extension Methods