recombee_api_client 2.1.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 67a55a5aad6cdef70d224b317e7487b91df21ebd
-  data.tar.gz: 1178066744ec92b39a3660e854ce709b4d431be6
+SHA256:
+  metadata.gz: c24717b90f3a557ec2ceda5bf24f0c62f1ae80384b0a993c7545c156b8586ddd
+  data.tar.gz: d1a88f7d65d7dc7456068975263d435d06059838d9e8c4a1deedf9cbce42e8c8
 SHA512:
-  metadata.gz: 5a06bfcbbb78f7b94231f542673be408222d25bd8eb1f22de6ccfedb9d1ce43cd7912621268d8799700221fe3bb3868db41f67157cfa0d79437a37800c46cc08
-  data.tar.gz: d4ccb9bd5fd18ad5279b09380fc447220e517b60783eace5e78c42df031c7b5a926820c1e9304fd4d2751f345b75b790393a0ecc5eb0f1b14a8095e5dc096656
+  metadata.gz: 6b33bd56d774de4240d04decbc4752b7c506062b26519b1d9e5afb335a61603bd2ba6723faeea545fe773cd659f54fb72490bafe66a112b6b31438eb7d2b0f6f
+  data.tar.gz: 1ea09e4189c88f8aa13f2e35ba36c1792da8877ae40ee1ca787f2f414ebc1da149f3557c0f26c09575106b25ec8019692d4b83e1ae1de88dce22574bdab8051c

data/README.md

@@ -29,7 +29,7 @@ Or install it yourself as:
 require 'recombee_api_client'
 include RecombeeApiClient
 
-client = RecombeeClient('--my-database-id--', '--my-secret-token--')
+client = RecombeeClient('--my-database-id--', '--db-private-token--')
 
 # Generate some random purchases of items by users
 NUM = 100
@@ -55,8 +55,13 @@ begin
   client.send(Batch.new(purchases))
   
   # Get recommendations for user 'user-25'
-  recommended = client.send(RecommendItemsToUser.new('user-25', 5))
-  puts "Recommended items for user-25: #{recommended}"
+  response = client.send(RecommendItemsToUser.new('user-25', 5))
+  puts "Recommended items for user-25: #{response}"
+
+  # User scrolled down - get next 3 recommended items
+  response = client.send(RecommendNextItems.new(response['recommId'], 3))
+  puts "Next recommended items for user-25: #{response}"
+
 rescue APIError => e
   puts e
   # Use fallback
@@ -71,8 +76,8 @@ include RecombeeApiClient
 NUM = 100
 PROBABILITY_PURCHASED = 0.1
 
-client = RecombeeClient('--my-database-id--', '--my-secret-token--')
-client.send(ResetDatabase.new) # Clear everything from the database
+client = RecombeeClient('--my-database-id--', '--db-private-token--')
+client.send(ResetDatabase.new) # Clear everything from the database (asynchronous)
 
 # We will use computers as items in this example
 # Computers have five properties 
@@ -103,7 +108,7 @@ requests = (1..NUM).map do |i|
       },
       #optional parameters:
       {
-        'cascadeCreate' => true  # Use cascadeCreate for creating item
+        :cascade_create => true  # Use cascade_create for creating item
                                  # with given itemId, if it doesn't exist
       }
     )
@@ -117,29 +122,38 @@ requests = []
 (1..NUM).map{|i| "computer-#{i}"}.each do |item_id|
   user_ids = (1..NUM).map{|i| "user-#{i}"}
   user_ids = user_ids.select { |_| rand(0.0..1.0) < PROBABILITY_PURCHASED }
-  # Use cascadeCreate to create unexisting users
-  user_ids.each { |user_id| requests.push(AddPurchase.new(user_id, item_id, 'cascadeCreate' => true)) }
+  # Use cascade_create to create unexisting users
+  user_ids.each { |user_id| requests.push(AddPurchase.new(user_id, item_id, :cascade_create => true)) }
 end
 
 # Send purchases to the recommender system
 client.send(Batch.new(requests))
 
 # Get 5 recommendations for user-42, who is currently viewing computer-6
-recommended = client.send(RecommendItemsToItem.new('computer-6', 'user-42', 5) )
-puts "Recommended items: #{recommended}"
-
 # Recommend only computers that have at least 3 cores
 recommended = client.send(
-  RecommendItemsToItem.new('computer-6', 'user-42', 5, {'filter' => "'num-cores'>=3"})
+  RecommendItemsToItem.new('computer-6', 'user-42', 5, {:filter => "'num-cores'>=3"})
   )
 puts "Recommended items with at least 3 processor cores: #{recommended}"
 
