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

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

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

{recombee_api_client-6.2.0 → recombee_api_client-6.3.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.2.0"}
+        headers = {"User-Agent": "recombee-python-api-client/6.3.0"}
         if additional_headers:
             headers.update(additional_headers)
         return headers

{recombee_api_client-6.2.0 → recombee_api_client-6.3.0}/recombee_api_client/api_requests/add_item_property.py

@@ -1,3 +1,5 @@
+from recombee_api_client.inputs.property_metadata import PropertyMetadata
+from recombee_api_client.inputs.property_role import PropertyRole
 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
@@ -19,7 +21,7 @@ class AddItemProperty(Request):
     :param type: Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.
 
 
-    * `int`- Signed integer number.
+    * `int` - Signed integer number.
 
 
     * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
@@ -31,7 +33,7 @@ class AddItemProperty(Request):
     * `boolean` - *true* / *false*
 
 
-    * `timestamp` - Value representing date and time.
+    * `timestamp` - Value representing date and time. ISO8601-1 pattern (string) or UTC epoch time (number).
 
 
     * `set` - Set of strings.
@@ -43,9 +45,23 @@ class AddItemProperty(Request):
     * `imageList` - List of URLs that refer to images.
 
 
+
+    Optional parameters:
+
+    :param role: [Role](https://docs.recombee.com/api/property_roles_metadata#roles) to assign to the property.
+
+
+    :param metadata: List of [metadata](https://docs.recombee.com/api/property_roles_metadata#metadata) entries to assign to the property.
+
     """
 
-    def __init__(self, property_name: str, type: str):
+    def __init__(
+        self,
+        property_name: str,
+        type: str,
+        role: PropertyRole = DEFAULT,
+        metadata: List[PropertyMetadata] = DEFAULT,
+    ):
         super().__init__(
             path="/items/properties/%s" % (property_name),
             method="put",
@@ -54,12 +70,19 @@ class AddItemProperty(Request):
         )
         self.property_name = property_name
         self.type = type
+        self.role = role
+        self.metadata = metadata
 
     def get_body_parameters(self) -> dict:
         """
         Values of body parameters as a dictionary (name of parameter: value of the parameter).
         """
         p = dict()
+        p["type"] = serialize_to_json(self.type)
+        if self.role is not DEFAULT:
+            p["role"] = serialize_to_json(self.role)
+        if self.metadata is not DEFAULT:
+            p["metadata"] = serialize_to_json(self.metadata)
 
         return p
 
@@ -68,6 +91,5 @@ class AddItemProperty(Request):
         Values of query parameters as a dictionary (name of parameter: value of the parameter).
         """
         params = dict()
-        params["type"] = serialize_to_json(self.type)
 
         return params

{recombee_api_client-6.2.0 → recombee_api_client-6.3.0}/recombee_api_client/api_requests/add_user_property.py

@@ -1,3 +1,5 @@
+from recombee_api_client.inputs.property_metadata import PropertyMetadata
+from recombee_api_client.inputs.property_role import PropertyRole
 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
@@ -31,15 +33,29 @@ class AddUserProperty(Request):
     * `boolean` - *true* / *false*
 
 
-    * `timestamp` - Value representing date and time.
+    * `timestamp` - Value representing date and time. ISO8601-1 pattern (string) or UTC epoch time (number).
 
 
     * `set` - Set of strings.
 
 
+
+    Optional parameters:
+
+    :param role: [Role](https://docs.recombee.com/api/property_roles_metadata#roles) to assign to the property.
+
+
+    :param metadata: List of [metadata](https://docs.recombee.com/api/property_roles_metadata#metadata) entries to assign to the property.
+
     """
 
-    def __init__(self, property_name: str, type: str):
+    def __init__(
+        self,
+        property_name: str,
+        type: str,
+        role: PropertyRole = DEFAULT,
+        metadata: List[PropertyMetadata] = DEFAULT,
+    ):
         super().__init__(
             path="/users/properties/%s" % (property_name),
             method="put",
@@ -48,12 +64,19 @@ class AddUserProperty(Request):
         )
         self.property_name = property_name
         self.type = type
+        self.role = role
+        self.metadata = metadata
 
     def get_body_parameters(self) -> dict:
         """
         Values of body parameters as a dictionary (name of parameter: value of the parameter).
         """
         p = dict()
+        p["type"] = serialize_to_json(self.type)
+        if self.role is not DEFAULT:
+            p["role"] = serialize_to_json(self.role)
+        if self.metadata is not DEFAULT:
+            p["metadata"] = serialize_to_json(self.metadata)
 
         return p
 
@@ -62,6 +85,5 @@ class AddUserProperty(Request):
         Values of query parameters as a dictionary (name of parameter: value of the parameter).
         """
         params = dict()
-        params["type"] = serialize_to_json(self.type)
 
         return params

{recombee_api_client-6.2.0 → recombee_api_client-6.3.0}/recombee_api_client/api_requests/recommend_next_item_segments.py

@@ -9,23 +9,24 @@ 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.
+    Returns [Item Segments](https://docs.recombee.com/segmentations) to be shown as the next recommendations when a user scrolls (e.g., within a carousel or feed of Item Segments such as brands, artists, topics, or categories).
+
+    The request requires the `recommId` of a base recommendation request and the number of Segments to return (`count`).
 
-    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.
+    All other parameters are inherited from the base request associated with the provided `recommId`.
 
-    *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.
+    This endpoint can be called multiple times for a single `recommId`. Each call returns different Item Segments that have not been recommended in previous calls.
+    The number of calls made 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.
+    Requests can be made up to 30 minutes after the base request or the most recent Recommend Next Item Segments call.
 
-    For billing purposes, each call to *Recommend next Item segments* is counted as a separate recommendation request.
+    For billing purposes, each call to this endpoint is counted as a separate recommendation request.
 
     Required parameters:
 

{recombee_api_client-6.2.0 → recombee_api_client-6.3.0}/recombee_api_client/inputs/__init__.py

@@ -1,3 +1,5 @@
+from recombee_api_client.inputs.property_role import PropertyRole
+from recombee_api_client.inputs.property_metadata import PropertyMetadata
 from recombee_api_client.inputs.composite_recommendation_stage_parameters import (
     CompositeRecommendationStageParameters,
 )

recombee_api_client-6.3.0/recombee_api_client/inputs/property_metadata.py

@@ -0,0 +1,38 @@
+from recombee_api_client.inputs.input import Input
+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 PropertyMetadata(Input):
+    """
+    Initializes PropertyMetadata input
+    Required parameters:
+
+    :param name: Name of the [metadata](https://docs.recombee.com/api/property_roles_metadata#metadata) assigned to the property.
+
+
+    Optional parameters:
+
+    :param settings: Optional configuration for this metadata entry.
+
+    """
+
+    def __init__(self, name: str, settings: dict = DEFAULT):
+        self.name = name
+        self.settings = settings
+
+    def to_dict(self) -> dict:
+        """
+        Serializes the input into a dict for sending to the Recombee API.
+        """
+        res = dict()
+        res["name"] = serialize_to_json(self.name)
+        if self.settings is not DEFAULT:
+            res["settings"] = serialize_to_json(self.settings)
+
+        return res

recombee_api_client-6.3.0/recombee_api_client/inputs/property_role.py

@@ -0,0 +1,38 @@
+from recombee_api_client.inputs.input import Input
+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 PropertyRole(Input):
+    """
+    Initializes PropertyRole input
+    Required parameters:
+
+    :param name: Name of the [role](https://docs.recombee.com/api/property_roles_metadata#roles) assigned to the property.
+
+
+    Optional parameters:
+
+    :param settings: Optional configuration specific to the selected role.
+
+    """
+
+    def __init__(self, name: str, settings: dict = DEFAULT):
+        self.name = name
+        self.settings = settings
+
+    def to_dict(self) -> dict:
+        """
+        Serializes the input into a dict for sending to the Recombee API.
+        """
+        res = dict()
+        res["name"] = serialize_to_json(self.name)
+        if self.settings is not DEFAULT:
+            res["settings"] = serialize_to_json(self.settings)
+
+        return res

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

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

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

@@ -100,6 +100,8 @@ recombee_api_client/inputs/__init__.py
 recombee_api_client/inputs/composite_recommendation_stage_parameters.py
 recombee_api_client/inputs/input.py
 recombee_api_client/inputs/logic.py
+recombee_api_client/inputs/property_metadata.py
+recombee_api_client/inputs/property_role.py
 recombee_api_client/utils/__init__.py
 recombee_api_client/utils/serialize_to_json.py
 tests/test.py

{recombee_api_client-6.2.0 → recombee_api_client-6.3.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.2.0",
+    version="6.3.0",
     description="Client for Recombee recommendation API",
     long_description=long_description,
     url="https://github.com/Recombee/python-api-client",