Skip to content

IBX-9124: Dynamic attribute submodels described in Developer Documentation #2523

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Oct 29, 2024
Merged

IBX-9124: Dynamic attribute submodels described in Developer Documentation #2523

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
000c1c8
Dynamic attribute submodels
julitafalcondusza Oct 23, 2024
2466d03
Update
julitafalcondusza Oct 23, 2024
83f046a
fix
julitafalcondusza Oct 29, 2024
2c3d87d
fix after doc review
julitafalcondusza Oct 29, 2024
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
11 changes: 11 additions & 0 deletions docs/personalization/api_reference/recommendation_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,17 @@ For more information, see [Submodels]([[= user_doc =]]/personalization/recommend

`GET https://reco.perso.ibexa.co/api/v2/00000/john.doe/landing_page.json?numrecs=50&outputtypeid=1&width-range=10:30&color=green`

!!! note "Dynamic attribute submodels"

If dynamic attribute submodels are enabled, you only need to add submodel parameters to the request to trigger dynamic submodels in the upcoming model build.

Dynamic attribute submodels must be enabled by [[= product_name_base =]] Team.
To start using this functionality, contact support@ibexa.co.

When enabled, to build dynamic attribute submodels, you need to send the request (which includes `"ATTRIBUTE_NAME=VALUE"` query parameters) to the scenario with model you want to use submodels for:

`GET https://reco.perso.ibexa.co/api/v2/00000/john.doe/{SCENARIO_NAME}?numrecs=50&outputtypeid=1&color=red`

##### Segment parameters

If you have configured segments, you can use them in the recommendation model. Pass the following parameter
Expand Down
Loading