Interface ChatOptions

The ChatOptions interface describes the request format for sending a message to an Assistant.

Hierarchy

  • ChatOptions

Properties

filter? messages model?

Properties

Optional filter

filter?: object

A filter against which documents can be retrieved.

messages

messages: string[] | {
    [key: string]: string;
}[]

The messages to send to the Assistant. Can be a list of strings or a list of objects. If sent as a list of objects, must have exactly two keys: role and content. The role key can only be one of user or assistant.

Optional model

model?: string

The large language model to use for answer generation. Must be one of the models defined in ChatModelEnum. If empty, the assistant will default to using 'gpt-4o' model.

Settings

Member Visibility

Theme

On This Page