Azure Connectors Node.js SDK
    Preparing search index...

    Options for the getSuggestions operation.

    interface GetSuggestionsOptions {
        abortSignal?: AbortSignalLike;
        countryCode?: string;
        domain?: string[];
        geoPoint?: string;
        includeSpellcheck?: string;
        includeTba?: string;
        includeTbd?: string;
        includeTest?: string;
        keyword?: string;
        latlong?: string;
        locale?: string;
        localStartEndDateTime?: string[];
        onResponse?: ConnectorRawResponseCallback;
        preferredCountry?: string;
        radius?: string;
        resource?: string[];
        segmentId?: string[];
        size?: string;
        source?: string;
        startEndDateTime?: string[];
        tracingOptions?: OperationTracingOptions;
        unit?: string;
    }

    Hierarchy (View Summary)

    Index
    abortSignal?: AbortSignalLike

    Signal used to cancel the operation.

    countryCode?: string

    The filter suggestions by country code.

    domain?: string[]

    The filter for entities based on domains they are available on.

    geoPoint?: string

    The filter for events by geoHash.

    includeSpellcheck?: string

    Indicates whether to include spell check suggestions in the response.

    includeTba?: string

    Indicates whether to include events with date to be announced (TBA). Defaults to no if date parameter sent, yes otherwise.

    includeTbd?: string

    Indicates whether to include events with a date to be defined (TBD). Defaults to no if date parameter sent, yes otherwise.

    includeTest?: string

    Indicates whether to include entities flagged as test in the response.

    keyword?: string

    The keyword to search on.

    latlong?: string

    The filter for events by latitude and longitude. This filter is deprecated and may be removed in a future release, please use geoPoint instead.

    locale?: string

    The locale in ISO code format. Multiple comma-separated values can be provided.

    localStartEndDateTime?: string[]

    The filter for events where event local start and end date overlap this range.

    Callback invoked with the complete response before the operation returns or throws.

    preferredCountry?: string

    The popularity boost by country, default is us.

    radius?: string

    The radius of the area in which we want to search for events.

    resource?: string[]

    Which resources to include in the suggest response, defaults to all resources.

    segmentId?: string[]

    The filter suggestions by segment identifier.

    size?: string

    Size of every entity returned in the response.

    source?: string

    The filter for entities by their primary source name or publishing source name.

    startEndDateTime?: string[]

    The filter for events where event start and end date overlap this range.

    tracingOptions?: OperationTracingOptions

    Context used to parent the operation's tracing span.

    unit?: string

    The unit of the radius.