Skip to main content

Interface: AiChatbotChatOptions

The options for the AI chatbot chat method.

Properties​

chatId​

• Optional chatId: string

A unique chat ID, if the same chat ID is used again and history is not disabled, it will continue the conversation

contextMetadataFilter​

• Optional contextMetadataFilter: AiContextMetadataFilter

A set of filters that will limit the context the AI can access

disableHistory​

• Optional disableHistory: boolean

Whether to disable history for the chat. Default to false

fileUrls​

• Optional fileUrls: AiFileUrl[]

File URLs (only images supported at the moment)

functions​

• Optional functions: string[]

Functions to expose to the AI

includeReference​

• Optional includeReference: boolean

Whether to include references from the source context in the response. Default to false

instructions​

• Optional instructions: string[]

A list of instructions to include with the prompt

maxTokens​

• Optional maxTokens: number

The maximum number of tokens to use when making the request to the AI model. Default to the max tokens the model can accept

overrideModel​

• Optional overrideModel: "gpt-3.5-turbo" | "gpt-3.5-turbo-1106" | "gpt-4" | "gpt-4-turbo-preview" | "gpt-4o" | "gpt-4o-mini" | "gpt-4o-2024-08-06" | "o1-preview" | "o1-mini" | "gpt-4-turbo" | "gemini-pro" | "gemini-1.5-pro" | "gemini-1.5-flash" | "claude-3-opus-20240229" | "claude-3-sonnet-20240229" | "claude-3-haiku-20240307" | "claude-3-5-sonnet-20240620"

The model to use for this chat. If not provided, the profile model will be used

responseFormat​

• Optional responseFormat: OpenAiResponseFormat

The format of the response from the AI model. Note that not all models support JSON format. Default to 'text'

smoothTyping​

• Optional smoothTyping: boolean

Whether to response in a "smooth typing" way, beneficial when the chat result is displayed in a UI. Default to true

temperature​

• Optional temperature: number

The temperature to use when sampling from the model. Default to 0.5

topP​

• Optional topP: number

The top P value to use when sampling from the model. Default to 1

voiceOptions​

• Optional voiceOptions: OpenAiCreateSpeechOptions

The options to use for the response in voice