recombee-api-client 6.0.0 → 6.1.0

package/lib/api-client.js

@@ -43,7 +43,7 @@ class ApiClient {
         method: request.method,
         headers: {'Accept': 'application/json',
                   'Content-Type': 'application/json',
-                  'User-Agent': 'recombee-node-api-client/6.0.0'},
+                  'User-Agent': 'recombee-node-api-client/6.1.0'},
         timeout: request.timeout,
         agent: this.options.agent
     };

package/lib/index.d.ts

@@ -2404,6 +2404,8 @@ declare module "recombee-api-client" {
           expertSettings?: Record<string, unknown>;
           /** If there is a custom AB-testing running, return the name of the group to which the request belongs. */
           returnAbGroup?: boolean;
+          /** A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment. */
+          reqlExpressions?: Record<string, string>;
         }
       );
 
@@ -2416,6 +2418,7 @@ declare module "recombee-api-client" {
       logic?: string | object;
       expertSettings?: Record<string, unknown>;
       returnAbGroup?: boolean;
+      reqlExpressions?: Record<string, string>;
       protected __response_type: RecommendationResponse;
 
       bodyParameters(): {
@@ -2427,6 +2430,7 @@ declare module "recombee-api-client" {
         logic?: string | object;
         expertSettings?: Record<string, unknown>;
         returnAbGroup?: boolean;
+        reqlExpressions?: Record<string, string>;
       };
 
       queryParameters(): {
@@ -2482,6 +2486,8 @@ declare module "recombee-api-client" {
           expertSettings?: Record<string, unknown>;
           /** If there is a custom AB-testing running, return the name of the group to which the request belongs. */
           returnAbGroup?: boolean;
+          /** A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment. */
+          reqlExpressions?: Record<string, string>;
         }
       );
 
@@ -2495,6 +2501,7 @@ declare module "recombee-api-client" {
       logic?: string | object;
       expertSettings?: Record<string, unknown>;
       returnAbGroup?: boolean;
+      reqlExpressions?: Record<string, string>;
       protected __response_type: RecommendationResponse;
 
       bodyParameters(): {
@@ -2507,6 +2514,7 @@ declare module "recombee-api-client" {
         logic?: string | object;
         expertSettings?: Record<string, unknown>;
         returnAbGroup?: boolean;
+        reqlExpressions?: Record<string, string>;
       };
 
       queryParameters(): {
@@ -2561,6 +2569,8 @@ declare module "recombee-api-client" {
           expertSettings?: Record<string, unknown>;
           /** If there is a custom AB-testing running, return the name of the group to which the request belongs. */
           returnAbGroup?: boolean;
+          /** A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment. */
+          reqlExpressions?: Record<string, string>;
         }
       );
 
@@ -2574,6 +2584,7 @@ declare module "recombee-api-client" {
       logic?: string | object;
       expertSettings?: Record<string, unknown>;
       returnAbGroup?: boolean;
+      reqlExpressions?: Record<string, string>;
       protected __response_type: RecommendationResponse;
 
       bodyParameters(): {
@@ -2587,6 +2598,7 @@ declare module "recombee-api-client" {
         logic?: string | object;
         expertSettings?: Record<string, unknown>;
         returnAbGroup?: boolean;
+        reqlExpressions?: Record<string, string>;
       };
 
       queryParameters(): {
@@ -2788,6 +2800,8 @@ declare module "recombee-api-client" {
           expertSettings?: Record<string, unknown>;
           /** If there is a custom AB-testing running, return the name of the group to which the request belongs. */
           returnAbGroup?: boolean;
+          /** A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment. */
+          reqlExpressions?: Record<string, string>;
         }
       );
 
@@ -2801,6 +2815,7 @@ declare module "recombee-api-client" {
       logic?: string | object;
       expertSettings?: Record<string, unknown>;
       returnAbGroup?: boolean;
+      reqlExpressions?: Record<string, string>;
       protected __response_type: SearchResponse;
 
       bodyParameters(): {
@@ -2813,6 +2828,7 @@ declare module "recombee-api-client" {
         logic?: string | object;
         expertSettings?: Record<string, unknown>;
         returnAbGroup?: boolean;
+        reqlExpressions?: Record<string, string>;
       };
 
       queryParameters(): {

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/search-item-segments.js

@@ -50,6 +50,41 @@ class SearchItemSegments 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, searchQuery, count, optional) {
     super('POST', `/search/users/${userId}/item-segments/`, 3000, false);
@@ -64,6 +99,7 @@ class SearchItemSegments extends rqs.Request {
     this.logic = optional.logic;
     this.expertSettings = optional.expertSettings;
     this.returnAbGroup = optional.returnAbGroup;
+    this.reqlExpressions = optional.reqlExpressions;
   }
 
   /**
@@ -96,6 +132,9 @@ class SearchItemSegments extends rqs.Request {
     if(this.returnAbGroup !== undefined)
       params.returnAbGroup = this.returnAbGroup;
 
+    if(this.reqlExpressions !== undefined)
+      params.reqlExpressions = this.reqlExpressions;
+
     return params;
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "recombee-api-client",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "Node.js client (SDK) for easy use of the Recombee recommendation API",
   "main": "index.js",
   "types": "lib/index.d.ts",