Support endpoints for handling search synonyms

Author: OndraFiedler

recombee_api_client/api_client.py

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

recombee_api_client/api_requests/__init__.py

@@ -58,8 +58,12 @@
 from recombee_api_client.api_requests.recommend_next_items import RecommendNextItems
 from recombee_api_client.api_requests.recommend_users_to_user import RecommendUsersToUser
 from recombee_api_client.api_requests.recommend_users_to_item import RecommendUsersToItem
-from recombee_api_client.api_requests.search_items import SearchItems
 from recombee_api_client.api_requests.user_based_recommendation import UserBasedRecommendation
 from recombee_api_client.api_requests.item_based_recommendation import ItemBasedRecommendation
+from recombee_api_client.api_requests.search_items import SearchItems
+from recombee_api_client.api_requests.add_search_synonym import AddSearchSynonym
+from recombee_api_client.api_requests.list_search_synonyms import ListSearchSynonyms
+from recombee_api_client.api_requests.delete_all_search_synonyms import DeleteAllSearchSynonyms
+from recombee_api_client.api_requests.delete_search_synonym import DeleteSearchSynonym
 from recombee_api_client.api_requests.reset_database import ResetDatabase
 from recombee_api_client.api_requests.batch import Batch

recombee_api_client/api_requests/add_search_synonym.py

@@ -0,0 +1,58 @@
+from recombee_api_client.api_requests.request import Request
+import uuid
+
+DEFAULT = uuid.uuid4()
+
+class AddSearchSynonym(Request):
+    """
+    Adds a new synonym for the [Search items](https://docs.recombee.com/api.html#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`).
+    
+    An example of a synonym can be `science fiction` for the term `sci-fi`.
+    
+    Required parameters:
+    
+    :param term: A word to which the `synonym` is specified.
+    
+    :param synonym: A word that should be considered equal to the `term` by the full-text search engine.
+    
+    
+    Optional parameters:
+    
+    :param one_way: If set to `true`, only `term` -> `synonym` is considered. If set to `false`, also `synonym` -> `term` works.
+    
+    
+    Default: `false`.
+    
+    
+
+    """
+
+    def __init__(self, term, synonym, one_way=DEFAULT):
+        self.term = term
+        self.synonym = synonym
+        self.one_way = one_way
+        self.timeout = 10000
+        self.ensure_https = False
+        self.method = 'post'
+        self.path = "/synonyms/items/" % ()
+
+    def get_body_parameters(self):
+        """
+        Values of body parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        p = dict()
+        p['term'] = self.term
+        p['synonym'] = self.synonym
+        if self.one_way is not DEFAULT:
+            p['oneWay'] = self.one_way
+        return p
+
+    def get_query_parameters(self):
+        """
+        Values of query parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        params = dict()
+        return params

recombee_api_client/api_requests/delete_all_search_synonyms.py

@@ -0,0 +1,31 @@
+from recombee_api_client.api_requests.request import Request
+import uuid
+
+DEFAULT = uuid.uuid4()
+
+class DeleteAllSearchSynonyms(Request):
+    """
+    Deletes all synonyms defined in the database.
+    
+
+    """
+
+    def __init__(self):
+        self.timeout = 10000
+        self.ensure_https = False
+        self.method = 'delete'
+        self.path = "/synonyms/items/" % ()
+
+    def get_body_parameters(self):
+        """
+        Values of body parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        p = dict()
+        return p
+
+    def get_query_parameters(self):
+        """
+        Values of query parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        params = dict()
+        return params

recombee_api_client/api_requests/delete_search_synonym.py

@@ -0,0 +1,36 @@
+from recombee_api_client.api_requests.request import Request
+import uuid
+
+DEFAULT = uuid.uuid4()
+
+class DeleteSearchSynonym(Request):
+    """
+    Deletes synonym of given `id` and this synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
+    
+    Required parameters:
+    
+    :param id: ID of the synonym that should be deleted.
+    
+
+    """
+
+    def __init__(self, id):
+        self.id = id
+        self.timeout = 10000
+        self.ensure_https = False
+        self.method = 'delete'
+        self.path = "/synonyms/items/%s" % (self.id)
+
+    def get_body_parameters(self):
+        """
+        Values of body parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        p = dict()
+        return p
+
+    def get_query_parameters(self):
+        """
+        Values of query parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        params = dict()
+        return params

