@squidcloud/client
    Preparing search index...

    Interface AiQuerySelectCollectionsOptions

    Options for the collection selection stage.

    At this stage Squid selects a subset of collections that will be used by the later stage to generate the real query. It is recommended that the set of collections selected by this stage be broad enough so the query generation stage has a good view of the database.

    interface AiQuerySelectCollectionsOptions {
        aiOptions?:
            | BaseAiChatOptions
            | GeminiChatOptions
            | OpenAiChatOptions
            | OpenAiReasoningChatOptions
            | AnthropicChatOptions;
        collectionsToUse?: string[];
        runMode?: AiQueryCollectionsSelectionStageRunMode;
    }
    Index

    Properties

    aiOptions? collectionsToUse? runMode?

    Properties

    aiOptions?:
        | BaseAiChatOptions
        | GeminiChatOptions
        | OpenAiChatOptions
        | OpenAiReasoningChatOptions
        | AnthropicChatOptions

    Used to customize AI agent behavior used by the stage.

    collectionsToUse?: string[]

    Limits collections to be used in the query only to these collections. When not provided, all collections are used.

    runMode?: AiQueryCollectionsSelectionStageRunMode

    Defines the stage algorithm. Default: 'auto'.

    Settings

    Member Visibility

    On This Page

    Properties