Interface RealtimeModelOptions

interface RealtimeModelOptions {
    additionalLanguages?: string[];
    apiKey: string;
    audioSpeed?: number;
    baseUrl?: string;
    boostedKeywords?: string[];
    connOptions: APIConnectOptions;
    defaultLanguage?: string;
    generateNoInputPokeText?: boolean;
    generateWelcomeMessage?: boolean;
    instructions?: string;
    minWordsToInterrupt?: number;
    model: string;
    multilingualMode?: "auto" | "request";
    noInputEndConversationSec?: number;
    noInputPokeSec?: number;
    noInputPokeText?: string;
    phonicAgent?: string;
    phonicTools?: string[];
    project?: string;
    voice?: string;
    welcomeMessage?: string;
}

Properties

additionalLanguages? apiKey audioSpeed? baseUrl? boostedKeywords? connOptions defaultLanguage? generateNoInputPokeText? generateWelcomeMessage? instructions? minWordsToInterrupt? model multilingualMode? noInputEndConversationSec? noInputPokeSec? noInputPokeText? phonicAgent? phonicTools? project? voice? welcomeMessage?

Properties

Optional additionalLanguages

additionalLanguages?: string[]

apiKey

apiKey: string

Optional audioSpeed

audioSpeed?: number

Optional baseUrl

baseUrl?: string

Optional boostedKeywords

boostedKeywords?: string[]

connOptions

connOptions: APIConnectOptions

Optional defaultLanguage

defaultLanguage?: string

Optional generateNoInputPokeText

generateNoInputPokeText?: boolean

Optional generateWelcomeMessage

generateWelcomeMessage?: boolean

Optional instructions

instructions?: string

Set by updateInstructions via voice.Agent rather than the RealtimeModel constructor

Optional minWordsToInterrupt

minWordsToInterrupt?: number

model

model: string

Optional multilingualMode

multilingualMode?: "auto" | "request"

Optional noInputEndConversationSec

noInputEndConversationSec?: number

Optional noInputPokeSec

noInputPokeSec?: number

Optional noInputPokeText

noInputPokeText?: string

Optional phonicAgent

phonicAgent?: string

Optional phonicTools

phonicTools?: string[]

Optional project

project?: string

Optional voice

voice?: string

Optional welcomeMessage

welcomeMessage?: string

Settings

Member Visibility

Theme

On This Page

additionalLanguagesapiKeyaudioSpeedbaseUrlboostedKeywordsconnOptionsdefaultLanguagegenerateNoInputPokeTextgenerateWelcomeMessageinstructionsminWordsToInterruptmodelmultilingualModenoInputEndConversationSecnoInputPokeSecnoInputPokeTextphonicAgentphonicToolsprojectvoicewelcomeMessage