@squidcloud/client
    Preparing search index...

    Interface AiQueryResponse

    Response from an AI query execution. Contains the generated answer, optional explanation, and executed query details.

    interface AiQueryResponse {
        answer: string;
        clarificationQuestion?: string;
        executedQueries: ExecutedQueryInfo[];
        explanation?: string;
        queryMarkdownType?: string;
        rawResultsUrl?: string;
        success: boolean;
        usedCodeInterpreter?: boolean;
    }
    Index

    Properties

    answer clarificationQuestion? executedQueries explanation? queryMarkdownType? rawResultsUrl? success usedCodeInterpreter?

    Properties

    answer: string

    AI-generated answer for the query.

    clarificationQuestion?: string

    When the AI needs clarification to generate a query, this field contains the clarification question. Only populated when generateQueryOptions.allowClarification is enabled, and the AI determines it cannot generate a valid query without more information.

    executedQueries: ExecutedQueryInfo[]

    Executed queries with their details and raw result URLs.

    explanation?: string

    Optional explanation for the AI-generated answer.

    queryMarkdownType?: string

    Markdown format type of the executed query response.

    rawResultsUrl?: string

    Use ExecutedQueryInfo.rawResult in executedQueries instead. URL to access raw results from the first executed query. Populated for backward compatibility.

    success: boolean

    Indicates whether the query execution was successful.

    usedCodeInterpreter?: boolean

    Indicates whether a code interpreter was used to analyze the results.

    Settings

    Member Visibility

    On This Page

    Properties