Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IBX-8918: Time-slot based models described in User Documentation #316

Merged
merged 8 commits into from
Oct 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion docs/personalization/recommendation_models.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,4 +212,28 @@

You can specify a single or multiple attributes with multiple values for requesting recommendations.
Recommendation are fetched from all the submodels and merged based on the weight (relevance).
If one of the submodels delivers recommendations with better relevance, the results of other models can disappear from the list.
If one of the submodels delivers recommendations with better relevance, the results of other models can disappear from the list.

julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
## Time-slot based models

Time-slot based models consider only a particular range of time rather than the full day when calculating recommendations.
They can be used for [popularity](recommendation_models#popularity-models) and [collaborative](recommendation_models#collaborative-models) types of models.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

These models can be an optimum answer for customers who notice variable consumption of their content or products throughout the day, with different content being popular, for example, in the morning and afternoon.

Check warning on line 222 in docs/personalization/recommendation_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/recommendation_models.md#L222

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/personalization/recommendation_models.md", "range": {"start": {"line": 222, "column": 1}}}, "severity": "WARNING"}
Time-slot based models can cover these needs, as you can request to configure and set specific time slots.

In these models, recommendations are created for both configured time slots and for the main model (for example, for the last 30 days).
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
However, time-slot based recommendations are shown as priority in the hours for which time slots are configured (if requested in a recommendation call).

These time slots:

- can cover any time frame, including minutes (for example, 11 A.M. - 3:30 P.M.), and don't necessarily have to start and end at full hour
- cannot overlap, for example, you cannot set slots 8 A.M. - 11 A.M. and 9 A.M. - 12 A.M. at once
- cannot span between two days, for example, you cannot set a slot to 11 P.M. - 3 A.M.

To use time slot-based models, this feature must be enabled.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

!!! note "Enable time slots"

Time slots must be enabled by and configured [[= product_name_base =]] Team.
To start using this functionality and request that a specific model is created, contact customer support ([email protected]).
Loading