-# Recommend only items thatare more expensive then currently viewed item (up-sell)
+# Recommend only items that are more expensive then currently viewed item (up-sell)
 recommended = client.send(
   RecommendItemsToItem.new('computer-6', 'user-42', 5,
-    {'filter' => "'price' > context_item[\"price\"]"})
+    {:filter => "'price' > context_item[\"price\"]"})
   )
 puts "Recommended up-sell items: #{recommended}"
+
+# Filters, boosters and other settings can be also set in the Admin UI (admin.recombee.com)
+# when scenario is specified
+recommended = client.send(
+  RecommendItemsToItem.new('computer-6', 'user-42', 5, {:scenario => 'product_detail'})
+  )
+
+# Perform personalized full-text search with a user's search query (e.g. 'computers').
+matches = client.send(
+  SearchItems.new('user-42', 'computers', 5, {:scenario => 'search_top'})
+  )
+puts "Matched items: #{matches}"
 ```
 
 ### Exception handling

data/lib/recombee_api_client.rb

@@ -18,13 +18,13 @@ module RecombeeApiClient
     include HTTParty
 
     BATCH_MAX_SIZE = 10000
-    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/2.1.0'}
+    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/3.1.0'}
 
     ##
     #   - +account+ -> Name of your account at Recombee
     #   - +token+ -> Secret token obtained from Recombee for signing requests
     #   - +protocol+ -> Default protocol for sending requests. Possible values: 'http', 'https'.
-    def initialize(account, token, protocol = 'http', options = {})
+    def initialize(account, token, protocol = 'https', options = {})
       @account = account
       @token = token
       @protocol = protocol

data/lib/recombee_api_client/api/add_bookmark.rb

@@ -10,7 +10,7 @@ module RecombeeApiClient
   #Adds a bookmark of a given item made by a given user.
   #
   class AddBookmark < ApiRequest
-    attr_reader :user_id, :item_id, :timestamp, :cascade_create
+    attr_reader :user_id, :item_id, :timestamp, :cascade_create, :recomm_id, :additional_data
     attr_accessor :timeout
     attr_accessor :ensure_https
   
@@ -22,6 +22,8 @@ module RecombeeApiClient
   # * *Optional arguments (given as hash optional)*
   #   - +timestamp+ -> UTC timestamp of the bookmark 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.
+  #   - +recommId+ -> If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+  #   - +additionalData+ -> A dictionary of additional data for the interaction.
   #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
@@ -29,11 +31,13 @@ module RecombeeApiClient
       optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
+      @recomm_id = optional['recommId']
+      @additional_data = optional['additionalData']
       @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","recommId","additionalData"].include? par
       end
     end
   
@@ -49,6 +53,8 @@ module RecombeeApiClient
       p['itemId'] = @item_id
       p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['recommId'] = @optional['recommId'] if @optional.include? 'recommId'
+      p['additionalData'] = @optional['additionalData'] if @optional.include? 'additionalData'
       p
     end
   

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, :amount, :price
+    attr_reader :user_id, :item_id, :timestamp, :cascade_create, :amount, :price, :recomm_id, :additional_data
     attr_accessor :timeout
     attr_accessor :ensure_https
   
@@ -24,6 +24,8 @@ module RecombeeApiClient
   #   - +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.
+  #   - +recommId+ -> If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+  #   - +additionalData+ -> A dictionary of additional data for the interaction.
   #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
@@ -33,11 +35,13 @@ module RecombeeApiClient
       @cascade_create = optional['cascadeCreate']
       @amount = optional['amount']
       @price = optional['price']
+      @recomm_id = optional['recommId']
+      @additional_data = optional['additionalData']
       @optional = optional
       @timeout = 1000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price","recommId","additionalData"].include? par
       end
     end
   
@@ -55,6 +59,8 @@ module RecombeeApiClient
       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['recommId'] = @optional['recommId'] if @optional.include? 'recommId'
+      p['additionalData'] = @optional['additionalData'] if @optional.include? 'additionalData'
       p
     end
   

data/lib/recombee_api_client/api/add_detail_view.rb

@@ -10,7 +10,7 @@ module RecombeeApiClient
   #Adds a detail view of a given item made by a given user.
   #
   class AddDetailView < ApiRequest
-    attr_reader :user_id, :item_id, :timestamp, :duration, :cascade_create
+    attr_reader :user_id, :item_id, :timestamp, :duration, :cascade_create, :recomm_id, :additional_data
     attr_accessor :timeout
     attr_accessor :ensure_https
   
@@ -23,6 +23,8 @@ module RecombeeApiClient
   #   - +timestamp+ -> UTC timestamp of the view as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
   #   - +duration+ -> Duration of the view
   #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
+  #   - +recommId+ -> If this detail view is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+  #   - +additionalData+ -> A dictionary of additional data for the interaction.
   #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
@@ -31,11 +33,13 @@ module RecombeeApiClient
       @timestamp = optional['timestamp']
       @duration = optional['duration']
       @cascade_create = optional['cascadeCreate']
+      @recomm_id = optional['recommId']
+      @additional_data = optional['additionalData']
       @optional = optional
       @timeout = 1000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","duration","cascadeCreate"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["timestamp","duration","cascadeCreate","recommId","additionalData"].include? par
       end
     end
   
@@ -52,6 +56,8 @@ module RecombeeApiClient
       p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
       p['duration'] = @optional['duration'] if @optional.include? 'duration'
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['recommId'] = @optional['recommId'] if @optional.include? 'recommId'
+      p['additionalData'] = @optional['additionalData'] if @optional.include? 'additionalData'
       p
     end
   

data/lib/recombee_api_client/api/add_item_property.rb

@@ -20,6 +20,22 @@ module RecombeeApiClient
   #
   #   - +type+ -> Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.
   #
+  #* `int`- Signed integer number.
+  #
+  #* `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
+  #
+  #* `string` - UTF-8 string.
+  #
+  #* `boolean` - *true* / *false*
+  #
+  #* `timestamp` - Value representing date and time.
+  #
+  #* `set` - Set of strings.
+  #
+  #* `image` - URL of an image (`jpeg`, `png` or `gif`).
+  #
+  #* `imageList` - List of URLs that refer to images. 
+  #
   #
     def initialize(property_name, type)
       @property_name = property_name

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, :amount, :price, :profit
+    attr_reader :user_id, :item_id, :timestamp, :cascade_create, :amount, :price, :profit, :recomm_id, :additional_data
     attr_accessor :timeout
     attr_accessor :ensure_https
   
