Skip to content

@sibilance.is/client v0.1.0-alpha.4


@sibilance.is/client / index / SibilanceConfig

Interface: SibilanceConfig

Defined in: CmdPr/sibilance/client/src/types.ts:118

Sibilance client configuration.

Either surveyKey (production mode) or survey (editor/test mode) must be provided.

Properties

PropertyTypeDescriptionDefined in
surveyKey?stringSurvey key for fetching survey from backend (production mode)CmdPr/sibilance/client/src/types.ts:120
survey?SurveyConfigDirect survey configuration (editor/test mode)CmdPr/sibilance/client/src/types.ts:122
backendUrl?stringSibilance backend URL (optional, defaults to production)CmdPr/sibilance/client/src/types.ts:124
appId?stringVowel app ID (optional - will use default test app if not provided)CmdPr/sibilance/client/src/types.ts:126
voiceConfig?{ [key: string]: any; provider?: "vowel-prime" | "gemini" | "openai"; model?: string; llmProvider?: string; vad?: { enabled: boolean; mode?: "simple" | "advanced"; }; voice?: string; speakingRate?: number; }Voice provider configuration (optional)CmdPr/sibilance/client/src/types.ts:128
voiceConfig.provider?"vowel-prime" | "gemini" | "openai"-CmdPr/sibilance/client/src/types.ts:129
voiceConfig.model?string-CmdPr/sibilance/client/src/types.ts:130
voiceConfig.llmProvider?stringLLM provider for Vowel Prime (groq, openrouter, cerebras, etc.)CmdPr/sibilance/client/src/types.ts:132
voiceConfig.vad?{ enabled: boolean; mode?: "simple" | "advanced"; }-CmdPr/sibilance/client/src/types.ts:133
voiceConfig.vad.enabledboolean-CmdPr/sibilance/client/src/types.ts:134
voiceConfig.vad.mode?"simple" | "advanced"-CmdPr/sibilance/client/src/types.ts:135
voiceConfig.voice?stringInWorld TTS voice IDCmdPr/sibilance/client/src/types.ts:138
voiceConfig.speakingRate?numberInWorld TTS speaking rate (0.5 = slow, 1.0 = normal, 1.5 = fast)CmdPr/sibilance/client/src/types.ts:140
customInstructions?stringCustom instructions to append to system promptCmdPr/sibilance/client/src/types.ts:144
autoStart?booleanAuto-start voice session on mountCmdPr/sibilance/client/src/types.ts:146
initialGreetingPrompt?stringInitial greeting prompt - tells AI which step to start at (pointer only)CmdPr/sibilance/client/src/types.ts:148
enableTestTools?booleanEnable test-specific tools (endTest) - ONLY for platform survey tester, never in productionCmdPr/sibilance/client/src/types.ts:150