@squidcloud/client
    Preparing search index...

    Interface AiKnowledgeBaseChatOptions

    The options for the AI knowledgebase search method.

    interface AiKnowledgeBaseChatOptions {
        chatModel?: string;
        chunkLimit?: number;
        contextMetadataFilter?: AiContextMetadataFilter;
        includeMetadata?: boolean;
        includeReference?: boolean;
        limit?: number;
        rerankProvider?: "cohere" | "none";
    }
    Index

    Properties

    chatModel? chunkLimit? contextMetadataFilter? includeMetadata? includeReference? limit? rerankProvider?

    Properties

    chatModel?: string

    Which chat model to use when asking the question

    chunkLimit?: number

    How many chunks to look over. Defaults to 100

    contextMetadataFilter?: AiContextMetadataFilter

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

    includeMetadata?: boolean

    Include metadata in the context

    includeReference?: boolean

    Whether to include references from the source context in the response. Default to false.

    limit?: number

    The maximum number of results to return

    rerankProvider?: "cohere" | "none"

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

    Settings

    Member Visibility

    On This Page

    Properties