@@ -25,6 +25,8 @@ module RecombeeApiClient
   #   - +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.
+  #   - +recommId+ -> If this purchase is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+  #   - +additionalData+ -> A dictionary of additional data for the interaction.
   #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
@@ -35,11 +37,13 @@ module RecombeeApiClient
       @amount = optional['amount']
       @price = optional['price']
       @profit = optional['profit']
+      @recomm_id = optional['recommId']
+      @additional_data = optional['additionalData']
       @optional = optional
       @timeout = 1000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price","profit"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price","profit","recommId","additionalData"].include? par
       end
     end
   
@@ -58,6 +62,8 @@ module RecombeeApiClient
       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['recommId'] = @optional['recommId'] if @optional.include? 'recommId'
+      p['additionalData'] = @optional['additionalData'] if @optional.include? 'additionalData'
       p
     end
   

data/lib/recombee_api_client/api/add_rating.rb

@@ -10,7 +10,7 @@ module RecombeeApiClient
   #Adds a rating of given item made by a given user.
   #
   class AddRating < ApiRequest
-    attr_reader :user_id, :item_id, :timestamp, :rating, :cascade_create
+    attr_reader :user_id, :item_id, :timestamp, :rating, :cascade_create, :recomm_id, :additional_data
     attr_accessor :timeout
     attr_accessor :ensure_https
   
@@ -23,6 +23,8 @@ module RecombeeApiClient
   # * *Optional arguments (given as hash optional)*
   #   - +timestamp+ -> UTC timestamp of the rating 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.
+  #   - +recommId+ -> If this rating is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+  #   - +additionalData+ -> A dictionary of additional data for the interaction.
   #
     def initialize(user_id, item_id, rating, optional = {})
       @user_id = user_id
@@ -31,11 +33,13 @@ module RecombeeApiClient
       optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
+      @recomm_id = optional['recommId']
+      @additional_data = optional['additionalData']
       @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","recommId","additionalData"].include? par
       end
     end
   
@@ -52,6 +56,8 @@ module RecombeeApiClient
       p['rating'] = @rating
       p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['recommId'] = @optional['recommId'] if @optional.include? 'recommId'
+      p['additionalData'] = @optional['additionalData'] if @optional.include? 'additionalData'
       p
     end
   

data/lib/recombee_api_client/api/add_user_property.rb

@@ -18,7 +18,19 @@ module RecombeeApiClient
   # * *Required arguments*
   #   - +property_name+ -> Name of the user property to be created. Currently, the following names are reserved:`id`, `userid`, case insensitively. Also, the length of the property name must not exceed 63 characters.
   #
