Interface SearchParameters

The parameters affecting the search response.

interface SearchParameters {
    af?: Record<string, string[]>;
    aq?: string;
    cf?: Record<string, string[]>;
    cq?: string;
    debug?: boolean;
    df?: Record<string, DateRangeRequest[]>;
    enableQuerySyntax?: boolean;
    f?: Record<string, string[]>;
    fExcluded?: Record<string, string[]>;
    firstResult?: number;
    mnf?: Record<string, NumericRangeRequest>;
    nf?: Record<string, NumericRangeRequest[]>;
    numberOfResults?: number;
    q?: string;
    sf?: Record<string, string[]>;
    sortCriteria?: string;
    tab?: string;
}

Properties

af? aq? cf? cq? debug? df? enableQuerySyntax? f? fExcluded? firstResult? mnf? nf? numberOfResults? q? sf? sortCriteria? tab?

Properties

Optionalaf

af?: Record<string, string[]>

A record of the automatic facets, where the key is the facet id, and value is an array containing the selected values.

Optionalaq

aq?: string

The advanced query expression.

Optionalcf

cf?: Record<string, string[]>

A record of the category facets, where the key is the facet id, and value is an array containing the parts of the selected path.

Optionalcq

cq?: string

The constant query expression.

Optionaldebug

debug?: boolean

Determines whether to return debug information for a query.

Optionaldf

df?: Record<string, DateRangeRequest[]>

A record of the date facets, where the key is the facet id, and value is an array containing the date ranges to request.

OptionalenableQuerySyntax

enableQuerySyntax?: boolean

Whether to interpret advanced Coveo Cloud query syntax in the query.

Optionalf

f?: Record<string, string[]>

A record of the facets, where the key is the facet id, and value is an array containing the selected values.

OptionalfExcluded

fExcluded?: Record<string, string[]>

A record of the excluded facets, where the key is the facet id, and value is an array containing the excluded values.

OptionalfirstResult

firstResult?: number

A zero-based index of the first result.

Optionalmnf

mnf?: Record<string, NumericRangeRequest>

A record of the manual numeric facets, where the key is the facet id, and the value is the selected numeric range.

Optionalnf

nf?: Record<string, NumericRangeRequest[]>

A record of the numeric facets, where the key is the facet id, and value is an array containing the numeric ranges to request.

OptionalnumberOfResults

numberOfResults?: number

The number of results to return.

Optionalq

q?: string

The query.

Optionalsf

sf?: Record<string, string[]>

A record of the static filters, where the key is the static filter id, and value is an array containing the selected static filter captions.

OptionalsortCriteria

sortCriteria?: string

The sort expression to order returned results by.

Optionaltab

tab?: string

The active tab id.

Settings

Member Visibility

On This Page

Properties