Interface ContextOptions

The ContextOptions interface describes the query and optional filter to retrieve context snippets from an Assistant.

Hierarchy

  • ContextOptions

Properties

filter? messages? query? snippetSize? topK?

Properties

Optional filter

filter?: Record<string, string>

Optional filter to apply to the context snippets.

Optional messages

messages?: MessagesModel

The list of MessageModel to use for generating the context. Either query or messages should be provided.

Optional query

query?: string

The query to retrieve context snippets for. Either query or messages should be provided.

Optional snippetSize

snippetSize?: number

The maximum context snippet size. Default is 2048 tokens. Minimum is 512 tokens. Maximum is 8192 tokens.

Optional topK

topK?: number

The maximum number of context snippets to return. Default is 16. Maximum is 64.

Settings

Member Visibility

Theme

On This Page