-  #   - +type+ -> Value type of the user property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`
+  #   - +type+ -> Value type of the user property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`.
+  #
+  #* `int` - Signed integer number.
+  #
+  #* `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
+  #
+  #* `string` - UTF-8 string.
+  #
+  #* `boolean` - *true* / *false*
+  #
+  #* `timestamp` - Value representing date and time.
+  #
+  #* `set` - Set of strings.
   #
   #
     def initialize(property_name, type)

data/lib/recombee_api_client/api/merge_users.rb

@@ -10,7 +10,7 @@ module RecombeeApiClient
   #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`.
+  #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**.
   #
   class MergeUsers < ApiRequest
     attr_reader :target_user_id, :source_user_id, :cascade_create

data/lib/recombee_api_client/api/recommend_items_to_item.rb

@@ -9,10 +9,17 @@ module RecombeeApiClient
   ##
   #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.
   #
+  #The returned items are sorted by relevance (first item being the most relevant).
+  #
+  #Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
+  #
+  #- 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.html#reported-metrics).
+  #- 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.html#recommend-next-items).
+  #
   #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_reader :item_id, :target_user_id, :count, :scenario, :cascade_create, :return_properties, :included_properties, :filter, :booster, :logic, :user_impact, :diversity, :min_relevance, :rotation_rate, :rotation_time, :expert_settings, :return_ab_group
     attr_accessor :timeout
     attr_accessor :ensure_https
   
@@ -40,12 +47,13 @@ module RecombeeApiClient
   #   - +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`.
+  #   - +scenario+ -> Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing".
+  #
+  #You can set various settings to the [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com). You can also see performance of each scenario in the Admin 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.
   #
-  #   - +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:
@@ -72,7 +80,8 @@ module RecombeeApiClient
   #            "url": "myshop.com/mixer-42"
   #          }
   #        }
-  #      ]
+  #      ],
+  #    "numberNextRecommsCalls": 0
   #  }
   #```
   #
@@ -98,13 +107,31 @@ module RecombeeApiClient
   #            "price": 39
   #          }
   #        }
-  #      ]
+  #      ],
+  #    "numberNextRecommsCalls": 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.
+  #
+  #Filters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+  #
+  #   - +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.
+  #
+  #Boosters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+  #
+  #   - +logic+ -> Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
+  #See [this section](https://docs.recombee.com/recommendation_logics.html) for list of available logics and other details.
+  #
+  #The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
+  #
+  #Logic can be also set to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+  #
+  #   - +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 user-based recommendation. The default value is `0`.
+  #
   #   - +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.
+  #   - +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 relevance, 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.
   #
@@ -112,29 +139,33 @@ module RecombeeApiClient
   #
   #   - +expertSettings+ -> Dictionary of custom options.
   #
+  #   - +returnAbGroup+ -> If there is a custom AB-testing running, return name of group to which the request belongs.
+  #
   #
     def initialize(item_id, target_user_id, count, optional = {})
       @item_id = item_id
       @target_user_id = target_user_id
       @count = count
       optional = normalize_optional(optional)
-      @user_impact = optional['userImpact']
-      @filter = optional['filter']
-      @booster = optional['booster']
-      @cascade_create = optional['cascadeCreate']
       @scenario = optional['scenario']
+      @cascade_create = optional['cascadeCreate']
       @return_properties = optional['returnProperties']
       @included_properties = optional['includedProperties']
+      @filter = optional['filter']
+      @booster = optional['booster']
+      @logic = optional['logic']
+      @user_impact = optional['userImpact']
       @diversity = optional['diversity']
       @min_relevance = optional['minRelevance']
       @rotation_rate = optional['rotationRate']
       @rotation_time = optional['rotationTime']
       @expert_settings = optional['expertSettings']
+      @return_ab_group = optional['returnAbGroup']
       @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
+        fail UnknownOptionalParameter.new(par) unless ["scenario","cascadeCreate","returnProperties","includedProperties","filter","booster","logic","userImpact","diversity","minRelevance","rotationRate","rotationTime","expertSettings","returnAbGroup"].include? par
       end
     end
   
@@ -148,18 +179,20 @@ module RecombeeApiClient
       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['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
       p['returnProperties'] = @optional['returnProperties'] if @optional.include? 'returnProperties'
       p['includedProperties'] = @optional['includedProperties'] if @optional.include? 'includedProperties'
+      p['filter'] = @optional['filter'] if @optional.include? 'filter'
+      p['booster'] = @optional['booster'] if @optional.include? 'booster'
+      p['logic'] = @optional['logic'] if @optional.include? 'logic'
+      p['userImpact'] = @optional['userImpact'] if @optional.include? 'userImpact'
       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['returnAbGroup'] = @optional['returnAbGroup'] if @optional.include? 'returnAbGroup'
       p
     end