recombee_api_client 5.1.0 → 6.0.0

data/lib/recombee_api_client/api/recommend_items_to_user.rb

@@ -5,131 +5,171 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Based on the user's past interactions (purchases, ratings, etc.) with the items, recommends top-N items that are most likely to be of high value for the given user.
+  # Based on the user's past interactions (purchases, ratings, etc.) with the items, recommends top-N items that are most likely to be of high value for the given user.
   #
-  #The most typical use cases are recommendations on the homepage, in some "Picked just for you" section, or in email.
+  # The most typical use cases are recommendations on the homepage, in some "Picked just for you" section, or in email.
   #
-  #The returned items are sorted by relevance (the first item being the most relevant).
+  # The returned items are sorted by relevance (the first item being the most relevant).
   #
-  #Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
+  # Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
   #
-  #- Let Recombee know that this recommendation was successful (e.g., user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui#reported-metrics).
-  #- Get subsequent recommended items when the user scrolls down (*infinite scroll*) or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api#recommend-next-items).
+  # - Let Recombee know that this recommendation was successful (e.g., user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui#reported-metrics).
+  # - Get subsequent recommended items when the user scrolls down (*infinite scroll*) or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api#recommend-next-items).
   #
-  #It is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.
+  # It is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.
   #
   class RecommendItemsToUser < ApiRequest
