Query Fields Stage
In Fusion 5.9.13 and up, you can configure this stage to collapse search results based on a field, such as product_id
, to group all variations of each item into a single search result.
This is useful for ecommerce sites where you want to show a single product with multiple SKUs or variations.
Unresolved directive in <stdin> - include::collapse-enable.asciidoc[]
For additional collapse options, see the configuration reference below.
|
When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.
|
Configure query parameters for Solr search
skip - boolean
Set to true to skip this stage.
Default: false
label - string
A unique label for this stage.
<= 255 characters
condition - string
Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.
rows - integer
Default: 10
start - integer
Default: 0
sort - string
sortOrder - array[object]
object attributes:{type
required : {
display name: Sort Type
type: string
}value
: {
display name: Field Name or Expression
type: string
}order
: {
display name: Sort Order
type: string
}}
queryFields - array[object]
object attributes:{field
: {
display name: Field Name
type: string
}boost
: {
display name: Field Boost
type: number
}}
returnFields - array[string]
returnScore - boolean
Default: true
minimumMatch - string
group - Collapse and Expand Results
field - string
leaderStrategy - Group Leader Strategy
Optional selection criteria for the representative document from each group. Only one method may be used at a time. Defaults to relevancy if not specified.
fieldLeader - By Field Value
Selects the document with the minimum or maximum value for the indicated field to be the representative document for each group.
field - string
selector - string
Allowed values: minmax
sortLeader - By Sort
Selects the representative document for each group based on the order they would be returned with the given sort criteria.
sort - array[object]
object attributes:{type
required : {
display name: Sort Type
type: string
}value
: {
display name: Field Name or Expression
type: string
}order
: {
display name: Sort Order
type: string
}}
collapseHint - string
Hint for collapse optimization.
Allowed values: top_fcblock
nullPolicy - string
Instruction for handling documents with a null values in the collapse field.
Allowed values: expandcollapse
size - integer
The number of results per group. Value greater than 0 will expand the results.
sort - array[object]
Determines the order of results within each group.
object attributes:{type
required : {
display name: Sort Type
type: string
}value
: {
display name: Field Name or Expression
type: string
}order
: {
display name: Sort Order
type: string
}}
expandField - string
Field used for expansion. The default is to use the main group field.
expandQuery - string
Overrides the main query (q), determines which documents to include in the main group.
expandFq - array[string]
Overrides main filter queries (fq), determines which documents to include in the main group. The default is to use the main filter queries.
expandNullGroup - boolean
Whether to group null values into a separate expansion.