Release: v6.1.0

- Added support for `reqlExpressions` on recommended item segments

Author: MichalDemko

lib/recombee_api_client.rb

@@ -19,7 +19,7 @@ class RecombeeClient
     include HTTParty
 
     BATCH_MAX_SIZE = 10_000
-    USER_AGENT = { 'User-Agent' => 'recombee-ruby-api-client/6.0.0' }
+    USER_AGENT = { 'User-Agent' => 'recombee-ruby-api-client/6.1.0' }
 
     ##
     #   - +account+ -> Name of your account at Recombee

lib/recombee_api_client/api/recommend_item_segments_to_item.rb

@@ -24,7 +24,7 @@ module RecombeeApiClient
   #
   class RecommendItemSegmentsToItem < ApiRequest
     attr_reader :item_id, :target_user_id, :count, :scenario, :cascade_create, :filter, :booster, :logic,
-                :expert_settings, :return_ab_group
+                :expert_settings, :return_ab_group, :reql_expressions
     attr_accessor :timeout, :ensure_https
 
     ##
@@ -75,6 +75,43 @@ class RecommendItemSegmentsToItem < ApiRequest
     #
     #   - +returnAbGroup+ -> If there is a custom AB-testing running, return the name of the group to which the request belongs.
     #
+    #   - +reqlExpressions+ -> 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
+    # }
+    # ```
+    #
     #
     def initialize(item_id, target_user_id, count, optional = {})
       @item_id = item_id
@@ -88,12 +125,13 @@ def initialize(item_id, target_user_id, count, optional = {})
       @logic = optional['logic']
       @expert_settings = optional['expertSettings']
       @return_ab_group = optional['returnAbGroup']
+      @reql_expressions = optional['reqlExpressions']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         raise UnknownOptionalParameter.new(par) unless %w[scenario cascadeCreate filter booster logic
-                                                          expertSettings returnAbGroup].include? par
+                                                          expertSettings returnAbGroup reqlExpressions].include? par
       end
     end
 
@@ -114,6 +152,7 @@ def body_parameters
       p['logic'] = @optional['logic'] if @optional.include? 'logic'
       p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
       p['returnAbGroup'] = @optional['returnAbGroup'] if @optional.include? 'returnAbGroup'
+      p['reqlExpressions'] = @optional['reqlExpressions'] if @optional.include? 'reqlExpressions'
 
       p
     end

lib/recombee_api_client/api/recommend_item_segments_to_item_segment.rb

@@ -23,7 +23,7 @@ module RecombeeApiClient
   #
   class RecommendItemSegmentsToItemSegment < ApiRequest
     attr_reader :context_segment_id, :target_user_id, :count, :scenario, :cascade_create, :filter, :booster, :logic,
-                :expert_settings, :return_ab_group
+                :expert_settings, :return_ab_group, :reql_expressions
     attr_accessor :timeout, :ensure_https
 
     ##
@@ -74,6 +74,43 @@ class RecommendItemSegmentsToItemSegment < ApiRequest
     #
     #   - +returnAbGroup+ -> If there is a custom AB-testing running, return the name of the group to which the request belongs.
     #
+    #   - +reqlExpressions+ -> 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
+    # }
+    # ```
+    #
     #
     def initialize(context_segment_id, target_user_id, count, optional = {})
       @context_segment_id = context_segment_id
@@ -87,12 +124,13 @@ def initialize(context_segment_id, target_user_id, count, optional = {})
       @logic = optional['logic']
       @expert_settings = optional['expertSettings']
       @return_ab_group = optional['returnAbGroup']
+      @reql_expressions = optional['reqlExpressions']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         raise UnknownOptionalParameter.new(par) unless %w[scenario cascadeCreate filter booster logic
-                                                          expertSettings returnAbGroup].include? par
+                                                          expertSettings returnAbGroup reqlExpressions].include? par
       end
     end
 
@@ -114,6 +152,7 @@ def body_parameters
       p['logic'] = @optional['logic'] if @optional.include? 'logic'
       p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
       p['returnAbGroup'] = @optional['returnAbGroup'] if @optional.include? 'returnAbGroup'
+      p['reqlExpressions'] = @optional['reqlExpressions'] if @optional.include? 'reqlExpressions'
 
       p
     end

lib/recombee_api_client/api/recommend_item_segments_to_user.rb

@@ -24,7 +24,7 @@ module RecombeeApiClient
   #
   class RecommendItemSegmentsToUser < ApiRequest
     attr_reader :user_id, :count, :scenario, :cascade_create, :filter, :booster, :logic, :expert_settings,
