Suggest Block Response
What is Suggest Block Response?
On this page you can configure two different aspects of the Suggest module. The search strategies allow, for example, manipulation of the queries or when suggestions should be returned. The field settings allow to influence which additional fields can be filtered and sorted.
This page gives you an overview of how the configuration options of the strategies and field settings affect the Suggest module.
1. What are search strategies?
Search strategies are used to set the above mentioned query manipulations before the search.
Examples:
| Starts with | Adds a * after each word entered Example: "bik tool" | bik* tool* |
Ends with | Inserts a * before each word Example: "ike ols" | *ike *ols |
| Starts or ends with wordwise | Combines the two strategies above including all permutations to one Example: "bike tools" | *bike *tools || *bike tools* || bike* *tools || bike* tools* |
| Exact | Adds a + in front of each word Example: "bike tools" | +bike +tools |
| Phrase | Performs a search with the term in quotation marks Example: "bike tools" | "bike tools" |
| Error tolerant | The normal error tolerant search is used. The default case if no strategy is specified for a channel | |
| Article Number | Instead of a normal search, a pattern is searched for in the specified search field. If a result is found using this pattern, the other strategies are not executed. |
The execution of the search strategies can be further restricted with the following (optional) conditions:
| Min. Word Count | The query must contain at least X words. |
| Max. Word Count | The query may contain a maximum of X words. |
| Min. Query Length | The query must contain at least X characters. |
| Max. Query Length | The query may contain a maximum of X characters |
| Search Field | The field to be searched. Depends on the strategy type. Article Number strategies require the field, for all others it is optional and may only be set to the fields "Name" or "Additional Search Content & Name". |
| Reduction | The relevance of the results of the search strategies can be devaluated. If results are found using two search strategies, they will be sorted by relevance. |
1.1 Examples for the use of search strategies
In that case, a Suggest query is executed first without strategies:
As you can see, FACT-Finder's error tolerance takes effect, since "Vaude" is also found, although it is not searched for. Now the following search strategy is added:
If you now enter the same query again, you will see that the error-tolerant search does not take effect, and therefore fewer suggestions are found:
Important
Once a search strategy is configured for a channel, the error-tolerant search does not work.
So, in case of doubt, it is recommended to add the fault-tolerant search as a fallback with a devaluation.
Example:
By means of this behavior, it is also possible to enable the Suggest to take effect only with longer queries. As an example, with the following strategy, a Suggest result was obtained only with a query of six characters instead of the usual two characters:
Using the article number strategy, you can output suggestions based on article numbers:
This requires a suitable pattern that matches the article numbers and a specification in which field the pattern to be searched is available.
It is also recommended to add a "fuzzy" strategy, otherwise only article numbers with the specified pattern can be found.
1.2. Summary search strategies
With search strategies...
... can be used to manipulate the search queries to FACT-Finder.
... the triggering of Suggest queries can be linked to conditions.
... article numbers can be made known to the Suggest.
... can easily break the Suggest, so you should do extensive testing and if in doubt add an error tolerant strategy with devaluation.
2. What are field settings
Normally, only the standard fields like Name or Category are sortable and filterable in Suggest. (Attribute Suggest fields are normally neither sortable nor filterable. This can be configured via the field settings).
The settings are divided into groups and the group names are not self-namable, unlike the Ranking Rules, but represent the Suggest Types defined on the Suggest main page in the table. In each group, each field may be configured only once.
The following settings can be made for a field within a suggestion type:
| Filterable | The field becomes filterable for this suggest type. |
| Append filter to param | Adds filters for the field to the Suggest parameters. |
| Sortable | The field becomes sortable for this suggest type. |
| Append sort to param | Adds the sort value sent with the suggest request to the parameter list. If nothing was sent and "Override sort on param" is not active, it will be written to the params in descending order. |
| Override sort on param | Always overrides the sort value of the suggest query. Also overrides "Append sort to param" (this is possible to combine, but we wouldn't recommend it, since there is no significant benefit to be seen from it) |
Info
The Suggest search logic mode "Search with block response" has the advantage of processing your Suggest queries faster, because it makes the Suggest databases smaller.
This advantage has its necessity for particularly large data sets. With smaller data sets, this may result in less precise suggestions.
2.1 Examples of field settings
The following settings have been made on the Suggest Import page. This must be set before to be able to select the possibilities in the fields -> Field name:
After you have made the necessary setting in the Suggest Import, you can add a new field in the Suggest Block Response page.
With the help of the Swagger Ui you can now set filters that influence the Suggest. As an example, we have set the filter "Price" so that only products with a price between 0 - 10 should be displayed. The term searched for in the example would be "Ring".
In the response you can see that products between 0 - 10 are played.
If you remove the set filter again, you will be shown products without a price limit.
2.2. Summary Field Settings
The field settings on the Suggest Block Response page can be used to:
... override default Suggest field settings for each type
... make attribute fields sortable and filterable
... transfer the filter and sort specifications from the requests to the suggest parameters
... overwrite the sorting parameters
Attention
You cannot use the Suggest search logic mode "Search with block response" if you use the Customer Specific Pricing module. This allows you to offer customer specific prices for products. See CSP
For more technical information, please click on the following link.
https://doku.fact-finder.de/display/DOC/.Suggest+Integration+vNGalt