recombee_api_client 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f352c6ef8fe7deec30fcbe75a95f6fca0973d332
-  data.tar.gz: 99dc6053c007b41e86ebf06cf688740a8beeb5d9
+  metadata.gz: 459b60d097073f0ab3172fcd183ae14560acb374
+  data.tar.gz: 1563a5306b4eadd16aad23ab27aeb438046688e9
 SHA512:
-  metadata.gz: d39f7acd6fffaa2a2de295959845b5444a240d31f5639314c05e6e23b4752fbe7d57bba46236e7e47b3dd8f17498cf748d54df3a88f6438158b96415d383bdbc
-  data.tar.gz: a57d0ca06bced0c0b5ccfcb384c308d0323e27637011e37d0a60824fab90ac4a26a4f550ddf1c273e0690cbb070a3070a294ec6593d7dbc5b099d9a1ced0b27a
+  metadata.gz: 722df39fe6db7183b6a488b166a0776998205dc6322863b2039f225c9c73dc62b7dc2e307dbefc7987d3565f7f32a87bb009f4719f89974ac7480e38b3265134
+  data.tar.gz: 724dc7c636925783e632a3b5573c624bc18b567174e63a98ecd428c328fe35e8f62a57774b8be74a367c280cc736db37d6c0086be0837dc7c164878e35cec89c

data/lib/recombee_api_client/api/add_cart_addition.rb

@@ -10,7 +10,7 @@ module RecombeeApiClient
   #Adds a cart addition of a given item made by a given user.
   #
   class AddCartAddition < ApiRequest
-    attr_reader :user_id, :item_id, :timestamp, :cascade_create
+    attr_reader :user_id, :item_id, :timestamp, :cascade_create, :amount, :price
     attr_accessor :timeout
     attr_accessor :ensure_https
   
@@ -22,17 +22,21 @@ module RecombeeApiClient
   # * *Optional arguments (given as hash optional)*
   #   - +timestamp+ -> UTC timestamp of the cart addition as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
   #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
+  #   - +amount+ -> Amount (number) added to cart. The default is 1. For example if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal to 2.
+  #   - +price+ -> Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.
   #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
+      @amount = optional['amount']
+      @price = optional['price']
       @optional = optional
       @timeout = 1000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price"].include? par
       end
     end
   
@@ -48,6 +52,8 @@ module RecombeeApiClient
       p['itemId'] = @item_id
       p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['amount'] = @optional['amount'] if @optional.include? 'amount'
+      p['price'] = @optional['price'] if @optional.include? 'price'
       p
     end
   

data/lib/recombee_api_client/api/add_item_property.rb

@@ -24,7 +24,7 @@ module RecombeeApiClient
     def initialize(property_name, type)
       @property_name = property_name
       @type = type
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/add_purchase.rb

@@ -10,7 +10,7 @@ module RecombeeApiClient
   #Adds a purchase of a given item made by a given user.
   #
   class AddPurchase < ApiRequest
-    attr_reader :user_id, :item_id, :timestamp, :cascade_create
+    attr_reader :user_id, :item_id, :timestamp, :cascade_create, :amount, :price, :profit
     attr_accessor :timeout
     attr_accessor :ensure_https
   
@@ -22,17 +22,23 @@ module RecombeeApiClient
   # * *Optional arguments (given as hash optional)*
   #   - +timestamp+ -> UTC timestamp of the purchase as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
   #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
+  #   - +amount+ -> Amount (number) of purchased items. The default is 1. For example if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal to 2.
+  #   - +price+ -> Price paid by the user for the item. If `amount` is greater than 1, sum of prices of all the items should be given.
+  #   - +profit+ -> Your profit from the purchased item. The profit is natural in e-commerce domain (for example if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30), but is applicable also in other domains (for example at a news company it may be income from displayed advertisement on article page). If `amount` is greater than 1, sum of profit of all the items should be given.
   #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
+      @amount = optional['amount']
+      @price = optional['price']
+      @profit = optional['profit']
       @optional = optional
       @timeout = 1000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price","profit"].include? par
       end
     end
   
