Skip to main content

Interface: ChatOptions

Options controlling a chat invocation.

Examples​

const options: ChatOptions = {
  model: 'gpt-4o-mini',
  showTyping: true
}
const options: ChatOptions = {
  userId: '123',
  voice: {
    sessionId: 'abc',
    strategy: 'server-vad'
  }
}

Properties​

conversation?​

optional conversation: ConversationInput;

Existing conversation context to continue.

functions?​

optional functions: ChatFunction[];

List of available functions the engine may call.

model?​

optional model: string;

Preferred model identifier.

showTyping?​

optional showTyping: boolean;

Toggle for Discord typing indicator.

temperature?​

optional temperature: number;

Temperature applied to sampling, when supported.

threadId?​

optional threadId: null | string;

Discord thread identifier for context.

userId?​

optional userId: null | string;

Discord user identifier for analytics attribution.

voice?​

optional voice: VoiceChatOptions;

Voice chat configuration enabling hybrid sessions.