recombee_api_client 1.2.0 → 1.2.1

data/lib/recombee_api_client/api/delete_item.rb

@@ -39,7 +39,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -47,14 +47,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/items/#{@item_id}"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/items/#{@item_id}"
-      p
+      "/{databaseId}/items/#{@item_id}"
     end
   end
 end

data/lib/recombee_api_client/api/delete_item_property.rb

@@ -35,7 +35,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -43,14 +43,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/items/properties/#{@property_name}"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/items/properties/#{@property_name}"
-      p
+      "/{databaseId}/items/properties/#{@property_name}"
     end
   end
 end

data/lib/recombee_api_client/api/delete_purchase.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Deletes an existing purchase uniquely specified by `userId`, `itemId`, and `timestamp`.
+  #Deletes an existing purchase uniquely specified by `userId`, `itemId`, and `timestamp` or all the purchases with given `userId` and `itemId` if `timestamp` is omitted.
   #
   class DeletePurchase < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
@@ -45,7 +45,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -56,18 +56,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/purchases/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/purchases/?userId=#{@user_id}&itemId=#{@item_id}"
-      if @optional.include? 'timestamp'
-        p += (p.include? '?') ? '&' : '?'
-        p += "timestamp=#{@optional['timestamp']}"
-      end
-      p
+      "/{databaseId}/purchases/"
     end
   end
 end

data/lib/recombee_api_client/api/delete_rating.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Deletes an existing rating specified by (`userId`, `itemId`, `timestamp`) from the database.
+  #Deletes an existing rating specified by (`userId`, `itemId`, `timestamp`) from the database or all the ratings with given `userId` and `itemId` if `timestamp` is omitted.
   #
   class DeleteRating < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
@@ -45,7 +45,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -56,18 +56,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/ratings/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/ratings/?userId=#{@user_id}&itemId=#{@item_id}"
-      if @optional.include? 'timestamp'
-        p += (p.include? '?') ? '&' : '?'
-        p += "timestamp=#{@optional['timestamp']}"
-      end
-      p
+      "/{databaseId}/ratings/"
     end
   end
 end

data/lib/recombee_api_client/api/delete_series.rb

@@ -37,7 +37,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -45,14 +45,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/series/#{@series_id}"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/series/#{@series_id}"
-      p
+      "/{databaseId}/series/#{@series_id}"
     end
   end
 end

data/lib/recombee_api_client/api/delete_user.rb

@@ -37,7 +37,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -45,14 +45,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/users/#{@user_id}"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/users/#{@user_id}"
-      p
+      "/{databaseId}/users/#{@user_id}"
     end
   end
 end

data/lib/recombee_api_client/api/get_item_property_info.rb

@@ -35,7 +35,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -43,14 +43,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/items/properties/#{@property_name}"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/items/properties/#{@property_name}"
-      p
+      "/{databaseId}/items/properties/#{@property_name}"
     end
   end
 end

data/lib/recombee_api_client/api/get_item_values.rb

@@ -36,7 +36,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -44,14 +44,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/items/#{@item_id}"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/items/#{@item_id}"
-      p
+      "/{databaseId}/items/#{@item_id}"
     end
   end
 end

data/lib/recombee_api_client/api/insert_to_group.rb

@@ -50,7 +50,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -58,14 +58,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/groups/#{@group_id}/items/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/groups/#{@group_id}/items/"
-      p
+      "/{databaseId}/groups/#{@group_id}/items/"
     end
   end
 end

data/lib/recombee_api_client/api/insert_to_series.rb

@@ -53,7 +53,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -61,14 +61,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/series/#{@series_id}/items/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/series/#{@series_id}/items/"
-      p
+      "/{databaseId}/series/#{@series_id}/items/"
     end
   end
 end

data/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, :cascade_create, :scenario, :diversity, :min_relevance, :rotation_rate, :rotation_time
+    attr_reader :item_id, :count, :target_user_id, :user_impact, :filter, :booster, :allow_nonexistent, :cascade_create, :scenario, :return_properties, :included_properties, :diversity, :min_relevance, :rotation_rate, :rotation_time
     attr_accessor :timeout
     attr_accessor :ensure_https
   
@@ -28,13 +28,53 @@ module RecombeeApiClient
   #   - +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.
