Class: RecombeeApiClient::RecommendUsersToItem

Inherits:
ApiRequest
  • Object
show all
Defined in:
lib/recombee_api_client/api/recommend_users_to_item.rb

Overview

Recommends users that are likely to be interested in the given item.

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

The returned users are sorted by predicted interest in the item (the first user being the most interested).

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashNormalizer

#camelize, #normalize_optional

Constructor Details

#initialize(item_id, count, optional = {}) ⇒ RecommendUsersToItem

  • *Required arguments*

    • item_id -> ID of the item for which the recommendations are to be generated.

    • count -> Number of items to be recommended (N for the top-N recommendation).

  • *Optional arguments (given as hash optional)*

    • 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](docs.recombee.com/scenarios) in the [Admin UI](admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.

The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.

- +cascadeCreate+ -> If an item of the given *itemId* doesn't exist in the database, it creates the missing item.
- +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 to easily display the recommended users.

Example response: “‘json

{
  "recommId": "039b71dc-b9cc-4645-a84f-62b841eecfce",
  "recomms":
    [
      {
        "id": "user-17",
        "values": {
          "country": "US",
          "sex": "F"
        }
      },
      {
        "id": "user-2",
        "values": {
          "country": "CAN",
          "sex": "M"
        }
      }
    ],
  "numberNextRecommsCalls": 0
}

“‘

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

Example response for ‘includedProperties=country`: “`json

{
  "recommId": "b2b355dd-972a-4728-9c6b-2dc229db0678",
  "recomms":
    [
      {
        "id": "user-17",
        "values": {
          "country": "US"
        }
      },
      {
        "id": "user-2",
        "values": {
          "country": "CAN"
        }
      }
    ],
  "numberNextRecommsCalls": 0
}

“‘

- +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes.

Filters can also be assigned to a [scenario](docs.recombee.com/scenarios) in the [Admin UI](admin.recombee.com).

- +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.

Boosters can also be assigned to a [scenario](docs.recombee.com/scenarios) in the [Admin UI](admin.recombee.com).

- +logic+ -> Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.

See [this section](docs.recombee.com/recommendation_logics) for a 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 also be set to a [scenario](docs.recombee.com/scenarios) in the [Admin UI](admin.recombee.com).

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

- +expertSettings+ -> Dictionary of custom options.

- +returnAbGroup+ -> If there is a custom AB-testing running, return the name of the group to which the request belongs.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 108

def initialize(item_id, count, optional = {})
  @item_id = item_id
  @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']
  @diversity = optional['diversity']
  @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 ["scenario","cascadeCreate","returnProperties","includedProperties","filter","booster","logic","diversity","expertSettings","returnAbGroup"].include? par
  end
end

Instance Attribute Details

#booster ⇒ Object (readonly)

Returns the value of attribute booster.



17
18
19
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 17

def booster
  @booster
end

#cascade_create ⇒ Object (readonly)

Returns the value of attribute cascade_create.



17
18
19
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 17

def cascade_create
  @cascade_create
end

#count ⇒ Object (readonly)

Returns the value of attribute count.



17
18
19
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 17

def count
  @count
end

#diversity ⇒ Object (readonly)

Returns the value of attribute diversity.



17
18
19
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 17

def diversity
  @diversity
end

#ensure_https ⇒ Object

Returns the value of attribute ensure_https.



19
20
21
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 19

def ensure_https
  @ensure_https
end

#expert_settings ⇒ Object (readonly)

Returns the value of attribute expert_settings.



17
18
19
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 17

def expert_settings
  @expert_settings
end

#filter ⇒ Object (readonly)

Returns the value of attribute filter.



17
18
19
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 17

def filter
  @filter
end

#included_properties ⇒ Object (readonly)

Returns the value of attribute included_properties.



17
18
19
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 17

def included_properties
  @included_properties
end

#item_id ⇒ Object (readonly)

Returns the value of attribute item_id.



17
18
19
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 17

def item_id
  @item_id
end

#logic ⇒ Object (readonly)

Returns the value of attribute logic.



17
18
19
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 17

def logic
  @logic
end

#return_ab_group ⇒ Object (readonly)

Returns the value of attribute return_ab_group.



17
18
19
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 17

def return_ab_group
  @return_ab_group
end

#return_properties ⇒ Object (readonly)

Returns the value of attribute return_properties.



17
18
19
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 17

def return_properties
  @return_properties
end

#scenario ⇒ Object (readonly)

Returns the value of attribute scenario.



17
18
19
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 17

def scenario
  @scenario
end

#timeout ⇒ Object

Returns the value of attribute timeout.



18
19
20
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 18

def timeout
  @timeout
end

Instance Method Details

#body_parameters ⇒ Object

Values of body parameters as a Hash



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 136

def body_parameters
  p = Hash.new
  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['diversity'] = @optional['diversity'] if @optional.include? 'diversity'
  p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
  p['returnAbGroup'] = @optional['returnAbGroup'] if @optional.include? 'returnAbGroup'
  p
end

#method ⇒ Object

HTTP method



131
132
133
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 131

def method
  :post
end

#path ⇒ Object

Relative path to the endpoint



160
161
162
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 160

def path
  "/{databaseId}/recomms/items/#{@item_id}/users/"
end

#query_parameters ⇒ Object

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



154
155
156
157
 
# File 'lib/recombee_api_client/api/recommend_users_to_item.rb', line 154

def query_parameters
  params = {}
  params
end