RubyGems - recombee_api_client - Versions diffs - 4.1.0 → 5.1.0 - Mend

recombee_api_client 4.1.0 → 5.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (61) hide show

data/lib/recombee_api_client/api/recommend_item_segments_to_user.rb CHANGED Viewed

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   ##
-  #Recommends the top Segments from a Segmentation for a particular user, based on the user's past interactions.
+  #Recommends the top Segments from a [Segmentation](https://docs.recombee.com/segmentations) for a particular user, based on the user's past interactions.
   #
   #Based on the used Segmentation, this endpoint can be used for example for:
   #
@@ -16,7 +16,7 @@ module RecombeeApiClient
   #  - Recommending the top brands for the user
   #  - Recommending the top artists for the user
   #
-  #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](https://docs.recombee.com/scenarios) prior to using this endpoint.
   #
   #The returned segments are sorted by relevance (first segment being the most relevant).
   #
@@ -36,22 +36,22 @@ module RecombeeApiClient
   # * *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.html) 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.
+  #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.html) expression which allows you to filter recommended segments based on the `segmentationId`.
+  #   - +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.html) expression which allows you to boost recommendation rate of some 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.html) for a list of available logics and other details.
+  #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.html) in the [Admin UI](https://admin.recombee.com).
+  #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.
   #

data/lib/recombee_api_client/api/recommend_items_to_item.rb CHANGED Viewed

@@ -13,8 +13,8 @@ module RecombeeApiClient
   #
   #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.html#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.html#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.
   #
@@ -49,7 +49,7 @@ module RecombeeApiClient
   # * *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.html) 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.
+  #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.
   #
@@ -57,7 +57,7 @@ module RecombeeApiClient
   #   - +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": "0c6189e7-dc1a-429a-b613-192696309361",
   #    "recomms":
@@ -88,7 +88,7 @@ module RecombeeApiClient
   #   - +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": "6842c725-a79f-4537-a02c-f34d668a3f80",
   #    "recomms":
@@ -112,30 +112,30 @@ module RecombeeApiClient
   #  }
   #```
   #
-  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter recommended items based on the values of their attributes.
+  #   - +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.html) in the [Admin UI](https://admin.recombee.com).
+  #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.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
+  #   - +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.html) in the [Admin UI](https://admin.recombee.com).
+  #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.html) for a list of available logics and other details.
+  #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.html) in the [Admin UI](https://admin.recombee.com).
+  #Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
   #
-  #   - +userImpact+ -> **Expert option** If *targetUserId* parameter is present, the recommendations are biased towards the given user. Using *userImpact*, you may control this bias. For an extreme case of `userImpact=0.0`, the interactions made by the user are not taken into account at all (with the exception of history-based blacklisting), for `userImpact=1.0`, you'll get a user-based recommendation. The default value is `0`.
+  #   - +userImpact+ -> **Expert option:** If *targetUserId* parameter is present, the recommendations are biased towards the given user. Using *userImpact*, you may control this bias. For an extreme case of `userImpact=0.0`, the interactions made by the user are not taken into account at all (with the exception of history-based blacklisting), for `userImpact=1.0`, you'll get a user-based recommendation. The default value is `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.
+  #   - +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** If the *targetUserId* is provided:  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 being appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such 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.
+  #   - +minRelevance+ -> **Expert option:** If the *targetUserId* is provided:  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 being appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such 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 the *targetUserId* is provided: 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.
+  #   - +rotationRate+ -> **Expert option:** If the *targetUserId* is provided: 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.
   #
-  #   - +rotationTime+ -> **Expert option** If the *targetUserId* is provided: 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.
+  #   - +rotationTime+ -> **Expert option:** If the *targetUserId* is provided: 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.
   #
   #   - +expertSettings+ -> Dictionary of custom options.
   #

data/lib/recombee_api_client/api/recommend_items_to_item_segment.rb ADDED Viewed

