Timestamp is now optional parameter when deleting an interaction. cascadeCreate and scenario parameters for recommendations.

Author: OndraFiedler

lib/recombee_api_client/api/delete_bookmark.rb

@@ -17,13 +17,19 @@ class DeleteBookmark < ApiRequest
   # * *Required arguments*
   #   - +user_id+ -> ID of the user who made the bookmark.
   #   - +item_id+ -> ID of the item of which was bookmarked.
-  #   - +timestamp+ -> Unix timestamp of the bookmark.
   #
-    def initialize(user_id, item_id, timestamp)
+  # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> Unix timestamp of the bookmark. If the `timestamp` is omitted, then all the bookmarks with given `userId` and `itemId` are deleted.
+  #
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
+      @optional = optional
       @timeout = 1000
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+      end
     end
 
     # HTTP method
@@ -43,7 +49,7 @@ def query_parameters
       params = {}
       params['userId'] = @user_id
       params['itemId'] = @item_id
-      params['timestamp'] = @timestamp
+      params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       params
     end
 
@@ -54,7 +60,11 @@ def basic_path
 
     # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/bookmarks/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p = "/{databaseId}/bookmarks/?userId=#{@user_id}&itemId=#{@item_id}"
+      if @optional.include? 'timestamp'
+        p += (p.include? '?') ? '&' : '?'
+        p += "timestamp=#{@optional['timestamp']}"
+      end
       p
     end
   end

lib/recombee_api_client/api/delete_cart_addition.rb

@@ -17,13 +17,19 @@ class DeleteCartAddition < ApiRequest
   # * *Required arguments*
   #   - +user_id+ -> ID of the user who made the cart addition.
   #   - +item_id+ -> ID of the item of which was added to cart.
-  #   - +timestamp+ -> Unix timestamp of the cart addition.
   #
-    def initialize(user_id, item_id, timestamp)
+  # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> Unix timestamp of the cart addition. If the `timestamp` is omitted, then all the cart additions with given `userId` and `itemId` are deleted.
+  #
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
+      @optional = optional
       @timeout = 1000
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+      end
     end
 
     # HTTP method
@@ -43,7 +49,7 @@ def query_parameters
       params = {}
       params['userId'] = @user_id
       params['itemId'] = @item_id
-      params['timestamp'] = @timestamp
+      params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       params
     end
 
@@ -54,7 +60,11 @@ def basic_path
 
     # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/cartadditions/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p = "/{databaseId}/cartadditions/?userId=#{@user_id}&itemId=#{@item_id}"
+      if @optional.include? 'timestamp'
+        p += (p.include? '?') ? '&' : '?'
+        p += "timestamp=#{@optional['timestamp']}"
+      end
       p
     end
   end

lib/recombee_api_client/api/delete_detail_view.rb

@@ -17,13 +17,19 @@ class DeleteDetailView < ApiRequest
   # * *Required arguments*
   #   - +user_id+ -> ID of the user who made the detail view.
   #   - +item_id+ -> ID of the item of which the details were viewed.
-  #   - +timestamp+ -> Unix timestamp of the detail view.
   #
-    def initialize(user_id, item_id, timestamp)
+  # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> Unix timestamp of the detail view. If the `timestamp` is omitted, then all the detail views with given `userId` and `itemId` are deleted.
+  #
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
+      @optional = optional
       @timeout = 1000
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+      end
     end
 
     # HTTP method
@@ -43,7 +49,7 @@ def query_parameters
       params = {}
       params['userId'] = @user_id
       params['itemId'] = @item_id
-      params['timestamp'] = @timestamp
+      params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       params
     end
 
@@ -54,7 +60,11 @@ def basic_path
 
     # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/detailviews/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p = "/{databaseId}/detailviews/?userId=#{@user_id}&itemId=#{@item_id}"
+      if @optional.include? 'timestamp'
+        p += (p.include? '?') ? '&' : '?'
+        p += "timestamp=#{@optional['timestamp']}"
+      end
       p
     end
   end

lib/recombee_api_client/api/delete_purchase.rb

@@ -17,13 +17,19 @@ class DeletePurchase < ApiRequest
   # * *Required arguments*
   #   - +user_id+ -> ID of the user who made the purchase.
   #   - +item_id+ -> ID of the item of which was purchased.
-  #   - +timestamp+ -> Unix timestamp of the purchase.
   #
-    def initialize(user_id, item_id, timestamp)
+  # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> Unix timestamp of the purchase. If the `timestamp` is omitted, then all the purchases with given `userId` and `itemId` are deleted.
+  #
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
+      @optional = optional
       @timeout = 1000
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+      end
     end
 
     # HTTP method
@@ -43,7 +49,7 @@ def query_parameters
       params = {}
       params['userId'] = @user_id
       params['itemId'] = @item_id
-      params['timestamp'] = @timestamp
+      params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       params
     end
 
