Interface VPAOptions

interface VPAOptions {
    allowInterruptions: boolean;
    beforeLLMCallback: BeforeLLMCallback;
    beforeTTSCallback: BeforeTTSCallback;
    chatCtx?: ChatContext;
    fncCtx?: FunctionContext;
    interruptMinWords: number;
    interruptSpeechDuration: number;
    maxNestedFncCalls: number;
    minEndpointingDelay: number;
    noiseCancellation?: NoiseCancellationOptions;
    preemptiveSynthesis: boolean;
    transcription: AgentTranscriptionOptions;
    turnDetector?: TurnDetector;
}

Properties

allowInterruptions beforeLLMCallback beforeTTSCallback chatCtx? fncCtx? interruptMinWords interruptSpeechDuration maxNestedFncCalls minEndpointingDelay noiseCancellation? preemptiveSynthesis transcription turnDetector?

Properties

allowInterruptions

allowInterruptions: boolean

Whether to allow the user to interrupt the assistant.

beforeLLMCallback

beforeLLMCallback: BeforeLLMCallback

beforeTTSCallback

beforeTTSCallback: BeforeTTSCallback

Optional chatCtx

chatCtx?: ChatContext

Chat context for the assistant.

Optional fncCtx

fncCtx?: FunctionContext

Function context for the assistant.

interruptMinWords

interruptMinWords: number

Minimum number of words to consider for interuption. This may increase latency.

interruptSpeechDuration

interruptSpeechDuration: number

Minimum duration of speech to consider for interruption.

maxNestedFncCalls

maxNestedFncCalls: number

minEndpointingDelay

minEndpointingDelay: number

Delay to wait before considering the user speech done.

Optional noiseCancellation

noiseCancellation?: NoiseCancellationOptions

Noise cancellation options.

preemptiveSynthesis

preemptiveSynthesis: boolean

transcription

transcription: AgentTranscriptionOptions

Options for assistant transcription.

Optional turnDetector

turnDetector?: TurnDetector

Turn detection model to use.

Settings

Member Visibility

Theme

On This Page

allowInterruptionsbeforeLLMCallbackbeforeTTSCallbackchatCtxfncCtxinterruptMinWordsinterruptSpeechDurationmaxNestedFncCallsminEndpointingDelaynoiseCancellationpreemptiveSynthesistranscriptionturnDetector