+  #   - +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:
+  #```
+  #  [
+  #    {
+  #      "itemId": "tv-178",
+  #      "description": "4K TV with 3D feature",
+  #      "categories":   ["Electronics", "Televisions"],
+  #      "price": 342,
+  #      "url": "myshop.com/tv-178"
+  #    },
+  #    {
+  #      "itemId": "mixer-42",
+  #      "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`:
+  #```
+  #  [
+  #    {
+  #      "itemId": "tv-178",
+  #      "description": "4K TV with 3D feature",
+  #      "price": 342
+  #    },
+  #    {
+  #      "itemId": "mixer-42",
+  #      "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 qualit, 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 fully recover from the penalization. By example, `rotationTime=7200.0` means that items recommended more than 2 hours ago are definitely not penalized anymore. Currently, the penalization is linear, so for `rotationTime=7200.0`, an item is still penalized by `0.5` to the user after 1 hour. |
+  #   - +rotationTime+ -> **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an item to fully recover from the penalization. By example, `rotationTime=7200.0` means that items recommended more than 2 hours ago are definitely not penalized anymore. Currently, the penalization is linear, so for `rotationTime=7200.0`, an item is still penalized by `0.5` to the user after 1 hour.
   #
   #
     def initialize(item_id, count, optional = {})
@@ -47,6 +87,8 @@ module RecombeeApiClient
       @allow_nonexistent = optional['allowNonexistent']
       @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']
@@ -55,7 +97,7 @@ module RecombeeApiClient
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["targetUserId","userImpact","filter","booster","allowNonexistent","cascadeCreate","scenario","diversity","minRelevance","rotationRate","rotationTime"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["targetUserId","userImpact","filter","booster","allowNonexistent","cascadeCreate","scenario","returnProperties","includedProperties","diversity","minRelevance","rotationRate","rotationTime"].include? par
       end
     end
   
@@ -70,7 +112,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -82,6 +124,8 @@ module RecombeeApiClient
       params['allowNonexistent'] = @optional['allowNonexistent'] if @optional['allowNonexistent']
       params['cascadeCreate'] = @optional['cascadeCreate'] if @optional['cascadeCreate']
       params['scenario'] = @optional['scenario'] if @optional['scenario']
+      params['returnProperties'] = @optional['returnProperties'] if @optional['returnProperties']
+      params['includedProperties'] = @optional['includedProperties'] if @optional['includedProperties']
       params['diversity'] = @optional['diversity'] if @optional['diversity']
       params['minRelevance'] = @optional['minRelevance'] if @optional['minRelevance']
       params['rotationRate'] = @optional['rotationRate'] if @optional['rotationRate']
@@ -90,58 +134,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/items/#{@item_id}/recomms/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/items/#{@item_id}/recomms/?count=#{@count}"
-      if @optional.include? 'targetUserId'
-        p += (p.include? '?') ? '&' : '?'
-        p += "targetUserId=#{@optional['targetUserId']}"
-      end
-      if @optional.include? 'userImpact'
-        p += (p.include? '?') ? '&' : '?'
-        p += "userImpact=#{@optional['userImpact']}"
-      end
-      if @optional.include? 'filter'
-        p += (p.include? '?') ? '&' : '?'
-        p += "filter=#{@optional['filter']}"
-      end
-      if @optional.include? 'booster'
-        p += (p.include? '?') ? '&' : '?'
-        p += "booster=#{@optional['booster']}"
-      end
-      if @optional.include? 'allowNonexistent'
-        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']}"
-      end
-      if @optional.include? 'minRelevance'
-        p += (p.include? '?') ? '&' : '?'
-        p += "minRelevance=#{@optional['minRelevance']}"
-      end
-      if @optional.include? 'rotationRate'
-        p += (p.include? '?') ? '&' : '?'
-        p += "rotationRate=#{@optional['rotationRate']}"
-      end
-      if @optional.include? 'rotationTime'
-        p += (p.include? '?') ? '&' : '?'
-        p += "rotationTime=#{@optional['rotationTime']}"
-      end
-      p
+      "/{databaseId}/items/#{@item_id}/recomms/"
     end
   end
 end

data/lib/recombee_api_client/api/list_group_items.rb

@@ -34,7 +34,7 @@ module RecombeeApiClient
       p
     end
   
-    # Values of query path parameters as a Hash.
+    # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
@@ -42,14 +42,8 @@ module RecombeeApiClient
     end
   
     # Relative path to the endpoint
-    def basic_path
-      "/{databaseId}/groups/#{@group_id}/items/"
-    end
-  
-    # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/groups/#{@group_id}/items/"
-      p
+      "/{databaseId}/groups/#{@group_id}/items/"
     end
   end
 end