-    attr_reader :user_id, :count, :scenario, :cascade_create, :return_properties, :included_properties, :filter, :booster, :logic, :diversity, :min_relevance, :rotation_rate, :rotation_time, :expert_settings, :return_ab_group
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> ID of the user for whom personalized recommendations are to be generated.
-  #   - +count+ -> Number of items 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.
-  #
-  #   - +returnProperties+ -> With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user. 
-  #
-  #Example response:
-  #```json
-  #  {
-  #    "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
-  #    "recomms": 
-  #      [
-  #        {
-  #          "id": "tv-178",
-  #          "values": {
-  #            "description": "4K TV with 3D feature",
-  #            "categories":   ["Electronics", "Televisions"],
-  #            "price": 342,
-  #            "url": "myshop.com/tv-178"
-  #          }
-  #        },
-  #        {
-  #          "id": "mixer-42",
-  #          "values": {
-  #            "description": "Stainless Steel Mixer",
-  #            "categories":   ["Home & Kitchen"],
-  #            "price": 39,
-  #            "url": "myshop.com/mixer-42"
-  #          }
-  #        }
-  #      ],
-  #     "numberNextRecommsCalls": 0
-  #  }
-  #```
-  #
-  #   - +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=description,price`:
-  #```json
-  #  {
-  #    "recommId": "a86ee8d5-cd8e-46d1-886c-8b3771d0520b",
-  #    "recomms":
-  #      [
-  #        {
-  #          "id": "tv-178",
-  #          "values": {
-  #            "description": "4K TV with 3D feature",
-  #            "price": 342
-  #          }
-  #        },
-  #        {
-  #          "id": "mixer-42",
-  #          "values": {
-  #            "description": "Stainless Steel Mixer",
-  #            "price": 39
-  #          }
-  #        }
-  #      ],
-  #    "numberNextRecommsCalls": 0
-  #  }
-  #```
-  #
-  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes.
-  #
-  #Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
-  #
-  #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
-  #
-  #Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
-  #
-  #   - +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).
-  #
-  #   - +diversity+ -> **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended items should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
-  #
-  #   - +minRelevance+ -> **Expert option:** Specifies the threshold of how relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend a number of items equal to *count* at any cost. If there is not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such a case, the system only recommends items of at least the requested relevance and may return less than *count* items when there is not enough data to fulfill it.
-  #
-  #   - +rotationRate+ -> **Expert option:** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per request in a backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example, `rotationRate=0.2` for only slight rotation of recommended items. Default: `0`.
-  #
-  #   - +rotationTime+ -> **Expert option:** Taking *rotationRate* into account, specifies how long it takes for an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.
-  #
-  #   - +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, :count, :scenario, :cascade_create, :return_properties, :included_properties, :filter,
+                :booster, :logic, :reql_expressions, :diversity, :min_relevance, :rotation_rate, :rotation_time, :expert_settings, :return_ab_group
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> ID of the user for whom personalized recommendations are to be generated.
+    #   - +count+ -> Number of items 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.
+    #
+    #   - +returnProperties+ -> With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user.
+    #
+    # Example response:
+    # ```json
+    #  {
+    #    "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
+    #    "recomms":
+    #      [
+    #        {
+    #          "id": "tv-178",
+    #          "values": {
+    #            "description": "4K TV with 3D feature",
+    #            "categories":   ["Electronics", "Televisions"],
+    #            "price": 342,
+    #            "url": "myshop.com/tv-178"
+    #          }
+    #        },
+    #        {
+    #          "id": "mixer-42",
+    #          "values": {
+    #            "description": "Stainless Steel Mixer",
+    #            "categories":   ["Home & Kitchen"],
+    #            "price": 39,
+    #            "url": "myshop.com/mixer-42"
+    #          }
+    #        }
+    #      ],
+    #     "numberNextRecommsCalls": 0
+    #  }
+    # ```
+    #
+    #   - +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=description,price`:
+    # ```json
+    #  {
+    #    "recommId": "a86ee8d5-cd8e-46d1-886c-8b3771d0520b",
+    #    "recomms":
+    #      [
+    #        {
+    #          "id": "tv-178",
+    #          "values": {
+    #            "description": "4K TV with 3D feature",
+    #            "price": 342
+    #          }
+    #        },
+    #        {
+    #          "id": "mixer-42",
+    #          "values": {
+    #            "description": "Stainless Steel Mixer",
+    #            "price": 39
+    #          }
+    #        }
+    #      ],
+    #    "numberNextRecommsCalls": 0
+    #  }
+    # ```
+    #
+    #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes.
+    #
+    # Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
+    #
+    #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
+    #
+    # Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
+    #
+    #   - +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).
+    #
+    #   - +reqlExpressions+ -> A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended item.
+    # This can be used to compute additional properties of the recommended items that are not stored in the database.
+    #
+    # The keys are the names of the expressions, and the values are the actual ReQL expressions.
+    #
+    # Example request:
+    # ```json
+    # {
+    #  "reqlExpressions": {
+    #    "isInUsersCity": "context_user[\"city\"] in 'cities'",
+    #    "distanceToUser": "earth_distance('location', context_user[\"location\"])"
+    #  }
+    # }
+    # ```
+    #
+    # Example response:
+    # ```json
+    # {
+    #  "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
+    #  "recomms":
+    #    [
+    #      {
+    #        "id": "restaurant-178",
+    #        "reqlEvaluations": {
+    #          "isInUsersCity": true,
+    #          "distanceToUser": 5200.2
+    #        }
+    #      },
+    #      {
+    #        "id": "bar-42",
+    #        "reqlEvaluations": {
+    #          "isInUsersCity": false,
+    #          "distanceToUser": 2516.0
+    #        }
+    #      }
+    #    ],
+    #   "numberNextRecommsCalls": 0
+    # }
+    # ```
+    #
+    #   - +diversity+ -> **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended items should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
+    #
+    #   - +minRelevance+ -> **Expert option:** Specifies the threshold of how relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend a number of items equal to *count* at any cost. If there is not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such a case, the system only recommends items of at least the requested relevance and may return less than *count* items when there is not enough data to fulfill it.
+    #
+    #   - +rotationRate+ -> **Expert option:** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per request in a backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example, `rotationRate=0.2` for only slight rotation of recommended items. Default: `0`.
+    #
+    #   - +rotationTime+ -> **Expert option:** Taking *rotationRate* into account, specifies how long it takes for an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.
+    #
+    #   - +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.
+    #
+    #
     def initialize(user_id, count, optional = {})
       @user_id = user_id
       @count = count
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @scenario = optional['scenario']
       @cascade_create = optional['cascadeCreate']
       @return_properties = optional['returnProperties']