@@ -54,7 +60,11 @@ def basic_path
 
     # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/purchases/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p = "/{databaseId}/purchases/?userId=#{@user_id}&itemId=#{@item_id}"
+      if @optional.include? 'timestamp'
+        p += (p.include? '?') ? '&' : '?'
+        p += "timestamp=#{@optional['timestamp']}"
+      end
       p
     end
   end

lib/recombee_api_client/api/delete_rating.rb

@@ -17,13 +17,19 @@ class DeleteRating < ApiRequest
   # * *Required arguments*
   #   - +user_id+ -> ID of the user who rated the item.
   #   - +item_id+ -> ID of the item which was rated.
-  #   - +timestamp+ -> Unix timestamp of the rating.
   #
-    def initialize(user_id, item_id, timestamp)
+  # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> Unix timestamp of the rating. If the `timestamp` is omitted, then all the ratings with given `userId` and `itemId` are deleted.
+  #
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
+      @optional = optional
       @timeout = 1000
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+      end
     end
 
     # HTTP method
@@ -43,7 +49,7 @@ def query_parameters
       params = {}
       params['userId'] = @user_id
       params['itemId'] = @item_id
-      params['timestamp'] = @timestamp
+      params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       params
     end
 
@@ -54,7 +60,11 @@ def basic_path
 
     # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/ratings/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p = "/{databaseId}/ratings/?userId=#{@user_id}&itemId=#{@item_id}"
+      if @optional.include? 'timestamp'
+        p += (p.include? '?') ? '&' : '?'
+        p += "timestamp=#{@optional['timestamp']}"
+      end
       p
     end
   end

lib/recombee_api_client/api/item_based_recommendation.rb

@@ -10,7 +10,7 @@ module RecombeeApiClient
   #Recommends set of items that are somehow related to one given item, *X*. Typical scenario for using item-based recommendation is when user *A* is viewing *X*. Then you may display items to the user that he might be also interested in. Item-recommendation request gives you Top-N such items, optionally taking the target user *A* into account.
   #
   class ItemBasedRecommendation < ApiRequest
-    attr_reader :item_id, :count, :target_user_id, :user_impact, :filter, :booster, :allow_nonexistent, :diversity, :min_relevance, :rotation_rate, :rotation_time
+    attr_reader :item_id, :count, :target_user_id, :user_impact, :filter, :booster, :allow_nonexistent, :cascade_create, :scenario, :diversity, :min_relevance, :rotation_rate, :rotation_time
     attr_accessor :timeout
 
   ##
@@ -24,7 +24,9 @@ class ItemBasedRecommendation < ApiRequest
   #
   #   - +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.
-  #   - +allowNonexistent+ -> If the user does not exist in the database, returns a list of non-personalized recommendations instead of causing HTTP 404 error.
+  #   - +allowNonexistent+ -> Instead of causing HTTP 404 error, returns some (non-personalized) recommendations if either item of given *itemId* or user of given *targetUserId* does not exist in the database. It creates neither of the missing entities in the database.
+  #   - +cascadeCreate+ -> If item of given *itemId* or user of given *targetUserId* doesn't exist in the database, it creates the missing enity/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" or "cart". 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.
   #   - +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 qualit, and may return less than *count* items when there is not enough data to fulfill it.
@@ -42,14 +44,16 @@ def initialize(item_id, count, optional = {})
       @filter = optional['filter']
       @booster = optional['booster']
       @allow_nonexistent = optional['allowNonexistent']
