Recombee API client

RecommendItemsToItem extends Request

Recommends set of items that are somehow related to one given item, *X*. Typical scenario is when user *A* is viewing *X*. Then you may display items to the user that he might be also interested in. Recommend items to item request gives you Top-N such items, optionally taking the target user *A* into account.

The returned items are sorted by relevance (first item being the most relevant). Besides the recommended items, also a unique recommId is returned in the response. It can be used to:

  • Let Recombee know that this recommendation was successful (e.g. user clicked one of the recommended items). See Reported metrics.
  • Get subsequent recommended items when the user scrolls down (infinite scroll) or goes to the next page. See Recommend Next Items. It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.

Table of Contents

$booster  : string
$cascade_create  : bool
$count  : int
$diversity  : float
$ensure_https  : bool
$expert_settings  : array<string|int, mixed>
$filter  : string
$included_properties  : array<string|int, mixed>
$item_id  : string
$logic  : string|array<string|int, mixed>
$min_relevance  : string
$optional  : array<string|int, mixed>
$return_ab_group  : bool
$return_properties  : bool
$rotation_rate  : float
$rotation_time  : float
$scenario  : string
$target_user_id  : string
$timeout  : int
$user_impact  : float
__construct()  : mixed
Construct the request
getBodyParameters()  : array<string|int, mixed>
Get body parameters
getEnsureHttps()  : bool
Returns true if HTTPS must be chosen over HTTP for this request
getMethod()  : static
Get used HTTP method
getPath()  : string
Get URI to the endpoint
getQueryParameters()  : array<string|int, mixed>
Get query parameters
getTimeout()  : int
Get request timeout
setEnsureHttps()  : mixed
Sets if HTTPS must be chosen over HTTP for this request
setTimeout()  : mixed
Sets request timeout

Properties

$ensure_https

protected bool $ensure_https

Methods

__construct()

Construct the request

public __construct(string $item_id, string $target_user_id, int $count[, array<string|int, mixed> $optional = array() ]) : mixed
Parameters
$item_id : string

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

$target_user_id : string

ID of the user who will see the recommendations. Specifying the targetUserId is beneficial because:

  • It makes the recommendations personalized
  • Allows the calculation of Actions and Conversions in the graphical user interface, as Recombee can pair the user who got recommendations and who afterwards viewed/purchased an item. If you insist on not specifying the user, pass null (None, nil, NULL etc. depending on language) to targetUserId. Do not create some special dummy user for getting recommendations, as it could mislead the recommendation models, and result in wrong recommendations. For anonymous/unregistered users it is possible to use for example their session ID.
$count : int

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

$optional : array<string|int, mixed> = array()

Optional parameters given as an array containing pairs name of the parameter => value

  • Allowed parameters:
    • scenario
      • Type: string
      • Description: 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.
    • cascadeCreate
      • Type: bool
      • Description: If item of given itemId or user of given targetUserId doesn't exist in the database, it creates the missing entity/entities and returns some (non-personalized) recommendations. This allows for example rotations in the following recommendations for the user of given targetUserId, as the user will be already known to the system.
    • returnProperties
      • Type: bool
      • Description: With returnProperties=true, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used for easy displaying of the recommended items to the user. Example response:
  {
    "recommId": "0c6189e7-dc1a-429a-b613-192696309361",
    "recomms":
      [
        {
          "id": "tv-178",
          "values": {
            "description": "4K TV with 3D feature",
            "categories":   ["Electronics", "Televisions"],
            "price": 342,
            "url": "myshop.com/tv-178"
          }
        },
        {
          "id": "mixer-42",
          "values": {
            "description": "Stainless Steel Mixer",
            "categories":   ["Home & Kitchen"],
            "price": 39,
            "url": "myshop.com/mixer-42"
          }
        }
      ],
    "numberNextRecommsCalls": 0
  }

- *includedProperties*
    - Type: array
    - 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=description,price:

  {
    "recommId": "6842c725-a79f-4537-a02c-f34d668a3f80",
    "recomms":
      [
        {
          "id": "tv-178",
          "values": {
            "description": "4K TV with 3D feature",
            "price": 342
          }
        },
        {
          "id": "mixer-42",
          "values": {
            "description": "Stainless Steel Mixer",
            "price": 39
          }
        }
      ],
    "numberNextRecommsCalls": 0
  }

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

Filters can be also assigned to a scenario in the Admin UI. - booster - Type: string - Description: 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. - logic - Type: string|array - Description: 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. - userImpact - Type: float - Description: Expert option If targetUserId parameter is present, the recommendations are biased towards the given user. Using userImpact, you may control this bias. For an extreme case of userImpact=0.0, the interactions made by the user are not taken into account at all (with the exception of history-based blacklisting), for userImpact=1.0, you'll get user-based recommendation. The default value is 0. - diversity - Type: float - 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. - minRelevance - Type: string - Description: Expert option If the targetUserId is provided: Specifies the threshold of how much relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of items equal to count at any cost. If there are not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full count. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested relevance, and may return less than count items when there is not enough data to fulfill it. - rotationRate - Type: float - Description: Expert option If the targetUserId is provided: If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, rotationRate=1 means maximal rotation, rotationRate=0 means absolutely no rotation. You may also use, for example rotationRate=0.2 for only slight rotation of recommended items. - rotationTime - Type: float - Description: Expert option If the targetUserId is provided: Taking rotationRate into account, specifies how long time it takes to an item to recover from the penalization. For example, rotationTime=7200.0 means that items recommended less than 2 hours ago are penalized. - expertSettings - Type: array - Description: Dictionary of custom options. - returnAbGroup - Type: bool - Description: If there is a custom AB-testing running, return name of group to which the request belongs.

Tags
throws
UnknownOptionalParameterException

UnknownOptionalParameterException if an unknown optional parameter is given in $optional

Return values
mixed —

getBodyParameters()

Get body parameters

public getBodyParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Values of body parameters (name of parameter => value of the parameter)

getEnsureHttps()

Returns true if HTTPS must be chosen over HTTP for this request

public getEnsureHttps() : bool
Return values
bool —

true if HTTPS must be chosen

getMethod()

Get used HTTP method

public getMethod() : static
Return values
static —

Used HTTP method

getPath()

Get URI to the endpoint

public getPath() : string
Return values
string —

URI to the endpoint

getQueryParameters()

Get query parameters

public getQueryParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Values of query parameters (name of parameter => value of the parameter)

getTimeout()

Get request timeout

public getTimeout() : int
Return values
int —

Request timeout in milliseconds

setEnsureHttps()

Sets if HTTPS must be chosen over HTTP for this request

public setEnsureHttps(mixed $ensure_https) : mixed
Parameters
$ensure_https : mixed
Return values
mixed —

setTimeout()

Sets request timeout

public setTimeout(mixed $timeout) : mixed
Parameters
$timeout : mixed
Return values
mixed —

Search results