@@ -0,0 +1,207 @@
+#
+# This file is auto-generated, do not edit
+#
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  ##
+  #Recommends Items that are the most relevant to a particular Segment from a context [Segmentation](https://docs.recombee.com/segmentations).
+  #
+  #Based on the used Segmentation, this endpoint can be used for example for:
+  #
+  #- Recommending articles related to a particular topic
+  #- Recommending songs belonging to a particular genre
+  #- Recommending products produced by a particular brand
+  #
+  #You need to set the used context Segmentation in the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.
+  #
+  #The returned items are sorted by relevance (the first item being the most relevant).
+  #
+  #It is also possible to use the POST HTTP method (for example, in the case of a very long ReQL filter) — query parameters then become body parameters.
+  #
+  class RecommendItemsToItemSegment < ApiRequest
+    attr_reader :context_segment_id, :target_user_id, :count, :scenario, :cascade_create, :return_properties, :included_properties, :filter, :booster, :logic, :min_relevance, :rotation_rate, :rotation_time, :expert_settings, :return_ab_group
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  ##
+  # * *Required arguments*
+  #   - +context_segment_id+ -> ID of the segment from `contextSegmentationId` 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 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 a user of the given *targetUserId* doesn't exist in the database, it creates this user and returns some (non-personalized) recommendations. This allows, for example, rotations in the following recommendations for the user of the given *targetUserId*, 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": "0c6189e7-dc1a-429a-b613-192696309361",
+  #    "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": "6842c725-a79f-4537-a02c-f34d668a3f80",
+  #    "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).
+  #
+  #   - +minRelevance+ -> **Expert option:** If the *targetUserId* is provided:  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 being appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such 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 the *targetUserId* is provided: 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.
+  #
+  #   - +rotationTime+ -> **Expert option:** If the *targetUserId* is provided: 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.
+  #
+  #   - +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(context_segment_id, target_user_id, count, optional = {})
+      @context_segment_id = context_segment_id
+      @target_user_id = target_user_id
+      @count = count
+      optional = normalize_optional(optional)
+      @scenario = optional['scenario']
+      @cascade_create = optional['cascadeCreate']
+      @return_properties = optional['returnProperties']
+      @included_properties = optional['includedProperties']
+      @filter = optional['filter']
+      @booster = optional['booster']
+      @logic = optional['logic']
+      @min_relevance = optional['minRelevance']
+      @rotation_rate = optional['rotationRate']
+      @rotation_time = optional['rotationTime']
+      @expert_settings = optional['expertSettings']
+      @return_ab_group = optional['returnAbGroup']
+      @optional = optional
+      @timeout = 3000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["scenario","cascadeCreate","returnProperties","includedProperties","filter","booster","logic","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['contextSegmentId'] = @context_segment_id
+      p['targetUserId'] = @target_user_id
+      p['count'] = @count
+      p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
+      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['returnProperties'] = @optional['returnProperties'] if @optional.include? 'returnProperties'
+      p['includedProperties'] = @optional['includedProperties'] if @optional.include? 'includedProperties'
+      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['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/item-segments/items/"
+    end
+  end
+end

data/lib/recombee_api_client/api/recommend_items_to_user.rb CHANGED Viewed

@@ -15,8 +15,8 @@ module RecombeeApiClient
   #
   #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.html#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.html#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.
   #
@@ -34,7 +34,7 @@ module RecombeeApiClient
   # * *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.html) 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.
+  #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.
   #
@@ -43,7 +43,7 @@ module RecombeeApiClient
   #   - +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":
@@ -74,7 +74,7 @@ module RecombeeApiClient
   #   - +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":
@@ -98,28 +98,28 @@ module RecombeeApiClient
   #  }
   #```
   #
-  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter recommended items based on the values of their attributes.
+  #   - +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.html) in the [Admin UI](https://admin.recombee.com).
+  #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.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
+  #   - +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.html) in the [Admin UI](https://admin.recombee.com).
+  #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.html) for a list of available logics and other details.
+  #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.html) in the [Admin UI](https://admin.recombee.com).
+  #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.
+  #   - +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.
+  #   - +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`.
+  #   - +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`.
+  #   - +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.
   #

data/lib/recombee_api_client/api/recommend_next_items.rb CHANGED Viewed

@@ -11,9 +11,10 @@ module RecombeeApiClient
   #
   #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.html#recommend-items-to-item)
-  #  - [Recommend items to user](https://docs.recombee.com/api.html#recommend-items-to-user)
-  #  - [Search items](https://docs.recombee.com/api.html#search-items)
+  #  - [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.
   #

data/lib/recombee_api_client/api/recommend_users_to_item.rb CHANGED Viewed

@@ -26,7 +26,7 @@ module RecombeeApiClient
   # * *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.html) 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.
+  #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.
   #
@@ -34,7 +34,7 @@ module RecombeeApiClient
   #   - +returnProperties+ -> With `returnProperties=true`, property values of the recommended users are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended users.
   #
   #Example response:
-  #```
+  #```json
   #  {
   #    "recommId": "039b71dc-b9cc-4645-a84f-62b841eecfce",
   #    "recomms":
@@ -61,7 +61,7 @@ module RecombeeApiClient
   #   - +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
   #  {
   #    "recommId": "b2b355dd-972a-4728-9c6b-2dc229db0678",
   #    "recomms":
@@ -83,22 +83,22 @@ module RecombeeApiClient
   #  }
   #```
   #
-  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter recommended items based on the values of their attributes.
+  #   - +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.html) in the [Admin UI](https://admin.recombee.com).
+  #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.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
+  #   - +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.html) in the [Admin UI](https://admin.recombee.com).
+  #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.html) for a list of available logics and other details.
+  #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.html) in the [Admin UI](https://admin.recombee.com).
+  #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.
+  #   - +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.
   #
   #   - +expertSettings+ -> Dictionary of custom options.
   #

data/lib/recombee_api_client/api/recommend_users_to_user.rb CHANGED Viewed

@@ -26,7 +26,7 @@ module RecombeeApiClient
   # * *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.html) 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.
+  #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.
   #
@@ -34,7 +34,7 @@ module RecombeeApiClient
   #   - +returnProperties+ -> With `returnProperties=true`, property values of the recommended users are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended users.
   #
   #Example response:
-  #```
+  #```json
   #  {
   #    "recommId": "9cb9c55d-50ba-4478-84fd-ab456136156e",
   #    "recomms":
@@ -61,7 +61,7 @@ module RecombeeApiClient
   #   - +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
   #  {
   #    "recommId": "b326d82d-5d57-4b45-b362-c9d6f0895855",
   #    "recomms":
@@ -83,28 +83,28 @@ module RecombeeApiClient
   #  }
   #```
   #
-  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter recommended items based on the values of their attributes.
+  #   - +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.html) in the [Admin UI](https://admin.recombee.com).
+  #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.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
+  #   - +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.html) in the [Admin UI](https://admin.recombee.com).
+  #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.html) for a list of available logics and other details.
+  #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.html) in the [Admin UI](https://admin.recombee.com).
+  #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 users should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
+  #   - +diversity+ -> **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended users 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 users be. Possible values one of: "low", "medium", "high".
+  #   - +minRelevance+ -> **Expert option:** Specifies the threshold of how relevant must the recommended users be. Possible values one of: "low", "medium", "high".
   #
-  #   - +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 a user 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 users.
+  #   - +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 a user 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 users.
   #
-  #   - +rotationTime+ -> **Expert option** Taking *rotationRate* into account, specifies how long it takes for a user to recover from the penalization. For example, `rotationTime=7200.0` means that users recommended less than 2 hours ago are penalized.
+  #   - +rotationTime+ -> **Expert option:** Taking *rotationRate* into account, specifies how long it takes for a user to recover from the penalization. For example, `rotationTime=7200.0` means that users recommended less than 2 hours ago are penalized.
   #
   #   - +expertSettings+ -> Dictionary of custom options.
   #

data/lib/recombee_api_client/api/remove_from_series.rb CHANGED Viewed

@@ -9,7 +9,7 @@ module RecombeeApiClient
   ##
   #Removes an existing series item from the series.
   class RemoveFromSeries < ApiRequest
-    attr_reader :series_id, :item_type, :item_id, :time
+    attr_reader :series_id, :item_type, :item_id
     attr_accessor :timeout
     attr_accessor :ensure_https
@@ -18,14 +18,12 @@ module RecombeeApiClient
   #   - +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`.
-  #   - +time+ -> Time index of the item to be removed.
   #
-    def initialize(series_id, item_type, item_id, time)
+    def initialize(series_id, item_type, item_id)
       @series_id = series_id
       @item_type = item_type
       @item_id = item_id
-      @time = time
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
@@ -37,6 +35,8 @@ module RecombeeApiClient
     # Values of body parameters as a Hash
     def body_parameters
       p = Hash.new
+      p['itemType'] = @item_type
+      p['itemId'] = @item_id
       p
     end
@@ -44,9 +44,6 @@ module RecombeeApiClient
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
-      params['itemType'] = @item_type
-      params['itemId'] = @item_id
-      params['time'] = @time
       params
     end