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 scenario=null, bool? cascadeCreate=null, bool? returnProperties=null, string[] includedProperties=null, string filter=null, string booster=null, Logic logic=null, double? diversity=null, Dictionary< string, object > expertSettings=null, bool? returnAbGroup=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 Scenario [get]
 Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can set various settings to the scenario in the Admin UI. You can also see performance of each scenario in the Admin 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? CascadeCreate [get]
 If item of given itemId doesn't exist in the database, it creates the missing item. 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: 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: More...
 
string Filter [get]
 Boolean-returning ReQL expression which allows you to filter recommended items based on the values of their attributes. Filters can be also assigned to a scenario in the Admin UI. 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. Boosters can be also assigned to a scenario in the Admin UI. More...
 
Logic Logic [get]
 Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case. See this section for 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 be also set to a scenario in the Admin UI. 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...
 
bool? ReturnAbGroup [get]
 If there is a custom AB-testing running, return name of group to which the request belongs. 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. The returned users are sorted by predicted interest in the item (first user being the most interested).

Constructor & Destructor Documentation

◆ RecommendUsersToItem()

Recombee.ApiClient.ApiRequests.RecommendUsersToItem.RecommendUsersToItem ( string  itemId,
long  count,
string  scenario = null,
bool?  cascadeCreate = null,
bool?  returnProperties = null,
string[]  includedProperties = null,
string  filter = null,
string  booster = null,
Logic  logic = null,
double?  diversity = null,
Dictionary< string, object >  expertSettings = null,
bool?  returnAbGroup = 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).
scenarioScenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can set various settings to the scenario in the Admin UI. You can also see performance of each scenario in the Admin 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.
cascadeCreateIf item of given itemId doesn't exist in the database, it creates the missing item.
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"
}
}
],
"numberNextRecommsCalls": 0
}
Parameters
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"
}
}
],
"numberNextRecommsCalls": 0
}
Parameters
filterBoolean-returning ReQL expression which allows you to filter recommended items based on the values of their attributes. Filters can be also assigned to a scenario in the Admin UI.
boosterNumber-returning ReQL expression which allows you to boost recommendation rate of some items based on the values of their attributes. Boosters can be also assigned to a scenario in the Admin UI.
logicLogic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case. See this section for 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 be also set to a scenario in the Admin UI.
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.
returnAbGroupIf there is a custom AB-testing running, return name of group to which the request belongs.

Member Function Documentation

◆ BodyParameters()

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.

◆ Path()

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

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

◆ Booster

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. Boosters can be also assigned to a scenario in the Admin UI.

◆ CascadeCreate

bool? Recombee.ApiClient.ApiRequests.RecommendUsersToItem.CascadeCreate
get

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

◆ Count

long Recombee.ApiClient.ApiRequests.RecommendUsersToItem.Count
get

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

◆ Diversity

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.

◆ ExpertSettings

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

Dictionary of custom options.

◆ Filter

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. Filters can be also assigned to a scenario in the Admin UI.

◆ IncludedProperties

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"
}
}
],
"numberNextRecommsCalls": 0
}

◆ ItemId

string Recombee.ApiClient.ApiRequests.RecommendUsersToItem.ItemId
get

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

◆ Logic

Logic Recombee.ApiClient.ApiRequests.RecommendUsersToItem.Logic
get

Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case. See this section for 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 be also set to a scenario in the Admin UI.

◆ ReturnAbGroup

bool? Recombee.ApiClient.ApiRequests.RecommendUsersToItem.ReturnAbGroup
get

If there is a custom AB-testing running, return name of group to which the request belongs.

◆ ReturnProperties

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"
}
}
],
"numberNextRecommsCalls": 0
}

◆ Scenario

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 set various settings to the scenario in the Admin UI. You can also see performance of each scenario in the Admin 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: