recombee-api-client 6.0.0__tar.gz → 6.2.0__tar.gz

{recombee_api_client-6.0.0 → recombee_api_client-6.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: recombee-api-client
-Version: 6.0.0
+Version: 6.2.0
 Summary: Client for Recombee recommendation API
 Home-page: https://github.com/Recombee/python-api-client
 Author: Recombee

{recombee_api_client-6.0.0 → recombee_api_client-6.2.0}/recombee_api_client/api_client.py

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

{recombee_api_client-6.0.0 → recombee_api_client-6.2.0}/recombee_api_client/api_requests/__init__.py

@@ -82,6 +82,9 @@ from recombee_api_client.api_requests.recommend_item_segments_to_item import (
 from recombee_api_client.api_requests.recommend_item_segments_to_item_segment import (
     RecommendItemSegmentsToItemSegment,
 )
+from recombee_api_client.api_requests.recommend_next_item_segments import (
+    RecommendNextItemSegments,
+)
 from recombee_api_client.api_requests.composite_recommendation import (
     CompositeRecommendation,
 )

{recombee_api_client-6.0.0 → recombee_api_client-6.2.0}/recombee_api_client/api_requests/composite_recommendation.py

@@ -13,7 +13,7 @@ DEFAULT = uuid.uuid4()
 
 class CompositeRecommendation(Request):
     """
-    Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations.html)) and a list of related recommendations in a single response.
+    Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations)) and a list of related recommendations in a single response.
 
     It is ideal for use cases such as personalized homepage sections (*Articles from <category>*), *Because You Watched <movie>*, or *Artists Related to Your Favorite Artist <artist>*.
 
@@ -79,6 +79,9 @@ class CompositeRecommendation(Request):
     :param segment_id: ID of the segment from `contextSegmentationId` for which the recommendations are to be generated.
 
 
+    :param search_query: Search query provided by the user. It is used for the full-text search. Only applicable if the *scenario* corresponds to a search scenario.
+
+
     :param cascade_create: If the entity for the source recommendation 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 entity, as the entity will be already known to the system.
 
 
@@ -101,6 +104,7 @@ class CompositeRecommendation(Request):
         user_id: str = DEFAULT,
         logic: Logic = DEFAULT,
         segment_id: str = DEFAULT,
+        search_query: str = DEFAULT,
         cascade_create: bool = DEFAULT,
         source_settings: CompositeRecommendationStageParameters = DEFAULT,
         result_settings: CompositeRecommendationStageParameters = DEFAULT,
@@ -115,6 +119,7 @@ class CompositeRecommendation(Request):
         self.user_id = user_id
         self.logic = logic
         self.segment_id = segment_id
+        self.search_query = search_query
         self.cascade_create = cascade_create
         self.source_settings = source_settings
         self.result_settings = result_settings
@@ -135,6 +140,8 @@ class CompositeRecommendation(Request):
             p["logic"] = serialize_to_json(self.logic)
         if self.segment_id is not DEFAULT:
             p["segmentId"] = serialize_to_json(self.segment_id)
+        if self.search_query is not DEFAULT:
+            p["searchQuery"] = serialize_to_json(self.search_query)
         if self.cascade_create is not DEFAULT:
             p["cascadeCreate"] = serialize_to_json(self.cascade_create)
         if self.source_settings is not DEFAULT:

{recombee_api_client-6.0.0 → recombee_api_client-6.2.0}/recombee_api_client/api_requests/recommend_item_segments_to_item.py

@@ -101,6 +101,69 @@ class RecommendItemSegmentsToItem(Request):
     :param return_ab_group: If there is a custom AB-testing running, return the name of the group to which the request belongs.
 
 
+    :param reql_expressions: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment.
+
+    This can be used to compute additional properties of the recommended Item Segments.
+
+
+    The keys are the names of the expressions, and the values are the actual ReQL expressions.
+
+
+    Example request:
+
+    ```json
+
+    E{lb}
+
+    "reqlExpressions": E{lb}
+
+    "countItems": "size(segment_items(\"categories\", 'segmentId'))"
+    E{rb}
+    E{rb}
+
+    ```
+
+
+    Example response:
+
+    ```json
+
+    E{lb}
+
+    "recommId": "a7ac55a4-8d6e-4f19-addc-abac4164d8a8",
+
+    "recomms":
+
+    [
+
+    E{lb}
+
+    "id": "category-fantasy-books",
+
+    "reqlEvaluations": E{lb}
+
+    "countItems": 486
+    E{rb}
+    E{rb},
+
+    E{lb}
+
+    "id": "category-sci-fi-costumes",
+
+    "reqlEvaluations": E{lb}
+
+    "countItems": 19
+    E{rb}
+    E{rb}
+
+    ],
+
+    "numberNextRecommsCalls": 0
+    E{rb}
+
+    ```
+
+
     """
 
     def __init__(
@@ -115,6 +178,7 @@ class RecommendItemSegmentsToItem(Request):
         logic: Logic = DEFAULT,
         expert_settings: dict = DEFAULT,
         return_ab_group: bool = DEFAULT,
+        reql_expressions: dict = DEFAULT,
     ):
         super().__init__(
             path="/recomms/items/%s/item-segments/" % (item_id),
@@ -132,6 +196,7 @@ class RecommendItemSegmentsToItem(Request):
         self.logic = logic
         self.expert_settings = expert_settings
         self.return_ab_group = return_ab_group
+        self.reql_expressions = reql_expressions
 
     def get_body_parameters(self) -> dict:
         """
@@ -154,6 +219,8 @@ class RecommendItemSegmentsToItem(Request):
             p["expertSettings"] = serialize_to_json(self.expert_settings)
         if self.return_ab_group is not DEFAULT:
             p["returnAbGroup"] = serialize_to_json(self.return_ab_group)
+        if self.reql_expressions is not DEFAULT:
+            p["reqlExpressions"] = serialize_to_json(self.reql_expressions)
 
         return p
 

{recombee_api_client-6.0.0 → recombee_api_client-6.2.0}/recombee_api_client/api_requests/recommend_item_segments_to_item_segment.py

@@ -100,6 +100,69 @@ class RecommendItemSegmentsToItemSegment(Request):
     :param return_ab_group: If there is a custom AB-testing running, return the name of the group to which the request belongs.
 
 
+    :param reql_expressions: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment.
+
+    This can be used to compute additional properties of the recommended Item Segments.
+
+
+    The keys are the names of the expressions, and the values are the actual ReQL expressions.
+
+
+    Example request:
+
+    ```json
+
+    E{lb}
+
+    "reqlExpressions": E{lb}
+
+    "countItems": "size(segment_items(\"categories\", 'segmentId'))"
+    E{rb}
+    E{rb}
+
+    ```
+
+
+    Example response:
+
+    ```json
+
+    E{lb}
+
+    "recommId": "a7ac55a4-8d6e-4f19-addc-abac4164d8a8",
+
+    "recomms":
+
+    [
+
+    E{lb}
+
+    "id": "category-fantasy-books",
+
+    "reqlEvaluations": E{lb}
+
+    "countItems": 486
+    E{rb}
+    E{rb},
+
+    E{lb}
+
+    "id": "category-sci-fi-costumes",
+
+    "reqlEvaluations": E{lb}
+
+    "countItems": 19
+    E{rb}
+    E{rb}
+
+    ],
+
+    "numberNextRecommsCalls": 0
+    E{rb}
+
+    ```
+
+
     """
 
     def __init__(
@@ -114,6 +177,7 @@ class RecommendItemSegmentsToItemSegment(Request):
         logic: Logic = DEFAULT,
         expert_settings: dict = DEFAULT,
         return_ab_group: bool = DEFAULT,
+        reql_expressions: dict = DEFAULT,
     ):
         super().__init__(
             path="/recomms/item-segments/item-segments/",
@@ -131,6 +195,7 @@ class RecommendItemSegmentsToItemSegment(Request):
         self.logic = logic
         self.expert_settings = expert_settings
         self.return_ab_group = return_ab_group
+        self.reql_expressions = reql_expressions
 
     def get_body_parameters(self) -> dict:
         """
@@ -154,6 +219,8 @@ class RecommendItemSegmentsToItemSegment(Request):
             p["expertSettings"] = serialize_to_json(self.expert_settings)
         if self.return_ab_group is not DEFAULT:
             p["returnAbGroup"] = serialize_to_json(self.return_ab_group)
+        if self.reql_expressions is not DEFAULT:
+            p["reqlExpressions"] = serialize_to_json(self.reql_expressions)
 
         return p
 

{recombee_api_client-6.0.0 → recombee_api_client-6.2.0}/recombee_api_client/api_requests/recommend_item_segments_to_user.py

@@ -70,6 +70,69 @@ class RecommendItemSegmentsToUser(Request):
     :param return_ab_group: If there is a custom AB-testing running, return the name of the group to which the request belongs.
 
 
+    :param reql_expressions: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment.
+
+    This can be used to compute additional properties of the recommended Item Segments.
+
+
+    The keys are the names of the expressions, and the values are the actual ReQL expressions.
+
+
+    Example request:
+
+    ```json
+
+    E{lb}
+
+    "reqlExpressions": E{lb}
+
+    "countItems": "size(segment_items(\"categories\", 'segmentId'))"
+    E{rb}
+    E{rb}
+
+    ```
+
+
+    Example response:
+
+    ```json
+
+    E{lb}
+
+    "recommId": "a7ac55a4-8d6e-4f19-addc-abac4164d8a8",
+
+    "recomms":
+
+    [
+
+    E{lb}
+
+    "id": "category-fantasy-books",
+
+    "reqlEvaluations": E{lb}
+
+    "countItems": 486
+    E{rb}
+    E{rb},
+
+    E{lb}
+
+    "id": "category-sci-fi-costumes",
+
+    "reqlEvaluations": E{lb}
+
+    "countItems": 19
+    E{rb}
+    E{rb}
+
+    ],
+
+    "numberNextRecommsCalls": 0
+    E{rb}
+
+    ```
+
+
     """
 
     def __init__(
@@ -83,6 +146,7 @@ class RecommendItemSegmentsToUser(Request):
         logic: Logic = DEFAULT,
         expert_settings: dict = DEFAULT,
         return_ab_group: bool = DEFAULT,
+        reql_expressions: dict = DEFAULT,
     ):
         super().__init__(
             path="/recomms/users/%s/item-segments/" % (user_id),
@@ -99,6 +163,7 @@ class RecommendItemSegmentsToUser(Request):
         self.logic = logic
         self.expert_settings = expert_settings
         self.return_ab_group = return_ab_group
+        self.reql_expressions = reql_expressions
 
     def get_body_parameters(self) -> dict:
         """
@@ -120,6 +185,8 @@ class RecommendItemSegmentsToUser(Request):
             p["expertSettings"] = serialize_to_json(self.expert_settings)
         if self.return_ab_group is not DEFAULT:
             p["returnAbGroup"] = serialize_to_json(self.return_ab_group)
+        if self.reql_expressions is not DEFAULT:
+            p["reqlExpressions"] = serialize_to_json(self.reql_expressions)
 
         return p
 

recombee_api_client-6.2.0/recombee_api_client/api_requests/recommend_next_item_segments.py

@@ -0,0 +1,64 @@
+from recombee_api_client.api_requests.request import Request
+from recombee_api_client.utils.serialize_to_json import serialize_to_json
+from typing import Union, List
+from datetime import datetime
+import uuid
+
+DEFAULT = uuid.uuid4()
+
+
+class RecommendNextItemSegments(Request):
+    """
+    Returns Item segments that shall be shown to a user as next recommendations when the user e.g. scrolls the page down (*infinite scroll*) or goes to the next page.
+
+    It accepts `recommId` of a base recommendation request (e.g., request from the first page) and the number of segments that shall be returned (`count`).
+    The base request can be one of:
+      - [Recommend Item Segments to Item](https://docs.recombee.com/api#recommend-item-segments-to-item)
+      - [Recommend Item Segments to User](https://docs.recombee.com/api#recommend-item-segments-to-user)
+      - [Recommend Item Segments to Item Segment](https://docs.recombee.com/api#recommend-item-segments-to-item-segment)
+      - [Search Item Segments](https://docs.recombee.com/api#search-item-segments)
+
+    All the other parameters are inherited from the base request.
+
+    *Recommend next Item segments* can be called many times for a single `recommId` and each call returns different (previously not recommended) segments.
+    The number of *Recommend next Item segments* calls performed so far is returned in the `numberNextRecommsCalls` field.
+
+    *Recommend next Item segments* can be requested up to 30 minutes after the base request or a previous *Recommend next Item segments* call.
+
+    For billing purposes, each call to *Recommend next Item segments* is counted as a separate recommendation request.
+
+    Required parameters:
+
+    :param recomm_id: ID of the base recommendation request for which next recommendations should be returned
+
+    :param count: Number of item segments to be recommended
+
+
+    """
+
+    def __init__(self, recomm_id: str, count: int):
+        super().__init__(
+            path="/recomms/next/item-segments/%s" % (recomm_id),
+            method="post",
+            timeout=3000,
+            ensure_https=False,
+        )
+        self.recomm_id = recomm_id
+        self.count = count
+
+    def get_body_parameters(self) -> dict:
+        """
+        Values of body parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        p = dict()
+        p["count"] = serialize_to_json(self.count)
+
+        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-6.0.0 → recombee_api_client-6.2.0}/recombee_api_client/api_requests/search_item_segments.py

@@ -71,6 +71,69 @@ class SearchItemSegments(Request):
     :param return_ab_group: If there is a custom AB-testing running, return the name of the group to which the request belongs.
 
 
+    :param reql_expressions: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment.
+
+    This can be used to compute additional properties of the recommended Item Segments.
+
+
+    The keys are the names of the expressions, and the values are the actual ReQL expressions.
+
+
+    Example request:
+
+    ```json
+
+    E{lb}
+
+    "reqlExpressions": E{lb}
+
+    "countItems": "size(segment_items(\"categories\", 'segmentId'))"
+    E{rb}
+    E{rb}
+
+    ```
+
+
+    Example response:
+
+    ```json
+
+    E{lb}
+
+    "recommId": "a7ac55a4-8d6e-4f19-addc-abac4164d8a8",
+
+    "recomms":
+
+    [
+
+    E{lb}
+
+    "id": "category-fantasy-books",
+
+    "reqlEvaluations": E{lb}
+
+    "countItems": 486
+    E{rb}
+    E{rb},
+
+    E{lb}
+
+    "id": "category-sci-fi-costumes",
+
+    "reqlEvaluations": E{lb}
+
+    "countItems": 19
+    E{rb}
+    E{rb}
+
+    ],
+
+    "numberNextRecommsCalls": 0
+    E{rb}
+
+    ```
+
+
     """
 
     def __init__(
@@ -85,6 +148,7 @@ class SearchItemSegments(Request):
         logic: Logic = DEFAULT,
         expert_settings: dict = DEFAULT,
         return_ab_group: bool = DEFAULT,
+        reql_expressions: dict = DEFAULT,
     ):
         super().__init__(
             path="/search/users/%s/item-segments/" % (user_id),
@@ -102,6 +166,7 @@ class SearchItemSegments(Request):
         self.logic = logic
         self.expert_settings = expert_settings
         self.return_ab_group = return_ab_group
+        self.reql_expressions = reql_expressions
 
     def get_body_parameters(self) -> dict:
         """
@@ -124,6 +189,8 @@ class SearchItemSegments(Request):
             p["expertSettings"] = serialize_to_json(self.expert_settings)
         if self.return_ab_group is not DEFAULT:
             p["returnAbGroup"] = serialize_to_json(self.return_ab_group)
+        if self.reql_expressions is not DEFAULT:
+            p["reqlExpressions"] = serialize_to_json(self.reql_expressions)
 
         return p
 

{recombee_api_client-6.0.0 → recombee_api_client-6.2.0}/recombee_api_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: recombee-api-client
-Version: 6.0.0
+Version: 6.2.0
 Summary: Client for Recombee recommendation API
 Home-page: https://github.com/Recombee/python-api-client
 Author: Recombee

{recombee_api_client-6.0.0 → recombee_api_client-6.2.0}/recombee_api_client.egg-info/SOURCES.txt

@@ -78,6 +78,7 @@ recombee_api_client/api_requests/recommend_item_segments_to_user.py
 recombee_api_client/api_requests/recommend_items_to_item.py
 recombee_api_client/api_requests/recommend_items_to_item_segment.py
 recombee_api_client/api_requests/recommend_items_to_user.py
+recombee_api_client/api_requests/recommend_next_item_segments.py
 recombee_api_client/api_requests/recommend_next_items.py
 recombee_api_client/api_requests/recommend_users_to_item.py
 recombee_api_client/api_requests/recommend_users_to_user.py

{recombee_api_client-6.0.0 → recombee_api_client-6.2.0}/setup.py

@@ -10,7 +10,7 @@ with open(path.join(here, "README.rst"), encoding="utf-8") as f:
 
 setup(
     name="recombee-api-client",
-    version="6.0.0",
+    version="6.2.0",
     description="Client for Recombee recommendation API",
     long_description=long_description,
     url="https://github.com/Recombee/python-api-client",

{recombee_api_client-6.0.0 → recombee_api_client-6.2.0}/tests/test.py

@@ -326,6 +326,15 @@ if __name__ == "__main__":
             RecommendItemSegmentsToItemSegmentTestCase
         )
     )
+    from tests.test_cases.test_recommend_next_item_segments import (
+        RecommendNextItemSegmentsTestCase,
+    )
+
+    suite.addTests(
+        unittest.defaultTestLoader.loadTestsFromTestCase(
+            RecommendNextItemSegmentsTestCase
+        )
+    )
     from tests.test_cases.test_composite_recommendation import (
         CompositeRecommendationTestCase,
     )