recombee-api-client 5.1.1 → 6.1.0

package/lib/requests/add-detail-view.js

@@ -31,6 +31,9 @@ class AddDetailView extends rqs.Request {
    *     - *additionalData*
    *         - Type: object
    *         - Description: A dictionary of additional data for the interaction.
+   *     - *autoPresented*
+   *         - Type: boolean
+   *         - Description: Indicates whether the item was automatically presented to the user (e.g., in a swiping feed) or explicitly requested by the user (e.g., by clicking on a link). Defaults to `false`.
    */
   constructor(userId, itemId, optional) {
     super('POST', '/detailviews/', 3000, false);
@@ -42,6 +45,7 @@ class AddDetailView extends rqs.Request {
     this.cascadeCreate = optional.cascadeCreate;
     this.recommId = optional.recommId;
     this.additionalData = optional.additionalData;
+    this.autoPresented = optional.autoPresented;
   }
 
   /**
@@ -68,6 +72,9 @@ class AddDetailView extends rqs.Request {
     if(this.additionalData !== undefined)
       params.additionalData = this.additionalData;
 
+    if(this.autoPresented !== undefined)
+      params.autoPresented = this.autoPresented;
+
     return params;
   }
 

package/lib/requests/composite-recommendation.js

@@ -0,0 +1,127 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations.html)) and a list of related recommendations in a single response.
+ * It is ideal for use cases such as personalized homepage sections (*Articles from <category>*), *Because You Watched <movie>*, or *Artists Related to Your Favorite Artist <artist>*.
+ * See detailed **examples and configuration guidance** in the [Composite Scenarios documentation](https://docs.recombee.com/scenarios#composite-recommendations).
+ * **Structure**
+ * The endpoint operates in two stages:
+ * 1. Recommends the *source* (e.g., an Item Segment or item) to the user.
+ * 2. Recommends *results* (items or Item Segments) related to that *source*.
+ * For example, *Articles from <category>* can be decomposed into:
+ *   - [Recommend Item Segments To User](https://docs.recombee.com/api#recommend-item-segments-to-user) to find the category.
+ *   - [Recommend Items To Item Segment](https://docs.recombee.com/api#recommend-items-to-item-segment) to recommend articles from that category.
+ * Since the first step uses [Recommend Item Segments To User](https://docs.recombee.com/api#recommend-items-to-user), you must include the `userId` parameter in the *Composite Recommendation* request.
+ * Each *Composite Recommendation* counts as a single recommendation API request for billing.
+ * **Stage-specific Parameters**
+ * Additional parameters can be supplied via [sourceSettings](https://docs.recombee.com/api#composite-recommendation-param-sourceSettings) and [resultSettings](https://docs.recombee.com/api#composite-recommendation-param-resultSettings).
+ * In the example above:
+ *   - `sourceSettings` may include any parameter valid for [Recommend Item Segments To User](https://docs.recombee.com/api#recommend-items-to-user) (e.g., `filter`, `booster`).
+ *   - `resultSettings` may include any parameter valid for [Recommend Items To Item Segment](https://docs.recombee.com/api#recommend-items-to-item-segment).
+ * See [this example](https://docs.recombee.com/api#composite-recommendation-example-setting-parameters-for-individual-stages) for more details.
+ */
+class CompositeRecommendation extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {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) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
+   * The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
+   * @param {number} count - Number of items to be recommended (N for the top-N recommendation).
+   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
+   * - Allowed parameters:
+   *     - *itemId*
+   *         - Type: string
+   *         - Description: ID of the item for which the recommendations are to be generated.
+   *     - *userId*
+   *         - Type: string
+   *         - Description: ID of the user for which the recommendations are to be generated.
+   *     - *logic*
+   *         - Type: string | object
+   *         - Description: Logic specifies the 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) for a 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 also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
+   *     - *segmentId*
+   *         - Type: string
+   *         - Description: ID of the segment from `contextSegmentationId` for which the recommendations are to be generated.
+   *     - *cascadeCreate*
+   *         - Type: boolean
+   *         - Description: If the entity for the source recommendation does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that entity, as the entity will be already known to the system.
+   *     - *sourceSettings*
+   *         - Type: object
+   *         - Description: Parameters applied for recommending the *Source* stage. The accepted parameters correspond with the recommendation sub-endpoint used to recommend the *Source*.
+   *     - *resultSettings*
+   *         - Type: object
+   *         - Description: Parameters applied for recommending the *Result* stage. The accepted parameters correspond with the recommendation sub-endpoint used to recommend the *Result*.
+   *     - *expertSettings*
+   *         - Type: object
+   *         - Description: Dictionary of custom options.
+   */
+  constructor(scenario, count, optional) {
+    super('POST', '/recomms/composite/', 3000, false);
+    this.scenario = scenario;
+    this.count = count;
+    optional = optional || {};
+    this.itemId = optional.itemId;
+    this.userId = optional.userId;
+    this.logic = optional.logic;
+    this.segmentId = optional.segmentId;
+    this.cascadeCreate = optional.cascadeCreate;
+    this.sourceSettings = optional.sourceSettings;
+    this.resultSettings = optional.resultSettings;
+    this.expertSettings = optional.expertSettings;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+    params.scenario = this.scenario;
+    params.count = this.count;
+
+    if(this.itemId !== undefined)
+      params.itemId = this.itemId;
+
+    if(this.userId !== undefined)
+      params.userId = this.userId;
+
+    if(this.logic !== undefined)
+      params.logic = this.logic;
+
+    if(this.segmentId !== undefined)
+      params.segmentId = this.segmentId;
+
+    if(this.cascadeCreate !== undefined)
+      params.cascadeCreate = this.cascadeCreate;
+
+    if(this.sourceSettings !== undefined)
+      params.sourceSettings = this.sourceSettings;
+
+    if(this.resultSettings !== undefined)
+      params.resultSettings = this.resultSettings;
+
+    if(this.expertSettings !== undefined)
+      params.expertSettings = this.expertSettings;
+
+    return params;
+  }
+
+  /**
+   * Get query parameters
+   * @return {Object} The values of query parameters (name of parameter: value of the parameter)
+   */
+  queryParameters() {
+    let params = {};
+    return params;
+  }
+}
+
+exports.CompositeRecommendation = CompositeRecommendation