@@ -48,6 +54,9 @@ module RecombeeApiClient
       p['itemId'] = @item_id
       p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['amount'] = @optional['amount'] if @optional.include? 'amount'
+      p['price'] = @optional['price'] if @optional.include? 'price'
+      p['profit'] = @optional['profit'] if @optional.include? 'profit'
       p
     end
   

data/lib/recombee_api_client/api/add_user_property.rb

@@ -24,7 +24,7 @@ module RecombeeApiClient
     def initialize(property_name, type)
       @property_name = property_name
       @type = type
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/delete_item_property.rb

@@ -20,7 +20,7 @@ module RecombeeApiClient
   #
     def initialize(property_name)
       @property_name = property_name
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/delete_user_property.rb

@@ -20,7 +20,7 @@ module RecombeeApiClient
   #
     def initialize(property_name)
       @property_name = property_name
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/get_user_property_info.rb

@@ -20,7 +20,7 @@ module RecombeeApiClient
   #
     def initialize(property_name)
       @property_name = property_name
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/list_group_items.rb

@@ -19,7 +19,7 @@ module RecombeeApiClient
   #
     def initialize(group_id)
       @group_id = group_id
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/list_groups.rb

@@ -16,7 +16,7 @@ module RecombeeApiClient
   ##
   #
     def initialize()
-      @timeout = 239000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/list_item_properties.rb

@@ -17,7 +17,7 @@ module RecombeeApiClient
   ##
   #
     def initialize()
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/list_items.rb

@@ -67,7 +67,7 @@ module RecombeeApiClient
       @return_properties = optional['returnProperties']
       @included_properties = optional['includedProperties']
       @optional = optional
-      @timeout = 600000
+      @timeout = 100000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["filter","count","offset","returnProperties","includedProperties"].include? par

data/lib/recombee_api_client/api/list_series.rb

@@ -16,7 +16,7 @@ module RecombeeApiClient
   ##
   #
     def initialize()
-      @timeout = 239000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/list_series_items.rb

@@ -19,7 +19,7 @@ module RecombeeApiClient
   #
     def initialize(series_id)
       @series_id = series_id
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/list_user_properties.rb

@@ -17,7 +17,7 @@ module RecombeeApiClient
   ##
   #
     def initialize()
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/list_users.rb

@@ -61,7 +61,7 @@ module RecombeeApiClient
       @return_properties = optional['returnProperties']
       @included_properties = optional['includedProperties']
       @optional = optional
-      @timeout = 239000
+      @timeout = 100000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["filter","count","offset","returnProperties","includedProperties"].include? par

data/lib/recombee_api_client/api/merge_users.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Merges purchases, ratings, bookmarks, and detail views of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable.
+  #Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable.
   #
   #
   #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** unless special parameter `keepSourceUser` is set `true`.

data/lib/recombee_api_client/api/recommend_items_to_item.rb

