class RecombeeApiClient::RecommendUsersToUser

Get similar users as some given user, based on the user's past interactions (purchases, ratings, etc.) and values of properties.

It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.



Public Class Methods

new(user_id, count, optional = {}) click to toggle source
* *Required arguments*
  - +user_id+ -> User to which we find similar users
  - +count+ -> Number of users to be recommended (N for the top-N recommendation).

* *Optional arguments (given as hash optional)*
  - +filter+ -> Boolean-returning [ReQL]( expression which allows you to filter recommended users based on the values of their attributes.
  - +booster+ -> Number-returning [ReQL]( expression which allows you to boost recommendation rate of some users based on the values of their attributes.
  - +cascadeCreate+ -> If the user does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows for example rotations in the following recommendations for that user, as the user will be already known to the system.
  - +scenario+ -> Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
  - +returnProperties+ -> With `returnProperties=true`, property values of the recommended users are returned along with their IDs in a JSON dictionary. The acquired property values can be used for easy displaying the recommended users.

Example response: “`

  "recommId": "9cb9c55d-50ba-4478-84fd-ab456136156e",
        "id": "user-17",
        "values": {
          "country": "US",
          "sex": "F"
        "id": "user-2",
        "values": {
          "country": "CAN",
          "sex": "M"


- +includedProperties+ -> Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.

Example response for `includedProperties=country`: “`

  "recommId": "b326d82d-5d57-4b45-b362-c9d6f0895855",
        "id": "user-17",
        "values": {
          "country": "US"
        "id": "user-2",
        "values": {
          "country": "CAN"


- +diversity+ -> **Expert option** Real number from [0.0, 1.0] which determines how much mutually dissimilar should the recommended users be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.

- +minRelevance+ -> **Expert option** Specifies the threshold of how much relevant must the recommended users be. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of users equal to *count* at any cost. If there are not enough data (such as interactions or user properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends users of at least the requested relevancy, and may return less than *count* users when there is not enough data to fulfill it.

- +rotationRate+ -> **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an user for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended users.

- +rotationTime+ -> **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an user to recover from the penalization. For example, `rotationTime=7200.0` means that users recommended less than 2 hours ago are penalized.

- +expertSettings+ -> Dictionary of custom options.
# File lib/recombee_api_client/api/recommend_users_to_user.rb, line 90
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']
  @return_properties = optional['returnProperties']
  @included_properties = optional['includedProperties']
  @diversity = optional['diversity']
  @min_relevance = optional['minRelevance']
  @rotation_rate = optional['rotationRate']
  @rotation_time = optional['rotationTime']
  @expert_settings = optional['expertSettings']
  @optional = optional
  @timeout = 50000
  @ensure_https = false
  @optional.each do |par, _|
    fail unless ["filter","booster","cascadeCreate","scenario","returnProperties","includedProperties","diversity","minRelevance","rotationRate","rotationTime","expertSettings"].include? par

Public Instance Methods

body_parameters() click to toggle source

Values of body parameters as a Hash

# File lib/recombee_api_client/api/recommend_users_to_user.rb, line 119
def body_parameters
  p =
  p['count'] = @count
  p['filter'] = @optional['filter'] if @optional.include? 'filter'
  p['booster'] = @optional['booster'] if @optional.include? 'booster'
  p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
  p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
  p['returnProperties'] = @optional['returnProperties'] if @optional.include? 'returnProperties'
  p['includedProperties'] = @optional['includedProperties'] if @optional.include? 'includedProperties'
  p['diversity'] = @optional['diversity'] if @optional.include? 'diversity'
  p['minRelevance'] = @optional['minRelevance'] if @optional.include? 'minRelevance'
  p['rotationRate'] = @optional['rotationRate'] if @optional.include? 'rotationRate'
  p['rotationTime'] = @optional['rotationTime'] if @optional.include? 'rotationTime'
  p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
method() click to toggle source

HTTP method

# File lib/recombee_api_client/api/recommend_users_to_user.rb, line 114
def method
path() click to toggle source

Relative path to the endpoint

# File lib/recombee_api_client/api/recommend_users_to_user.rb, line 144
def path
query_parameters() click to toggle source

Values of query parameters as a Hash. name of parameter => value of the parameter

# File lib/recombee_api_client/api/recommend_users_to_user.rb, line 138
def query_parameters
  params = {}