Skip to content

Commit 40851eb

Browse files
IBX-9124: Dynamic attribute submodels described in Developer Documentation (#2523)
* Dynamic attribute submodels * Update * fix * fix after doc review
1 parent 0ee8171 commit 40851eb

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

docs/guide/personalization/developer_guide/recommendation_api.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,37 @@ For more information, see [Submodels]([[= user_doc =]]/personalization/recommend
6969
|Parameter|Example|Description|Value|
7070
|---|---|---|---|
7171
|attribute key|`&color=red`|Applicable if a submodel with the same name and value is configured.|string|
72-
|`userattribute`|gender|If defined, the recommendation engine tries to find the attribute value for the current user and, if found, "prefers" recommendations that are typically followed by users with the same value of the attribute. The default value is null.|string, csv list|
72+
|`userattribute`|gender|If defined, the Personalization server tries to find the attribute value for the current user and, if found, "prefers" recommendations that are typically followed by users with the same value of the attribute. The default value is null.|string, csv list|
73+
74+
!!! note "Multiple submodels in recommendations"
75+
76+
If you send a request with two attribute keys, the response contains an intersection of two recommendation sets that originate from submodels calculated for these attributes.
77+
78+
For example, to get recommendations for items of certain type that are limited by submodels based on both a nominal and numeric attribute, you can send the following request:
79+
80+
`GET https://reco.perso.ibexa.co/api/v2/00000/john.doe/landing_page.json?numrecs=50&outputtypeid=1&width-range=10:30&color=green`
81+
82+
!!! note "Dynamic attribute submodels"
83+
84+
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.
85+
86+
Dynamic attribute submodels must be enabled by [[= product_name_base =]] Team.
87+
To start using this functionality, contact [email protected].
88+
89+
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:
90+
91+
`GET https://reco.perso.ibexa.co/api/v2/00000/john.doe/{SCENARIO_NAME}?numrecs=50&outputtypeid=1&color=red`
92+
93+
##### Segment parameters
94+
95+
If you have configured segments, you can use them in the recommendation model. Pass the following parameter
96+
to request recommendations for a specific segment or segment group.
97+
98+
Parameter|Example|Description|Value|
99+
|---|---|---|---|
100+
|`segments`|`&segments=7,8,10,11`|ID from segment group management|string|
101+
102+
For more information, see [Segments]([[= user_doc =]]/personalization/segment_management).
73103

74104
## Responses
75105

0 commit comments

Comments
 (0)