@@ -0,0 +1,179 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #This feature is currently in beta.
+  #
+  #Recommends set of items that are somehow related to one given item, *X*. Typical scenario  is when user *A* is viewing *X*. Then you may display items to the user that he might be also interested in. Recommend items to item request gives you Top-N such items, optionally taking the target user *A* into account.
+  #
+  #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
+  #
+  class RecommendItemsToItem < ApiRequest
+    attr_reader :item_id, :target_user_id, :count, :user_impact, :filter, :booster, :cascade_create, :scenario, :return_properties, :included_properties, :diversity, :min_relevance, :rotation_rate, :rotation_time, :expert_settings
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +item_id+ -> ID of the item for which the recommendations are to be generated.
+  #   - +target_user_id+ -> ID of the user who will see the recommendations.
+  #
+  #Specifying the *targetUserId* is beneficial because:
+  #
+  #* It makes the recommendations personalized
+  #* Allows the calculation of Actions and Conversions
+  #  in the graphical user interface,
+  #  as Recombee can pair the user who got recommendations
+  #  and who afterwards viewed/purchased an item.
+  #
+  #If you insist on not specifying the user, pass `null`
+  #(`None`, `nil`, `NULL` etc. depending on language) to *targetUserId*.
+  #Do not create some special dummy user for getting recommendations,
+  #as it could cause  mislead the recommendation models,
+  #leading to wrong recommendations.
+  #
+  #For anonymous/unregistered users it is possible to use for example their session ID.
+  #
+  #   - +count+ -> Number of items to be recommended (N for the top-N recommendation).
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +userImpact+ -> If *targetUserId* parameter is present, the recommendations are biased towards the user given. 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 user-based recommendation. The default value is `0`.
+  #
+  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended items based on the values of their attributes.
+  #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to boost recommendation rate of some items based on the values of their attributes.
+  #   - +cascadeCreate+ -> If item of given *itemId* or user of given *targetUserId* doesn't exist in the database, it creates the missing entity/entities and returns some (non-personalized) recommendations. This allows for example rotations in the following recommendations for the user of given *targetUserId*, as the user will be already known to the system.
+  #   - +scenario+ -> Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
+  #   - +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 for easy displaying of the recommended items to the user. 
+  #
+  #Example response:
+  #```
+  #  {
+  #    "recommId": "8ac80708afe9148130528757ebf6aaba",
+  #    "recomms":
+  #      [
+  #        {
+  #          "id": "tv-178",
+  #          "values": {
+  #            "description": "4K TV with 3D feature",
+  #            "categories":   ["Electronics", "Televisions"],
+  #            "price": 342,
+  #            "url": "myshop.com/tv-178"
+  #          }
+  #        },
+  #        {
+  #          "id": "mixer-42",
+  #          "values": {
+  #            "description": "Stainless Steel Mixer",
+  #            "categories":   ["Home & Kitchen"],
+  #            "price": 39,
+  #            "url": "myshop.com/mixer-42"
+  #          }
+  #        }
+  #      ]
+  #  }
+  #```
+  #
+  #   - +includedProperties+ -> Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
+  #
+  #Example response for `includedProperties=description,price`:
+  #```
+  #  {
+  #    "recommId": "c7dbfc503d262b80b77b4949ee9855fb",
+  #    "recomms": 
+  #      [
+  #        {
+  #          "id": "tv-178",
+  #          "values": {
+  #            "description": "4K TV with 3D feature",
+  #            "price": 342
+  #          }
+  #        },
+  #        {
+  #          "id": "mixer-42",
+  #          "values": {
+  #            "description": "Stainless Steel Mixer",
+  #            "price": 39
+  #          }
+  #        }
+  #      ]
+  #  }
+  #```
+  #
+  #   - +diversity+ -> **Expert option** Real number from [0.0, 1.0] which determines how much mutually dissimilar should the recommended items be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
+  #
+  #   - +minRelevance+ -> **Expert option** If the *targetUserId* is provided:  Specifies the threshold of how much 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 number of items equal to *count* at any cost. If there are 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 case, the system only recommends items of at least the requested relevancy, and may return less than *count* items when there is not enough data to fulfill it.
+  #
+  #   - +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 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.
+  #
+  #   - +rotationTime+ -> **Expert option** If the *targetUserId* is provided: Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized.
+  #
+  #   - +expertSettings+ -> Dictionary of custom options.
+  #
+  #
+    def initialize(item_id, target_user_id, count, optional = {})
+      @item_id = item_id
+      @target_user_id = target_user_id
+      @count = count
+      @user_impact = optional['userImpact']
+      @filter = optional['filter']
+      @booster = optional['booster']
+      @cascade_create = optional['cascadeCreate']
+      @scenario = optional['scenario']
+      @return_properties = optional['returnProperties']
+      @included_properties = optional['includedProperties']
+      @diversity = optional['diversity']
+      @min_relevance = optional['minRelevance']
+      @rotation_rate = optional['rotationRate']
+      @rotation_time = optional['rotationTime']
+      @expert_settings = optional['expertSettings']
+      @optional = optional
+      @timeout = 3000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["userImpact","filter","booster","cascadeCreate","scenario","returnProperties","includedProperties","diversity","minRelevance","rotationRate","rotationTime","expertSettings"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['targetUserId'] = @target_user_id
+      p['count'] = @count
+      p['userImpact'] = @optional['userImpact'] if @optional.include? 'userImpact'
+      p['filter'] = @optional['filter'] if @optional.include? 'filter'
+      p['booster'] = @optional['booster'] if @optional.include? 'booster'
+      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
+      p['returnProperties'] = @optional['returnProperties'] if @optional.include? 'returnProperties'
+      p['includedProperties'] = @optional['includedProperties'] if @optional.include? 'includedProperties'
+      p['diversity'] = @optional['diversity'] if @optional.include? 'diversity'
+      p['minRelevance'] = @optional['minRelevance'] if @optional.include? 'minRelevance'
+      p['rotationRate'] = @optional['rotationRate'] if @optional.include? 'rotationRate'
+      p['rotationTime'] = @optional['rotationTime'] if @optional.include? 'rotationTime'
+      p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
+      p
+    end
+  
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/recomms/items/#{@item_id}/items/"
+    end
+  end
+end

data/lib/recombee_api_client/api/recommend_items_to_user.rb

@@ -0,0 +1,155 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #This feature is currently in beta.
+  #
+  #Based on user's past interactions (purchases, ratings, etc.) with the items, recommends top-N items that are most likely to be of high value for a given user.
+  #
+  #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
+  #
+  class RecommendItemsToUser < ApiRequest
+    attr_reader :user_id, :count, :filter, :booster, :cascade_create, :scenario, :return_properties, :included_properties, :diversity, :min_relevance, :rotation_rate, :rotation_time, :expert_settings
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user for which personalized recommendations are to be generated.
+  #   - +count+ -> Number of items to be recommended (N for the top-N recommendation).
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended items based on the values of their attributes.
+  #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to boost recommendation rate of some items based on the values of their attributes.
+  #   - +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.
+  #   - +scenario+ -> Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
+  #   - +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 for easy displaying of the recommended items to the user. 
+  #
+  #Example response:
+  #```
+  #  {
+  #    "recommId": "1644e7b31759a08480da5f3b0a13045b",
+  #    "recomms": 
+  #      [
+  #        {
+  #          "id": "tv-178",
+  #          "values": {
+  #            "description": "4K TV with 3D feature",
+  #            "categories":   ["Electronics", "Televisions"],
+  #            "price": 342,
+  #            "url": "myshop.com/tv-178"
+  #          }
+  #        },
+  #        {
+  #          "id": "mixer-42",
+  #          "values": {
+  #            "description": "Stainless Steel Mixer",
+  #            "categories":   ["Home & Kitchen"],
+  #            "price": 39,
+  #            "url": "myshop.com/mixer-42"
+  #          }
+  #        }
+  #      ]
+  #  }
+  #```
+  #
+  #   - +includedProperties+ -> Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
+  #
+  #Example response for `includedProperties=description,price`:
+  #```
+  #  {
+  #    "recommId": "e3ba43af1a4e59dd08a00adced1729a7",
+  #    "recomms":
+  #      [
+  #        {
+  #          "id": "tv-178",
+  #          "values": {
+  #            "description": "4K TV with 3D feature",
+  #            "price": 342
+  #          }
+  #        },
+  #        {
+  #          "id": "mixer-42",
+  #          "values": {
+  #            "description": "Stainless Steel Mixer",
+  #            "price": 39
+  #          }
+  #        }
+  #      ]
+  #  }
+  #```
+  #
+  #   - +diversity+ -> **Expert option** Real number from [0.0, 1.0] which determines how much mutually dissimilar should the recommended items be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
+  #
+  #   - +minRelevance+ -> **Expert option** Specifies the threshold of how much 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 number of items equal to *count* at any cost. If there are 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 case, the system only recommends items of at least the requested relevancy, and may return less than *count* items when there is not enough data to fulfill it.
+  #
+  #   - +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 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.
+  #
+  #   - +rotationTime+ -> **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized.
+  #
+  #   - +expertSettings+ -> Dictionary of custom options.
+  #
+  #
+    def initialize(user_id, count, optional = {})
+      @user_id = user_id
+      @count = count
+      @filter = optional['filter']
+      @booster = optional['booster']
+      @cascade_create = optional['cascadeCreate']
+      @scenario = optional['scenario']
+      @return_properties = optional['returnProperties']
+      @included_properties = optional['includedProperties']
+      @diversity = optional['diversity']
+      @min_relevance = optional['minRelevance']
+      @rotation_rate = optional['rotationRate']
+      @rotation_time = optional['rotationTime']
+      @expert_settings = optional['expertSettings']
+      @optional = optional
+      @timeout = 3000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["filter","booster","cascadeCreate","scenario","returnProperties","includedProperties","diversity","minRelevance","rotationRate","rotationTime","expertSettings"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['count'] = @count
+      p['filter'] = @optional['filter'] if @optional.include? 'filter'
+      p['booster'] = @optional['booster'] if @optional.include? 'booster'
+      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
+      p['returnProperties'] = @optional['returnProperties'] if @optional.include? 'returnProperties'
+      p['includedProperties'] = @optional['includedProperties'] if @optional.include? 'includedProperties'
+      p['diversity'] = @optional['diversity'] if @optional.include? 'diversity'
+      p['minRelevance'] = @optional['minRelevance'] if @optional.include? 'minRelevance'
+      p['rotationRate'] = @optional['rotationRate'] if @optional.include? 'rotationRate'
+      p['rotationTime'] = @optional['rotationTime'] if @optional.include? 'rotationTime'
+      p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
+      p
+    end
+  
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/recomms/users/#{@user_id}/items/"
+    end
+  end
+end

data/lib/recombee_api_client/api/recommend_users_to_item.rb

@@ -0,0 +1,137 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #This feature is currently in beta.
+  #
+  #Recommend users that are likely to be interested in a given item.
+  #
+  #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
+  #
+  class RecommendUsersToItem < ApiRequest
+    attr_reader :item_id, :count, :filter, :booster, :cascade_create, :scenario, :return_properties, :included_properties, :diversity, :expert_settings
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +item_id+ -> ID of the item for which the recommendations are to be generated.
+  #   - +count+ -> Number of items to be recommended (N for the top-N recommendation).
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended items based on the values of their attributes.
+  #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to boost recommendation rate of some items based on the values of their attributes.
+  #   - +cascadeCreate+ -> If item of given *itemId* doesn't exist in the database, it creates the missing item.
+  #   - +scenario+ -> Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
+  #   - +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 for easy displaying the recommended users. 
+  #
+  #Example response:
+  #```
+  #  {
+  #    "recommId": "9eeebc318508302529e3241f4570834d",
+  #    "recomms":
+  #      [
+  #        {
+  #          "id": "user-17",
+  #          "values": {
+  #            "country": "US",
+  #            "sex": "F"
+  #          }
+  #        },
+  #        {
+  #          "id": "user-2",
+  #          "values": {
+  #            "country": "CAN",
+  #            "sex": "M"
+  #          }
+  #        }
+  #      ]
+  #  }
+  #```
+  #
+  #   - +includedProperties+ -> Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
+  #
+  #Example response for `includedProperties=country`:
+  #```
+  #  {
+  #    "recommId": "d4c826635efc3e01a83470008c5697f1",
+  #    "recomms":
+  #      [
+  #        {
+  #          "id": "user-17",
+  #          "values": {
+  #            "country": "US"
+  #          }
+  #        },
+  #        {
+  #          "id": "user-2",
+  #          "values": {
+  #            "country": "CAN"
+  #          }
+  #        }
+  #      ]
+  #  }
+  #```
+  #
+  #   - +diversity+ -> **Expert option** Real number from [0.0, 1.0] which determines how much mutually dissimilar should the recommended items be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
+  #
+  #   - +expertSettings+ -> Dictionary of custom options.
+  #
+  #
+    def initialize(item_id, count, optional = {})
+      @item_id = item_id
+      @count = count
+      @filter = optional['filter']
+      @booster = optional['booster']
+      @cascade_create = optional['cascadeCreate']
+      @scenario = optional['scenario']
+      @return_properties = optional['returnProperties']
+      @included_properties = optional['includedProperties']
+      @diversity = optional['diversity']
+      @expert_settings = optional['expertSettings']
+      @optional = optional
+      @timeout = 3000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["filter","booster","cascadeCreate","scenario","returnProperties","includedProperties","diversity","expertSettings"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['count'] = @count
+      p['filter'] = @optional['filter'] if @optional.include? 'filter'
+      p['booster'] = @optional['booster'] if @optional.include? 'booster'
+      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
+      p['returnProperties'] = @optional['returnProperties'] if @optional.include? 'returnProperties'
+      p['includedProperties'] = @optional['includedProperties'] if @optional.include? 'includedProperties'
+      p['diversity'] = @optional['diversity'] if @optional.include? 'diversity'
+      p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
+      p
+    end
+  
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/recomms/items/#{@item_id}/users/"
+    end
+  end
+end

data/lib/recombee_api_client/api/recommend_users_to_user.rb

@@ -0,0 +1,149 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #This feature is currently in beta.
+  #
+  #Get similar users as some given user, based on the user's past interactions (purchases, ratings, etc.) and values of properties.
+  #
+  #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
+  #
+  class RecommendUsersToUser < ApiRequest
+    attr_reader :user_id, :count, :filter, :booster, :cascade_create, :scenario, :return_properties, :included_properties, :diversity, :min_relevance, :rotation_rate, :rotation_time, :expert_settings
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> User to which we find similar users
+  #   - +count+ -> Number of users to be recommended (N for the top-N recommendation).
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended users based on the values of their attributes.
+  #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to boost recommendation rate of some users based on the values of their attributes.
+  #   - +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.
+  #   - +scenario+ -> Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
+  #   - +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 for easy displaying the recommended users. 
+  #
+  #Example response:
+  #```
+  #  {
+  #    "recommId": "32fc671480eb29d843e47def43503992",
+  #    "recomms": 
+  #      [
+  #        {
+  #          "id": "user-17",
+  #          "values": {
+  #            "country": "US",
+  #            "sex": "F"
+  #          }
+  #        },
+  #        {
+  #          "id": "user-2",
+  #          "values": {
+  #            "country": "CAN",
+  #            "sex": "M"
+  #          }
+  #        }
+  #      ]
+  #    }
+  #```
+  #
+  #   - +includedProperties+ -> Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
+  #
+  #Example response for `includedProperties=country`:
+  #```
+  #  {
+  #    "recommId": "27d81ade643621f45cc6ba5d30d7d683",
+  #    "recomms":
+  #      [
+  #        {
+  #          "id": "user-17",
+  #          "values": {
+  #            "country": "US"
+  #          }
+  #        },
+  #        {
+  #          "id": "user-2",
+  #          "values": {
+  #            "country": "CAN"
+  #          }
+  #        }
+  #      ]
+  #  }
+  #```
+  #
+  #   - +diversity+ -> **Expert option** Real number from [0.0, 1.0] which determines how much mutually dissimilar should the recommended users be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
+  #
+  #   - +minRelevance+ -> **Expert option** Specifies the threshold of how much relevant must the recommended users be. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of users equal to *count* at any cost. If there are not enough data (such as interactions or user 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 case, the system only recommends users of at least the requested relevancy, and may return less than *count* users when there is not enough data to fulfill it.
+  #
+  #   - +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 backward fashion. You may penalize an 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.
+  #
+  #   - +rotationTime+ -> **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an user to recover from the penalization. For example, `rotationTime=7200.0` means that users recommended less than 2 hours ago are penalized.
+  #
+  #   - +expertSettings+ -> Dictionary of custom options.
+  #
+  #
+    def initialize(user_id, count, optional = {})
+      @user_id = user_id
+      @count = count
+      @filter = optional['filter']
+      @booster = optional['booster']
+      @cascade_create = optional['cascadeCreate']
+      @scenario = optional['scenario']
+      @return_properties = optional['returnProperties']
+      @included_properties = optional['includedProperties']
+      @diversity = optional['diversity']
+      @min_relevance = optional['minRelevance']
+      @rotation_rate = optional['rotationRate']
+      @rotation_time = optional['rotationTime']
+      @expert_settings = optional['expertSettings']
+      @optional = optional
+      @timeout = 3000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["filter","booster","cascadeCreate","scenario","returnProperties","includedProperties","diversity","minRelevance","rotationRate","rotationTime","expertSettings"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['count'] = @count
+      p['filter'] = @optional['filter'] if @optional.include? 'filter'
+      p['booster'] = @optional['booster'] if @optional.include? 'booster'
+      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
+      p['returnProperties'] = @optional['returnProperties'] if @optional.include? 'returnProperties'
+      p['includedProperties'] = @optional['includedProperties'] if @optional.include? 'includedProperties'
+      p['diversity'] = @optional['diversity'] if @optional.include? 'diversity'
+      p['minRelevance'] = @optional['minRelevance'] if @optional.include? 'minRelevance'
+      p['rotationRate'] = @optional['rotationRate'] if @optional.include? 'rotationRate'
+      p['rotationTime'] = @optional['rotationTime'] if @optional.include? 'rotationTime'
+      p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
+      p
+    end
+  
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/recomms/users/#{@user_id}/users/"
+    end
+  end
+end

data/lib/recombee_api_client/api/reset_database.rb

@@ -17,7 +17,7 @@ module RecombeeApiClient
   ##
   #
     def initialize()
-      @timeout = 239000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/set_view_portion.rb

@@ -13,7 +13,7 @@ module RecombeeApiClient
   #If you send new request with the same (`userId`, `itemId`, `sessionId`), the portion gets updated.
   #
   class SetViewPortion < ApiRequest
-    attr_reader :user_id, :item_id, :session_id, :timestamp, :portion, :cascade_create
+    attr_reader :user_id, :item_id, :portion, :session_id, :timestamp, :cascade_create
     attr_accessor :timeout
     attr_accessor :ensure_https
   

data/lib/recombee_api_client/api/user_based_recommendation.rb

@@ -18,7 +18,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +user_id+ -> ID of the user whose personalized recommendations are to be generated.
+  #   - +user_id+ -> ID of the user for which the personalized recommendations are to be generated.
   #   - +count+ -> Number of items to be recommended (N for the top-N recommendation).
   #
   # * *Optional arguments (given as hash optional)*

data/lib/recombee_api_client/version.rb

@@ -1,3 +1,3 @@
 module RecombeeApiClient
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'
 end

data/lib/recombee_api_client.rb

@@ -18,7 +18,7 @@ module RecombeeApiClient
     include HTTParty
 
     BATCH_MAX_SIZE = 10000
-    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/1.5.0'}
+    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/1.6.0'}
 
     ##
     #   - +account+ -> Name of your account at Recombee

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recombee_api_client
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Ondřej Fiedler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -144,6 +144,10 @@ files:
 - lib/recombee_api_client/api/list_user_view_portions.rb
 - lib/recombee_api_client/api/list_users.rb
 - lib/recombee_api_client/api/merge_users.rb
+- lib/recombee_api_client/api/recommend_items_to_item.rb
+- lib/recombee_api_client/api/recommend_items_to_user.rb
+- lib/recombee_api_client/api/recommend_users_to_item.rb
+- lib/recombee_api_client/api/recommend_users_to_user.rb
 - lib/recombee_api_client/api/remove_from_group.rb
 - lib/recombee_api_client/api/remove_from_series.rb
 - lib/recombee_api_client/api/request.rb