@squidcloud/client
    Preparing search index...

    Interface AiQueryOptions

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

    interface AiQueryOptions {
        analyzeResultsOptions?: AiQueryAnalyzeResultsOptions;
        collectionsToUse?: string[];
        enableCodeInterpreter?: boolean;
        enableRawResults?: boolean;
        generateQueryOptions?: AiQueryGenerateQueryOptions;
        generateWalkthrough?: boolean;
        instructions?: string;
        maxErrorCorrections?: number;
        overrideModel?: string;
        selectCollectionsOptions?: AiQuerySelectCollectionsOptions;
        sessionContext?: AiSessionContext;
    }
    Index

    Properties

    analyzeResultsOptions? collectionsToUse? enableCodeInterpreter? enableRawResults? generateQueryOptions? generateWalkthrough? instructions? maxErrorCorrections? overrideModel? selectCollectionsOptions? sessionContext?

    Properties

    analyzeResultsOptions?: AiQueryAnalyzeResultsOptions

    Options specify how to query result should be analyzed (processed) before returning it to user.

    collectionsToUse?: string[]

    Set of collections that can be used in a native query. @deprecated, use 'selectCollectionsOptions.collectionsToUse'. @internal.

    enableCodeInterpreter?: boolean

    Whether to enable a code interpreter for query execution. @deprecated. Use analyzeResultsOptions.enableCodeInterpreter. @internal.

    enableRawResults?: boolean

    Whether to enable raw results output.

    generateQueryOptions?: AiQueryGenerateQueryOptions

    Options for the query generation stage.

    generateWalkthrough?: boolean

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

    instructions?: string

    Custom instructions to modify AI query generation behavior. Used for all stages unless there is a per-stage override.

    maxErrorCorrections?: number

    The number of allowed retries in case of errors during query execution. Defaults to 2. @deprecated. Use generateQueryOptions.maxErrorCorrections @internal.

    overrideModel?: string

    Specific AI model override for the query execution. @deprecated. Use per-stage models. @internal.

    selectCollectionsOptions?: AiQuerySelectCollectionsOptions

    Options for the collection selection stage.

    sessionContext?: AiSessionContext

    Session information for the AI query execution.

    Settings

    Member Visibility

    On This Page

    Properties