recombee_api_client 2.2.0 → 3.2.0

data/lib/recombee_api_client/api/recommend_users_to_user.rb

@@ -11,21 +11,26 @@ module RecombeeApiClient
   #
   #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
   #
+  #The returned users are sorted by similarity (first user being the most similar).
+  #
   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_reader :user_id, :count, :scenario, :cascade_create, :return_properties, :included_properties, :filter, :booster, :logic, :diversity, :min_relevance, :rotation_rate, :rotation_time, :expert_settings, :return_ab_group
     attr_accessor :timeout
     attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
-  #   - +user_id+ -> User to which we find similar users
+  #   - +user_id+ -> User to whom 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.
+  #   - +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.
+  #
   #   - +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:
@@ -48,8 +53,9 @@ module RecombeeApiClient
   #            "sex": "M"
   #          }
   #        }
-  #      ]
-  #    }
+  #      ],
+  #    "numberNextRecommsCalls": 0
+  #  }
   #```
   #
   #   - +includedProperties+ -> Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
@@ -72,13 +78,29 @@ module RecombeeApiClient
   #            "country": "CAN"
   #          }
   #        }
-  #      ]
+  #      ],
+  #    "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).
+  #
   #   - +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.
+  #   - +minRelevance+ -> **Expert option** Specifies the threshold of how much relevant must the recommended users be. Possible values one of: "low", "medium", "high".
   #
   #   - +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.
   #
@@ -86,27 +108,31 @@ 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(user_id, count, optional = {})
       @user_id = user_id
       @count = count
       optional = normalize_optional(optional)
-      @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']
       @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 = 50000
       @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
+        fail UnknownOptionalParameter.new(par) unless ["scenario","cascadeCreate","returnProperties","includedProperties","filter","booster","logic","diversity","minRelevance","rotationRate","rotationTime","expertSettings","returnAbGroup"].include? par
       end
     end
   
