Class: RecombeeApiClient::CompositeRecommendationStageParameters

Inherits:
Input
  • Object
show all
Defined in:
lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb

Overview

Initializes CompositeRecommendationStageParameters input#

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashNormalizer

#camelize, #normalize_hash_to_camel_case

Constructor Details

#initialize(optional = {}) ⇒ CompositeRecommendationStageParameters

  • *Optional arguments (given as hash optional)*

    • 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 to easily display the recommended items to the user.

Example response with ‘returnProperties` set in the `resultSettings`: “`json

{
  "recommId": "ee94fa8b-efe7-4b35-abc6-2bc3456d66ed",
  "source": {
    "id": "category-sport"
  },
  "recomms": [
    {
      "id": "article-1024",
      "values": {
        "title": "Champions League: Stunning Comeback Secures Final Spot",
        "categories": ["Sport", "Football"],
        "author": "Jane Smith",
        "url": "newsportal.com/articles/champions-league-comeback"
      }
    },
    {
      "id": "article-2031",
      "values": {
        "title": "Top 10 Moments from the Summer Olympics",
        "categories": ["Sport", "Olympics"],
        "author": "Mark Johnson",
        "url": "newsportal.com/articles/olympic-top-moments"
      }
    },
    {
      "id": "article-3042",
      "values": {
        "title": "Rising Stars in Women's Tennis to Watch This Season",
        "categories": ["Sport", "Tennis"],
        "author": "Laura Chen",
        "url": "newsportal.com/articles/womens-tennis-stars"
      }
    }
  ],
  "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 ‘returnProperties=true` and `includedProperties=title,url` set in `resultSettings`: “`json

{
  "recommId": "ee94fa8b-efe7-4b35-abc6-2bc3456d66ed",
  "source": {
    "id": "category-sport"
  },
  "recomms": [
    {
      "id": "article-1024",
      "values": {
        "title": "Champions League: Stunning Comeback Secures Final Spot",
        "url": "newsportal.com/articles/champions-league-comeback"
      }
    },
    {
      "id": "article-2031",
      "values": {
        "title": "Top 10 Moments from the Summer Olympics",
        "url": "newsportal.com/articles/olympic-top-moments"
      }
    },
    {
      "id": "article-3042",
      "values": {
        "title": "Rising Stars in Women's Tennis to Watch This Season",
        "url": "newsportal.com/articles/womens-tennis-stars"
      }
    }
  ],
  "numberNextRecommsCalls": 0
}

“‘

- +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended entities 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 entities 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).

- +reqlExpressions+ -> Only usable if the stage corresponds to the one of these recommendation endpoints:

A dictionary of [ReQL](docs.recombee.com/reql) expressions that will be executed for each recommended item. This can be used to compute additional properties of the recommended items that are not stored in the database.

The keys are the names of the expressions, and the values are the actual ReQL expressions.

Example request: “‘json {

"reqlExpressions": {
  "isInUsersCity": "context_user[\"city\"] in 'cities'",
  "distanceToUser": "earth_distance('location', context_user[\"location\"])"
}

} “‘

Example response: “‘json {

"recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
"source": {
  "id": "restaurant-123",
  "reqlEvaluations": {
    "isInUsersCity": true,
    "distanceToUser": 3450.5
  }
},
"recomms":
  [
    {
      "id": "restaurant-178",
      "reqlEvaluations": {
        "isInUsersCity": true,
        "distanceToUser": 5200.2
      }
    },
    {
      "id": "bar-42",
      "reqlEvaluations": {
        "isInUsersCity": false,
        "distanceToUser": 2516.0
      }
    }
  ],
 "numberNextRecommsCalls": 0

} “‘

- +minRelevance+ -> **Expert option:** Only usable if the stage corresponds to the one of these recommendation endpoints:

If the userId is provided: Specifies the threshold of how 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 a number of items equal to count at any cost. If there is not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations being 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:** Only usable if the stage corresponds to the one of these recommendation endpoints:

If the userId 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 a 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:** Only usable if the stage corresponds to the one of these recommendation endpoints:

If the userId is provided: Taking rotationRate into account, specifies how long it takes for an item to recover from the penalization. For example, ‘rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized.



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb', line 202

def initialize(optional = {})
  optional = normalize_hash_to_camel_case(optional)
  @return_properties = optional['returnProperties']
  @included_properties = optional['includedProperties']
  @filter = optional['filter']
  @booster = optional['booster']
  @logic = optional['logic']
  @reql_expressions = optional['reqlExpressions']
  @min_relevance = optional['minRelevance']
  @rotation_rate = optional['rotationRate']
  @rotation_time = optional['rotationTime']
  @optional = optional
  @optional.each do |par, _|
    raise UnknownOptionalParameter.new(par) unless %w[returnProperties includedProperties filter booster
                                                      logic reqlExpressions minRelevance rotationRate rotationTime].include? par
  end
end

Instance Attribute Details

#booster ⇒ Object (readonly)

Returns the value of attribute booster.



14
15
16
 
# File 'lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb', line 14

def booster
  @booster
end

#filter ⇒ Object (readonly)

Returns the value of attribute filter.



14
15
16
 
# File 'lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb', line 14

def filter
  @filter
end

#included_properties ⇒ Object (readonly)

Returns the value of attribute included_properties.



14
15
16
 
# File 'lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb', line 14

def included_properties
  @included_properties
end

#logic ⇒ Object (readonly)

Returns the value of attribute logic.



14
15
16
 
# File 'lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb', line 14

def logic
  @logic
end

#min_relevance ⇒ Object (readonly)

Returns the value of attribute min_relevance.



14
15
16
 
# File 'lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb', line 14

def min_relevance
  @min_relevance
end

#reql_expressions ⇒ Object (readonly)

Returns the value of attribute reql_expressions.



14
15
16
 
# File 'lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb', line 14

def reql_expressions
  @reql_expressions
end

#return_properties ⇒ Object (readonly)

Returns the value of attribute return_properties.



14
15
16
 
# File 'lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb', line 14

def return_properties
  @return_properties
end

#rotation_rate ⇒ Object (readonly)

Returns the value of attribute rotation_rate.



14
15
16
 
# File 'lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb', line 14

def rotation_rate
  @rotation_rate
end

#rotation_time ⇒ Object (readonly)

Returns the value of attribute rotation_time.



14
15
16
 
# File 'lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb', line 14

def rotation_time
  @rotation_time
end

Instance Method Details

#as_json(_options = {}) ⇒ Object

Return only JSON-serializable primitives.



221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb', line 221

def as_json(_options = {})
  res = {}
  res['returnProperties'] = @optional['returnProperties'] if @optional['returnProperties']
  res['includedProperties'] = @optional['includedProperties'] if @optional['includedProperties']
  res['filter'] = @optional['filter'] if @optional['filter']
  res['booster'] = @optional['booster'] if @optional['booster']
  res['logic'] = @optional['logic'] if @optional['logic']
  res['reqlExpressions'] = @optional['reqlExpressions'] if @optional['reqlExpressions']
  res['minRelevance'] = @optional['minRelevance'] if @optional['minRelevance']
  res['rotationRate'] = @optional['rotationRate'] if @optional['rotationRate']
  res['rotationTime'] = @optional['rotationTime'] if @optional['rotationTime']

  res
end

#to_json(*args) ⇒ Object 



236
237
238
 
# File 'lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb', line 236

def to_json(*args)
  as_json.to_json(*args)
end