Add recommId parameter to add interaction requests

Author: OndraFiedler

recombee_api_client/api_client.py

@@ -63,7 +63,7 @@ def send(self, request):
 
     @staticmethod
     def __get_http_headers(additional_headers=None):
-        headers = {'User-Agent': 'recombee-python-api-client/2.1.0'}
+        headers = {'User-Agent': 'recombee-python-api-client/2.2.0'}
         if additional_headers:
             headers.update(additional_headers)
         return headers

recombee_api_client/api_requests/add_bookmark.py

@@ -9,7 +9,7 @@ class AddBookmark(Request):
 
     """
 
-    def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT):
+    def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT, recomm_id=DEFAULT):
         """
         Required parameters:
         @param user_id: User who bookmarked the item
@@ -22,11 +22,14 @@ def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT):
         
         @param cascade_create: Sets whether the given user/item should be created if not present in the database.
         
+        @param recomm_id: If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+        
         """
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp
         self.cascade_create = cascade_create
+        self.recomm_id = recomm_id
         self.timeout = 1000
         self.ensure_https = False
         self.method = 'post'
@@ -43,6 +46,8 @@ def get_body_parameters(self):
             p['timestamp'] = self.timestamp
         if self.cascade_create is not DEFAULT:
             p['cascadeCreate'] = self.cascade_create
+        if self.recomm_id is not DEFAULT:
+            p['recommId'] = self.recomm_id
         return p
 
     def get_query_parameters(self):

recombee_api_client/api_requests/add_cart_addition.py

@@ -9,7 +9,7 @@ class AddCartAddition(Request):
 
     """
 
-    def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT, amount=DEFAULT, price=DEFAULT):
+    def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT, amount=DEFAULT, price=DEFAULT, recomm_id=DEFAULT):
         """
         Required parameters:
         @param user_id: User who added the item to the cart
@@ -26,13 +26,16 @@ def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT,
         
         @param price: Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.
         
+        @param recomm_id: If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+        
         """
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp
         self.cascade_create = cascade_create
         self.amount = amount
         self.price = price
+        self.recomm_id = recomm_id
         self.timeout = 1000
         self.ensure_https = False
         self.method = 'post'
@@ -53,6 +56,8 @@ def get_body_parameters(self):
             p['amount'] = self.amount
         if self.price is not DEFAULT:
             p['price'] = self.price
+        if self.recomm_id is not DEFAULT:
+            p['recommId'] = self.recomm_id
         return p
 
     def get_query_parameters(self):

recombee_api_client/api_requests/add_detail_view.py

@@ -9,7 +9,7 @@ class AddDetailView(Request):
 
     """
 
-    def __init__(self, user_id, item_id, timestamp=DEFAULT, duration=DEFAULT, cascade_create=DEFAULT):
+    def __init__(self, user_id, item_id, timestamp=DEFAULT, duration=DEFAULT, cascade_create=DEFAULT, recomm_id=DEFAULT):
         """
         Required parameters:
         @param user_id: User who viewed the item