@@ -119,17 +145,19 @@ module RecombeeApiClient
     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['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['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
   

data/lib/recombee_api_client/api/search_items.rb

@@ -0,0 +1,178 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Full-text personalized search. The results are based on the provided `searchQuery` and also on the user's past interactions (purchases, ratings, etc.) with the items (items more suitable for the user are preferred in the results).
+  #
+  #All the string and set item properties are indexed by the search engine.
+  #
+  #This endpoint should be used in a search box at your website/app. It can be called multiple times as the user is typing the query in order to get the most viable suggestions based on current state of the query, or once after submitting the whole query. 
+  #
+  #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 search 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 search results when the user scrolls down 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 SearchItems < ApiRequest
+    attr_reader :user_id, :search_query, :count, :scenario, :cascade_create, :return_properties, :included_properties, :filter, :booster, :logic, :expert_settings, :return_ab_group
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user for whom personalized search will be performed.
+  #   - +search_query+ -> Search query provided by the user. It is used for the full-text search.
+  #   - +count+ -> Number of items to be returned (N for the top-N results).
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +scenario+ -> Scenario defines a particular search field in your user interface.
+  #
+  #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 field 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.
+  #
+  #   - +cascadeCreate+ -> If the user does not exist in the database, returns a list of non-personalized search results 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.
+  #   - +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": "ce52ada4-e4d9-4885-943c-407db2dee837",
+  #    "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"
+  #          }
+  #        }
+  #      ],
+  #    "numberNextRecommsCalls": 0
+  #  }
+  #```
+  #
+  #   - +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": "a86ee8d5-cd8e-46d1-886c-8b3771d0520b",
+  #    "recomms":
+  #      [
+  #        {
+  #          "id": "tv-178",
+  #          "values": {
+  #            "description": "4K TV with 3D feature",
+  #            "price": 342
+  #          }
+  #        },
+  #        {
+  #          "id": "mixer-42",
+  #          "values": {
+  #            "description": "Stainless Steel Mixer",
+  #            "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).
+  #
+  #   - +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(user_id, search_query, count, optional = {})
+      @user_id = user_id
+      @search_query = search_query
+      @count = count
+      optional = normalize_optional(optional)
+      @scenario = optional['scenario']
+      @cascade_create = optional['cascadeCreate']
+      @return_properties = optional['returnProperties']
+      @included_properties = optional['includedProperties']
+      @filter = optional['filter']
+      @booster = optional['booster']
+      @logic = optional['logic']
+      @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 ["scenario","cascadeCreate","returnProperties","includedProperties","filter","booster","logic","expertSettings","returnAbGroup"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['searchQuery'] = @search_query
+      p['count'] = @count
+      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['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
+      p['returnAbGroup'] = @optional['returnAbGroup'] if @optional.include? 'returnAbGroup'
+      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}/search/users/#{@user_id}/items/"
+    end
+  end
+end

data/lib/recombee_api_client/api/set_view_portion.rb

@@ -11,7 +11,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, :portion, :session_id, :timestamp, :cascade_create, :recomm_id
+    attr_reader :user_id, :item_id, :portion, :session_id, :timestamp, :cascade_create, :recomm_id, :additional_data
     attr_accessor :timeout
     attr_accessor :ensure_https
   
@@ -26,6 +26,7 @@ module RecombeeApiClient
   #   - +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 view portion 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, portion, optional = {})
       @user_id = user_id
@@ -36,11 +37,12 @@ module RecombeeApiClient
       @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 ["sessionId","timestamp","cascadeCreate","recommId"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["sessionId","timestamp","cascadeCreate","recommId","additionalData"].include? par
       end
     end
   
@@ -59,6 +61,7 @@ module RecombeeApiClient
       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/user_based_recommendation.rb

@@ -20,7 +20,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +user_id+ -> ID of the user for which the personalized recommendations are to be generated.
+  #   - +user_id+ -> ID of the user for whom 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 = '2.2.0'
+  VERSION = '3.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recombee_api_client
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Ondřej Fiedler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -100,10 +100,12 @@ files:
 - lib/recombee_api_client/api/add_item_property.rb
 - lib/recombee_api_client/api/add_purchase.rb
 - lib/recombee_api_client/api/add_rating.rb
+- lib/recombee_api_client/api/add_search_synonym.rb
 - lib/recombee_api_client/api/add_series.rb
 - lib/recombee_api_client/api/add_user.rb
 - lib/recombee_api_client/api/add_user_property.rb
 - lib/recombee_api_client/api/batch.rb
+- lib/recombee_api_client/api/delete_all_search_synonyms.rb
 - lib/recombee_api_client/api/delete_bookmark.rb
 - lib/recombee_api_client/api/delete_cart_addition.rb
 - lib/recombee_api_client/api/delete_detail_view.rb
@@ -112,6 +114,7 @@ files:
 - lib/recombee_api_client/api/delete_item_property.rb
 - lib/recombee_api_client/api/delete_purchase.rb
 - lib/recombee_api_client/api/delete_rating.rb
+- lib/recombee_api_client/api/delete_search_synonym.rb
 - lib/recombee_api_client/api/delete_series.rb
 - lib/recombee_api_client/api/delete_user.rb
 - lib/recombee_api_client/api/delete_user_property.rb
@@ -134,6 +137,7 @@ files:
 - lib/recombee_api_client/api/list_item_ratings.rb
 - lib/recombee_api_client/api/list_item_view_portions.rb
 - lib/recombee_api_client/api/list_items.rb
+- lib/recombee_api_client/api/list_search_synonyms.rb
 - lib/recombee_api_client/api/list_series.rb
 - lib/recombee_api_client/api/list_series_items.rb
 - lib/recombee_api_client/api/list_user_bookmarks.rb
@@ -147,12 +151,14 @@ files:
 - 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_next_items.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
 - lib/recombee_api_client/api/reset_database.rb
+- lib/recombee_api_client/api/search_items.rb
 - lib/recombee_api_client/api/set_item_values.rb
 - lib/recombee_api_client/api/set_user_values.rb
 - lib/recombee_api_client/api/set_values.rb
@@ -180,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Client for Recombee recommendation API