Recombee API Client
Public Member Functions | Properties | List of all members
Recombee.ApiClient.ApiRequests.AddRating Class Reference

Add rating More...

Inheritance diagram for Recombee.ApiClient.ApiRequests.AddRating:
Inheritance graph
[legend]
Collaboration diagram for Recombee.ApiClient.ApiRequests.AddRating:
Collaboration graph
[legend]

Public Member Functions

 AddRating (string userId, string itemId, double rating, DateTime?timestamp=null, bool?cascadeCreate=null, string recommId=null)
 Construct the request More...
 
override string Path ()
 
Returns
URI to the endpoint including path parameters
More...
 
override Dictionary< string, object > QueryParameters ()
 Get query parameters More...
 
override Dictionary< string, object > BodyParameters ()
 Get body parameters More...
 
- Public Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
 Request (HttpMethod httpMethod, int timeoutMilliseconds, bool ensureHttps=false)
 Construct the request More...
 

Properties

string UserId [get]
 User who submitted the rating More...
 
string ItemId [get]
 Rated item More...
 
DateTime Timestamp [get]
 UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time. More...
 
double Rating [get]
 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. More...
 
bool CascadeCreate [get]
 Sets whether the given user/item should be created if not present in the database. More...
 
string RecommId [get]
 If this rating is based on a recommendation request, recommId is the id of the clicked recommendation. More...
 
- Properties inherited from Recombee.ApiClient.ApiRequests.Request
TimeSpan Timeout [get, set]
 Timeout for the request in milliseconds More...
 
bool EnsureHttps [get]
 If true, HTTPS must be chosen over HTTP for this request More...
 
HttpMethod RequestHttpMehod [get]
 Used HTTP method More...
 

Additional Inherited Members

- Protected Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
double ConvertToUnixTimestamp (DateTime date)
 
Returns
Converts DateTime to UNIX timestamp (epoch)
More...
 

Detailed Description

Add rating

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

Constructor & Destructor Documentation

Recombee.ApiClient.ApiRequests.AddRating.AddRating ( string  userId,
string  itemId,
double  rating,
DateTime?  timestamp = null,
bool?  cascadeCreate = null,
string  recommId = null 
)
inline

Construct the request

Parameters
userIdUser who submitted the rating
itemIdRated item
timestampUTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
ratingRating 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.
cascadeCreateSets whether the given user/item should be created if not present in the database.
recommIdIf this rating is based on a recommendation request, recommId is the id of the clicked recommendation.

Member Function Documentation

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.AddRating.BodyParameters ( )
inlinevirtual

Get body parameters

Returns
Dictionary containing values of body parameters (name of parameter: value of the parameter)

Implements Recombee.ApiClient.ApiRequests.Request.

override string Recombee.ApiClient.ApiRequests.AddRating.Path ( )
inlinevirtual

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.AddRating.QueryParameters ( )
inlinevirtual

Get query parameters

Returns
Dictionary containing values of query parameters (name of parameter: value of the parameter)

Implements Recombee.ApiClient.ApiRequests.Request.

Property Documentation

bool Recombee.ApiClient.ApiRequests.AddRating.CascadeCreate
get

Sets whether the given user/item should be created if not present in the database.

string Recombee.ApiClient.ApiRequests.AddRating.ItemId
get

Rated item

double Recombee.ApiClient.ApiRequests.AddRating.Rating
get

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.

string Recombee.ApiClient.ApiRequests.AddRating.RecommId
get

If this rating is based on a recommendation request, recommId is the id of the clicked recommendation.

DateTime Recombee.ApiClient.ApiRequests.AddRating.Timestamp
get

UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

string Recombee.ApiClient.ApiRequests.AddRating.UserId
get

User who submitted the rating


The documentation for this class was generated from the following file: