@squidcloud/client
    Preparing search index...

    Interface QueryAssistantOptions

    The options for configuring an AI assistant's behavior and response.

    interface QueryAssistantOptions {
        agentContext?: Record<string, unknown>;
        functionContexts?: Record<string, Record<string, unknown>>;
        instructions?: string;
        model?:
            | "o1"
            | "o3"
            | "o3-mini"
            | "o4-mini"
            | "gpt-5"
            | "gpt-5-mini"
            | "gpt-5-nano"
            | "gpt-4.1"
            | "gpt-4.1-mini"
            | "gpt-4.1-nano"
            | "gpt-4o"
            | "gpt-4o-mini";
        reasoningEffort?: AiReasoningEffort;
        responseFormat?: AiAgentResponseFormat;
    }
    Index

    Properties

    agentContext? functionContexts? instructions? model? reasoningEffort? responseFormat?

    Properties

    agentContext?: Record<string, unknown>

    Additional context provided to all AI functions for processing.

    functionContexts?: Record<string, Record<string, unknown>>

    Specific context provided per AI function, keyed by function ID.

    instructions?: string

    Custom instructions to guide the assistant's behavior, if provided.

    model?:
        | "o1"
        | "o3"
        | "o3-mini"
        | "o4-mini"
        | "gpt-5"
        | "gpt-5-mini"
        | "gpt-5-nano"
        | "gpt-4.1"
        | "gpt-4.1-mini"
        | "gpt-4.1-nano"
        | "gpt-4o"
        | "gpt-4o-mini"

    The OpenAI chat model to use for the assistant, if specified.

    reasoningEffort?: AiReasoningEffort

    The level of reasoning effort to apply, as defined by OpenAI.

    responseFormat?: AiAgentResponseFormat

    The desired format of the AI model's response; defaults to 'text'.

    Settings

    Member Visibility

    On This Page

    Properties