recombee_api_client 5.1.0 → 6.1.0

data/lib/recombee_api_client/api/list_users.rb

@@ -5,81 +5,80 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Gets a list of IDs of users currently present in the catalog.
+  # Gets a list of IDs of users currently present in the catalog.#
   class ListUsers < ApiRequest
     attr_reader :filter, :count, :offset, :return_properties, :included_properties
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter users to be listed. Only the users for which the expression is *true* will be returned.
-  #   - +count+ -> The number of users to be listed.
-  #   - +offset+ -> Specifies the number of users to skip (ordered by `userId`).
-  #   - +returnProperties+ -> With `returnProperties=true`, property values of the listed users are returned along with their IDs in a JSON dictionary. 
-  #
-  #Example response:
-  #```json
-  #  [
-  #    {
-  #      "userId": "user-81",
-  #      "country": "US",
-  #      "sex": "M"
-  #    },
-  #    {
-  #      "userId": "user-314",
-  #      "country": "CAN",
-  #      "sex": "F"
-  #    }
-  #  ]
-  #```
-  #
-  #   - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
-  #
-  #Example response for `includedProperties=country`:
-  #```json
-  #  [
-  #    {
-  #      "userId": "user-81",
-  #      "country": "US"
-  #    },
-  #    {
-  #      "userId": "user-314",
-  #      "country": "CAN"
-  #    }
-  #  ]
-  #```
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter users to be listed. Only the users for which the expression is *true* will be returned.
+    #   - +count+ -> The number of users to be listed.
+    #   - +offset+ -> Specifies the number of users to skip (ordered by `userId`).
+    #   - +returnProperties+ -> With `returnProperties=true`, property values of the listed users are returned along with their IDs in a JSON dictionary.
+    #
+    # Example response:
+    # ```json
+    #  [
+    #    {
+    #      "userId": "user-81",
+    #      "country": "US",
+    #      "sex": "M"
+    #    },
+    #    {
+    #      "userId": "user-314",
+    #      "country": "CAN",
+    #      "sex": "F"
+    #    }
+    #  ]
+    # ```
+    #
+    #   - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
+    #
+    # Example response for `includedProperties=country`:
+    # ```json
+    #  [
+    #    {
+    #      "userId": "user-81",
+    #      "country": "US"
+    #    },
+    #    {
+    #      "userId": "user-314",
+    #      "country": "CAN"
+    #    }
+    #  ]
+    # ```
+    #
+    #
     def initialize(optional = {})
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @filter = optional['filter']
       @count = optional['count']
       @offset = optional['offset']
       @return_properties = optional['returnProperties']
       @included_properties = optional['includedProperties']
       @optional = optional
