Class: RecommendUsersToItem

RecommendUsersToItem(itemId, count, optional)

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

new RecommendUsersToItem(itemId, count, optional)

Construct the request
Parameters:
Name Type Description
itemId string ID of the item for which the recommendations are to be generated.
count number Number of items to be recommended (N for the top-N recommendation).
optional Object Optional parameters given as an object with structure name of the parameter: value - Allowed parameters: - *filter* - Type: string - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended items based on the values of their attributes. - *booster* - Type: string - Description: Number-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to boost recommendation rate of some items based on the values of their attributes. - *cascadeCreate* - Type: boolean - Description: If item of given *itemId* doesn't exist in the database, it creates the missing item. - *scenario* - Type: string - Description: 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. - *returnProperties* - Type: boolean - Description: 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" } } ] } ``` - *includedProperties* - Type: string[] - Description: 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" } } ] } ``` - *diversity* - Type: number - Description: **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* - Type: - Description: Dictionary of custom options.
Source:

Methods

bodyParameters() → {Object}

Get body parameters
Source:
Returns:
The values of body parameters (name of parameter: value of the parameter)
Type
Object

queryParameters() → {Object}

Get query parameters
Source:
Returns:
The values of query parameters (name of parameter: value of the parameter)
Type
Object