Interface ChatOptions

Describes the request format for sending a chat or chatStream request to an assistant.

Hierarchy

  • ChatOptions

Properties

filter? includeHighlights? jsonResponse? messages model?

Properties

Optional filter

filter?: object

A filter against which documents can be retrieved.

Optional includeHighlights

includeHighlights?: boolean

If true, the assistant will be instructed to return highlights from the referenced documents that support its response.

Optional jsonResponse

jsonResponse?: boolean

If true, the assistant will be instructed to return a JSON response.

messages

messages: MessagesModel

The MessagesModel 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