AAI SDK
    Preparing search index...

    Interface SttOpenOptions

    Options the host passes when opening an STT stream.

    interface SttOpenOptions {
        agentContext?: string;
        apiKey: string;
        sampleRate: number;
        signal: AbortSignal;
        sttPrompt?: string;
    }
    Index
    agentContext? apiKey sampleRate signal sttPrompt?
    agentContext?: string

    Initial agent-side context to seed at connect time (e.g. the opening greeting), for providers that support it. Providers that don't support it, or whose resolved model doesn't qualify, ignore this.

    apiKey: string

    Provider API key, resolved from the agent's env.

    sampleRate: number

    Capture sample rate of the inbound PCM, in Hz.

    signal: AbortSignal
    sttPrompt?: string

    Settings
    Member Visibility

    On This Page
    Properties