recombee_api_client 6.0.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88fa1bd148ace9bb4ddfa4c75037c4242bf693a96e7395de3b0c23dafb325d03
-  data.tar.gz: c4bbc5474baf87cfaabc58f07b0c4e5161190473e1816e2b6f6ab61b90d32347
+  metadata.gz: 946801c5ff87b7b436bdebae1c869bb47adaa63d07f0a779da3da48961fdb704
+  data.tar.gz: 14e9ead529eb19b683314182f8cdf2c22f18f208f4d58559a6aa8086e788343f
 SHA512:
-  metadata.gz: ba77e029c00f29e3e4ec1d8b7790620d205e13bb4cbcc16b06061f0ce3045b74b39b815706bf0cde69d88964460a6149d8012f976e2563c9f2188464833ebc2b
-  data.tar.gz: 3a6abbe8a347b15d2fec1ec457a23870c4321839c18f75e344adaf607dcb95b2e379b20057af1d90a3edb023eb97643d2788a35088c853588cfe368e7a9a7abe
+  metadata.gz: 41cf5de6569aae7b973a3d03eccd2d819aaadcce8c2afccba7d8b38462c822bb04efbbe033fa96a4ad7d89a7a9891d947c6fe8779fe9732ae2cd59ae1584acae
+  data.tar.gz: f8ef99a8dffd542ea917e43a2ae776eeda38308daa9dc12f62155623df2ff633793aa5d5a054c10d48f0065d9633dbe1e382f07fd3fc73d22636e9635b825ebb

data/lib/recombee_api_client/api/composite_recommendation.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
 
   ##
-  # 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.
+  # Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations)) 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>*.
   #
@@ -37,8 +37,8 @@ module RecombeeApiClient
   # See [this example](https://docs.recombee.com/api#composite-recommendation-example-setting-parameters-for-individual-stages) for more details.
   #
   class CompositeRecommendation < ApiRequest
-    attr_reader :scenario, :count, :item_id, :user_id, :logic, :segment_id, :cascade_create, :source_settings,
-                :result_settings, :expert_settings
+    attr_reader :scenario, :count, :item_id, :user_id, :logic, :segment_id, :search_query, :cascade_create,
+                :source_settings, :result_settings, :expert_settings
     attr_accessor :timeout, :ensure_https
 
     ##
@@ -66,6 +66,8 @@ module RecombeeApiClient
     #
     #   - +segmentId+ -> ID of the segment from `contextSegmentationId` for which the recommendations are to be generated.
     #
+    #   - +searchQuery+ -> Search query provided by the user. It is used for the full-text search. Only applicable if the *scenario* corresponds to a search scenario.
+    #
     #   - +cascadeCreate+ -> 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+ -> Parameters applied for recommending the *Source* stage. The accepted parameters correspond with the recommendation sub-endpoint used to recommend the *Source*.
@@ -83,6 +85,7 @@ module RecombeeApiClient
       @user_id = optional['userId']
       @logic = optional['logic']
       @segment_id = optional['segmentId']
+      @search_query = optional['searchQuery']
       @cascade_create = optional['cascadeCreate']
       @source_settings = optional['sourceSettings']
       @result_settings = optional['resultSettings']
@@ -91,8 +94,8 @@ module RecombeeApiClient
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        raise UnknownOptionalParameter.new(par) unless %w[itemId userId logic segmentId cascadeCreate
-                                                          sourceSettings resultSettings expertSettings].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[itemId userId logic segmentId searchQuery
+                                                          cascadeCreate sourceSettings resultSettings expertSettings].include? par
       end
     end
 
@@ -110,6 +113,7 @@ module RecombeeApiClient
       p['userId'] = @optional['userId'] if @optional.include? 'userId'
       p['logic'] = @optional['logic'] if @optional.include? 'logic'
       p['segmentId'] = @optional['segmentId'] if @optional.include? 'segmentId'