-      @timeout = 100000
+      @timeout = 100_000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["filter","count","offset","returnProperties","includedProperties"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[filter count offset returnProperties
+                                                          includedProperties].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :get
     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
@@ -89,12 +88,13 @@ module RecombeeApiClient
       params['offset'] = @optional['offset'] if @optional['offset']
       params['returnProperties'] = @optional['returnProperties'] if @optional['returnProperties']
       params['includedProperties'] = @optional['includedProperties'] if @optional['includedProperties']
+
       params
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/users/list/"
+      '/{databaseId}/users/list/'
     end
   end
 end

data/lib/recombee_api_client/api/merge_users.rb

@@ -5,61 +5,60 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two becomes desirable.
+  # Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two becomes desirable.
   #
   #
-  #Merging happens between two users referred to as the *target* and the *source*. After the merge, all the interactions of the source user are attributed to the target user, and the source user is **deleted**.
+  # Merging happens between two users referred to as the *target* and the *source*. After the merge, all the interactions of the source user are attributed to the target user, and the source user is **deleted**.
   #
-  #By default, the *Merge Users* request is only available from server-side integrations for security reasons, to prevent potential abuse.
-  #If you need to call this request from a client-side environment (such as a web or mobile app), please contact our support and request access to enable this feature for your database.
+  # By default, the *Merge Users* request is only available from server-side integrations for security reasons, to prevent potential abuse.
+  # If you need to call this request from a client-side environment (such as a web or mobile app), please contact our support and request access to enable this feature for your database.
   #
   class MergeUsers < ApiRequest
     attr_reader :target_user_id, :source_user_id, :cascade_create
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +target_user_id+ -> ID of the target user.
-  #   - +source_user_id+ -> ID of the source user.
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +cascadeCreate+ -> Sets whether the user *targetUserId* should be created if not present in the database.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +target_user_id+ -> ID of the target user.
+    #   - +source_user_id+ -> ID of the source user.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +cascadeCreate+ -> Sets whether the user *targetUserId* should be created if not present in the database.
+    #
     def initialize(target_user_id, source_user_id, optional = {})
       @target_user_id = target_user_id
       @source_user_id = source_user_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @cascade_create = optional['cascadeCreate']
       @optional = optional
-      @timeout = 10000
+      @timeout = 10_000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['cascadeCreate'].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :put
     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['cascadeCreate'] = @optional['cascadeCreate'] if @optional['cascadeCreate']
+
       params
     end
-  
+
     # Relative path to the endpoint
     def path
       "/{databaseId}/users/#{@target_user_id}/merge/#{@source_user_id}"

data/lib/recombee_api_client/api/recommend_item_segments_to_item.rb

@@ -5,82 +5,119 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Recommends Segments from a [Segmentation](https://docs.recombee.com/segmentations) that are the most relevant to a particular item.
+  # Recommends Segments from a [Segmentation](https://docs.recombee.com/segmentations) that are the most relevant to a particular item.
   #
-  #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:
   #
   #  - Recommending the related categories
   #  - Recommending the related genres
   #  - Recommending the related brands
   #  - Recommending the related artists
   #
-  #You need to set the used Segmentation the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.
+  # You need to set the used Segmentation the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) 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 RecommendItemSegmentsToItem < ApiRequest
-    attr_reader :item_id, :target_user_id, :count, :scenario, :cascade_create, :filter, :booster, :logic, :expert_settings, :return_ab_group
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +item_id+ -> ID of the item for which the recommendations are to be generated.
-  #   - +target_user_id+ -> ID of the user who will see the recommendations.
-  #
-  #Specifying the *targetUserId* is beneficial because:
-  #
-  #* It makes the recommendations personalized
-  #* Allows the calculation of Actions and Conversions
-  #  in the graphical user interface,
-  #  as Recombee can pair the user who got recommendations
-  #  and who afterward viewed/purchased an item.
-  #
-  #If you insist on not specifying the user, pass `null`
-  #(`None`, `nil`, `NULL` etc., depending on the language) to *targetUserId*.
-  #Do not create some special dummy user for getting recommendations,
-  #as it could mislead the recommendation models,
-  #and result in wrong recommendations.
-  #
-  #For anonymous/unregistered users, it is possible to use, for example, their session ID.
-  #
-  #   - +count+ -> Number of item segments to be recommended (N for the top-N recommendation).
-  #
-  #
-  # * *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 :item_id, :target_user_id, :count, :scenario, :cascade_create, :filter, :booster, :logic,
+                :expert_settings, :return_ab_group, :reql_expressions
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +item_id+ -> ID of the item for which the recommendations are to be generated.
+    #   - +target_user_id+ -> ID of the user who will see the recommendations.
+    #
+    # Specifying the *targetUserId* is beneficial because:
+    #
+    # * It makes the recommendations personalized
+    # * Allows the calculation of Actions and Conversions
+    #  in the graphical user interface,
+    #  as Recombee can pair the user who got recommendations
+    #  and who afterward viewed/purchased an item.
+    #
+    # If you insist on not specifying the user, pass `null`
+    # (`None`, `nil`, `NULL` etc., depending on the language) to *targetUserId*.
+    # Do not create some special dummy user for getting recommendations,
+    # as it could mislead the recommendation models,
+    # and result in wrong recommendations.
+    #
+    # For anonymous/unregistered users, it is possible to use, for example, their session ID.
+    #
+    #   - +count+ -> Number of item segments to be recommended (N for the top-N recommendation).
+    #
+    #
+    # * *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(item_id, target_user_id, count, optional = {})
       @item_id = item_id
       @target_user_id = target_user_id
       @count = count
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @scenario = optional['scenario']
       @cascade_create = optional['cascadeCreate']
       @filter = optional['filter']
@@ -88,22 +125,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['targetUserId'] = @target_user_id
       p['count'] = @count
       p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
@@ -113,16 +152,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}/recomms/items/#{@item_id}/item-segments/"