+      @cascade_create = optional['cascadeCreate']
+      @scenario = optional['scenario']
       @diversity = optional['diversity']
       @min_relevance = optional['minRelevance']
       @rotation_rate = optional['rotationRate']
       @rotation_time = optional['rotationTime']
       @optional = optional
       @timeout = 3000
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["targetUserId","userImpact","filter","booster","allowNonexistent","diversity","minRelevance","rotationRate","rotationTime"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["targetUserId","userImpact","filter","booster","allowNonexistent","cascadeCreate","scenario","diversity","minRelevance","rotationRate","rotationTime"].include? par
       end
     end
 
@@ -74,6 +78,8 @@ def query_parameters
       params['filter'] = @optional['filter'] if @optional['filter']
       params['booster'] = @optional['booster'] if @optional['booster']
       params['allowNonexistent'] = @optional['allowNonexistent'] if @optional['allowNonexistent']
+      params['cascadeCreate'] = @optional['cascadeCreate'] if @optional['cascadeCreate']
+      params['scenario'] = @optional['scenario'] if @optional['scenario']
       params['diversity'] = @optional['diversity'] if @optional['diversity']
       params['minRelevance'] = @optional['minRelevance'] if @optional['minRelevance']
       params['rotationRate'] = @optional['rotationRate'] if @optional['rotationRate']
@@ -109,6 +115,14 @@ def path
         p += (p.include? '?') ? '&' : '?'
         p += "allowNonexistent=#{@optional['allowNonexistent']}"
       end
+      if @optional.include? 'cascadeCreate'
+        p += (p.include? '?') ? '&' : '?'
+        p += "cascadeCreate=#{@optional['cascadeCreate']}"
+      end
+      if @optional.include? 'scenario'
+        p += (p.include? '?') ? '&' : '?'
+        p += "scenario=#{@optional['scenario']}"
+      end
       if @optional.include? 'diversity'
         p += (p.include? '?') ? '&' : '?'
         p += "diversity=#{@optional['diversity']}"

lib/recombee_api_client/api/reset_database.rb

@@ -16,7 +16,7 @@ class ResetDatabase < ApiRequest
   ##
   #
     def initialize()
-      @timeout = 3000
+      @timeout = 5000
     end
 
     # HTTP method

lib/recombee_api_client/api/user_based_recommendation.rb

@@ -10,7 +10,7 @@ module RecombeeApiClient
   #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.
   #
   class UserBasedRecommendation < ApiRequest
-    attr_reader :user_id, :count, :filter, :booster, :allow_nonexistent, :diversity, :min_relevance, :rotation_rate, :rotation_time
+    attr_reader :user_id, :count, :filter, :booster, :allow_nonexistent, :cascade_create, :scenario, :diversity, :min_relevance, :rotation_rate, :rotation_time
     attr_accessor :timeout
 
   ##
@@ -21,7 +21,9 @@ class UserBasedRecommendation < ApiRequest
   # * *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.
-  #   - +allowNonexistent+ -> If the user does not exist in the database, returns a list of non-personalized recommendations instead of causing HTTP 404 error.
+  #   - +allowNonexistent+ -> If the user does not exist in the database, returns a list of non-personalized recommendations instead of causing HTTP 404 error. It doesn't create the user in the database.
+  #   - +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" or "cart". 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.
   #   - +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 qualit, and may return less than *count* items when there is not enough data to fulfill it.
@@ -37,14 +39,16 @@ def initialize(user_id, count, optional = {})
       @filter = optional['filter']
       @booster = optional['booster']
       @allow_nonexistent = optional['allowNonexistent']
+      @cascade_create = optional['cascadeCreate']
+      @scenario = optional['scenario']
       @diversity = optional['diversity']
       @min_relevance = optional['minRelevance']
       @rotation_rate = optional['rotationRate']
       @rotation_time = optional['rotationTime']
       @optional = optional
       @timeout = 3000
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["filter","booster","allowNonexistent","diversity","minRelevance","rotationRate","rotationTime"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["filter","booster","allowNonexistent","cascadeCreate","scenario","diversity","minRelevance","rotationRate","rotationTime"].include? par
       end
     end
 
@@ -67,6 +71,8 @@ def query_parameters
       params['filter'] = @optional['filter'] if @optional['filter']
       params['booster'] = @optional['booster'] if @optional['booster']
       params['allowNonexistent'] = @optional['allowNonexistent'] if @optional['allowNonexistent']
+      params['cascadeCreate'] = @optional['cascadeCreate'] if @optional['cascadeCreate']
+      params['scenario'] = @optional['scenario'] if @optional['scenario']
       params['diversity'] = @optional['diversity'] if @optional['diversity']
       params['minRelevance'] = @optional['minRelevance'] if @optional['minRelevance']
       params['rotationRate'] = @optional['rotationRate'] if @optional['rotationRate']
@@ -94,6 +100,14 @@ def path
         p += (p.include? '?') ? '&' : '?'
         p += "allowNonexistent=#{@optional['allowNonexistent']}"
       end
+      if @optional.include? 'cascadeCreate'
+        p += (p.include? '?') ? '&' : '?'
+        p += "cascadeCreate=#{@optional['cascadeCreate']}"
+      end
+      if @optional.include? 'scenario'
+        p += (p.include? '?') ? '&' : '?'
+        p += "scenario=#{@optional['scenario']}"
+      end
       if @optional.include? 'diversity'
         p += (p.include? '?') ? '&' : '?'
         p += "diversity=#{@optional['diversity']}"

spec/api/delete_interaction.rb

@@ -6,12 +6,12 @@
   include_context 'set interactions'
 
   it 'does not fail with existing entity id' do
-    delete_req = described_class.new('user', 'item', 0)
+    delete_req = described_class.new('user', 'item', 'timestamp' => 0)
     expect { @client.send(delete_req) }.not_to raise_exception
   end
 
   it 'really deletes the interaction' do
-    delete_req = described_class.new('user', 'item', 0)
+    delete_req = described_class.new('user', 'item')
     expect { @client.send(delete_req) }.not_to raise_exception
     expect { @client.send(delete_req) }.to raise_exception { |exception|
       expect(exception).to be_a(RecombeeApiClient::ResponseError)