recombee_api_client 5.0.0 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/LICENSE.txt +1 -1
- data/lib/recombee_api_client/api/add_manual_reql_segment.rb +1 -1
- data/lib/recombee_api_client/api/add_search_synonym.rb +1 -1
- data/lib/recombee_api_client/api/create_auto_reql_segmentation.rb +1 -1
- data/lib/recombee_api_client/api/create_manual_reql_segmentation.rb +1 -1
- data/lib/recombee_api_client/api/delete_item.rb +1 -1
- data/lib/recombee_api_client/api/delete_more_items.rb +2 -2
- data/lib/recombee_api_client/api/delete_search_synonym.rb +1 -1
- data/lib/recombee_api_client/api/list_items.rb +3 -3
- data/lib/recombee_api_client/api/list_scenarios.rb +47 -0
- data/lib/recombee_api_client/api/list_users.rb +3 -3
- data/lib/recombee_api_client/api/merge_users.rb +3 -0
- data/lib/recombee_api_client/api/recommend_item_segments_to_item.rb +6 -6
- data/lib/recombee_api_client/api/recommend_item_segments_to_item_segment.rb +6 -6
- data/lib/recombee_api_client/api/recommend_item_segments_to_user.rb +6 -6
- data/lib/recombee_api_client/api/recommend_items_to_item.rb +16 -16
- data/lib/recombee_api_client/api/recommend_items_to_item_segment.rb +14 -14
- data/lib/recombee_api_client/api/recommend_items_to_user.rb +15 -15
- data/lib/recombee_api_client/api/recommend_next_items.rb +4 -3
- data/lib/recombee_api_client/api/recommend_users_to_item.rb +10 -10
- data/lib/recombee_api_client/api/recommend_users_to_user.rb +13 -13
- data/lib/recombee_api_client/api/search_item_segments.rb +5 -6
- data/lib/recombee_api_client/api/search_items.rb +11 -11
- data/lib/recombee_api_client/api/set_item_values.rb +1 -1
- data/lib/recombee_api_client/api/set_user_values.rb +1 -1
- data/lib/recombee_api_client/api/set_view_portion.rb +1 -1
- data/lib/recombee_api_client/api/update_more_items.rb +2 -2
- data/lib/recombee_api_client/version.rb +1 -1
- data/lib/recombee_api_client.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '01199f5f35eecc707fae959cf983926aeb1a27a0abbeba5c04d3aedacf1a750b'
|
|
4
|
+
data.tar.gz: 96df288201b167f39e340732398f1e084d9cf503b778b220e5fadc0638df4b76
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d248ef770c97da18c94379e924ab57943dfea87b7a4f2483fc28f328623763281853362352321c8d5c25cb8b5556bbf82cf688574ded90da8e530bf611b9407c
|
|
7
|
+
data.tar.gz: 8c7748c00edff1a6e5459aa853d18cb743a96ec6e4b0d796ade5b6ec69cd0567fc8e3dfbda3b061141a069439e6011447e26540d41e527d1f67e6ef2104c2d02
|
data/LICENSE.txt
CHANGED
|
@@ -9,7 +9,7 @@ module RecombeeApiClient
|
|
|
9
9
|
##
|
|
10
10
|
#Adds a new Segment into a Manual ReQL Segmentation.
|
|
11
11
|
#
|
|
12
|
-
#The new Segment is defined by a [ReQL](https://docs.recombee.com/reql
|
|
12
|
+
#The new Segment is defined by a [ReQL](https://docs.recombee.com/reql) filter that returns `true` for an item in case that this item belongs to the segment.
|
|
13
13
|
#
|
|
14
14
|
class AddManualReqlSegment < ApiRequest
|
|
15
15
|
attr_reader :segmentation_id, :segment_id, :filter, :title
|
|
@@ -7,7 +7,7 @@ module RecombeeApiClient
|
|
|
7
7
|
require_relative '../errors'
|
|
8
8
|
|
|
9
9
|
##
|
|
10
|
-
#Adds a new synonym for the [Search items](https://docs.recombee.com/api
|
|
10
|
+
#Adds a new synonym for the [Search items](https://docs.recombee.com/api#search-items).
|
|
11
11
|
#
|
|
12
12
|
#When the `term` is used in the search query, the `synonym` is also used for the full-text search.
|
|
13
13
|
#Unless `oneWay=true`, it works also in the opposite way (`synonym` -> `term`).
|
|
@@ -7,7 +7,7 @@ module RecombeeApiClient
|
|
|
7
7
|
require_relative '../errors'
|
|
8
8
|
|
|
9
9
|
##
|
|
10
|
-
#Segment the items using a [ReQL](https://docs.recombee.com/reql
|
|
10
|
+
#Segment the items using a [ReQL](https://docs.recombee.com/reql) expression.
|
|
11
11
|
#
|
|
12
12
|
#For each item, the expression should return a set that contains IDs of segments to which the item belongs to.
|
|
13
13
|
#
|
|
@@ -7,7 +7,7 @@ module RecombeeApiClient
|
|
|
7
7
|
require_relative '../errors'
|
|
8
8
|
|
|
9
9
|
##
|
|
10
|
-
#Segment the items using multiple [ReQL](https://docs.recombee.com/reql
|
|
10
|
+
#Segment the items using multiple [ReQL](https://docs.recombee.com/reql) filters.
|
|
11
11
|
#
|
|
12
12
|
#Use the Add Manual ReQL Items Segment endpoint to create the individual segments.
|
|
13
13
|
#
|
|
@@ -11,7 +11,7 @@ module RecombeeApiClient
|
|
|
11
11
|
#
|
|
12
12
|
#If there are any *purchases*, *ratings*, *bookmarks*, *cart additions*, or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
|
|
13
13
|
#
|
|
14
|
-
#If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql
|
|
14
|
+
#If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.
|
|
15
15
|
#
|
|
16
16
|
class DeleteItem < ApiRequest
|
|
17
17
|
attr_reader :item_id
|
|
@@ -9,7 +9,7 @@ module RecombeeApiClient
|
|
|
9
9
|
##
|
|
10
10
|
#Deletes all the items that pass the filter.
|
|
11
11
|
#
|
|
12
|
-
#If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql
|
|
12
|
+
#If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.
|
|
13
13
|
class DeleteMoreItems < ApiRequest
|
|
14
14
|
attr_reader :filter
|
|
15
15
|
attr_accessor :timeout
|
|
@@ -17,7 +17,7 @@ module RecombeeApiClient
|
|
|
17
17
|
|
|
18
18
|
##
|
|
19
19
|
# * *Required arguments*
|
|
20
|
-
# - +filter+ -> A [ReQL](https://docs.recombee.com/reql
|
|
20
|
+
# - +filter+ -> A [ReQL](https://docs.recombee.com/reql) expression, which returns `true` for the items that shall be updated.
|
|
21
21
|
#
|
|
22
22
|
def initialize(filter)
|
|
23
23
|
@filter = filter
|
|
@@ -7,7 +7,7 @@ module RecombeeApiClient
|
|
|
7
7
|
require_relative '../errors'
|
|
8
8
|
|
|
9
9
|
##
|
|
10
|
-
#Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api
|
|
10
|
+
#Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api#search-items).
|
|
11
11
|
#
|
|
12
12
|
class DeleteSearchSynonym < ApiRequest
|
|
13
13
|
attr_reader :id
|
|
@@ -16,13 +16,13 @@ module RecombeeApiClient
|
|
|
16
16
|
##
|
|
17
17
|
#
|
|
18
18
|
# * *Optional arguments (given as hash optional)*
|
|
19
|
-
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql
|
|
19
|
+
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter items to be listed. Only the items for which the expression is *true* will be returned.
|
|
20
20
|
# - +count+ -> The number of items to be listed.
|
|
21
21
|
# - +offset+ -> Specifies the number of items to skip (ordered by `itemId`).
|
|
22
22
|
# - +returnProperties+ -> With `returnProperties=true`, property values of the listed items are returned along with their IDs in a JSON dictionary.
|
|
23
23
|
#
|
|
24
24
|
#Example response:
|
|
25
|
-
#```
|
|
25
|
+
#```json
|
|
26
26
|
# [
|
|
27
27
|
# {
|
|
28
28
|
# "itemId": "tv-178",
|
|
@@ -44,7 +44,7 @@ module RecombeeApiClient
|
|
|
44
44
|
# - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
|
|
45
45
|
#
|
|
46
46
|
#Example response for `includedProperties=description,price`:
|
|
47
|
-
#```
|
|
47
|
+
#```json
|
|
48
48
|
# [
|
|
49
49
|
# {
|
|
50
50
|
# "itemId": "tv-178",
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
#
|
|
2
|
+
# This file is auto-generated, do not edit
|
|
3
|
+
#
|
|
4
|
+
|
|
5
|
+
module RecombeeApiClient
|
|
6
|
+
require_relative 'request'
|
|
7
|
+
require_relative '../errors'
|
|
8
|
+
|
|
9
|
+
##
|
|
10
|
+
#Get all [Scenarios](https://docs.recombee.com/scenarios) of the given database.
|
|
11
|
+
#
|
|
12
|
+
class ListScenarios < ApiRequest
|
|
13
|
+
|
|
14
|
+
attr_accessor :timeout
|
|
15
|
+
attr_accessor :ensure_https
|
|
16
|
+
|
|
17
|
+
##
|
|
18
|
+
#
|
|
19
|
+
def initialize()
|
|
20
|
+
@timeout = 10000
|
|
21
|
+
@ensure_https = false
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
# HTTP method
|
|
25
|
+
def method
|
|
26
|
+
:get
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
# Values of body parameters as a Hash
|
|
30
|
+
def body_parameters
|
|
31
|
+
p = Hash.new
|
|
32
|
+
p
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Values of query parameters as a Hash.
|
|
36
|
+
# name of parameter => value of the parameter
|
|
37
|
+
def query_parameters
|
|
38
|
+
params = {}
|
|
39
|
+
params
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# Relative path to the endpoint
|
|
43
|
+
def path
|
|
44
|
+
"/{databaseId}/scenarios/"
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
@@ -16,13 +16,13 @@ module RecombeeApiClient
|
|
|
16
16
|
##
|
|
17
17
|
#
|
|
18
18
|
# * *Optional arguments (given as hash optional)*
|
|
19
|
-
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql
|
|
19
|
+
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter users to be listed. Only the users for which the expression is *true* will be returned.
|
|
20
20
|
# - +count+ -> The number of users to be listed.
|
|
21
21
|
# - +offset+ -> Specifies the number of users to skip (ordered by `userId`).
|
|
22
22
|
# - +returnProperties+ -> With `returnProperties=true`, property values of the listed users are returned along with their IDs in a JSON dictionary.
|
|
23
23
|
#
|
|
24
24
|
#Example response:
|
|
25
|
-
#```
|
|
25
|
+
#```json
|
|
26
26
|
# [
|
|
27
27
|
# {
|
|
28
28
|
# "userId": "user-81",
|
|
@@ -40,7 +40,7 @@ module RecombeeApiClient
|
|
|
40
40
|
# - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
|
|
41
41
|
#
|
|
42
42
|
#Example response for `includedProperties=country`:
|
|
43
|
-
#```
|
|
43
|
+
#```json
|
|
44
44
|
# [
|
|
45
45
|
# {
|
|
46
46
|
# "userId": "user-81",
|
|
@@ -12,6 +12,9 @@ module RecombeeApiClient
|
|
|
12
12
|
#
|
|
13
13
|
#Merging happens between two users referred to as the *target* and the *source*. After the merge, all the interactions of the source user are attributed to the target user, and the source user is **deleted**.
|
|
14
14
|
#
|
|
15
|
+
#By default, the *Merge Users* request is only available from server-side integrations for security reasons, to prevent potential abuse.
|
|
16
|
+
#If you need to call this request from a client-side environment (such as a web or mobile app), please contact our support and request access to enable this feature for your database.
|
|
17
|
+
#
|
|
15
18
|
class MergeUsers < ApiRequest
|
|
16
19
|
attr_reader :target_user_id, :source_user_id, :cascade_create
|
|
17
20
|
attr_accessor :timeout
|
|
@@ -7,7 +7,7 @@ module RecombeeApiClient
|
|
|
7
7
|
require_relative '../errors'
|
|
8
8
|
|
|
9
9
|
##
|
|
10
|
-
#Recommends Segments from a [Segmentation](https://docs.recombee.com/segmentations
|
|
10
|
+
#Recommends Segments from a [Segmentation](https://docs.recombee.com/segmentations) that are the most relevant to a particular item.
|
|
11
11
|
#
|
|
12
12
|
#Based on the used Segmentation, this endpoint can be used for example for:
|
|
13
13
|
#
|
|
@@ -54,22 +54,22 @@ module RecombeeApiClient
|
|
|
54
54
|
# * *Optional arguments (given as hash optional)*
|
|
55
55
|
# - +scenario+ -> Scenario defines a particular application of recommendations. It can be, for example, "homepage", "cart", or "emailing".
|
|
56
56
|
#
|
|
57
|
-
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios
|
|
57
|
+
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
|
|
58
58
|
#
|
|
59
59
|
#The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
|
|
60
60
|
#
|
|
61
61
|
# - +cascadeCreate+ -> If the user does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that user, as the user will be already known to the system.
|
|
62
62
|
#
|
|
63
|
-
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql
|
|
63
|
+
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
|
|
64
64
|
#
|
|
65
|
-
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql
|
|
65
|
+
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
|
|
66
66
|
#
|
|
67
67
|
# - +logic+ -> Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
|
|
68
|
-
#See [this section](https://docs.recombee.com/recommendation_logics
|
|
68
|
+
#See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
|
|
69
69
|
#
|
|
70
70
|
#The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
|
|
71
71
|
#
|
|
72
|
-
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios
|
|
72
|
+
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
73
73
|
#
|
|
74
74
|
# - +expertSettings+ -> Dictionary of custom options.
|
|
75
75
|
#
|
|
@@ -7,7 +7,7 @@ module RecombeeApiClient
|
|
|
7
7
|
require_relative '../errors'
|
|
8
8
|
|
|
9
9
|
##
|
|
10
|
-
#Recommends Segments from a result [Segmentation](https://docs.recombee.com/segmentations
|
|
10
|
+
#Recommends Segments from a result [Segmentation](https://docs.recombee.com/segmentations) that are the most relevant to a particular Segment from a context Segmentation.
|
|
11
11
|
#
|
|
12
12
|
#Based on the used Segmentations, this endpoint can be used for example for:
|
|
13
13
|
#
|
|
@@ -53,22 +53,22 @@ module RecombeeApiClient
|
|
|
53
53
|
# * *Optional arguments (given as hash optional)*
|
|
54
54
|
# - +scenario+ -> Scenario defines a particular application of recommendations. It can be, for example, "homepage", "cart", or "emailing".
|
|
55
55
|
#
|
|
56
|
-
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios
|
|
56
|
+
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
|
|
57
57
|
#
|
|
58
58
|
#The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
|
|
59
59
|
#
|
|
60
60
|
# - +cascadeCreate+ -> If the user does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that user, as the user will be already known to the system.
|
|
61
61
|
#
|
|
62
|
-
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql
|
|
62
|
+
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
|
|
63
63
|
#
|
|
64
|
-
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql
|
|
64
|
+
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
|
|
65
65
|
#
|
|
66
66
|
# - +logic+ -> Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
|
|
67
|
-
#See [this section](https://docs.recombee.com/recommendation_logics
|
|
67
|
+
#See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
|
|
68
68
|
#
|
|
69
69
|
#The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
|
|
70
70
|
#
|
|
71
|
-
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios
|
|
71
|
+
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
72
72
|
#
|
|
73
73
|
# - +expertSettings+ -> Dictionary of custom options.
|
|
74
74
|
#
|
|
@@ -7,7 +7,7 @@ module RecombeeApiClient
|
|
|
7
7
|
require_relative '../errors'
|
|
8
8
|
|
|
9
9
|
##
|
|
10
|
-
#Recommends the top Segments from a [Segmentation](https://docs.recombee.com/segmentations
|
|
10
|
+
#Recommends the top Segments from a [Segmentation](https://docs.recombee.com/segmentations) for a particular user, based on the user's past interactions.
|
|
11
11
|
#
|
|
12
12
|
#Based on the used Segmentation, this endpoint can be used for example for:
|
|
13
13
|
#
|
|
@@ -36,22 +36,22 @@ module RecombeeApiClient
|
|
|
36
36
|
# * *Optional arguments (given as hash optional)*
|
|
37
37
|
# - +scenario+ -> Scenario defines a particular application of recommendations. It can be, for example, "homepage", "cart", or "emailing".
|
|
38
38
|
#
|
|
39
|
-
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios
|
|
39
|
+
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
|
|
40
40
|
#
|
|
41
41
|
#The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
|
|
42
42
|
#
|
|
43
43
|
# - +cascadeCreate+ -> If the user does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that user, as the user will be already known to the system.
|
|
44
44
|
#
|
|
45
|
-
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql
|
|
45
|
+
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
|
|
46
46
|
#
|
|
47
|
-
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql
|
|
47
|
+
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
|
|
48
48
|
#
|
|
49
49
|
# - +logic+ -> Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
|
|
50
|
-
#See [this section](https://docs.recombee.com/recommendation_logics
|
|
50
|
+
#See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
|
|
51
51
|
#
|
|
52
52
|
#The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
|
|
53
53
|
#
|
|
54
|
-
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios
|
|
54
|
+
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
55
55
|
#
|
|
56
56
|
# - +expertSettings+ -> Dictionary of custom options.
|
|
57
57
|
#
|
|
@@ -13,8 +13,8 @@ module RecombeeApiClient
|
|
|
13
13
|
#
|
|
14
14
|
#Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
|
|
15
15
|
#
|
|
16
|
-
#- Let Recombee know that this recommendation was successful (e.g., user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui
|
|
17
|
-
#- Get subsequent recommended items when the user scrolls down (*infinite scroll*) or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api
|
|
16
|
+
#- Let Recombee know that this recommendation was successful (e.g., user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui#reported-metrics).
|
|
17
|
+
#- Get subsequent recommended items when the user scrolls down (*infinite scroll*) or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api#recommend-next-items).
|
|
18
18
|
#
|
|
19
19
|
#It is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.
|
|
20
20
|
#
|
|
@@ -49,7 +49,7 @@ module RecombeeApiClient
|
|
|
49
49
|
# * *Optional arguments (given as hash optional)*
|
|
50
50
|
# - +scenario+ -> Scenario defines a particular application of recommendations. It can be, for example, "homepage", "cart", or "emailing".
|
|
51
51
|
#
|
|
52
|
-
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios
|
|
52
|
+
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
|
|
53
53
|
#
|
|
54
54
|
#The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
|
|
55
55
|
#
|
|
@@ -57,7 +57,7 @@ module RecombeeApiClient
|
|
|
57
57
|
# - +returnProperties+ -> With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user.
|
|
58
58
|
#
|
|
59
59
|
#Example response:
|
|
60
|
-
#```
|
|
60
|
+
#```json
|
|
61
61
|
# {
|
|
62
62
|
# "recommId": "0c6189e7-dc1a-429a-b613-192696309361",
|
|
63
63
|
# "recomms":
|
|
@@ -88,7 +88,7 @@ module RecombeeApiClient
|
|
|
88
88
|
# - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
|
|
89
89
|
#
|
|
90
90
|
#Example response for `includedProperties=description,price`:
|
|
91
|
-
#```
|
|
91
|
+
#```json
|
|
92
92
|
# {
|
|
93
93
|
# "recommId": "6842c725-a79f-4537-a02c-f34d668a3f80",
|
|
94
94
|
# "recomms":
|
|
@@ -112,30 +112,30 @@ module RecombeeApiClient
|
|
|
112
112
|
# }
|
|
113
113
|
#```
|
|
114
114
|
#
|
|
115
|
-
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql
|
|
115
|
+
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes.
|
|
116
116
|
#
|
|
117
|
-
#Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios
|
|
117
|
+
#Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
118
118
|
#
|
|
119
|
-
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql
|
|
119
|
+
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
|
|
120
120
|
#
|
|
121
|
-
#Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios
|
|
121
|
+
#Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
122
122
|
#
|
|
123
123
|
# - +logic+ -> Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
|
|
124
|
-
#See [this section](https://docs.recombee.com/recommendation_logics
|
|
124
|
+
#See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
|
|
125
125
|
#
|
|
126
126
|
#The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
|
|
127
127
|
#
|
|
128
|
-
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios
|
|
128
|
+
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
129
129
|
#
|
|
130
|
-
# - +userImpact+ -> **Expert option
|
|
130
|
+
# - +userImpact+ -> **Expert option:** If *targetUserId* parameter is present, the recommendations are biased towards the given user. Using *userImpact*, you may control this bias. For an extreme case of `userImpact=0.0`, the interactions made by the user are not taken into account at all (with the exception of history-based blacklisting), for `userImpact=1.0`, you'll get a user-based recommendation. The default value is `0`.
|
|
131
131
|
#
|
|
132
|
-
# - +diversity+ -> **Expert option
|
|
132
|
+
# - +diversity+ -> **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended items should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
|
|
133
133
|
#
|
|
134
|
-
# - +minRelevance+ -> **Expert option
|
|
134
|
+
# - +minRelevance+ -> **Expert option:** If the *targetUserId* is provided: Specifies the threshold of how relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend a number of items equal to *count* at any cost. If there is not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations being appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested relevance and may return less than *count* items when there is not enough data to fulfill it.
|
|
135
135
|
#
|
|
136
|
-
# - +rotationRate+ -> **Expert option
|
|
136
|
+
# - +rotationRate+ -> **Expert option:** If the *targetUserId* is provided: If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per request in a backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example, `rotationRate=0.2` for only slight rotation of recommended items.
|
|
137
137
|
#
|
|
138
|
-
# - +rotationTime+ -> **Expert option
|
|
138
|
+
# - +rotationTime+ -> **Expert option:** If the *targetUserId* is provided: Taking *rotationRate* into account, specifies how long it takes for an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized.
|
|
139
139
|
#
|
|
140
140
|
# - +expertSettings+ -> Dictionary of custom options.
|
|
141
141
|
#
|
|
@@ -7,7 +7,7 @@ module RecombeeApiClient
|
|
|
7
7
|
require_relative '../errors'
|
|
8
8
|
|
|
9
9
|
##
|
|
10
|
-
#Recommends Items that are the most relevant to a particular Segment from a context [Segmentation](https://docs.recombee.com/segmentations
|
|
10
|
+
#Recommends Items that are the most relevant to a particular Segment from a context [Segmentation](https://docs.recombee.com/segmentations).
|
|
11
11
|
#
|
|
12
12
|
#Based on the used Segmentation, this endpoint can be used for example for:
|
|
13
13
|
#
|
|
@@ -52,15 +52,15 @@ module RecombeeApiClient
|
|
|
52
52
|
# * *Optional arguments (given as hash optional)*
|
|
53
53
|
# - +scenario+ -> Scenario defines a particular application of recommendations. It can be, for example, "homepage", "cart", or "emailing".
|
|
54
54
|
#
|
|
55
|
-
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios
|
|
55
|
+
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
|
|
56
56
|
#
|
|
57
57
|
#The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
|
|
58
58
|
#
|
|
59
|
-
# - +cascadeCreate+ -> If
|
|
59
|
+
# - +cascadeCreate+ -> If a user of the given *targetUserId* doesn't exist in the database, it creates this user and returns some (non-personalized) recommendations. This allows, for example, rotations in the following recommendations for the user of the given *targetUserId*, as the user will be already known to the system.
|
|
60
60
|
# - +returnProperties+ -> With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user.
|
|
61
61
|
#
|
|
62
62
|
#Example response:
|
|
63
|
-
#```
|
|
63
|
+
#```json
|
|
64
64
|
# {
|
|
65
65
|
# "recommId": "0c6189e7-dc1a-429a-b613-192696309361",
|
|
66
66
|
# "recomms":
|
|
@@ -91,7 +91,7 @@ module RecombeeApiClient
|
|
|
91
91
|
# - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
|
|
92
92
|
#
|
|
93
93
|
#Example response for `includedProperties=description,price`:
|
|
94
|
-
#```
|
|
94
|
+
#```json
|
|
95
95
|
# {
|
|
96
96
|
# "recommId": "6842c725-a79f-4537-a02c-f34d668a3f80",
|
|
97
97
|
# "recomms":
|
|
@@ -115,26 +115,26 @@ module RecombeeApiClient
|
|
|
115
115
|
# }
|
|
116
116
|
#```
|
|
117
117
|
#
|
|
118
|
-
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql
|
|
118
|
+
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes.
|
|
119
119
|
#
|
|
120
|
-
#Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios
|
|
120
|
+
#Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
121
121
|
#
|
|
122
|
-
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql
|
|
122
|
+
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
|
|
123
123
|
#
|
|
124
|
-
#Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios
|
|
124
|
+
#Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
125
125
|
#
|
|
126
126
|
# - +logic+ -> Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
|
|
127
|
-
#See [this section](https://docs.recombee.com/recommendation_logics
|
|
127
|
+
#See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
|
|
128
128
|
#
|
|
129
129
|
#The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
|
|
130
130
|
#
|
|
131
|
-
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios
|
|
131
|
+
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
132
132
|
#
|
|
133
|
-
# - +minRelevance+ -> **Expert option
|
|
133
|
+
# - +minRelevance+ -> **Expert option:** If the *targetUserId* is provided: Specifies the threshold of how relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend a number of items equal to *count* at any cost. If there is not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations being appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested relevance and may return less than *count* items when there is not enough data to fulfill it.
|
|
134
134
|
#
|
|
135
|
-
# - +rotationRate+ -> **Expert option
|
|
135
|
+
# - +rotationRate+ -> **Expert option:** If the *targetUserId* is provided: If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per request in a backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example, `rotationRate=0.2` for only slight rotation of recommended items.
|
|
136
136
|
#
|
|
137
|
-
# - +rotationTime+ -> **Expert option
|
|
137
|
+
# - +rotationTime+ -> **Expert option:** If the *targetUserId* is provided: Taking *rotationRate* into account, specifies how long it takes for an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized.
|
|
138
138
|
#
|
|
139
139
|
# - +expertSettings+ -> Dictionary of custom options.
|
|
140
140
|
#
|
|
@@ -15,8 +15,8 @@ module RecombeeApiClient
|
|
|
15
15
|
#
|
|
16
16
|
#Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
|
|
17
17
|
#
|
|
18
|
-
#- Let Recombee know that this recommendation was successful (e.g., user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui
|
|
19
|
-
#- Get subsequent recommended items when the user scrolls down (*infinite scroll*) or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api
|
|
18
|
+
#- Let Recombee know that this recommendation was successful (e.g., user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui#reported-metrics).
|
|
19
|
+
#- Get subsequent recommended items when the user scrolls down (*infinite scroll*) or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api#recommend-next-items).
|
|
20
20
|
#
|
|
21
21
|
#It is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.
|
|
22
22
|
#
|
|
@@ -34,7 +34,7 @@ module RecombeeApiClient
|
|
|
34
34
|
# * *Optional arguments (given as hash optional)*
|
|
35
35
|
# - +scenario+ -> Scenario defines a particular application of recommendations. It can be, for example, "homepage", "cart", or "emailing".
|
|
36
36
|
#
|
|
37
|
-
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios
|
|
37
|
+
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
|
|
38
38
|
#
|
|
39
39
|
#The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
|
|
40
40
|
#
|
|
@@ -43,7 +43,7 @@ module RecombeeApiClient
|
|
|
43
43
|
# - +returnProperties+ -> With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user.
|
|
44
44
|
#
|
|
45
45
|
#Example response:
|
|
46
|
-
#```
|
|
46
|
+
#```json
|
|
47
47
|
# {
|
|
48
48
|
# "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
|
|
49
49
|
# "recomms":
|
|
@@ -74,7 +74,7 @@ module RecombeeApiClient
|
|
|
74
74
|
# - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
|
|
75
75
|
#
|
|
76
76
|
#Example response for `includedProperties=description,price`:
|
|
77
|
-
#```
|
|
77
|
+
#```json
|
|
78
78
|
# {
|
|
79
79
|
# "recommId": "a86ee8d5-cd8e-46d1-886c-8b3771d0520b",
|
|
80
80
|
# "recomms":
|
|
@@ -98,28 +98,28 @@ module RecombeeApiClient
|
|
|
98
98
|
# }
|
|
99
99
|
#```
|
|
100
100
|
#
|
|
101
|
-
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql
|
|
101
|
+
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes.
|
|
102
102
|
#
|
|
103
|
-
#Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios
|
|
103
|
+
#Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
104
104
|
#
|
|
105
|
-
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql
|
|
105
|
+
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
|
|
106
106
|
#
|
|
107
|
-
#Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios
|
|
107
|
+
#Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
108
108
|
#
|
|
109
109
|
# - +logic+ -> Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
|
|
110
|
-
#See [this section](https://docs.recombee.com/recommendation_logics
|
|
110
|
+
#See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
|
|
111
111
|
#
|
|
112
112
|
#The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
|
|
113
113
|
#
|
|
114
|
-
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios
|
|
114
|
+
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
115
115
|
#
|
|
116
|
-
# - +diversity+ -> **Expert option
|
|
116
|
+
# - +diversity+ -> **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended items should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
|
|
117
117
|
#
|
|
118
|
-
# - +minRelevance+ -> **Expert option
|
|
118
|
+
# - +minRelevance+ -> **Expert option:** Specifies the threshold of how relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend a number of items equal to *count* at any cost. If there is not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such a case, the system only recommends items of at least the requested relevance and may return less than *count* items when there is not enough data to fulfill it.
|
|
119
119
|
#
|
|
120
|
-
# - +rotationRate+ -> **Expert option
|
|
120
|
+
# - +rotationRate+ -> **Expert option:** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per request in a backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example, `rotationRate=0.2` for only slight rotation of recommended items. Default: `0`.
|
|
121
121
|
#
|
|
122
|
-
# - +rotationTime+ -> **Expert option
|
|
122
|
+
# - +rotationTime+ -> **Expert option:** Taking *rotationRate* into account, specifies how long it takes for an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.
|
|
123
123
|
#
|
|
124
124
|
# - +expertSettings+ -> Dictionary of custom options.
|
|
125
125
|
#
|
|
@@ -11,9 +11,10 @@ module RecombeeApiClient
|
|
|
11
11
|
#
|
|
12
12
|
#It accepts `recommId` of a base recommendation request (e.g., request from the first page) and the number of items that shall be returned (`count`).
|
|
13
13
|
#The base request can be one of:
|
|
14
|
-
# - [Recommend
|
|
15
|
-
# - [Recommend
|
|
16
|
-
# - [
|
|
14
|
+
# - [Recommend Items to Item](https://docs.recombee.com/api#recommend-items-to-item)
|
|
15
|
+
# - [Recommend Items to User](https://docs.recombee.com/api#recommend-items-to-user)
|
|
16
|
+
# - [Recommend Items to Item Segment](https://docs.recombee.com/api#recommend-items-to-item-segment)
|
|
17
|
+
# - [Search Items](https://docs.recombee.com/api#search-items)
|
|
17
18
|
#
|
|
18
19
|
#All the other parameters are inherited from the base request.
|
|
19
20
|
#
|
|
@@ -26,7 +26,7 @@ module RecombeeApiClient
|
|
|
26
26
|
# * *Optional arguments (given as hash optional)*
|
|
27
27
|
# - +scenario+ -> Scenario defines a particular application of recommendations. It can be, for example, "homepage", "cart", or "emailing".
|
|
28
28
|
#
|
|
29
|
-
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios
|
|
29
|
+
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
|
|
30
30
|
#
|
|
31
31
|
#The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
|
|
32
32
|
#
|
|
@@ -34,7 +34,7 @@ module RecombeeApiClient
|
|
|
34
34
|
# - +returnProperties+ -> With `returnProperties=true`, property values of the recommended users are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended users.
|
|
35
35
|
#
|
|
36
36
|
#Example response:
|
|
37
|
-
#```
|
|
37
|
+
#```json
|
|
38
38
|
# {
|
|
39
39
|
# "recommId": "039b71dc-b9cc-4645-a84f-62b841eecfce",
|
|
40
40
|
# "recomms":
|
|
@@ -61,7 +61,7 @@ module RecombeeApiClient
|
|
|
61
61
|
# - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
|
|
62
62
|
#
|
|
63
63
|
#Example response for `includedProperties=country`:
|
|
64
|
-
#```
|
|
64
|
+
#```json
|
|
65
65
|
# {
|
|
66
66
|
# "recommId": "b2b355dd-972a-4728-9c6b-2dc229db0678",
|
|
67
67
|
# "recomms":
|
|
@@ -83,22 +83,22 @@ module RecombeeApiClient
|
|
|
83
83
|
# }
|
|
84
84
|
#```
|
|
85
85
|
#
|
|
86
|
-
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql
|
|
86
|
+
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes.
|
|
87
87
|
#
|
|
88
|
-
#Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios
|
|
88
|
+
#Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
89
89
|
#
|
|
90
|
-
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql
|
|
90
|
+
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
|
|
91
91
|
#
|
|
92
|
-
#Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios
|
|
92
|
+
#Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
93
93
|
#
|
|
94
94
|
# - +logic+ -> Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
|
|
95
|
-
#See [this section](https://docs.recombee.com/recommendation_logics
|
|
95
|
+
#See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
|
|
96
96
|
#
|
|
97
97
|
#The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
|
|
98
98
|
#
|
|
99
|
-
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios
|
|
99
|
+
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
100
100
|
#
|
|
101
|
-
# - +diversity+ -> **Expert option
|
|
101
|
+
# - +diversity+ -> **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended items should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
|
|
102
102
|
#
|
|
103
103
|
# - +expertSettings+ -> Dictionary of custom options.
|
|
104
104
|
#
|
|
@@ -26,7 +26,7 @@ module RecombeeApiClient
|
|
|
26
26
|
# * *Optional arguments (given as hash optional)*
|
|
27
27
|
# - +scenario+ -> Scenario defines a particular application of recommendations. It can be, for example, "homepage", "cart", or "emailing".
|
|
28
28
|
#
|
|
29
|
-
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios
|
|
29
|
+
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
|
|
30
30
|
#
|
|
31
31
|
#The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
|
|
32
32
|
#
|
|
@@ -34,7 +34,7 @@ module RecombeeApiClient
|
|
|
34
34
|
# - +returnProperties+ -> With `returnProperties=true`, property values of the recommended users are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended users.
|
|
35
35
|
#
|
|
36
36
|
#Example response:
|
|
37
|
-
#```
|
|
37
|
+
#```json
|
|
38
38
|
# {
|
|
39
39
|
# "recommId": "9cb9c55d-50ba-4478-84fd-ab456136156e",
|
|
40
40
|
# "recomms":
|
|
@@ -61,7 +61,7 @@ module RecombeeApiClient
|
|
|
61
61
|
# - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
|
|
62
62
|
#
|
|
63
63
|
#Example response for `includedProperties=country`:
|
|
64
|
-
#```
|
|
64
|
+
#```json
|
|
65
65
|
# {
|
|
66
66
|
# "recommId": "b326d82d-5d57-4b45-b362-c9d6f0895855",
|
|
67
67
|
# "recomms":
|
|
@@ -83,28 +83,28 @@ module RecombeeApiClient
|
|
|
83
83
|
# }
|
|
84
84
|
#```
|
|
85
85
|
#
|
|
86
|
-
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql
|
|
86
|
+
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes.
|
|
87
87
|
#
|
|
88
|
-
#Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios
|
|
88
|
+
#Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
89
89
|
#
|
|
90
|
-
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql
|
|
90
|
+
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
|
|
91
91
|
#
|
|
92
|
-
#Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios
|
|
92
|
+
#Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
93
93
|
#
|
|
94
94
|
# - +logic+ -> Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
|
|
95
|
-
#See [this section](https://docs.recombee.com/recommendation_logics
|
|
95
|
+
#See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
|
|
96
96
|
#
|
|
97
97
|
#The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
|
|
98
98
|
#
|
|
99
|
-
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios
|
|
99
|
+
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
100
100
|
#
|
|
101
|
-
# - +diversity+ -> **Expert option
|
|
101
|
+
# - +diversity+ -> **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended users should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
|
|
102
102
|
#
|
|
103
|
-
# - +minRelevance+ -> **Expert option
|
|
103
|
+
# - +minRelevance+ -> **Expert option:** Specifies the threshold of how relevant must the recommended users be. Possible values one of: "low", "medium", "high".
|
|
104
104
|
#
|
|
105
|
-
# - +rotationRate+ -> **Expert option
|
|
105
|
+
# - +rotationRate+ -> **Expert option:** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per request in a backward fashion. You may penalize a user for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example, `rotationRate=0.2` for only slight rotation of recommended users.
|
|
106
106
|
#
|
|
107
|
-
# - +rotationTime+ -> **Expert option
|
|
107
|
+
# - +rotationTime+ -> **Expert option:** Taking *rotationRate* into account, specifies how long it takes for a user to recover from the penalization. For example, `rotationTime=7200.0` means that users recommended less than 2 hours ago are penalized.
|
|
108
108
|
#
|
|
109
109
|
# - +expertSettings+ -> Dictionary of custom options.
|
|
110
110
|
#
|
|
@@ -7,7 +7,6 @@ module RecombeeApiClient
|
|
|
7
7
|
require_relative '../errors'
|
|
8
8
|
|
|
9
9
|
##
|
|
10
|
-
#
|
|
11
10
|
#Full-text personalized search that returns Segments from a Segmentation. The results are based on the provided `searchQuery` and also on the user's past interactions (purchases, ratings, etc.).
|
|
12
11
|
#
|
|
13
12
|
#Based on the used Segmentation, this endpoint can be used for example for:
|
|
@@ -37,22 +36,22 @@ module RecombeeApiClient
|
|
|
37
36
|
# * *Optional arguments (given as hash optional)*
|
|
38
37
|
# - +scenario+ -> Scenario defines a particular application of recommendations. It can be, for example, "homepage", "cart", or "emailing".
|
|
39
38
|
#
|
|
40
|
-
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios
|
|
39
|
+
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
|
|
41
40
|
#
|
|
42
41
|
#The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
|
|
43
42
|
#
|
|
44
43
|
# - +cascadeCreate+ -> If the user does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that user, as the user will be already known to the system.
|
|
45
44
|
#
|
|
46
|
-
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql
|
|
45
|
+
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
|
|
47
46
|
#
|
|
48
|
-
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql
|
|
47
|
+
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
|
|
49
48
|
#
|
|
50
49
|
# - +logic+ -> Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
|
|
51
|
-
#See [this section](https://docs.recombee.com/recommendation_logics
|
|
50
|
+
#See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
|
|
52
51
|
#
|
|
53
52
|
#The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
|
|
54
53
|
#
|
|
55
|
-
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios
|
|
54
|
+
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
56
55
|
#
|
|
57
56
|
# - +expertSettings+ -> Dictionary of custom options.
|
|
58
57
|
#
|
|
@@ -17,8 +17,8 @@ module RecombeeApiClient
|
|
|
17
17
|
#
|
|
18
18
|
#Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
|
|
19
19
|
#
|
|
20
|
-
#- Let Recombee know that this search was successful (e.g., user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui
|
|
21
|
-
#- Get subsequent search results when the user scrolls down or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api
|
|
20
|
+
#- Let Recombee know that this search was successful (e.g., user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui#reported-metrics).
|
|
21
|
+
#- Get subsequent search results when the user scrolls down or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api#recommend-next-items).
|
|
22
22
|
#
|
|
23
23
|
#It is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.
|
|
24
24
|
#
|
|
@@ -36,7 +36,7 @@ module RecombeeApiClient
|
|
|
36
36
|
# * *Optional arguments (given as hash optional)*
|
|
37
37
|
# - +scenario+ -> Scenario defines a particular search field in your user interface.
|
|
38
38
|
#
|
|
39
|
-
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios
|
|
39
|
+
#You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each field performs.
|
|
40
40
|
#
|
|
41
41
|
#The AI that optimizes models to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
|
|
42
42
|
#
|
|
@@ -44,7 +44,7 @@ module RecombeeApiClient
|
|
|
44
44
|
# - +returnProperties+ -> With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user.
|
|
45
45
|
#
|
|
46
46
|
#Example response:
|
|
47
|
-
#```
|
|
47
|
+
#```json
|
|
48
48
|
# {
|
|
49
49
|
# "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
|
|
50
50
|
# "recomms":
|
|
@@ -75,7 +75,7 @@ module RecombeeApiClient
|
|
|
75
75
|
# - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
|
|
76
76
|
#
|
|
77
77
|
#Example response for `includedProperties=description,price`:
|
|
78
|
-
#```
|
|
78
|
+
#```json
|
|
79
79
|
# {
|
|
80
80
|
# "recommId": "a86ee8d5-cd8e-46d1-886c-8b3771d0520b",
|
|
81
81
|
# "recomms":
|
|
@@ -99,20 +99,20 @@ module RecombeeApiClient
|
|
|
99
99
|
# }
|
|
100
100
|
#```
|
|
101
101
|
#
|
|
102
|
-
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql
|
|
102
|
+
# - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes.
|
|
103
103
|
#
|
|
104
|
-
#Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios
|
|
104
|
+
#Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
105
105
|
#
|
|
106
|
-
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql
|
|
106
|
+
# - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
|
|
107
107
|
#
|
|
108
|
-
#Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios
|
|
108
|
+
#Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
109
109
|
#
|
|
110
110
|
# - +logic+ -> Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
|
|
111
|
-
#See [this section](https://docs.recombee.com/recommendation_logics
|
|
111
|
+
#See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
|
|
112
112
|
#
|
|
113
113
|
#The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
|
|
114
114
|
#
|
|
115
|
-
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios
|
|
115
|
+
#Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
|
|
116
116
|
#
|
|
117
117
|
# - +expertSettings+ -> Dictionary of custom options.
|
|
118
118
|
#
|
|
@@ -3,7 +3,7 @@ module RecombeeApiClient
|
|
|
3
3
|
require_relative '../errors'
|
|
4
4
|
|
|
5
5
|
##
|
|
6
|
-
#Set/update (some) property values of a given item. The properties (columns) must be previously created by [Add item property](https://docs.recombee.com/api
|
|
6
|
+
#Set/update (some) property values of a given item. The properties (columns) must be previously created by [Add item property](https://docs.recombee.com/api#add-item-property).
|
|
7
7
|
#
|
|
8
8
|
class SetItemValues < SetValues
|
|
9
9
|
attr_reader :item_id
|
|
@@ -3,7 +3,7 @@ module RecombeeApiClient
|
|
|
3
3
|
require_relative '../errors'
|
|
4
4
|
|
|
5
5
|
##
|
|
6
|
-
#Set/update (some) property values of a given user. The properties (columns) must be previously created by [Add user property](https://docs.recombee.com/api
|
|
6
|
+
#Set/update (some) property values of a given user. The properties (columns) must be previously created by [Add user property](https://docs.recombee.com/api#add-user-property).
|
|
7
7
|
#
|
|
8
8
|
class SetUserValues < SetValues
|
|
9
9
|
attr_reader :user_id
|
|
@@ -23,7 +23,7 @@ module RecombeeApiClient
|
|
|
23
23
|
#
|
|
24
24
|
# * *Optional arguments (given as hash optional)*
|
|
25
25
|
# - +sessionId+ -> ID of the session in which the user viewed the item. Default is `null` (`None`, `nil`, `NULL` etc., depending on the language).
|
|
26
|
-
# - +timestamp+ -> UTC timestamp of the
|
|
26
|
+
# - +timestamp+ -> UTC timestamp of the view portion as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
|
|
27
27
|
# - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
|
|
28
28
|
# - +recommId+ -> If this view portion is based on a recommendation request, `recommId` is the id of the clicked recommendation.
|
|
29
29
|
# - +additionalData+ -> A dictionary of additional data for the interaction.
|
|
@@ -11,7 +11,7 @@ module RecombeeApiClient
|
|
|
11
11
|
#
|
|
12
12
|
#Example: *Setting all the items that are older than a week as unavailable*
|
|
13
13
|
#
|
|
14
|
-
# ```
|
|
14
|
+
# ```json
|
|
15
15
|
# {
|
|
16
16
|
# "filter": "'releaseDate' < now() - 7*24*3600",
|
|
17
17
|
# "changes": {"available": false}
|
|
@@ -25,7 +25,7 @@ module RecombeeApiClient
|
|
|
25
25
|
|
|
26
26
|
##
|
|
27
27
|
# * *Required arguments*
|
|
28
|
-
# - +filter+ -> A [ReQL](https://docs.recombee.com/reql
|
|
28
|
+
# - +filter+ -> A [ReQL](https://docs.recombee.com/reql) expression, which returns `true` for the items that shall be updated.
|
|
29
29
|
# - +changes+ -> A dictionary where the keys are properties that shall be updated.
|
|
30
30
|
#
|
|
31
31
|
def initialize(filter, changes)
|
data/lib/recombee_api_client.rb
CHANGED
|
@@ -18,7 +18,7 @@ module RecombeeApiClient
|
|
|
18
18
|
include HTTParty
|
|
19
19
|
|
|
20
20
|
BATCH_MAX_SIZE = 10000
|
|
21
|
-
USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/5.
|
|
21
|
+
USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/5.1.0'}
|
|
22
22
|
|
|
23
23
|
##
|
|
24
24
|
# - +account+ -> Name of your account at Recombee
|
metadata
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: recombee_api_client
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 5.
|
|
4
|
+
version: 5.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ondřej Fiedler
|
|
8
8
|
bindir: bin
|
|
9
9
|
cert_chain: []
|
|
10
|
-
date: 2025-
|
|
10
|
+
date: 2025-07-24 00:00:00.000000000 Z
|
|
11
11
|
dependencies:
|
|
12
12
|
- !ruby/object:Gem::Dependency
|
|
13
13
|
name: multi_json
|
|
@@ -139,6 +139,7 @@ files:
|
|
|
139
139
|
- lib/recombee_api_client/api/list_item_ratings.rb
|
|
140
140
|
- lib/recombee_api_client/api/list_item_view_portions.rb
|
|
141
141
|
- lib/recombee_api_client/api/list_items.rb
|
|
142
|
+
- lib/recombee_api_client/api/list_scenarios.rb
|
|
142
143
|
- lib/recombee_api_client/api/list_search_synonyms.rb
|
|
143
144
|
- lib/recombee_api_client/api/list_segmentations.rb
|
|
144
145
|
- lib/recombee_api_client/api/list_series.rb
|