@@ -24,12 +24,15 @@ def __init__(self, user_id, item_id, timestamp=DEFAULT, duration=DEFAULT, cascad
         
         @param cascade_create: Sets whether the given user/item should be created if not present in the database.
         
+        @param recomm_id: If this detail view is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+        
         """
         self.user_id = user_id
         self.item_id = item_id
         self.timestamp = timestamp
         self.duration = duration
         self.cascade_create = cascade_create
+        self.recomm_id = recomm_id
         self.timeout = 1000
         self.ensure_https = False
         self.method = 'post'
@@ -48,6 +51,8 @@ def get_body_parameters(self):
             p['duration'] = self.duration
         if self.cascade_create is not DEFAULT:
             p['cascadeCreate'] = self.cascade_create
+        if self.recomm_id is not DEFAULT:
+            p['recommId'] = self.recomm_id
         return p
 
     def get_query_parameters(self):

recombee_api_client/api_requests/add_item_property.py

@@ -18,6 +18,30 @@ def __init__(self, property_name, type):
         @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.
+        
+        
+        * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
+        
+        
+        * `string` - UTF-8 string.
+        
+        
+        * `boolean` - *true* / *false*
+        
+        
+        * `timestamp` - Value representing date and time.
+        
+        
+        * `set` - Set of strings.
+        
+        
+        * `image` - URL of an image (`jpeg`, `png` or `gif`).
+        
+        
+        * `imageList` - List of URLs that refer to images. 
+        
+        
         """
         self.property_name = property_name
         self.type = type

recombee_api_client/api_requests/add_purchase.py

@@ -9,7 +9,7 @@ class AddPurchase(Request):
 
     """
 
-    def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT, amount=DEFAULT, price=DEFAULT, profit=DEFAULT):
+    def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT, amount=DEFAULT, price=DEFAULT, profit=DEFAULT, recomm_id=DEFAULT):
         """
         Required parameters:
         @param user_id: User who purchased the item
@@ -28,6 +28,8 @@ def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT,
         
         @param profit: Your profit from the purchased item. The profit is natural in e-commerce domain (for example if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30), but is applicable also in other domains (for example at a news company it may be income from displayed advertisement on article page). If `amount` is greater than 1, sum of profit of all the items should be given.
         
+        @param recomm_id: If this purchase is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+        
         """
         self.user_id = user_id
         self.item_id = item_id
@@ -36,6 +38,7 @@ def __init__(self, user_id, item_id, timestamp=DEFAULT, cascade_create=DEFAULT,
         self.amount = amount
         self.price = price
         self.profit = profit
+        self.recomm_id = recomm_id
         self.timeout = 1000
         self.ensure_https = False
         self.method = 'post'
@@ -58,6 +61,8 @@ def get_body_parameters(self):
             p['price'] = self.price
         if self.profit is not DEFAULT:
             p['profit'] = self.profit
+        if self.recomm_id is not DEFAULT:
+            p['recommId'] = self.recomm_id
         return p
 
     def get_query_parameters(self):

recombee_api_client/api_requests/add_rating.py

@@ -9,7 +9,7 @@ class AddRating(Request):
 
     """
 
-    def __init__(self, user_id, item_id, rating, timestamp=DEFAULT, cascade_create=DEFAULT):
+    def __init__(self, user_id, item_id, rating, timestamp=DEFAULT, cascade_create=DEFAULT, recomm_id=DEFAULT):
         """
         Required parameters:
         @param user_id: User who submitted the rating
@@ -24,12 +24,15 @@ def __init__(self, user_id, item_id, rating, timestamp=DEFAULT, cascade_create=D
         
         @param cascade_create: Sets whether the given user/item should be created if not present in the database.
         
+        @param recomm_id: If this rating is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+        
         """
         self.user_id = user_id
         self.item_id = item_id
         self.rating = rating
         self.timestamp = timestamp
         self.cascade_create = cascade_create
+        self.recomm_id = recomm_id
         self.timeout = 1000
         self.ensure_https = False
         self.method = 'post'
@@ -47,6 +50,8 @@ def get_body_parameters(self):
             p['timestamp'] = self.timestamp
         if self.cascade_create is not DEFAULT:
             p['cascadeCreate'] = self.cascade_create
+        if self.recomm_id is not DEFAULT:
+            p['recommId'] = self.recomm_id
         return p
 
     def get_query_parameters(self):

recombee_api_client/api_requests/add_user_property.py

@@ -15,7 +15,25 @@ def __init__(self, property_name, type):
         @param property_name: Name of the user property to be created. Currently, the following names are reserved:`id`, `userid`, case insensitively. Also, the length of the property name must not exceed 63 characters.
         
         
-        @param type: Value type of the user property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`
+        @param type: Value type of the user property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`.
+        
+        
+        * `int` - Signed integer number.
+        
+        
+        * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
+        
+        
+        * `string` - UTF-8 string.
+        
+        
+        * `boolean` - *true* / *false*
+        
+        
+        * `timestamp` - Value representing date and time.
+        
+        
+        * `set` - Set of strings.
         
         
         """

recombee_api_client/api_requests/merge_users.py

@@ -8,7 +8,7 @@ class MergeUsers(Request):
     Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable.
     
     
-    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** unless special parameter `keepSourceUser` is set `true`.
+    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**.
 
     """
 

recombee_api_client/api_requests/set_view_portion.py

@@ -10,7 +10,7 @@ class SetViewPortion(Request):
 
     """
 
-    def __init__(self, user_id, item_id, portion, session_id=DEFAULT, timestamp=DEFAULT, cascade_create=DEFAULT):
+    def __init__(self, user_id, item_id, portion, session_id=DEFAULT, timestamp=DEFAULT, cascade_create=DEFAULT, recomm_id=DEFAULT):
         """
         Required parameters:
         @param user_id: User who viewed a portion of the item
@@ -27,13 +27,16 @@ def __init__(self, user_id, item_id, portion, session_id=DEFAULT, timestamp=DEFA
         
         @param cascade_create: Sets whether the given user/item should be created if not present in the database.
         
+        @param recomm_id: If this view portion is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+        
         """
         self.user_id = user_id
         self.item_id = item_id
         self.portion = portion
         self.session_id = session_id
         self.timestamp = timestamp
         self.cascade_create = cascade_create
+        self.recomm_id = recomm_id
         self.timeout = 1000
         self.ensure_https = False
         self.method = 'post'
@@ -53,6 +56,8 @@ def get_body_parameters(self):
             p['timestamp'] = self.timestamp
         if self.cascade_create is not DEFAULT:
             p['cascadeCreate'] = self.cascade_create
+        if self.recomm_id is not DEFAULT:
+            p['recommId'] = self.recomm_id
         return p
 
     def get_query_parameters(self):