recombee-api-client 5.0.2__tar.gz → 5.1.0__tar.gz

recombee_api_client-5.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Recombee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: recombee-api-client
-Version: 5.0.2
+Version: 5.1.0
 Summary: Client for Recombee recommendation API
 Home-page: https://github.com/Recombee/python-api-client
 Author: Recombee
@@ -20,6 +20,19 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.6
+License-File: LICENSE
+Requires-Dist: requests>=2.20.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 *****************
 RecombeeApiClient

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_client.py

@@ -94,7 +94,7 @@ class RecombeeClient:
 
     @staticmethod
     def __get_http_headers(additional_headers: dict = None) -> dict:
-        headers = {'User-Agent': 'recombee-python-api-client/5.0.2'}
+        headers = {'User-Agent': 'recombee-python-api-client/5.1.0'}
         if additional_headers:
             headers.update(additional_headers)
         return headers

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/__init__.py

@@ -76,6 +76,7 @@ from recombee_api_client.api_requests.delete_manual_reql_segment import DeleteMa
 from recombee_api_client.api_requests.list_segmentations import ListSegmentations
 from recombee_api_client.api_requests.get_segmentation import GetSegmentation
 from recombee_api_client.api_requests.delete_segmentation import DeleteSegmentation
-from recombee_api_client.api_requests.reset_database import ResetDatabase
 from recombee_api_client.api_requests.batch import Batch
+from recombee_api_client.api_requests.list_scenarios import ListScenarios
+from recombee_api_client.api_requests.reset_database import ResetDatabase
 from recombee_api_client.api_requests.request import Request

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/add_manual_reql_segment.py

@@ -8,7 +8,7 @@ class AddManualReqlSegment(Request):
     """
     Adds a new Segment into a Manual ReQL Segmentation.
     
-    The new Segment is defined by a [ReQL](https://docs.recombee.com/reql.html) filter that returns `true` for an item in case that this item belongs to the segment.
+    The new Segment is defined by a [ReQL](https://docs.recombee.com/reql) filter that returns `true` for an item in case that this item belongs to the segment.
     
     Required parameters:
     

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/add_search_synonym.py

@@ -6,7 +6,7 @@ DEFAULT = uuid.uuid4()
 
 class AddSearchSynonym(Request):
     """
