langchain.js
    Preparing search index...

    Interface XAIResponsesSearchParameters

    Search parameters configuration. Takes precedence over web_search_preview tool.

    interface XAIResponsesSearchParameters {
        from_date?: string;
        max_search_results?: number;
        mode?: XAIResponsesSearchMode;
        return_citations?: boolean;
        sources?: XAIResponsesSearchSource[];
        to_date?: string;
    }
    Index

    Properties

    from_date? max_search_results? mode? return_citations? sources? to_date?

    Properties

    from_date?: string

    Start date for search results (ISO-8601 YYYY-MM-DD).

    max_search_results?: number

    Maximum number of search results. Defaults to 15 (range: 1-30).

    mode?: XAIResponsesSearchMode

    Search mode. Defaults to on.

    return_citations?: boolean

    Whether to return citations. Defaults to true.

    sources?: XAIResponsesSearchSource[]

    List of search sources. If empty, searches web and X.

    to_date?: string

    End date for search results (ISO-8601 YYYY-MM-DD).

    Settings

    Member Visibility

    On This Page

    Properties