RecommendUsersToItem

java.lang.Object
- com.recombee.api_client.api_requests.Request
- - com.recombee.api_client.api_requests.RecommendUsersToItem

```
public class RecommendUsersToItem
extends Request
```
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).

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`booster` 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.
`protected java.lang.Boolean`	`cascadeCreate` If item of given itemId doesn't exist in the database, it creates the missing item.
`protected java.lang.Long`	`count` Number of items to be recommended (N for the top-N recommendation).
`protected java.lang.Double`	`diversity` Expert option Real number from [0.0, 1.0] which determines how much mutually dissimilar should the recommended items be.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`expertSettings` Dictionary of custom options.
`protected java.lang.String`	`filter` Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended items based on the values of their attributes.
`protected java.lang.String[]`	`includedProperties` Allows to specify, which properties should be returned when `returnProperties=true` is set.
`protected java.lang.String`	`itemId` ID of the item for which the recommendations are to be generated.
`protected Logic`	`logic` Logic specifies particular behavior of the recommendation models.
`protected java.lang.Boolean`	`returnAbGroup` If there is a custom AB-testing running, return name of group to which the request belongs.
`protected java.lang.Boolean`	`returnProperties` With `returnProperties=true`, property values of the recommended users are returned along with their IDs in a JSON dictionary.
`protected java.lang.String`	`scenario` Scenario defines a particular application of recommendations.

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

Constructor Summary

Constructors
Constructor and Description

RecommendUsersToItem(java.lang.String itemId, long count)
Construct the request

Constructors
Constructor and Description
`RecommendUsersToItem(java.lang.String itemId, long count)` Construct the request

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Map<java.lang.String,java.lang.Object>`	`getBodyParameters()` Get body parameters
`java.lang.String`	`getBooster()`
`boolean`	`getCascadeCreate()`
`long`	`getCount()`
`double`	`getDiversity()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getExpertSettings()`
`java.lang.String`	`getFilter()`
`HTTPMethod`	`getHTTPMethod()`
`java.lang.String[]`	`getIncludedProperties()`
`java.lang.String`	`getItemId()`
`Logic`	`getLogic()`
`java.lang.String`	`getPath()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getQueryParameters()` Get query parameters
`boolean`	`getReturnAbGroup()`
`boolean`	`getReturnProperties()`
`java.lang.String`	`getScenario()`
`RecommendUsersToItem`	`setBooster(java.lang.String booster)`
`RecommendUsersToItem`	`setCascadeCreate(boolean cascadeCreate)`
`RecommendUsersToItem`	`setDiversity(double diversity)`
`RecommendUsersToItem`	`setExpertSettings(java.util.Map<java.lang.String,java.lang.Object> expertSettings)`
`RecommendUsersToItem`	`setFilter(java.lang.String filter)`
`RecommendUsersToItem`	`setIncludedProperties(java.lang.String[] includedProperties)`
`RecommendUsersToItem`	`setLogic(Logic logic)`
`RecommendUsersToItem`	`setReturnAbGroup(boolean returnAbGroup)`
`RecommendUsersToItem`	`setReturnProperties(boolean returnProperties)`
`RecommendUsersToItem`	`setScenario(java.lang.String scenario)`

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
  - itemId
```
protected java.lang.String itemId
```
    ID of the item for which the recommendations are to be generated.
  - count
```
protected java.lang.Long count
```
    Number of items to be recommended (N for the top-N recommendation).
  - scenario
```
protected java.lang.String scenario
```
    Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can set various settings to the [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com). 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.
  - cascadeCreate
```
protected java.lang.Boolean cascadeCreate
```
    If item of given *itemId* doesn't exist in the database, it creates the missing item.
  - returnProperties
```
protected java.lang.Boolean returnProperties
```
    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 } ```
  - includedProperties
```
protected java.lang.String[] includedProperties
```
    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 } ```
  - filter
```
protected java.lang.String filter
```
    Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended items based on the values of their attributes. Filters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
  - booster
```
protected java.lang.String booster
```
    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. Boosters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
  - logic
```
protected Logic logic
```
    Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case. See [this section](https://docs.recombee.com/recommendation_logics.html) 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](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
  - diversity
```
protected java.lang.Double 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.
  - expertSettings
