com.recombee.api_client.api_requests

Class AddRating

java.lang.Object

com.recombee.api_client.api_requests.Request

com.recombee.api_client.api_requests.AddRating

public class AddRating
extends Request

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	additionalData A dictionary of additional data for the interaction.
protected java.lang.Boolean	cascadeCreate Sets whether the given user/item should be created if not present in the database.
protected java.lang.String	itemId Rated item
protected java.lang.Double	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.
protected java.lang.String	recommId If this rating is based on a recommendation request, `recommId` is the id of the clicked recommendation.
protected java.util.Date	timestamp UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time.
protected java.lang.String	userId User who submitted the rating

Fields inherited from class com.recombee.api_client.api_requests.Request

timeout

Constructor Summary

Constructors

Constructor and Description
AddRating(java.lang.String userId, java.lang.String itemId, double rating) Construct the request

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalData()
java.util.Map<java.lang.String,java.lang.Object>	getBodyParameters() Get body parameters
boolean	getCascadeCreate()
HTTPMethod	getHTTPMethod()
java.lang.String	getItemId()
java.lang.String	getPath()
java.util.Map<java.lang.String,java.lang.Object>	getQueryParameters() Get query parameters
double	getRating()
java.lang.String	getRecommId()
java.util.Date	getTimestamp()
java.lang.String	getUserId()
AddRating	setAdditionalData(java.util.Map<java.lang.String,java.lang.Object> additionalData)
AddRating	setCascadeCreate(boolean cascadeCreate)
AddRating	setRecommId(java.lang.String recommId)
AddRating	setTimestamp(java.util.Date timestamp)

Methods inherited from class com.recombee.api_client.api_requests.Request

getEnsureHttps, getTimeout, setTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

userId

protected java.lang.String userId

User who submitted the rating

itemId

protected java.lang.String itemId

Rated item

timestamp

protected java.util.Date timestamp

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

rating

protected java.lang.Double 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.

cascadeCreate

protected java.lang.Boolean cascadeCreate

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

recommId

protected java.lang.String recommId

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

additionalData

protected java.util.Map<java.lang.String,java.lang.Object> additionalData

A dictionary of additional data for the interaction.

Constructor Detail

AddRating

public AddRating(java.lang.String userId,
                 java.lang.String itemId,
                 double rating)

Construct the request

Parameters:

userId - User who submitted the rating

itemId - 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.

Method Detail

setTimestamp

public AddRating setTimestamp(java.util.Date timestamp)

Parameters:

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

setCascadeCreate

public AddRating setCascadeCreate(boolean cascadeCreate)

Parameters:

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

setRecommId

public AddRating setRecommId(java.lang.String recommId)

Parameters:

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

setAdditionalData

public AddRating setAdditionalData(java.util.Map<java.lang.String,java.lang.Object> additionalData)

Parameters:

additionalData - A dictionary of additional data for the interaction.

getUserId

public java.lang.String getUserId()

getItemId

public java.lang.String getItemId()

getTimestamp

public java.util.Date getTimestamp()

getRating

public double getRating()

getCascadeCreate

public boolean getCascadeCreate()

getRecommId

public java.lang.String getRecommId()

getAdditionalData

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalData()

getHTTPMethod

public HTTPMethod getHTTPMethod()

Specified by:

getHTTPMethod in class Request

Returns:

Used HTTP method

getPath

public java.lang.String getPath()

Specified by:

getPath in class Request

Returns:

URI to the endpoint including path parameters

getQueryParameters

public java.util.Map<java.lang.String,java.lang.Object> getQueryParameters()

Get query parameters

Specified by:

getQueryParameters in class Request

Returns:

Values of query parameters (name of parameter: value of the parameter)

getBodyParameters

public java.util.Map<java.lang.String,java.lang.Object> getBodyParameters()

Get body parameters

Specified by:

getBodyParameters in class Request

Returns:

Values of body parameters (name of parameter: value of the parameter)