@squidcloud/client
    Preparing search index...

    Interface AiQueryGenerateQueryOptions

    Options for the query generation stage.

    At this stage Squid generates the database native query based on the user prompt and a set of collections selected in the previous stage.

    interface AiQueryGenerateQueryOptions {
        agentId?: string;
        aiOptions?:
            | BaseAiChatOptions
            | GeminiChatOptions
            | OpenAiChatOptions
            | AnthropicChatOptions;
        allowClarification?: boolean;
        maxErrorCorrections?: number;
    }
    Index

    Properties

    agentId? aiOptions? allowClarification? maxErrorCorrections?

    Properties

    agentId?: string

    If provided, the AI Query process will use this agent to generate a query.

    aiOptions?:
        | BaseAiChatOptions
        | GeminiChatOptions
        | OpenAiChatOptions
        | AnthropicChatOptions

    Customizes AI agent behavior used by the stage.

    allowClarification?: boolean

    When enabled, allows the AI to ask for clarification instead of attempting to generate a query when the request is ambiguous, too complex, or impossible to answer with the available schema. Default: false.

    maxErrorCorrections?: number

    Number of retries due to errors in a generated AI query. Default: 2.

    Settings

    Member Visibility

    On This Page

    Properties