-                :return_ab_group
+                :return_ab_group, :reql_expressions
     attr_accessor :timeout, :ensure_https
 
     ##
@@ -57,6 +57,43 @@ class RecommendItemSegmentsToUser < ApiRequest
     #
     #   - +returnAbGroup+ -> If there is a custom AB-testing running, return the name of the group to which the request belongs.
     #
+    #   - +reqlExpressions+ -> 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
+    # }
+    # ```
+    #
     #
     def initialize(user_id, count, optional = {})
       @user_id = user_id
@@ -69,12 +106,13 @@ def initialize(user_id, count, optional = {})
       @logic = optional['logic']
       @expert_settings = optional['expertSettings']
       @return_ab_group = optional['returnAbGroup']
+      @reql_expressions = optional['reqlExpressions']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         raise UnknownOptionalParameter.new(par) unless %w[scenario cascadeCreate filter booster logic
-                                                          expertSettings returnAbGroup].include? par
+                                                          expertSettings returnAbGroup reqlExpressions].include? par
       end
     end
 
@@ -94,6 +132,7 @@ def body_parameters
       p['logic'] = @optional['logic'] if @optional.include? 'logic'
       p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
       p['returnAbGroup'] = @optional['returnAbGroup'] if @optional.include? 'returnAbGroup'
+      p['reqlExpressions'] = @optional['reqlExpressions'] if @optional.include? 'reqlExpressions'
 
       p
     end

lib/recombee_api_client/api/search_item_segments.rb

@@ -24,7 +24,7 @@ module RecombeeApiClient
   #
   class SearchItemSegments < ApiRequest
     attr_reader :user_id, :search_query, :count, :scenario, :cascade_create, :filter, :booster, :logic,
-                :expert_settings, :return_ab_group
+                :expert_settings, :return_ab_group, :reql_expressions
     attr_accessor :timeout, :ensure_https
 
     ##
@@ -57,6 +57,43 @@ class SearchItemSegments < ApiRequest
     #
     #   - +returnAbGroup+ -> If there is a custom AB-testing running, return the name of the group to which the request belongs.
     #
+    #   - +reqlExpressions+ -> 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
+    # }
+    # ```
+    #
     #
     def initialize(user_id, search_query, count, optional = {})
       @user_id = user_id
@@ -70,12 +107,13 @@ def initialize(user_id, search_query, count, optional = {})
       @logic = optional['logic']
       @expert_settings = optional['expertSettings']
       @return_ab_group = optional['returnAbGroup']
+      @reql_expressions = optional['reqlExpressions']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         raise UnknownOptionalParameter.new(par) unless %w[scenario cascadeCreate filter booster logic
-                                                          expertSettings returnAbGroup].include? par
+                                                          expertSettings returnAbGroup reqlExpressions].include? par
       end
     end
 
@@ -96,6 +134,7 @@ def body_parameters
       p['logic'] = @optional['logic'] if @optional.include? 'logic'
       p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
       p['returnAbGroup'] = @optional['returnAbGroup'] if @optional.include? 'returnAbGroup'
+      p['reqlExpressions'] = @optional['reqlExpressions'] if @optional.include? 'reqlExpressions'
 
       p
     end

lib/recombee_api_client/version.rb

@@ -1,3 +1,3 @@
 module RecombeeApiClient
-  VERSION = '6.0.0'
+  VERSION = '6.1.0'
 end

spec/api/batch_spec.rb

@@ -25,13 +25,13 @@
       ListItems.new('filter' => "'num' >= 99"),
       AddCartAddition.new('user', 'item2'),
       AddCartAddition.new('user', 'item2', 'cascadeCreate' => true),
-      RecommendItemsToUser.new('user_id', 25, filter: "'num'==68", cascade_create: True)
+      RecommendItemsToUser.new('user_id', 25, filter: "'num'==68", cascade_create: true)
     ]
     repl = @client.send(Batch.new(reqs))
 
     codes = repl.map { |r| r['code'] }
-    expect(codes).to match_array [200, 201, 201, 200, 409, 200, 200, 200, 200, 200, 404, 200]
-    expect(repl[12]['json']['recomms'][0].sort).to match_array ['item2']
+    expect(codes).to match_array [200, 201, 201, 200, 409, 200, 200, 200, 200, 200, 404, 200, 200]
+    expect(repl[12]['json']['recomms'][0]['id']).to eq 'item2'
   end
 
   it 'send large multi-part batch' do