Interface AiSearchOptions

The options for the AI agent search method.

interface AiSearchOptions {
    contextMetadataFilter?: AiContextMetadataFilter;
    contextMetadataFilterForKnowledgeBase?: Record<
        string,
        AiContextMetadataFilter,
    >;
    limit?: number;
    prompt: string;
    rerankProvider?: "cohere"
    | "none";
}

Properties

contextMetadataFilter?: AiContextMetadataFilter

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

contextMetadataFilterForKnowledgeBase?: Record<string, AiContextMetadataFilter>

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

limit?: number

The maximum number of results to return

prompt: string

The prompt to search for

rerankProvider?: "cohere" | "none"

Which provider's reranker to use for reranking the context. Defaults to 'cohere'.