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

Recommend users to item More...

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

Public Member Functions

 RecommendUsersToItem (string itemId, long count, string filter=null, string booster=null, bool?cascadeCreate=null, string scenario=null, bool?returnProperties=null, string[] includedProperties=null, double?diversity=null, Dictionary< string, object > expertSettings=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 ItemId [get]
 ID of the item for which the recommendations are to be generated. More...
 
long Count [get]
 Number of items to be recommended (N for the top-N recommendation). More...
 
string Filter [get]
 Boolean-returning ReQL expression which allows you to filter recommended items based on the values of their attributes. More...
 
string Booster [get]
 Number-returning ReQL expression which allows you to boost recommendation rate of some items based on the values of their attributes. More...
 
bool CascadeCreate [get]
 If item of given itemId doesn't exist in the database, it creates the missing item. More...
 
string Scenario [get]
 Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios. More...
 
bool ReturnProperties [get]
 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 for easy displaying the recommended users. Example response:

{
"recommId": "039b71dc-b9cc-4645-a84f-62b841eecfce",
"recomms":
[
{
"id": "user-17",
"values": {
"country": "US",
"sex": "F"
}
},
{
"id": "user-2",
"values": {
"country": "CAN",
"sex": "M"
}
}
]
}
More...
 
string[] IncludedProperties [get]
 Allows to specify, which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list. Example response for includedProperties=country:

{
"recommId": "b2b355dd-972a-4728-9c6b-2dc229db0678",
"recomms":
[
{
"id": "user-17",
"values": {
"country": "US"
}
},
{
"id": "user-2",
"values": {
"country": "CAN"
}
}
]
}
More...
 
double Diversity [get]
 **Expert option** Real number from [0.0, 1.0] which determines how much mutually dissimilar should the recommended items be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification. More...
 
Dictionary< string, object > ExpertSettings [get]
 Dictionary of custom options. 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

Recommend users to item

Recommend users that are likely to be interested in a given item. It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.

Constructor & Destructor Documentation

Recombee.ApiClient.ApiRequests.RecommendUsersToItem.RecommendUsersToItem ( string  itemId,
long  count,
string  filter = null,
string  booster = null,
bool?  cascadeCreate = null,
string  scenario = null,
bool?  returnProperties = null,
string[]  includedProperties = null,
double?  diversity = null,
Dictionary< string, object >  expertSettings = null 
)
inline

Construct the request

Parameters
itemIdID of the item for which the recommendations are to be generated.
countNumber of items to be recommended (N for the top-N recommendation).
filterBoolean-returning ReQL expression which allows you to filter recommended items based on the values of their attributes.
boosterNumber-returning ReQL expression which allows you to boost recommendation rate of some items based on the values of their attributes.
cascadeCreateIf item of given itemId doesn't exist in the database, it creates the missing item.
scenarioScenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
returnPropertiesWith 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 for easy displaying the recommended users. Example response:
{
"recommId": "039b71dc-b9cc-4645-a84f-62b841eecfce",
"recomms":
[
{
"id": "user-17",
"values": {
"country": "US",
"sex": "F"
}
},
{
"id": "user-2",
"values": {
"country": "CAN",
"sex": "M"
}
}
]
}
includedPropertiesAllows to specify, which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list. Example response for includedProperties=country:
{
"recommId": "b2b355dd-972a-4728-9c6b-2dc229db0678",
"recomms":
[
{
"id": "user-17",
"values": {
"country": "US"
}
},
{
"id": "user-2",
"values": {
"country": "CAN"
}
}
]
}
diversity**Expert option** Real number from [0.0, 1.0] which determines how much mutually dissimilar should the recommended items be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
expertSettingsDictionary of custom options.

Member Function Documentation

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.RecommendUsersToItem.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.RecommendUsersToItem.Path ( )
inlinevirtual

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.RecommendUsersToItem.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

string Recombee.ApiClient.ApiRequests.RecommendUsersToItem.Booster
get

Number-returning ReQL expression which allows you to boost recommendation rate of some items based on the values of their attributes.

bool Recombee.ApiClient.ApiRequests.RecommendUsersToItem.CascadeCreate
get

If item of given itemId doesn't exist in the database, it creates the missing item.

long Recombee.ApiClient.ApiRequests.RecommendUsersToItem.Count
get

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

double Recombee.ApiClient.ApiRequests.RecommendUsersToItem.Diversity
get

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

Dictionary<string, object> Recombee.ApiClient.ApiRequests.RecommendUsersToItem.ExpertSettings
get

Dictionary of custom options.

string Recombee.ApiClient.ApiRequests.RecommendUsersToItem.Filter
get

Boolean-returning ReQL expression which allows you to filter recommended items based on the values of their attributes.

string [] Recombee.ApiClient.ApiRequests.RecommendUsersToItem.IncludedProperties
get

Allows to specify, which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list. Example response for includedProperties=country:

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

string Recombee.ApiClient.ApiRequests.RecommendUsersToItem.ItemId
get

ID of the item for which the recommendations are to be generated.

bool Recombee.ApiClient.ApiRequests.RecommendUsersToItem.ReturnProperties
get

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 for easy displaying the recommended users. Example response:

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

string Recombee.ApiClient.ApiRequests.RecommendUsersToItem.Scenario
get

Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.


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