class RecombeeApiClient::AddRating

Adds a rating of given item made by a given user.

Attributes

cascade_create[R]
ensure_https[RW]
item_id[R]
rating[R]
recomm_id[R]
timeout[RW]
timestamp[R]
user_id[R]

Public Class Methods

new(user_id, item_id, rating, optional = {}) click to toggle source
  • *Required arguments*

    • user_id -> User who submitted the rating

    • item_id -> Rated item

    • rating -> Rating rescaled to interval [-1.0,1.0], where -1.0 means the worst rating possible, 0.0 means neutral, and 1.0 means absolutely positive rating. For example, in the case of 5-star evaluations, rating = (numStars-3)/2 formula may be used for the conversion.

  • *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.

# File lib/recombee_api_client/api/add_rating.rb, line 28
def initialize(user_id, item_id, rating, optional = {})
  @user_id = user_id
  @item_id = item_id
  @rating = rating
  optional = normalize_optional(optional)
  @timestamp = optional['timestamp']
  @cascade_create = optional['cascadeCreate']
  @recomm_id = optional['recommId']
  @optional = optional
  @timeout = 1000
  @ensure_https = false
  @optional.each do |par, _|
    fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","recommId"].include? par
  end
end

Public Instance Methods

body_parameters() click to toggle source

Values of body parameters as a Hash

# File lib/recombee_api_client/api/add_rating.rb, line 50
def body_parameters
  p = Hash.new
  p['userId'] = @user_id
  p['itemId'] = @item_id
  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
end
method() click to toggle source

HTTP method

# File lib/recombee_api_client/api/add_rating.rb, line 45
def method
  :post
end
path() click to toggle source

Relative path to the endpoint

# File lib/recombee_api_client/api/add_rating.rb, line 69
def path
  "/{databaseId}/ratings/"
end
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/add_rating.rb, line 63
def query_parameters
  params = {}
  params
end