@squidcloud/client
    Preparing search index...

    Interface AiQueryRequestOptions

    Options of a single AI query call: the query options plus a credential the client sends as a request header.

    interface AiQueryRequestOptions {
        accessToken?: string;
        analyzeResultsOptions?: AiQueryAnalyzeResultsOptions;
        enableRawResults?: boolean;
        generateQueriesOnly?: boolean;
        generateQueryOptions?: AiQueryGenerateQueryOptions;
        instructions?: string;
        memoryOptions?: AiAgentMemoryOptions;
        selectCollectionsOptions?: AiQuerySelectCollectionsOptions;
        sessionContext?: PartialBy<AiSessionContext, "agentId">;
        validateWithAiOptions?: AiQueryValidateWithAiOptions;
    }

    Hierarchy (View Summary)

    Index
    accessToken? analyzeResultsOptions? enableRawResults? generateQueriesOnly? generateQueryOptions? instructions? memoryOptions? selectCollectionsOptions? sessionContext? validateWithAiOptions?
    accessToken?: string

    Access token the generated queries run with in place of the integration's stored secret, for integration types that support it. Other types ignore it. Sent in the x-squid-integration-access-tokens request header rather than with the options, so it is never stored.

    analyzeResultsOptions?: AiQueryAnalyzeResultsOptions

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

    enableRawResults?: boolean

    Whether to enable raw results output.

    generateQueriesOnly?: boolean

    When true, returns generated queries without executing or analyzing them. Default: false.

    generateQueryOptions?: AiQueryGenerateQueryOptions

    Options for the query generation stage.

    instructions?: string

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

    memoryOptions?: AiAgentMemoryOptions

    memory options

    selectCollectionsOptions?: AiQuerySelectCollectionsOptions

    Options for the collection selection stage.

    sessionContext?: PartialBy<AiSessionContext, "agentId">

    Session information for the AI query execution.

    validateWithAiOptions?: AiQueryValidateWithAiOptions

    Optional AI validation of generated queries. Can be used independently or with generateQueriesOnly.

    Settings
    Member Visibility

    On This Page
    Properties