recombee-api-client 4.1.0__tar.gz → 5.0.0__tar.gz

recombee-api-client-5.0.0/PKG-INFO

@@ -0,0 +1,203 @@
+Metadata-Version: 2.1
+Name: recombee-api-client
+Version: 5.0.0
+Summary: Client for Recombee recommendation API
+Home-page: https://github.com/Recombee/python-api-client
+Author: Recombee
+Author-email: ondrej.fiedler@recombee.com
+License: MIT
+Keywords: recommendation engine,recommender engine as a service,search,personalization,recombee,API client,machine learning
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.6
+
+*****************
+RecombeeApiClient
+*****************
+
+A Python 3 client for easy use of the `Recombee <https://www.recombee.com/>`_  recommendation API.
+
+If you don't have an account at Recombee yet, you can create a free account `here <https://www.recombee.com/>`_.
+
+Documentation of the API can be found at `docs.recombee.com <https://docs.recombee.com/>`_.
+
+=============
+Installation
+=============
+
+Install the client with pip:
+
+.. code-block:: bash
+
+    $ pip install recombee-api-client
+
+========
+Examples
+========
+
+-------------
+Basic example
+-------------
+
+.. code-block:: python
+
+    from recombee_api_client.api_client import RecombeeClient, Region
+    from recombee_api_client.exceptions import APIException
+    from recombee_api_client.api_requests import *
+    import random
+
+    client = RecombeeClient('--my-database-id--', '--db-private-token--', region=Region.US_WEST)
+
+    #Generate some random purchases of items by users
+    PROBABILITY_PURCHASED = 0.1
+    NUM = 100
+    purchase_requests = []
+
+    for user_id in ["user-%s" % i for i in range(NUM) ]:
+      for item_id in ["item-%s" % i for i in range(NUM) ]:
+        if random.random() < PROBABILITY_PURCHASED:
+
+          request = AddPurchase(user_id, item_id, cascade_create=True)
+          purchase_requests.append(request)
+
+    try:
+        # Send the data to Recombee, use Batch for faster processing of larger data
+        print('Send purchases')
+        client.send(Batch(purchase_requests))
+
+        # Get recommendations for user 'user-25'
+        response = client.send(RecommendItemsToUser('user-25', 5))
+        print("Recommended items: %s" % response)
+
+        # User scrolled down - get next 3 recommended items
+        response = client.send(RecommendNextItems(response['recommId'], 3))
+        print("Next recommended items: %s" % response)
+
+    except APIException as e:
+        print(e)
+
+
+
+---------------------
+Using property values
+---------------------
+
+.. code-block:: python
+
+    from recombee_api_client.api_client import RecombeeClient, Region
+    from recombee_api_client.api_requests import AddItemProperty, SetItemValues, AddPurchase
+    from recombee_api_client.api_requests import RecommendItemsToItem, SearchItems, Batch, ResetDatabase
+    import random
+
+    NUM = 100
+    PROBABILITY_PURCHASED = 0.1
+
+    client = RecombeeClient('--my-database-id--', '--db-private-token--', region=Region.AP_SE)
+
+    # Clear the entire database
+    client.send(ResetDatabase())
+
+    # We will use computers as items in this example
+    # Computers have four properties 
+    #   - price (floating point number)
+    #   - number of processor cores (integer number)
+    #   - description (string)
+    #   - image (url of computer's photo)
+
+    # Add properties of items
+    client.send(AddItemProperty('price', 'double'))
+    client.send(AddItemProperty('num-cores', 'int'))
+    client.send(AddItemProperty('description', 'string'))
+    client.send(AddItemProperty('image', 'image'))
+
+    # Prepare requests for setting a catalog of computers
+    requests = [SetItemValues(
+        "computer-%s" % i, #itemId
+        #values:
+        { 
+          'price': random.uniform(500, 2000),
+          'num-cores': random.randrange(1,9),
+          'description': 'Great computer',
+          'image': 'http://examplesite.com/products/computer-%s.jpg' % i
+        },
+        cascade_create=True   # Use cascadeCreate for creating item
+                              # with given itemId if it doesn't exist
+      ) for i in range(NUM)]
+
+
+    # Send catalog to the recommender system
+    client.send(Batch(requests))
+
+    # Prepare some purchases of items by users
+    requests = []
+    items = ["computer-%s" % i for i in range(NUM)]
+    users = ["user-%s" % i for i in range(NUM)]
+
+    for item_id in items:
+        #Use cascadeCreate to create unexisting users
+        purchasing_users = [user_id for user_id in users if random.random() < PROBABILITY_PURCHASED]
+        requests += [AddPurchase(user_id, item_id, cascade_create=True) for user_id in purchasing_users]
+
+    # Send purchases to the recommender system
+    client.send(Batch(requests))
+
+    # Get 5 recommendations for user-42, who is currently viewing computer-6
+    # Recommend only computers that have at least 3 cores
+    recommended = client.send(
+        RecommendItemsToItem('computer-6', 'user-42', 5, filter="'num-cores'>=3")
+    )
+    print("Recommended items with at least 3 processor cores: %s" % recommended)
+
+    # Recommend only items that are more expensive then currently viewed item (up-sell)
+    recommended = client.send(
+        RecommendItemsToItem('computer-6', 'user-42', 5, filter="'price' > context_item[\"price\"]")
+    )
+    print("Recommended up-sell items: %s" % recommended)
+
+    # Filters, boosters and other settings can be also set in the Admin UI (admin.recombee.com)
+    # when scenario is specified
+    recommended = client.send(
+      RecommendItemsToItem('computer-6', 'user-42', 5, scenario='product_detail')
+      )
+
+    # Perform personalized full-text search with a user's search query (e.g. 'computers').
+    matches = client.send(SearchItems('user-42', 'computers', 5, scenario='search_top'))
+    print("Matched items: %s" % matches)
+
+------------------
+Exception handling
+------------------
+
+For the sake of brevity, the above examples omit exception handling. However, various exceptions can occur while processing request, for example because of adding an already existing item, submitting interaction of nonexistent user or because of timeout.
+
+We are doing our best to provide the fastest and most reliable service, but production-level applications must implement a fallback solution since errors can always happen. The fallback might be, for example, showing the most popular items from the current category, or not displaying recommendations at all.
+
+Example:
+
+.. code-block:: python
+
+  from recombee_api_client.exceptions import *
+
+  try:
+    recommended = client.send(
+        RecommendItemsToItem('computer-6', 'user-42', 5, filter="'price' > context_item[\"price\"]")
+    )
+  except ResponseException as e:
+    #Handle errorneous request => use fallback
+  except ApiTimeoutException as e:
+    #Handle timeout => use fallback
+  except APIException as e:
+    #APIException is parent of both ResponseException and ApiTimeoutException
+
+

