The Semantics section allows you to configure the settings for the Semantics microservice and its capabilities provided by the Semantics API—Semantics recommendations carousels.

warning

Only Playboard users with permissions for Instance Management can set up and edit the Semantics settings.

When you access the Semantics configuration form for the first time, the Deactivated label appears beside the Semantics section in the side menu. This means that there is no active configuration for the service. Once you have created the configuration, you need to activate the Semantics settings.

To set up the Semantics microservice settings, complete these steps:

1. Configure the settings for the Semantics microservice.
2. Save the configuration and activate Semantics.

Configuring Semantics microservice settings

Configure the following fields to ensure the good performance of the Semantics microservice. You don't need to configure all fields as every instance has different Semantics capabilities activated.

• Max distance: Maximum distance by which the semantic suggestions returned can differ from the input query.
• Pivot fields: Product catalog fields to use as pivots for filtering the query candidates to be returned.
• Valid languages: List of languages supported by the semantic model used to generate Semantics recommendations. Instance's languages not included in the list will be excluded.
• Max Semantics candidates: Maximum number of candidates to be returned per query.
• Filters: List of Semantics API default filters to refine the result set of suggestions. Find more details about the supported filters on the Semantics API page.
• Candidates from catalogue: Product catalog fields configured in the Catalog fields for candidates option are used to obtain semantic candidates, when active.
• Catalogue fields for candidates: Product catalog fields to be used to obtain semantic candidates.

Activating Semantics

Once you have updated the configuration and clicked Save, you need to activate the Semantics microservice by turning On the toggle switch.