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

disableHistory​

• Optional disableHistory: boolean

Whether to disable history for the chat. Default to false

includeReference​

• Optional includeReference: boolean

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

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-4-turbo" | "gemini-pro" | "claude-3-opus-20240229" | "claude-3-sonnet-20240229" | "claude-3-haiku-20240307"

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