recombee-api-client-5.0.0/recombee_api_client/__init__.py

@@ -0,0 +1 @@
+

{recombee-api-client-4.1.0 → recombee-api-client-5.0.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/4.1.0'}
+        headers = {'User-Agent': 'recombee-python-api-client/5.0.0'}
         if additional_headers:
             headers.update(additional_headers)
         return headers

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/__init__.py

@@ -15,12 +15,6 @@ from recombee_api_client.api_requests.list_series import ListSeries
 from recombee_api_client.api_requests.list_series_items import ListSeriesItems
 from recombee_api_client.api_requests.insert_to_series import InsertToSeries
 from recombee_api_client.api_requests.remove_from_series import RemoveFromSeries
-from recombee_api_client.api_requests.add_group import AddGroup
-from recombee_api_client.api_requests.delete_group import DeleteGroup
-from recombee_api_client.api_requests.list_groups import ListGroups
-from recombee_api_client.api_requests.list_group_items import ListGroupItems
-from recombee_api_client.api_requests.insert_to_group import InsertToGroup
-from recombee_api_client.api_requests.remove_from_group import RemoveFromGroup
 from recombee_api_client.api_requests.add_user import AddUser
 from recombee_api_client.api_requests.delete_user import DeleteUser
 from recombee_api_client.api_requests.set_user_values import SetUserValues
@@ -63,6 +57,7 @@ from recombee_api_client.api_requests.recommend_users_to_item import RecommendUs
 from recombee_api_client.api_requests.recommend_item_segments_to_user import RecommendItemSegmentsToUser
 from recombee_api_client.api_requests.recommend_item_segments_to_item import RecommendItemSegmentsToItem
 from recombee_api_client.api_requests.recommend_item_segments_to_item_segment import RecommendItemSegmentsToItemSegment
+from recombee_api_client.api_requests.recommend_items_to_item_segment import RecommendItemsToItemSegment
 from recombee_api_client.api_requests.search_items import SearchItems
 from recombee_api_client.api_requests.search_item_segments import SearchItemSegments
 from recombee_api_client.api_requests.add_search_synonym import AddSearchSynonym

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/add_bookmark.py

@@ -29,7 +29,7 @@ class AddBookmark(Request):
     """
 
     def __init__(self, user_id: str, item_id: str, timestamp: Union[str, int] = DEFAULT, cascade_create: bool = DEFAULT, recomm_id: str = DEFAULT, additional_data: dict = DEFAULT):
-        super().__init__(path="/bookmarks/", method='post', timeout=1000, ensure_https=False)
+        super().__init__(path="/bookmarks/", method='post', timeout=3000, ensure_https=False)
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/add_cart_addition.py

@@ -33,7 +33,7 @@ class AddCartAddition(Request):
     """
 
     def __init__(self, user_id: str, item_id: str, timestamp: Union[str, int] = DEFAULT, cascade_create: bool = DEFAULT, amount: float = DEFAULT, price: float = DEFAULT, recomm_id: str = DEFAULT, additional_data: dict = DEFAULT):
-        super().__init__(path="/cartadditions/", method='post', timeout=1000, ensure_https=False)
+        super().__init__(path="/cartadditions/", method='post', timeout=3000, ensure_https=False)
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/add_detail_view.py

@@ -31,7 +31,7 @@ class AddDetailView(Request):
     """
 
     def __init__(self, user_id: str, item_id: str, timestamp: Union[str, int] = DEFAULT, duration: int = DEFAULT, cascade_create: bool = DEFAULT, recomm_id: str = DEFAULT, additional_data: dict = DEFAULT):
-        super().__init__(path="/detailviews/", method='post', timeout=1000, ensure_https=False)
+        super().__init__(path="/detailviews/", method='post', timeout=3000, ensure_https=False)
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/add_item.py

@@ -18,7 +18,7 @@ class AddItem(Request):
     """
 
     def __init__(self, item_id: str):
-        super().__init__(path="/items/%s" % (item_id), method='put', timeout=1000, ensure_https=False)
+        super().__init__(path="/items/%s" % (item_id), method='put', timeout=3000, ensure_https=False)
         self.item_id = item_id
 
     def get_body_parameters(self) -> dict:

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/add_item_property.py

@@ -6,7 +6,7 @@ DEFAULT = uuid.uuid4()
 
 class AddItemProperty(Request):
     """
-    Adding an item property is somehow equivalent to adding a column to the table of items. The items may be characterized by various properties of different types.
+    Adding an item property is somewhat equivalent to adding a column to the table of items. The items may be characterized by various properties of different types.
     
     Required parameters:
     

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/add_purchase.py

@@ -35,7 +35,7 @@ class AddPurchase(Request):
     """
 
     def __init__(self, user_id: str, item_id: str, timestamp: Union[str, int] = DEFAULT, cascade_create: bool = DEFAULT, amount: float = DEFAULT, price: float = DEFAULT, profit: float = DEFAULT, recomm_id: str = DEFAULT, additional_data: dict = DEFAULT):
-        super().__init__(path="/purchases/", method='post', timeout=1000, ensure_https=False)
+        super().__init__(path="/purchases/", method='post', timeout=3000, ensure_https=False)
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/add_rating.py

@@ -31,7 +31,7 @@ class AddRating(Request):
     """
 
     def __init__(self, user_id: str, item_id: str, rating: float, timestamp: Union[str, int] = DEFAULT, cascade_create: bool = DEFAULT, recomm_id: str = DEFAULT, additional_data: dict = DEFAULT):
-        super().__init__(path="/ratings/", method='post', timeout=1000, ensure_https=False)
+        super().__init__(path="/ratings/", method='post', timeout=3000, ensure_https=False)
         self.user_id = user_id
         self.item_id = item_id
         self.rating = rating

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/add_series.py

@@ -11,18 +11,26 @@ class AddSeries(Request):
     
     :param series_id: ID of the series to be created.
     
+    
+    Optional parameters:
+    
+    :param cascade_create: If set to `true`, the item will be created with the same ID as the series. Default is `true`.
+    
 
     """
 
-    def __init__(self, series_id: str):
-        super().__init__(path="/series/%s" % (series_id), method='put', timeout=1000, ensure_https=False)
+    def __init__(self, series_id: str, cascade_create: bool = DEFAULT):
+        super().__init__(path="/series/%s" % (series_id), method='put', timeout=3000, ensure_https=False)
         self.series_id = series_id
+        self.cascade_create = cascade_create
 
     def get_body_parameters(self) -> dict:
         """
         Values of body parameters as a dictionary (name of parameter: value of the parameter).
         """
         p = dict()
+        if self.cascade_create is not DEFAULT:
+            p['cascadeCreate'] = self.cascade_create
         return p
 
     def get_query_parameters(self) -> dict:

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/add_user.py

@@ -16,7 +16,7 @@ class AddUser(Request):
     """
 
     def __init__(self, user_id: str):
-        super().__init__(path="/users/%s" % (user_id), method='put', timeout=1000, ensure_https=False)
+        super().__init__(path="/users/%s" % (user_id), method='put', timeout=3000, ensure_https=False)
         self.user_id = user_id
 
     def get_body_parameters(self) -> dict:

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/add_user_property.py

@@ -6,7 +6,7 @@ DEFAULT = uuid.uuid4()
 
 class AddUserProperty(Request):
     """
-    Adding a user property is somehow equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
+    Adding a user property is somewhat equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
     
     Required parameters:
     

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/delete_bookmark.py

@@ -23,7 +23,7 @@ class DeleteBookmark(Request):
     """
 
     def __init__(self, user_id: str, item_id: str, timestamp: Union[str, int] = DEFAULT):
-        super().__init__(path="/bookmarks/", method='delete', timeout=1000, ensure_https=False)
+        super().__init__(path="/bookmarks/", method='delete', timeout=3000, ensure_https=False)
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/delete_cart_addition.py

@@ -23,7 +23,7 @@ class DeleteCartAddition(Request):
     """
 
     def __init__(self, user_id: str, item_id: str, timestamp: Union[str, int] = DEFAULT):
-        super().__init__(path="/cartadditions/", method='delete', timeout=1000, ensure_https=False)
+        super().__init__(path="/cartadditions/", method='delete', timeout=3000, ensure_https=False)
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/delete_detail_view.py

@@ -23,7 +23,7 @@ class DeleteDetailView(Request):
     """
 
     def __init__(self, user_id: str, item_id: str, timestamp: Union[str, int] = DEFAULT):
-        super().__init__(path="/detailviews/", method='delete', timeout=1000, ensure_https=False)
+        super().__init__(path="/detailviews/", method='delete', timeout=3000, ensure_https=False)
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/delete_item.py

@@ -20,7 +20,7 @@ class DeleteItem(Request):
     """
 
     def __init__(self, item_id: str):
-        super().__init__(path="/items/%s" % (item_id), method='delete', timeout=1000, ensure_https=False)
+        super().__init__(path="/items/%s" % (item_id), method='delete', timeout=3000, ensure_https=False)
         self.item_id = item_id
 
     def get_body_parameters(self) -> dict:

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/delete_more_items.py

@@ -17,7 +17,7 @@ class DeleteMoreItems(Request):
     """
 
     def __init__(self, filter: str):
-        super().__init__(path="/more-items/", method='delete', timeout=1000, ensure_https=False)
+        super().__init__(path="/more-items/", method='delete', timeout=100000, ensure_https=False)
         self.filter = filter
 
     def get_body_parameters(self) -> dict:

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/delete_purchase.py

@@ -23,7 +23,7 @@ class DeletePurchase(Request):
     """
 
     def __init__(self, user_id: str, item_id: str, timestamp: Union[str, int] = DEFAULT):
-        super().__init__(path="/purchases/", method='delete', timeout=1000, ensure_https=False)
+        super().__init__(path="/purchases/", method='delete', timeout=3000, ensure_https=False)
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/delete_rating.py

@@ -23,7 +23,7 @@ class DeleteRating(Request):
     """
 
     def __init__(self, user_id: str, item_id: str, timestamp: Union[str, int] = DEFAULT):
-        super().__init__(path="/ratings/", method='delete', timeout=1000, ensure_https=False)
+        super().__init__(path="/ratings/", method='delete', timeout=3000, ensure_https=False)
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/delete_series.py

@@ -14,18 +14,26 @@ class DeleteSeries(Request):
     
     :param series_id: ID of the series to be deleted.
     
+    
+    Optional parameters:
+    
+    :param cascade_delete: If set to `true`, item with the same ID as seriesId will be also deleted. Default is `false`.
+    
 
     """
 
-    def __init__(self, series_id: str):
-        super().__init__(path="/series/%s" % (series_id), method='delete', timeout=1000, ensure_https=False)
+    def __init__(self, series_id: str, cascade_delete: bool = DEFAULT):
+        super().__init__(path="/series/%s" % (series_id), method='delete', timeout=3000, ensure_https=False)
         self.series_id = series_id
+        self.cascade_delete = cascade_delete
 
     def get_body_parameters(self) -> dict:
         """
         Values of body parameters as a dictionary (name of parameter: value of the parameter).
         """
         p = dict()
+        if self.cascade_delete is not DEFAULT:
+            p['cascadeDelete'] = self.cascade_delete
         return p
 
     def get_query_parameters(self) -> dict:

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/delete_user.py

@@ -18,7 +18,7 @@ class DeleteUser(Request):
     """
 
     def __init__(self, user_id: str):
-        super().__init__(path="/users/%s" % (user_id), method='delete', timeout=1000, ensure_https=False)
+        super().__init__(path="/users/%s" % (user_id), method='delete', timeout=3000, ensure_https=False)
         self.user_id = user_id
 
     def get_body_parameters(self) -> dict:

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/delete_view_portion.py

@@ -23,7 +23,7 @@ class DeleteViewPortion(Request):
     """
 
     def __init__(self, user_id: str, item_id: str, session_id: str = DEFAULT):
-        super().__init__(path="/viewportions/", method='delete', timeout=1000, ensure_https=False)
+        super().__init__(path="/viewportions/", method='delete', timeout=3000, ensure_https=False)
         self.user_id = user_id
         self.item_id = item_id
         self.session_id = session_id

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/get_item_property_info.py

@@ -16,7 +16,7 @@ class GetItemPropertyInfo(Request):
     """
 
     def __init__(self, property_name: str):
-        super().__init__(path="/items/properties/%s" % (property_name), method='get', timeout=1000, ensure_https=False)
+        super().__init__(path="/items/properties/%s" % (property_name), method='get', timeout=3000, ensure_https=False)
         self.property_name = property_name
 
     def get_body_parameters(self) -> dict:

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/get_item_values.py

@@ -17,7 +17,7 @@ class GetItemValues(Request):
     """
 
     def __init__(self, item_id: str):
-        super().__init__(path="/items/%s" % (item_id), method='get', timeout=1000, ensure_https=False)
+        super().__init__(path="/items/%s" % (item_id), method='get', timeout=3000, ensure_https=False)
         self.item_id = item_id
 
     def get_body_parameters(self) -> dict:

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/get_user_values.py

@@ -17,7 +17,7 @@ class GetUserValues(Request):
     """
 
     def __init__(self, user_id: str):
-        super().__init__(path="/users/%s" % (user_id), method='get', timeout=1000, ensure_https=False)
+        super().__init__(path="/users/%s" % (user_id), method='get', timeout=3000, ensure_https=False)
         self.user_id = user_id
 
     def get_body_parameters(self) -> dict:

{recombee-api-client-4.1.0 → recombee-api-client-5.0.0}/recombee_api_client/api_requests/insert_to_series.py

@@ -21,13 +21,13 @@ class InsertToSeries(Request):
     
     Optional parameters:
     
-    :param cascade_create: Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. Either item or series may be created if not present in the database.
+    :param cascade_create: Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. In case of `item`, an item is created, in case of `series` a series + corresponding item with the same ID is created.
     
 
     """
 
     def __init__(self, series_id: str, item_type: str, item_id: str, time: float, cascade_create: bool = DEFAULT):
-        super().__init__(path="/series/%s/items/" % (series_id), method='post', timeout=1000, ensure_https=False)
+        super().__init__(path="/series/%s/items/" % (series_id), method='post', timeout=3000, ensure_https=False)
         self.series_id = series_id
         self.item_type = item_type
         self.item_id = item_id

{recombee-api-client-4.1.0 → recombee-api-client-5.0.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 that are the most relevant to a particular item.
+    Recommends Segments from a [Segmentation](https://docs.recombee.com/segmentations.html) that are the most relevant to a particular item.
     
     Based on the used Segmentation, this endpoint can be used for example for:
     
@@ -15,7 +15,7 @@ class RecommendItemSegmentsToItem(Request):
       - Recommending the related brands
       - Recommending the related artists
     
-    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).
     

{recombee-api-client-4.1.0 → recombee-api-client-5.0.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 that are the most relevant to a particular Segment from a context Segmentation.
+    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.
     
     Based on the used Segmentations, this endpoint can be used for example for:
     
@@ -14,7 +14,7 @@ class RecommendItemSegmentsToItemSegment(Request):
       - Recommending the related brands to particular category
       - Recommending the related artists to a particular genre (assuming songs are the Items)
     
-    You need to set the used context and result Segmentation the Admin UI in the Scenario settings prior to using this endpoint.
+    You need to set the used context and result 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).
     

{recombee-api-client-4.1.0 → recombee-api-client-5.0.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 for a particular user, based on the user's past interactions.
+    Recommends the top Segments from a [Segmentation](https://docs.recombee.com/segmentations.html) for a particular user, based on the user's past interactions.
     
     Based on the used Segmentation, this endpoint can be used for example for:
     
@@ -15,7 +15,7 @@ class RecommendItemSegmentsToUser(Request):
       - 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).