@squidcloud/client
    Preparing search index...

    Interface ExecuteAiQueryOptions

    Options for configuring AI query execution. Includes instructions, model overrides, and additional execution settings.

    interface ExecuteAiQueryOptions {
        collectionsToUse?: string[];
        enableCodeInterpreter?: boolean;
        enableRawResults?: boolean;
        generateWalkthrough?: boolean;
        instructions?: string;
        overrideModel?:
            | "o1"
            | "o1-mini"
            | "o3"
            | "o3-mini"
            | "o4-mini"
            | "gpt-4o"
            | "gpt-4o-mini"
            | "gemini-1.5-pro"
            | "gemini-2.0-flash"
            | "claude-3-5-haiku-latest"
            | "claude-3-5-sonnet-latest"
            | "claude-3-7-sonnet-latest";
    }
    Index

    Properties

    collectionsToUse? enableCodeInterpreter? enableRawResults? generateWalkthrough? instructions? overrideModel?

    Properties

    collectionsToUse?: string[]

    List of collections to use in the AI query.

    enableCodeInterpreter?: boolean

    Whether to enable code interpreter for query execution.

    enableRawResults?: boolean

    Whether to enable raw results output.

    generateWalkthrough?: boolean

    Whether to generate a step-by-step walkthrough for the response.

    instructions?: string

    Custom instructions to modify AI query behavior.

    overrideModel?:
        | "o1"
        | "o1-mini"
        | "o3"
        | "o3-mini"
        | "o4-mini"
        | "gpt-4o"
        | "gpt-4o-mini"
        | "gemini-1.5-pro"
        | "gemini-2.0-flash"
        | "claude-3-5-haiku-latest"
        | "claude-3-5-sonnet-latest"
        | "claude-3-7-sonnet-latest"

    Specific AI model override for the query execution.

    Settings

    Member Visibility

    On This Page

    Properties