recombee_api_client 5.1.0 → 6.1.0

data/lib/recombee_api_client/api/remove_from_series.rb

@@ -5,20 +5,19 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Removes an existing series item from the series.
+  # Removes an existing series item from the series.#
   class RemoveFromSeries < ApiRequest
     attr_reader :series_id, :item_type, :item_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +series_id+ -> ID of the series from which a series item is to be removed.
-  #   - +item_type+ -> Type of the item to be removed.
-  #   - +item_id+ -> ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +series_id+ -> ID of the series from which a series item is to be removed.
+    #   - +item_type+ -> Type of the item to be removed.
+    #   - +item_id+ -> ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.
+    #
     def initialize(series_id, item_type, item_id)
       @series_id = series_id
       @item_type = item_type
@@ -26,27 +25,27 @@ module RecombeeApiClient
       @timeout = 3000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :delete
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
+      p = {}
       p['itemType'] = @item_type
       p['itemId'] = @item_id
+
       p
     end
-  
+
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params
+      {}
     end
-  
+
     # Relative path to the endpoint
     def path
       "/{databaseId}/series/#{@series_id}/items/"

data/lib/recombee_api_client/api/request.rb

@@ -3,7 +3,7 @@ module RecombeeApiClient
   # Parent class for API requests
   #
   class ApiRequest
-    require_relative 'hash_normalizer'
+    require_relative '../utils/hash_normalizer'
     include RecombeeApiClient::HashNormalizer
   end
 end

data/lib/recombee_api_client/api/reset_database.rb

@@ -5,43 +5,39 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Completely erases all your data, including items, item properties, series, user database, purchases, ratings, detail views, and bookmarks. Make sure the request is never executed in the production environment! Resetting your database is irreversible.
+  # Completely erases all your data, including items, item properties, series, user database, purchases, ratings, detail views, and bookmarks. Make sure the request is never executed in the production environment! Resetting your database is irreversible.
   #
   class ResetDatabase < ApiRequest
-  
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  #
-    def initialize()
-      @timeout = 100000
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    #
+    def initialize
+      @timeout = 100_000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :delete
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
-      p
+      {}
     end
-  
+
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params
+      {}
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/"
+      '/{databaseId}/'
     end
   end
 end

data/lib/recombee_api_client/api/search_item_segments.rb

@@ -5,64 +5,101 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Full-text personalized search that returns Segments from a Segmentation. The results are based on the provided `searchQuery` and also on the user's past interactions (purchases, ratings, etc.).
+  # Full-text personalized search that returns Segments from a Segmentation. The results are based on the provided `searchQuery` and also on the user's past interactions (purchases, ratings, etc.).
   #
-  #Based on the used Segmentation, this endpoint can be used for example for:
+  # Based on the used Segmentation, this endpoint can be used for example for:
   #
   #  - Searching within categories or brands
   #  - Searching within genres or artists
   #
-  #For example if the user is searching for "iPhone" this endpoint can return "cell phones" category.
+  # For example if the user is searching for "iPhone" this endpoint can return "cell phones" category.
   #
-  #You need to set the used Segmentation the Admin UI in the Scenario settings prior to using this endpoint.
+  # You need to set the used Segmentation the Admin UI in the Scenario settings prior to using this endpoint.
   #
-  #The returned segments are sorted by relevance (first segment being the most relevant).
+  # The returned segments are sorted by relevance (first segment being the most relevant).
   #
-  #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
+  # It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
   #
   class SearchItemSegments < ApiRequest
-    attr_reader :user_id, :search_query, :count, :scenario, :cascade_create, :filter, :booster, :logic, :expert_settings, :return_ab_group
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> ID of the user for whom personalized search will be performed.
-  #   - +search_query+ -> Search query provided by the user. It is used for the full-text search.
-  #   - +count+ -> Number of segments to be returned (N for the top-N results).
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +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.
-  #
-  #   - +cascadeCreate+ -> If the user 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 user, as the user will be already known to the system.
-  #
-  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
-  #
-  #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
-  #
-  #   - +logic+ -> 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).
-  #
-  #   - +expertSettings+ -> Dictionary of custom options.
-  #
-  #   - +returnAbGroup+ -> If there is a custom AB-testing running, return the name of the group to which the request belongs.
-  #
-  #
+    attr_reader :user_id, :search_query, :count, :scenario, :cascade_create, :filter, :booster, :logic,
+                :expert_settings, :return_ab_group, :reql_expressions
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> ID of the user for whom personalized search will be performed.
+    #   - +search_query+ -> Search query provided by the user. It is used for the full-text search.
+    #   - +count+ -> Number of segments to be returned (N for the top-N results).
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +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.
+    #
+    #   - +cascadeCreate+ -> If the user 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 user, as the user will be already known to the system.
+    #
+    #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
+    #
+    #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
+    #
+    #   - +logic+ -> 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).
+    #
+    #   - +expertSettings+ -> Dictionary of custom options.
+    #
+    #   - +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
       @search_query = search_query
       @count = count
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @scenario = optional['scenario']
       @cascade_create = optional['cascadeCreate']
       @filter = optional['filter']
@@ -70,22 +107,24 @@ 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, _|
-        fail UnknownOptionalParameter.new(par) unless ["scenario","cascadeCreate","filter","booster","logic","expertSettings","returnAbGroup"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[scenario cascadeCreate filter booster logic
+                                                          expertSettings returnAbGroup reqlExpressions].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :post
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
+      p = {}
       p['searchQuery'] = @search_query
       p['count'] = @count
       p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
@@ -95,16 +134,17 @@ 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
-  
+
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params
+      {}
     end
-  
+
     # Relative path to the endpoint
     def path
       "/{databaseId}/search/users/#{@user_id}/item-segments/"