recombee_api_client/api_requests/list_search_synonyms.py

@@ -0,0 +1,43 @@
+from recombee_api_client.api_requests.request import Request
+import uuid
+
+DEFAULT = uuid.uuid4()
+
+class ListSearchSynonyms(Request):
+    """
+    Gives the list of synonyms defined in the database.
+    
+    Optional parameters:
+    
+    :param count: The number of synonyms to be listed.
+    
+    :param offset: Specifies the number of synonyms to skip (ordered by `term`).
+    
+
+    """
+
+    def __init__(self, count=DEFAULT, offset=DEFAULT):
+        self.count = count
+        self.offset = offset
+        self.timeout = 100000
+        self.ensure_https = False
+        self.method = 'get'
+        self.path = "/synonyms/items/" % ()
+
+    def get_body_parameters(self):
+        """
+        Values of body parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        p = dict()
+        return p
+
+    def get_query_parameters(self):
+        """
+        Values of query parameters as a dictionary (name of parameter: value of the parameter).
+        """
+        params = dict()
+        if self.count is not DEFAULT:
+            params['count'] = self.count
+        if self.offset is not DEFAULT:
+            params['offset'] = self.offset
+        return params

setup.py

@@ -11,7 +11,7 @@
 setup(
     name='recombee-api-client',
 
-    version='3.1.0',
+    version='3.2.0',
 
     description='Client for Recombee recommendation API',
     long_description=long_description,

tests/test.py

@@ -134,12 +134,20 @@
     suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(RecommendUsersToUserTestCase))
     from tests.test_cases.test_recommend_users_to_item import RecommendUsersToItemTestCase
     suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(RecommendUsersToItemTestCase))
-    from tests.test_cases.test_search_items import SearchItemsTestCase
-    suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(SearchItemsTestCase))
     from tests.test_cases.test_user_based_recommendation import UserBasedRecommendationTestCase
     suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(UserBasedRecommendationTestCase))
     from tests.test_cases.test_item_based_recommendation import ItemBasedRecommendationTestCase
     suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(ItemBasedRecommendationTestCase))
+    from tests.test_cases.test_search_items import SearchItemsTestCase
+    suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(SearchItemsTestCase))
+    from tests.test_cases.test_add_search_synonym import AddSearchSynonymTestCase
+    suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(AddSearchSynonymTestCase))
+    from tests.test_cases.test_list_search_synonyms import ListSearchSynonymsTestCase
+    suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(ListSearchSynonymsTestCase))
+    from tests.test_cases.test_delete_all_search_synonyms import DeleteAllSearchSynonymsTestCase
+    suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(DeleteAllSearchSynonymsTestCase))
+    from tests.test_cases.test_delete_search_synonym import DeleteSearchSynonymTestCase
+    suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(DeleteSearchSynonymTestCase))
     from tests.test_cases.test_batch import BatchTestCase
     suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(BatchTestCase))
 

tests/test_cases/add_search_synonym.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# This file is auto-generated, do not edit
+#
+
+from tests.test_cases.recombee_test import RecombeeTest, InteractionsTest, RecommendationsTest
+from recombee_api_client.exceptions import ResponseException
+from recombee_api_client.api_requests import *
+
+class AddSearchSynonymTest (RecombeeTest ):
+
+    def create_request(self,term,synonym,one_way=None):
+        pass
+
+    def test_add_search_synonym(self):
+
+        # it 'adds search synonym'
+        req = self.create_request('sci-fi', 'science fiction', one_way=True)
+        resp = self.client.send(req)
+        self.assertEqual(resp['term'], 'sci-fi')
+        self.assertEqual(resp['synonym'], 'science fiction')
+        req = self.create_request('sci-fi', 'science fiction', one_way=True)
+        try:
+            self.client.send(req)
+            self.assertFail()
+        except ResponseException as ex:
+            self.assertEqual(ex.status_code, 409)
+

tests/test_cases/delete_all_search_synonyms.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# This file is auto-generated, do not edit
+#
+
+from tests.test_cases.recombee_test import RecombeeTest, InteractionsTest, RecommendationsTest
+from recombee_api_client.exceptions import ResponseException
+from recombee_api_client.api_requests import *
+
+class DeleteAllSearchSynonymsTest (RecombeeTest ):
+
+    def create_request(self):
+        pass
+
+    def test_delete_all_search_synonyms(self):
+
+        # it 'deletes all search synonyms'
+        req = self.create_request()
+        resp = self.client.send(req)
+

tests/test_cases/delete_search_synonym.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# This file is auto-generated, do not edit
+#
+
+from tests.test_cases.recombee_test import RecombeeTest, InteractionsTest, RecommendationsTest
+from recombee_api_client.exceptions import ResponseException
+from recombee_api_client.api_requests import *
+
+class DeleteSearchSynonymTest (RecombeeTest ):
+
+    def create_request(self,id):
+        pass
+
+    def test_delete_search_synonym(self):
+
+        # it 'deletes search synonym'
+        req = AddSearchSynonym('sci-fi', 'science fiction')
+        resp = self.client.send(req)
+        req = self.create_request(resp['id'])
+        resp = self.client.send(req)
+        req = self.create_request('a968271b-d666-4dfb-8a30-f459e564ba7b')
+        try:
+            self.client.send(req)
+            self.assertFail()
+        except ResponseException as ex:
+            self.assertEqual(ex.status_code, 404)
+

tests/test_cases/list_search_synonyms.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# This file is auto-generated, do not edit
+#
+
+from tests.test_cases.recombee_test import RecombeeTest, InteractionsTest, RecommendationsTest
+from recombee_api_client.exceptions import ResponseException
+from recombee_api_client.api_requests import *
+
+class ListSearchSynonymsTest (RecombeeTest ):
+
+    def create_request(self,count=None,offset=None):
+        pass
+
+    def test_list_search_synonyms(self):
+
+        # it 'lists search synonyms'
+        req = AddSearchSynonym('sci-fi', 'science fiction')
+        resp = self.client.send(req)
+        req = self.create_request()
+        resp = self.client.send(req)
+        self.assertEqual(len(resp['synonyms']), 1)
+        req = self.create_request(count=10, offset=1)
+        resp = self.client.send(req)
+        self.assertEqual(len(resp['synonyms']), 0)
+

tests/test_cases/test_add_search_synonym.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# This file is auto-generated, do not edit
+#
+
+from tests.test_cases.add_search_synonym import AddSearchSynonymTest
+from recombee_api_client.api_requests import *
+
+class AddSearchSynonymTestCase (AddSearchSynonymTest):
+
+    def create_request(self, term, synonym, one_way=None):
+        return AddSearchSynonym(term, synonym, one_way=one_way)

tests/test_cases/test_delete_all_search_synonyms.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# This file is auto-generated, do not edit
+#
+
+from tests.test_cases.delete_all_search_synonyms import DeleteAllSearchSynonymsTest
+from recombee_api_client.api_requests import *
+
+class DeleteAllSearchSynonymsTestCase (DeleteAllSearchSynonymsTest):
+
+    def create_request(self):
+        return DeleteAllSearchSynonyms()

tests/test_cases/test_delete_search_synonym.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# This file is auto-generated, do not edit
+#
+
+from tests.test_cases.delete_search_synonym import DeleteSearchSynonymTest
+from recombee_api_client.api_requests import *
+
+class DeleteSearchSynonymTestCase (DeleteSearchSynonymTest):
+
+    def create_request(self, id):
+        return DeleteSearchSynonym(id)

tests/test_cases/test_list_search_synonyms.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# This file is auto-generated, do not edit
+#
+
+from tests.test_cases.list_search_synonyms import ListSearchSynonymsTest
+from recombee_api_client.api_requests import *
+
+class ListSearchSynonymsTestCase (ListSearchSynonymsTest):
+
+    def create_request(self, count=None, offset=None):
+        return ListSearchSynonyms(count=count, offset=offset)