@@ -137,6 +177,7 @@ module RecombeeApiClient
       @filter = optional['filter']
       @booster = optional['booster']
       @logic = optional['logic']
+      @reql_expressions = optional['reqlExpressions']
       @diversity = optional['diversity']
       @min_relevance = optional['minRelevance']
       @rotation_rate = optional['rotationRate']
@@ -147,18 +188,19 @@ module RecombeeApiClient
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["scenario","cascadeCreate","returnProperties","includedProperties","filter","booster","logic","diversity","minRelevance","rotationRate","rotationTime","expertSettings","returnAbGroup"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[scenario cascadeCreate returnProperties
+                                                          includedProperties filter booster logic reqlExpressions diversity minRelevance rotationRate rotationTime expertSettings returnAbGroup].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['count'] = @count
       p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
@@ -167,22 +209,23 @@ module RecombeeApiClient
       p['filter'] = @optional['filter'] if @optional.include? 'filter'
       p['booster'] = @optional['booster'] if @optional.include? 'booster'
       p['logic'] = @optional['logic'] if @optional.include? 'logic'
+      p['reqlExpressions'] = @optional['reqlExpressions'] if @optional.include? 'reqlExpressions'
       p['diversity'] = @optional['diversity'] if @optional.include? 'diversity'
       p['minRelevance'] = @optional['minRelevance'] if @optional.include? 'minRelevance'
       p['rotationRate'] = @optional['rotationRate'] if @optional.include? 'rotationRate'
       p['rotationTime'] = @optional['rotationTime'] if @optional.include? 'rotationTime'
       p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
       p['returnAbGroup'] = @optional['returnAbGroup'] if @optional.include? 'returnAbGroup'
+
       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/users/#{@user_id}/items/"

data/lib/recombee_api_client/api/recommend_next_items.rb

@@ -5,63 +5,62 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Returns items 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.
+  # Returns items 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 items that shall be returned (`count`).
-  #The base request can be one of:
+  # It accepts `recommId` of a base recommendation request (e.g., request from the first page) and the number of items that shall be returned (`count`).
+  # The base request can be one of:
   #  - [Recommend Items to Item](https://docs.recombee.com/api#recommend-items-to-item)
   #  - [Recommend Items to User](https://docs.recombee.com/api#recommend-items-to-user)
   #  - [Recommend Items to Item Segment](https://docs.recombee.com/api#recommend-items-to-item-segment)
   #  - [Search Items](https://docs.recombee.com/api#search-items)
   #
-  #All the other parameters are inherited from the base request.
+  # All the other parameters are inherited from the base request.
   #
-  #*Recommend next items* can be called many times for a single `recommId` and each call returns different (previously not recommended) items.
-  #The number of *Recommend next items* calls performed so far is returned in the `numberNextRecommsCalls` field.
+  # *Recommend next items* can be called many times for a single `recommId` and each call returns different (previously not recommended) items.
+  # The number of *Recommend next items* calls performed so far is returned in the `numberNextRecommsCalls` field.
   #
-  #*Recommend next items* can be requested up to 30 minutes after the base request or a previous *Recommend next items* call.
+  # *Recommend next items* can be requested up to 30 minutes after the base request or a previous *Recommend next items* call.
   #
-  #For billing purposes, each call to *Recommend next items* is counted as a separate recommendation request.
+  # For billing purposes, each call to *Recommend next items* is counted as a separate recommendation request.
   #
   class RecommendNextItems < ApiRequest
     attr_reader :recomm_id, :count
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +recomm_id+ -> ID of the base recommendation request for which next recommendations should be returned
-  #   - +count+ -> Number of items to be recommended
-  #
-  #
+    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 items 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 = Hash.new
+      p = {}
       p['count'] = @count
+
       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/next/items/#{@recomm_id}"