package/lib/requests/index.js

@@ -63,6 +63,7 @@ exports.RecommendUsersToItem = require("./recommend-users-to-item").RecommendUse
 exports.RecommendItemSegmentsToUser = require("./recommend-item-segments-to-user").RecommendItemSegmentsToUser;
 exports.RecommendItemSegmentsToItem = require("./recommend-item-segments-to-item").RecommendItemSegmentsToItem;
 exports.RecommendItemSegmentsToItemSegment = require("./recommend-item-segments-to-item-segment").RecommendItemSegmentsToItemSegment;
+exports.CompositeRecommendation = require("./composite-recommendation").CompositeRecommendation;
 exports.SearchItems = require("./search-items").SearchItems;
 exports.SearchItemSegments = require("./search-item-segments").SearchItemSegments;
 exports.AddSearchSynonym = require("./add-search-synonym").AddSearchSynonym;

package/lib/requests/recommend-item-segments-to-item-segment.js

@@ -62,6 +62,41 @@ class RecommendItemSegmentsToItemSegment extends rqs.Request {
    *     - *returnAbGroup*
    *         - Type: boolean
    *         - Description: If there is a custom AB-testing running, return the name of the group to which the request belongs.
+   *     - *reqlExpressions*
+   *         - Type: object
+   *         - Description: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment.
+   * This can be used to compute additional properties of the recommended Item Segments.
+   * The keys are the names of the expressions, and the values are the actual ReQL expressions.
+   * Example request:
+   * ```json
+   * {
+   *   "reqlExpressions": {
+   *     "countItems": "size(segment_items(\"categories\", 'segmentId'))"
+   *   }
+   * }
+   * ```
+   * Example response:
+   * ```json
+   * {
+   *   "recommId": "a7ac55a4-8d6e-4f19-addc-abac4164d8a8",
+   *   "recomms": 
+   *     [
+   *       {
+   *         "id": "category-fantasy-books",
+   *         "reqlEvaluations": {
+   *           "countItems": 486
+   *         }
+   *       },
+   *       {
+   *         "id": "category-sci-fi-costumes",
+   *         "reqlEvaluations": {
+   *           "countItems": 19
+   *         }
+   *       }
+   *     ],
+   *    "numberNextRecommsCalls": 0
+   * }
+   * ```
    */
   constructor(contextSegmentId, targetUserId, count, optional) {
     super('POST', '/recomms/item-segments/item-segments/', 3000, false);
@@ -76,6 +111,7 @@ class RecommendItemSegmentsToItemSegment extends rqs.Request {
     this.logic = optional.logic;
     this.expertSettings = optional.expertSettings;
     this.returnAbGroup = optional.returnAbGroup;
+    this.reqlExpressions = optional.reqlExpressions;
   }
 
   /**
@@ -109,6 +145,9 @@ class RecommendItemSegmentsToItemSegment extends rqs.Request {
     if(this.returnAbGroup !== undefined)
       params.returnAbGroup = this.returnAbGroup;
 
+    if(this.reqlExpressions !== undefined)
+      params.reqlExpressions = this.reqlExpressions;
+
     return params;
   }
 

package/lib/requests/recommend-item-segments-to-item.js

@@ -63,6 +63,41 @@ class RecommendItemSegmentsToItem extends rqs.Request {
    *     - *returnAbGroup*
    *         - Type: boolean
    *         - Description: If there is a custom AB-testing running, return the name of the group to which the request belongs.
+   *     - *reqlExpressions*
+   *         - Type: object
+   *         - Description: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment.
+   * This can be used to compute additional properties of the recommended Item Segments.
+   * The keys are the names of the expressions, and the values are the actual ReQL expressions.
+   * Example request:
+   * ```json
+   * {
+   *   "reqlExpressions": {
+   *     "countItems": "size(segment_items(\"categories\", 'segmentId'))"
+   *   }
+   * }
+   * ```
+   * Example response:
+   * ```json
+   * {
+   *   "recommId": "a7ac55a4-8d6e-4f19-addc-abac4164d8a8",
+   *   "recomms": 
+   *     [
+   *       {
+   *         "id": "category-fantasy-books",
+   *         "reqlEvaluations": {
+   *           "countItems": 486
+   *         }
+   *       },
+   *       {
+   *         "id": "category-sci-fi-costumes",
+   *         "reqlEvaluations": {
+   *           "countItems": 19
+   *         }
+   *       }
+   *     ],
+   *    "numberNextRecommsCalls": 0
+   * }
+   * ```
    */
   constructor(itemId, targetUserId, count, optional) {
     super('POST', `/recomms/items/${itemId}/item-segments/`, 3000, false);
@@ -77,6 +112,7 @@ class RecommendItemSegmentsToItem extends rqs.Request {
     this.logic = optional.logic;
     this.expertSettings = optional.expertSettings;
     this.returnAbGroup = optional.returnAbGroup;
+    this.reqlExpressions = optional.reqlExpressions;
   }
 
   /**
@@ -109,6 +145,9 @@ class RecommendItemSegmentsToItem extends rqs.Request {
     if(this.returnAbGroup !== undefined)
       params.returnAbGroup = this.returnAbGroup;
 
+    if(this.reqlExpressions !== undefined)
+      params.reqlExpressions = this.reqlExpressions;
+
     return params;
   }
 

package/lib/requests/recommend-item-segments-to-user.js

@@ -50,6 +50,41 @@ class RecommendItemSegmentsToUser extends rqs.Request {
    *     - *returnAbGroup*
    *         - Type: boolean
    *         - Description: If there is a custom AB-testing running, return the name of the group to which the request belongs.
+   *     - *reqlExpressions*
+   *         - Type: object
+   *         - Description: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment.
+   * This can be used to compute additional properties of the recommended Item Segments.
+   * The keys are the names of the expressions, and the values are the actual ReQL expressions.
+   * Example request:
+   * ```json
+   * {
+   *   "reqlExpressions": {
+   *     "countItems": "size(segment_items(\"categories\", 'segmentId'))"
+   *   }
+   * }
+   * ```
+   * Example response:
+   * ```json
+   * {
+   *   "recommId": "a7ac55a4-8d6e-4f19-addc-abac4164d8a8",
+   *   "recomms": 
+   *     [
+   *       {
+   *         "id": "category-fantasy-books",
+   *         "reqlEvaluations": {
+   *           "countItems": 486
+   *         }
+   *       },
+   *       {
+   *         "id": "category-sci-fi-costumes",
+   *         "reqlEvaluations": {
+   *           "countItems": 19
+   *         }
+   *       }
+   *     ],
+   *    "numberNextRecommsCalls": 0
+   * }
+   * ```
    */
   constructor(userId, count, optional) {
     super('POST', `/recomms/users/${userId}/item-segments/`, 3000, false);
@@ -63,6 +98,7 @@ class RecommendItemSegmentsToUser extends rqs.Request {
     this.logic = optional.logic;
     this.expertSettings = optional.expertSettings;
     this.returnAbGroup = optional.returnAbGroup;
+    this.reqlExpressions = optional.reqlExpressions;
   }
 
   /**
@@ -94,6 +130,9 @@ class RecommendItemSegmentsToUser extends rqs.Request {
     if(this.returnAbGroup !== undefined)
       params.returnAbGroup = this.returnAbGroup;
 
+    if(this.reqlExpressions !== undefined)
+      params.reqlExpressions = this.reqlExpressions;
+
     return params;
   }
 

package/lib/requests/recommend-items-to-item-segment.js

@@ -116,6 +116,44 @@ class RecommendItemsToItemSegment extends rqs.Request {
    * See [this section](https://docs.recombee.com/recommendation_logics) for a 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 also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
+   *     - *reqlExpressions*
+   *         - Type: object
+   *         - Description: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended item.
+   * This can be used to compute additional properties of the recommended items that are not stored in the database.
+   * The keys are the names of the expressions, and the values are the actual ReQL expressions.
+   * Example request:
+   * ```json
+   * {
+   *   "reqlExpressions": {
+   *     "isInUsersCity": "context_user[\"city\"] in 'cities'",
+   *     "distanceToUser": "earth_distance('location', context_user[\"location\"])"
+   *   }
+   * }
+   * ```
+   * Example response:
+   * ```json
+   * {
+   *   "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
+   *   "recomms": 
+   *     [
+   *       {
+   *         "id": "restaurant-178",
+   *         "reqlEvaluations": {
+   *           "isInUsersCity": true,
+   *           "distanceToUser": 5200.2
+   *         }
+   *       },
+   *       {
+   *         "id": "bar-42",
+   *         "reqlEvaluations": {
+   *           "isInUsersCity": false,
+   *           "distanceToUser": 2516.0
+   *         }
+   *       }
+   *     ],
+   *    "numberNextRecommsCalls": 0
+   * }
+   * ```
    *     - *minRelevance*
    *         - Type: string
    *         - Description: **Expert option:** If the *targetUserId* is provided:  Specifies the threshold of how 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 a number of items equal to *count* at any cost. If there is not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations being 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.
@@ -145,6 +183,7 @@ class RecommendItemsToItemSegment extends rqs.Request {
     this.filter = optional.filter;
     this.booster = optional.booster;
     this.logic = optional.logic;
+    this.reqlExpressions = optional.reqlExpressions;
     this.minRelevance = optional.minRelevance;
     this.rotationRate = optional.rotationRate;
     this.rotationTime = optional.rotationTime;
@@ -183,6 +222,9 @@ class RecommendItemsToItemSegment extends rqs.Request {
     if(this.logic !== undefined)
       params.logic = this.logic;
 
+    if(this.reqlExpressions !== undefined)
+      params.reqlExpressions = this.reqlExpressions;
+
     if(this.minRelevance !== undefined)
       params.minRelevance = this.minRelevance;
 

package/lib/requests/recommend-items-to-item.js

@@ -114,6 +114,47 @@ class RecommendItemsToItem extends rqs.Request {
    * See [this section](https://docs.recombee.com/recommendation_logics) for a 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 also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
+   *     - *reqlExpressions*
+   *         - Type: object
+   *         - Description: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended item.
+   * This can be used to compute additional properties of the recommended items that are not stored in the database.
+   * The keys are the names of the expressions, and the values are the actual ReQL expressions.
+   * Example request:
+   * ```json
+   * {
+   *   "reqlExpressions": {
+   *     "isInUsersCity": "context_user[\"city\"] in 'cities'",
+   *     "distanceToUser": "earth_distance('location', context_user[\"location\"])",
+   *     "isFromSameCompany": "'company' == context_item[\"company\"]"
+   *   }
+   * }
+   * ```
+   * Example response:
+   * ```json
+   * {
+   *   "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
+   *   "recomms": 
+   *     [
+   *       {
+   *         "id": "restaurant-178",
+   *         "reqlEvaluations": {
+   *           "isInUsersCity": true,
+   *           "distanceToUser": 5200.2,
+   *           "isFromSameCompany": false
+   *         }
+   *       },
+   *       {
+   *         "id": "bar-42",
+   *         "reqlEvaluations": {
+   *           "isInUsersCity": false,
+   *           "distanceToUser": 2516.0,
+   *           "isFromSameCompany": true
+   *         }
+   *       }
+   *     ],
+   *    "numberNextRecommsCalls": 0
+   * }
+   * ```
    *     - *userImpact*
    *         - Type: number
    *         - 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 a user-based recommendation. The default value is `0`.
@@ -149,6 +190,7 @@ class RecommendItemsToItem extends rqs.Request {
     this.filter = optional.filter;
     this.booster = optional.booster;
     this.logic = optional.logic;
+    this.reqlExpressions = optional.reqlExpressions;
     this.userImpact = optional.userImpact;
     this.diversity = optional.diversity;
     this.minRelevance = optional.minRelevance;
@@ -188,6 +230,9 @@ class RecommendItemsToItem extends rqs.Request {
     if(this.logic !== undefined)
       params.logic = this.logic;
 
+    if(this.reqlExpressions !== undefined)
+      params.reqlExpressions = this.reqlExpressions;
+
     if(this.userImpact !== undefined)
       params.userImpact = this.userImpact;
 

package/lib/requests/recommend-items-to-user.js

@@ -102,6 +102,44 @@ class RecommendItemsToUser extends rqs.Request {
    * See [this section](https://docs.recombee.com/recommendation_logics) for a 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 also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
+   *     - *reqlExpressions*
+   *         - Type: object
+   *         - Description: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended item.
+   * This can be used to compute additional properties of the recommended items that are not stored in the database.
+   * The keys are the names of the expressions, and the values are the actual ReQL expressions.
+   * Example request:
+   * ```json
+   * {
+   *   "reqlExpressions": {
+   *     "isInUsersCity": "context_user[\"city\"] in 'cities'",
+   *     "distanceToUser": "earth_distance('location', context_user[\"location\"])"
+   *   }
+   * }
+   * ```
+   * Example response:
+   * ```json
+   * {
+   *   "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
+   *   "recomms": 
+   *     [
+   *       {
+   *         "id": "restaurant-178",
+   *         "reqlEvaluations": {
+   *           "isInUsersCity": true,
+   *           "distanceToUser": 5200.2
+   *         }
+   *       },
+   *       {
+   *         "id": "bar-42",
+   *         "reqlEvaluations": {
+   *           "isInUsersCity": false,
+   *           "distanceToUser": 2516.0
+   *         }
+   *       }
+   *     ],
+   *    "numberNextRecommsCalls": 0
+   * }
+   * ```
    *     - *diversity*
    *         - Type: number
    *         - Description: **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended items should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
@@ -133,6 +171,7 @@ class RecommendItemsToUser extends rqs.Request {
     this.filter = optional.filter;
     this.booster = optional.booster;
     this.logic = optional.logic;
+    this.reqlExpressions = optional.reqlExpressions;
     this.diversity = optional.diversity;
     this.minRelevance = optional.minRelevance;
     this.rotationRate = optional.rotationRate;
@@ -170,6 +209,9 @@ class RecommendItemsToUser extends rqs.Request {
     if(this.logic !== undefined)
       params.logic = this.logic;
 
+    if(this.reqlExpressions !== undefined)
+      params.reqlExpressions = this.reqlExpressions;
+
     if(this.diversity !== undefined)
       params.diversity = this.diversity;
 

package/lib/requests/recommend-users-to-item.js

@@ -92,6 +92,47 @@ class RecommendUsersToItem extends rqs.Request {
    * See [this section](https://docs.recombee.com/recommendation_logics) for a 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 also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
+   *     - *reqlExpressions*
+   *         - Type: object
+   *         - Description: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended user.
+   * This can be used to compute additional properties of the recommended users that are not stored in the database.
+   * The keys are the names of the expressions, and the values are the actual ReQL expressions.
+   * Example request:
+   * ```json
+   * {
+   *   "reqlExpressions": {
+   *     "isInUsersCity": "context_user[\"city\"] in 'cities'",
+   *     "distanceToUser": "earth_distance('location', context_user[\"location\"])",
+   *     "isFromSameCompany": "'company' == context_item[\"company\"]"
+   *   }
+   * }
+   * ```
+   * Example response:
+   * ```json
+   * {
+   *   "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
+   *   "recomms": 
+   *     [
+   *       {
+   *         "id": "restaurant-178",
+   *         "reqlEvaluations": {
+   *           "isInUsersCity": true,
+   *           "distanceToUser": 5200.2,
+   *           "isFromSameCompany": false
+   *         }
+   *       },
+   *       {
+   *         "id": "bar-42",
+   *         "reqlEvaluations": {
+   *           "isInUsersCity": false,
+   *           "distanceToUser": 2516.0,
+   *           "isFromSameCompany": true
+   *         }
+   *       }
+   *     ],
+   *    "numberNextRecommsCalls": 0
+   * }
+   * ```
    *     - *diversity*
    *         - Type: number
    *         - Description: **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended users should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
@@ -114,6 +155,7 @@ class RecommendUsersToItem extends rqs.Request {
     this.filter = optional.filter;
     this.booster = optional.booster;
     this.logic = optional.logic;
+    this.reqlExpressions = optional.reqlExpressions;
     this.diversity = optional.diversity;
     this.expertSettings = optional.expertSettings;
     this.returnAbGroup = optional.returnAbGroup;
@@ -148,6 +190,9 @@ class RecommendUsersToItem extends rqs.Request {
     if(this.logic !== undefined)
       params.logic = this.logic;
 
+    if(this.reqlExpressions !== undefined)
+      params.reqlExpressions = this.reqlExpressions;
+
     if(this.diversity !== undefined)
       params.diversity = this.diversity;
 

package/lib/requests/recommend-users-to-user.js

@@ -92,6 +92,44 @@ class RecommendUsersToUser extends rqs.Request {
    * See [this section](https://docs.recombee.com/recommendation_logics) for a 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 also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
+   *     - *reqlExpressions*
+   *         - Type: object
+   *         - Description: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended user.
+   * This can be used to compute additional properties of the recommended users that are not stored in the database.
+   * The keys are the names of the expressions, and the values are the actual ReQL expressions.
+   * Example request:
+   * ```json
+   * {
+   *   "reqlExpressions": {
+   *     "isInUsersCity": "context_user[\"city\"] in 'cities'",
+   *     "distanceToUser": "earth_distance('location', context_user[\"location\"])"
+   *   }
+   * }
+   * ```
+   * Example response:
+   * ```json
+   * {
+   *   "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
+   *   "recomms": 
+   *     [
+   *       {
+   *         "id": "restaurant-178",
+   *         "reqlEvaluations": {
+   *           "isInUsersCity": true,
+   *           "distanceToUser": 5200.2
+   *         }
+   *       },
+   *       {
+   *         "id": "bar-42",
+   *         "reqlEvaluations": {
+   *           "isInUsersCity": false,
+   *           "distanceToUser": 2516.0
+   *         }
+   *       }
+   *     ],
+   *    "numberNextRecommsCalls": 0
+   * }
+   * ```
    *     - *diversity*
    *         - Type: number
    *         - Description: **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended users should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
@@ -123,6 +161,7 @@ class RecommendUsersToUser extends rqs.Request {
     this.filter = optional.filter;
     this.booster = optional.booster;
     this.logic = optional.logic;
+    this.reqlExpressions = optional.reqlExpressions;
     this.diversity = optional.diversity;
     this.minRelevance = optional.minRelevance;
     this.rotationRate = optional.rotationRate;
@@ -160,6 +199,9 @@ class RecommendUsersToUser extends rqs.Request {
     if(this.logic !== undefined)
       params.logic = this.logic;
 
+    if(this.reqlExpressions !== undefined)
+      params.reqlExpressions = this.reqlExpressions;
+
     if(this.diversity !== undefined)
       params.diversity = this.diversity;