-    Adds a new synonym for the [Search items](https://docs.recombee.com/api.html#search-items).
+    Adds a new synonym for the [Search items](https://docs.recombee.com/api#search-items).
     
     When the `term` is used in the search query, the `synonym` is also used for the full-text search.
     Unless `oneWay=true`, it works also in the opposite way (`synonym` -> `term`).

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/create_auto_reql_segmentation.py

@@ -6,7 +6,7 @@ DEFAULT = uuid.uuid4()
 
 class CreateAutoReqlSegmentation(Request):
     """
-    Segment the items using a [ReQL](https://docs.recombee.com/reql.html) expression.
+    Segment the items using a [ReQL](https://docs.recombee.com/reql) expression.
     
     For each item, the expression should return a set that contains IDs of segments to which the item belongs to.
     

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/create_manual_reql_segmentation.py

@@ -6,7 +6,7 @@ DEFAULT = uuid.uuid4()
 
 class CreateManualReqlSegmentation(Request):
     """
-    Segment the items using multiple [ReQL](https://docs.recombee.com/reql.html) filters.
+    Segment the items using multiple [ReQL](https://docs.recombee.com/reql) filters.
     
     Use the Add Manual ReQL Items Segment endpoint to create the individual segments.
     

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/delete_item.py

@@ -10,7 +10,7 @@ class DeleteItem(Request):
     
     If there are any *purchases*, *ratings*, *bookmarks*, *cart additions*, or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
     
-    If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
+    If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.
     
     Required parameters:
     

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/delete_more_items.py

@@ -8,10 +8,10 @@ class DeleteMoreItems(Request):
     """
     Deletes all the items that pass the filter.
     
-    If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
+    If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.
     Required parameters:
     
-    :param filter: A [ReQL](https://docs.recombee.com/reql.html) expression, which returns `true` for the items that shall be updated.
+    :param filter: A [ReQL](https://docs.recombee.com/reql) expression, which returns `true` for the items that shall be updated.
     
 
     """

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/delete_search_synonym.py

@@ -6,7 +6,7 @@ DEFAULT = uuid.uuid4()
 
 class DeleteSearchSynonym(Request):
     """
-    Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
+    Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api#search-items).
     
     Required parameters:
     

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/list_items.py

@@ -10,7 +10,7 @@ class ListItems(Request):
     
     Optional parameters:
     
-    :param filter: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter items to be listed. Only the items for which the expression is *true* will be returned.
+    :param filter: Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter items to be listed. Only the items for which the expression is *true* will be returned.
     
     :param count: The number of items to be listed.
     

recombee_api_client-5.1.0/recombee_api_client/api_requests/list_scenarios.py

@@ -0,0 +1,29 @@
+from recombee_api_client.api_requests.request import Request
+from typing import Union, List
+import uuid
+
+DEFAULT = uuid.uuid4()
+
+class ListScenarios(Request):
+    """
+    Get all [Scenarios](https://docs.recombee.com/scenarios) of the given database.
+    
+
+    """
+
+    def __init__(self):
+        super().__init__(path="/scenarios/", method='get', timeout=10000, ensure_https=False)
+
+    def get_body_parameters(self) -> dict:
+        """
+        Values of body parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        p = dict()
+        return p
+
+    def get_query_parameters(self) -> dict:
+        """
+        Values of query parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        params = dict()
+        return params

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/list_users.py

@@ -10,7 +10,7 @@ class ListUsers(Request):
     
     Optional parameters:
     
-    :param filter: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter users to be listed. Only the users for which the expression is *true* will be returned.
+    :param 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.
     
     :param count: The number of users to be listed.
     

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/merge_users.py

@@ -11,6 +11,9 @@ class MergeUsers(Request):
     
     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.
+    
     Required parameters:
     
     :param target_user_id: ID of the target user.

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/recommend_item_segments_to_item.py

@@ -6,7 +6,7 @@ DEFAULT = uuid.uuid4()
 
 class RecommendItemSegmentsToItem(Request):
     """
-    Recommends Segments from a [Segmentation](https://docs.recombee.com/segmentations.html) 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:
     
@@ -65,7 +65,7 @@ class RecommendItemSegmentsToItem(Request):
     :param 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.
@@ -74,21 +74,21 @@ class RecommendItemSegmentsToItem(Request):
     :param cascade_create: 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.
     
     
-    :param filter: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended segments based on the `segmentationId`.
+    :param filter: Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
     
     
-    :param 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`.
+    :param booster: Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
     
     
     :param 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).
     
     
     :param expert_settings: Dictionary of custom options.

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/recommend_item_segments_to_item_segment.py

@@ -6,7 +6,7 @@ DEFAULT = uuid.uuid4()
 
 class RecommendItemSegmentsToItemSegment(Request):
     """
-    Recommends Segments from a result [Segmentation](https://docs.recombee.com/segmentations.html) that are the most relevant to a particular Segment from a context Segmentation.
+    Recommends Segments from a result [Segmentation](https://docs.recombee.com/segmentations) that are the most relevant to a particular Segment from a context Segmentation.
     
     Based on the used Segmentations, this endpoint can be used for example for:
     
@@ -64,7 +64,7 @@ class RecommendItemSegmentsToItemSegment(Request):
     :param 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.
@@ -73,21 +73,21 @@ class RecommendItemSegmentsToItemSegment(Request):
     :param cascade_create: 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.
     
     
-    :param filter: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended segments based on the `segmentationId`.
+    :param filter: Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
     
     
-    :param 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`.
+    :param booster: Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
     
     
     :param 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).
     
     
     :param expert_settings: Dictionary of custom options.

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/recommend_item_segments_to_user.py

@@ -6,7 +6,7 @@ DEFAULT = uuid.uuid4()
 
 class RecommendItemSegmentsToUser(Request):
     """
-    Recommends the top Segments from a [Segmentation](https://docs.recombee.com/segmentations.html) 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:
     
@@ -34,7 +34,7 @@ class RecommendItemSegmentsToUser(Request):
     :param 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,21 +43,21 @@ class RecommendItemSegmentsToUser(Request):
     :param cascade_create: 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.
     
     
-    :param filter: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended segments based on the `segmentationId`.
+    :param filter: Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
     
     
-    :param 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`.
+    :param booster: Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
     
     
     :param 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).
     
     
     :param expert_settings: Dictionary of custom options.

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/recommend_items_to_item.py

@@ -12,8 +12,8 @@ class RecommendItemsToItem(Request):
     
     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.
     
@@ -60,7 +60,7 @@ class RecommendItemsToItem(Request):
     :param 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.
@@ -170,42 +170,42 @@ class RecommendItemsToItem(Request):
     ```
     
     
-    :param 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.
+    :param 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).
     
     
-    :param 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.
+    :param 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).
     
     
     :param 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).
     
     
-    :param user_impact: **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`.
+    :param user_impact: **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`.
     
     
-    :param 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.
+    :param 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.
     
     
-    :param min_relevance: **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.
+    :param min_relevance: **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.
     
     
-    :param rotation_rate: **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.
+    :param rotation_rate: **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.
     
     
-    :param rotation_time: **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.
+    :param rotation_time: **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.
     
     
     :param expert_settings: Dictionary of custom options.

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/recommend_items_to_item_segment.py

@@ -6,7 +6,7 @@ DEFAULT = uuid.uuid4()
 
 class RecommendItemsToItemSegment(Request):
     """
-    Recommends Items that are the most relevant to a particular Segment from a context [Segmentation](https://docs.recombee.com/segmentations.html).
+    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:
     
@@ -63,13 +63,13 @@ class RecommendItemsToItemSegment(Request):
     :param 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.
     
     
-    :param cascade_create: If an item of the given *itemId* or user of the given *targetUserId* doesn't exist in the database, it creates the missing entity/entities 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.
+    :param cascade_create: 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.
     
     :param return_properties: 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. 
     
@@ -173,36 +173,36 @@ class RecommendItemsToItemSegment(Request):
     ```
     
     
-    :param 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.
+    :param 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).
     
     
-    :param 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.
+    :param 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).
     
     
     :param 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).
     
     
-    :param min_relevance: **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.
+    :param min_relevance: **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.
     
     
-    :param rotation_rate: **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.
+    :param rotation_rate: **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.
     
     
-    :param rotation_time: **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.
+    :param rotation_time: **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.
     
     
     :param expert_settings: Dictionary of custom options.

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/recommend_items_to_user.py

@@ -14,8 +14,8 @@ class RecommendItemsToUser(Request):
     
     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.
     
@@ -32,7 +32,7 @@ class RecommendItemsToUser(Request):
     :param 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.
@@ -143,39 +143,39 @@ class RecommendItemsToUser(Request):
     ```
     
     
-    :param 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.
+    :param 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).
     
     
-    :param 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.
+    :param 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).
     
     
     :param 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).
     
     
-    :param 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.
+    :param 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.
     
     
-    :param min_relevance: **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.
+    :param min_relevance: **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.
     
     
-    :param rotation_rate: **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`.
+    :param rotation_rate: **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`.
     
     
-    :param rotation_time: **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`.
+    :param rotation_time: **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`.
     
     
     :param expert_settings: Dictionary of custom options.

{recombee-api-client-5.0.2 → recombee_api_client-5.1.0}/recombee_api_client/api_requests/recommend_next_items.py

@@ -10,10 +10,10 @@ class RecommendNextItems(Request):
     
     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)
-      - [Recommend Items to Item Segment](https://docs.recombee.com/api.html#recommend-items-to-item-segment)
-      - [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.