Member Junction
    Preparing search index...

    Interface WebSearchParams

    Parameters for a web search. Only Query is required.

    interface WebSearchParams {
        Country?: string;
        ExcludeDomains?: string[];
        Freshness?: WebSearchFreshness;
        IncludeAnswer?: boolean;
        IncludeDomains?: string[];
        Language?: string;
        MaxResults?: number;
        Provider?: string;
        Query: string;
        SafeSearch?: WebSearchSafeSearch;
    }
    Index

    Properties

    Country? ExcludeDomains? Freshness? IncludeAnswer? IncludeDomains? Language? MaxResults? Provider? Query SafeSearch?

    Properties

    Country?: string

    Two-letter country code for localisation, e.g. US, GB.

    ExcludeDomains?: string[]

    Exclude these domains, where the provider supports it.

    Freshness?: WebSearchFreshness

    Restrict by recency.

    IncludeAnswer?: boolean

    Ask for a synthesized answer as well as hits.

    Restricts selection to providers whose WebSearchCapabilities.Answer is true — so it changes which provider serves the request, not just what comes back.

    IncludeDomains?: string[]

    Restrict results to these domains, where the provider supports it.

    Language?: string

    Language code for results, e.g. en.

    MaxResults?: number

    Desired result count. Clamped to the serving provider's cap. Default 10.

    Provider?: string

    Pin the search to one provider, by Name (case-insensitive) or DriverClass.

    When set, there is no failover. If the named provider is missing, inactive, unavailable or incapable of what was asked, the call fails with a specific result code. A silent substitution is how you discover in production that a "semantic research" search has been served by a keyword engine for a month.

    Query: string

    The search query. Required, non-empty.

    SafeSearch?: WebSearchSafeSearch

    Adult-content filter. Default moderate.

    Settings

    Member Visibility

    On This Page

    Properties