Interface BaseAiKnowledgeBaseSearchContextsRequest

Request structure for searching AI contexts in the AiKnowledgeBase.

interface BaseAiKnowledgeBaseSearchContextsRequest {
    chatModel?: string;
    contextMetadataFilter?: AiContextMetadataFilter;
    knowledgeBaseId: string;
    limit?: number;
    rerank?: boolean;
}

Hierarchy (View Summary)

BaseAiKnowledgeBaseSearchContextsRequest
- AiKnowledgeBaseSearchContextsWithPromptRequest
- AiKnowledgeBaseSearchContextsWithContextIdRequest

Index

Properties

chatModel? contextMetadataFilter? knowledgeBaseId limit? rerank?

Properties

`Optional`chatModel

chatModel?: string

Which chat model to use when doing reranking

`Optional`contextMetadataFilter

contextMetadataFilter?: AiContextMetadataFilter

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

knowledgeBaseId

knowledgeBaseId: string

The id of the AiKnowledgeBase

`Optional`limit

limit?: number

The maximum number of results to return

`Optional`rerank

rerank?: boolean

Whether to rerank the results with AI and provide reasoning - defaults to true