{isLoaded && `
}} />}
Powered by Lucidworks Agent Studio
;
};
[localhost link]: http://localhost:3000/docs/5/fusion/reference/config-ref/pipeline-stages/query-stages/recommendation-boosting-query-stage
[mintlify link]: https://doc.lucidworks.com/docs/5/fusion/reference/config-ref/pipeline-stages/query-stages/recommendation-boosting-query-stage
[old doc.lw link]: https://doc.lucidworks.com/fusion/5.9/511
The Boost with Signals query pipeline stage uses [aggregated signals](/docs/5/fusion/getting-data-out/query-enhancement/signals/aggregations) to selectively boost items in the set of search results.
Using the main query and the stage configuration parameters, this stage performs a secondary query to the `COLLECTION_NAME_signals_aggr` collection and returns updated boost weights for the items in the main query’s search results.
Items that have received more user interaction also receive higher boost weights.
See [Recommendation Methods](/docs/5/fusion/getting-data-out/query-enhancement/recommendations/recommendation-methods) for more information.
This stage supports [asynchronous processing](/docs/5/fusion/getting-data-out/query-basics/query-pipelines/overview).
This stage accesses the `signals_aggr` collection.
Before using it, verify that the following [permission](/docs/5/fusion/operations/security/access-control/permissions) is set:\
`GET:/solr/COLLECTION_NAME_signals_aggr/select`
## Signal sources
This stage works with aggregated signals from two sources:
### Fusion native signals
Signals captured via the [Fusion Signals API](/docs/5/fusion/getting-data-in/indexing/indexing-signals/overview) and aggregated by Fusion’s SQL aggregation jobs.
**Collection**: `{APP_NAME}_signals_aggr` (created by Fusion aggregation jobs)
**Aggregation Type values**: Typically `clicks`, `sessions`, or custom aggregation types configured in Fusion
### Platform signals
Pre-aggregated signals from [Lucidworks Platform](/docs/lw-platform/lw-analytics/signals/overview) can be captured via [Signals Beacon](/docs/lw-platform/lw-analytics/signals/signals-beacon) or [Platform Signals API](/docs/lw-platform/lw-analytics/signals/signals-api), then retrieved and indexed by Fusion.
**Collection**: `{APP_NAME}_signals_aggr` (populated by Fusion)
**Aggregation Type values**: Platform formula names such as `formula1`, `formula2`, configured in [Platform signals integration](/docs/5/fusion/getting-data-in/platform-signals/configuration)
**Configuration differences for Platform signals**:
* **Aggregation Type**: Set to the Platform formula name (e.g., `formula1`)
* **Rollup Field**: Use `doc_id` (without `_s` suffix)
* **Rollup Weight Strategy**: Use `weight_d`
See [Platform Signals Integration](/docs/5/fusion/getting-data-in/platform-signals/overview) for setup details.
## Configuration overview
The fields below are especially useful to understand when configuring this stage.
| | |
| ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Number of Recommendations** `numRecommendations` | Sets the `rows` query param in the main query as the maximum number of query results which will be boosted by this pipeline stage. |
| **Number of Signals** `numSignals` | Sets the `rows` query param in the query that searches the `COLLECTION_NAME_signals_aggr` collection, so only the specified number of aggregated signals are retrieved and used for boosting. When signals boosting is applied to a query, aggregated signals records are queried from the appropriate `_signals_aggr` collection to find out the popularity or boost weight for documents which have signals. `numSignals` limits the number of records to be queried from a `_signals_aggr` collection and used to calculate this boost. |
| **Aggregation Type** `aggrType` | A filter to retrieve aggregated signals in the `COLLECTION_NAME_signals_aggr` collection per each aggregated signal’s `aggr_type_s` field value. |
| **Solr Field to Boost On** `boostId` | The document field in the main collection on which to perform boosting. Typically it should use default field, which is `id`. This field corresponds to the **Rollup Field**/`rollupField` field. Together, these two fields act like a `FIELD:VALUE` pair in the query modification for boosting. |
| **Boost Method** `boostingMethod` | This adds a query parameter to the original query, either “query-param” or “query-parser”. The result is `(“query-param” or “query-parser”) + Boost Param(“boost” or `bq`)`, as in the examples below:
●“query-parser”+"boost", result boost query param\*\*: `bp_xxx_bbqx="map(query({!field f='id' v=‘6239046,13026192}), 0, 0, 1, 27.1705)"` When `Boost Param` uses `bq`, similar logic applies. When **Boost Param**/`boostingParam` uses “boost”, it works with both “query-param” and “query-parser”. |
| **Rollup Field** `rollupField` | Indicates which aggregated signal document field the boost parameter will use for the final boosting. It works in combination with the **Solr Field to Boost On**/`boostId` field. This should be set to the field in the aggregated signal collection that stores the doc list that is aggregated as one record. By default it’s set to `doc_id_s`. |
| **Rollup Weight Field** `rollupWeightField` | Indicates the final boost weight used to calculate the new score for docs retrieved by the main query. Similar to **Rollup Field**/`rollupField` above, this should be set to the field in the aggregated signal collection that stores the final weight that was calculated. By default it’s `weight_d`. |
| **Final Boost Weight Expression** `weightExpression` | Calculates the final weight using the weight and score retrieved from the `COLLECTION_NAME_signals_aggr` collection. The default value is `math:log(weight_d + 1) + 10 * math:log(score+1)`. |
## Solr query parameters
These parameters are used in the **Solr Query parameters**/`queryParams` field for retrieving signal aggregation docs from the `COLLECTION_NAME_signals_aggr` collection. These Solr query params will affect which aggregated signals are used for producing the boosting parameter on the main query.
| | |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `qf=query_t` | Defines which field to query. In the default case, the query searches on the `query_t` field of aggregated signal docs. |
| `pf=query_t^50` | Boosts docs within the set of retrieved docs using phrase matching. |
| `pf2=query_t^20` | `pf2` is similar to `pf`; the difference is that `pf2` works on bigram phrases. |
| `pf3=query_t^10` | `pf3` is similar to `pf`; the difference is that `pf3` works on trigram phrases. |
## FAQs
**If there is `fq` in the main query, how is it matched with the correct aggregated signal?**
In this case, you need to use the `lw.rec.fq` query parameter in the main query. `lw.rec.fq` can be parsed by the Boost with Signals stage, and therefore the filters specified in it can be added to the Solr query that is retrieving the aggregated signals.
For example, if we have filter query param `fq=format:CD&fq=name:Latin`, this needs to be translated into `lw.rec.fq=filters_s:"format:cd $ name:latin"`. Values must be lowercase. The final main query should be:
```sh wrap theme={"dark"}
http://FUSION_HOST:FUSION_PORT/api/apps/demo_app/query-pipelines/demo_app/collections/demo_app/select?echoParams=all&wt=json&json.nl=arrarr&sort&start=0&q=apple&debug=true&rows=10&lw.rec.fq=filters_s:"format:cd $ name:latin"
```
Now the Boost with Signals stage will only retrieve aggregated signals that have the same filter query.
If there are multiple `fq` values (for example, `format:cd` and `name:latin`), they are ordered alphabetically as strings and joined with " $" (a$ with a space on each side). In the example, `"format:cd $ name:latin"`.
**What if my aggregated signals are in a different collection?**
You can point the Boost with Signals stage to a different signal collection by adding a `collection` parameter in the `Solr Query Parameters` section.
## Query pipeline stage condition examples
Stages can be triggered conditionally when a script in the **Condition** field evaluates to true.
Some examples are shown below.
Run this stage only for mobile clients:
```js wrap theme={"dark"}
params.deviceType === "mobile"
```
Run this stage when debugging is enabled:
```js wrap theme={"dark"}
params.debug === "true"
```
Run this stage when the query includes a specific term:
```js wrap theme={"dark"}
params.q && params.q.includes("sale")
```
Run this stage when multiple conditions are met:
```js wrap theme={"dark"}
request.hasParam("fusion-user-name") && request.getFirstParam("fusion-user-name").equals("SuperUser");
!request.hasParam("isFusionPluginQuery")
```
The first condition checks that the request parameter "fusion-user-name" is present and has the value "SuperUser".
The second condition checks that the request parameter "isFusionPluginQuery" is not present.
## Configuration
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.
## Query pipeline stage condition examples
Stages can be triggered conditionally when a script in the **Condition** field evaluates to true.
Some examples are shown below.
Run this stage only for mobile clients:
```js wrap theme={"dark"}
params.deviceType === "mobile"
```
Run this stage when debugging is enabled:
```js wrap theme={"dark"}
params.debug === "true"
```
Run this stage when the query includes a specific term:
```js wrap theme={"dark"}
params.q && params.q.includes("sale")
```
Run this stage when multiple conditions are met:
```js wrap theme={"dark"}
request.hasParam("fusion-user-name") && request.getFirstParam("fusion-user-name").equals("SuperUser");
!request.hasParam("isFusionPluginQuery")
```
The first condition checks that the request parameter "fusion-user-name" is present and has the value "SuperUser".
The second condition checks that the request parameter "isFusionPluginQuery" is not present.
## Configuration