+      p['searchQuery'] = @optional['searchQuery'] if @optional.include? 'searchQuery'
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
       p['sourceSettings'] = @optional['sourceSettings'] if @optional.include? 'sourceSettings'
       p['resultSettings'] = @optional['resultSettings'] if @optional.include? 'resultSettings'

data/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 @@ module RecombeeApiClient
     #
     #   - +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 @@ module RecombeeApiClient
       @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 @@ module RecombeeApiClient
       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

data/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 @@ module RecombeeApiClient
     #
     #   - +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 @@ module RecombeeApiClient
       @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 @@ module RecombeeApiClient
       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

data/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 @@ module RecombeeApiClient
     #
     #   - +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 @@ module RecombeeApiClient
       @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 @@ module RecombeeApiClient
       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

data/lib/recombee_api_client/api/recommend_next_item_segments.rb

@@ -0,0 +1,69 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+
+  ##
+  # Returns Item segments that shall be shown to a user as next recommendations when the user e.g. scrolls the page down (*infinite scroll*) or goes to the next page.
+  #
+  # It accepts `recommId` of a base recommendation request (e.g., request from the first page) and the number of segments that shall be returned (`count`).
+  # The base request can be one of:
+  #  - [Recommend Item Segments to Item](https://docs.recombee.com/api#recommend-item-segments-to-item)
+  #  - [Recommend Item Segments to User](https://docs.recombee.com/api#recommend-item-segments-to-user)
+  #  - [Recommend Item Segments to Item Segment](https://docs.recombee.com/api#recommend-item-segments-to-item-segment)
+  #  - [Search Item Segments](https://docs.recombee.com/api#search-item-segments)
+  #
+  # All the other parameters are inherited from the base request.
+  #
+  # *Recommend next Item segments* can be called many times for a single `recommId` and each call returns different (previously not recommended) segments.
+  # The number of *Recommend next Item segments* calls performed so far is returned in the `numberNextRecommsCalls` field.
+  #
+  # *Recommend next Item segments* can be requested up to 30 minutes after the base request or a previous *Recommend next Item segments* call.
+  #
+  # For billing purposes, each call to *Recommend next Item segments* is counted as a separate recommendation request.
+  #
+  class RecommendNextItemSegments < ApiRequest
+    attr_reader :recomm_id, :count
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +recomm_id+ -> ID of the base recommendation request for which next recommendations should be returned
+    #   - +count+ -> Number of item segments to be recommended
+    #
+    #
+    def initialize(recomm_id, count)
+      @recomm_id = recomm_id
+      @count = count
+      @timeout = 3000
+      @ensure_https = false
+    end
+
+    # HTTP method
+    def method
+      :post
+    end
+
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = {}
+      p['count'] = @count
+
+      p
+    end
+
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      {}
+    end
+
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/recomms/next/item-segments/#{@recomm_id}"
+    end
+  end
+end

data/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 @@ module RecombeeApiClient
     #
     #   - +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 @@ module RecombeeApiClient
       @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 @@ module RecombeeApiClient
       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

data/lib/recombee_api_client/version.rb

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

data/lib/recombee_api_client.rb

@@ -19,7 +19,7 @@ module RecombeeApiClient
     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.2.0' }
 
     ##
     #   - +account+ -> Name of your account at Recombee

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recombee_api_client
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.2.0
 platform: ruby
 authors:
 - Ondřej Fiedler
@@ -159,6 +159,7 @@ files:
 - lib/recombee_api_client/api/recommend_items_to_item.rb
 - lib/recombee_api_client/api/recommend_items_to_item_segment.rb
 - lib/recombee_api_client/api/recommend_items_to_user.rb
+- lib/recombee_api_client/api/recommend_next_item_segments.rb
 - lib/recombee_api_client/api/recommend_next_items.rb
 - lib/recombee_api_client/api/recommend_users_to_item.rb
 - lib/recombee_api_client/api/recommend_users_to_user.rb