```
protected java.util.Map<java.lang.String,java.lang.Object> expertSettings
```
    Dictionary of custom options.
  - returnAbGroup
```
protected java.lang.Boolean returnAbGroup
```
    If there is a custom AB-testing running, return name of group to which the request belongs.
- Constructor Detail
  - RecommendUsersToItem
```
public RecommendUsersToItem(java.lang.String itemId,
                            long count)
```
    Construct the request
    
    Parameters:
    
    itemId - ID of the item for which the recommendations are to be generated.
    
    count - Number of items to be recommended (N for the top-N recommendation).
- Method Detail
  - setScenario
```
public RecommendUsersToItem setScenario(java.lang.String scenario)
```
    Parameters:
    
    scenario - Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can set various settings to the [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com). 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.
  - setCascadeCreate
```
public RecommendUsersToItem setCascadeCreate(boolean cascadeCreate)
```
    Parameters:
    
    cascadeCreate - If item of given *itemId* doesn't exist in the database, it creates the missing item.
  - setReturnProperties
```
public RecommendUsersToItem setReturnProperties(boolean returnProperties)
```
    Parameters:
    
    returnProperties - 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 } ```
  - setIncludedProperties
```
public RecommendUsersToItem setIncludedProperties(java.lang.String[] includedProperties)
```
    Parameters:
    
    includedProperties - 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 } ```
  - setFilter
```
public RecommendUsersToItem setFilter(java.lang.String filter)
```
    Parameters:
    
    filter - Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended items based on the values of their attributes. Filters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
  - setBooster
```
public RecommendUsersToItem setBooster(java.lang.String booster)
```
    Parameters:
    
    booster - 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. Boosters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
  - setLogic
```
public RecommendUsersToItem setLogic(Logic logic)
```
    Parameters:
    
    logic - Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case. See [this section](https://docs.recombee.com/recommendation_logics.html) 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](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
  - setDiversity
```
public RecommendUsersToItem setDiversity(double diversity)
```
    Parameters:
    
    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.
  - setExpertSettings
```
public RecommendUsersToItem setExpertSettings(java.util.Map<java.lang.String,java.lang.Object> expertSettings)
```
    Parameters:
    
    expertSettings - Dictionary of custom options.
  - setReturnAbGroup
```
public RecommendUsersToItem setReturnAbGroup(boolean returnAbGroup)
```
    Parameters:
    
    returnAbGroup - If there is a custom AB-testing running, return name of group to which the request belongs.
  - getItemId
```
public java.lang.String getItemId()
```
  - getCount
```
public long getCount()
```
  - getScenario
```
public java.lang.String getScenario()
```
  - getCascadeCreate
```
public boolean getCascadeCreate()
```
  - getReturnProperties
```
public boolean getReturnProperties()
```
  - getIncludedProperties
```
public java.lang.String[] getIncludedProperties()
```
  - getFilter
```
public java.lang.String getFilter()
```
  - getBooster
```
public java.lang.String getBooster()
```
  - getLogic
```
public Logic getLogic()
```
  - getDiversity
```
public double getDiversity()
```
  - getExpertSettings
```
public java.util.Map<java.lang.String,java.lang.Object> getExpertSettings()
```
  - getReturnAbGroup
```
public boolean getReturnAbGroup()
```
  - 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)

Class RecommendUsersToItem

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

itemId

count

scenario

cascadeCreate

returnProperties

includedProperties

filter

booster

logic

diversity

expertSettings

returnAbGroup

Constructor Detail

RecommendUsersToItem

Method Detail

setScenario

setCascadeCreate

setReturnProperties

setIncludedProperties

setFilter

setBooster

setLogic

setDiversity

setExpertSettings

setReturnAbGroup

getItemId

getCount

getScenario

getCascadeCreate

getReturnProperties

getIncludedProperties

getFilter

getBooster

getLogic

getDiversity

getExpertSettings

getReturnAbGroup

getHTTPMethod

getPath

getQueryParameters

getBodyParameters