feat: Updated xpert client to newer version

Author: irfanuddinahmad

CHANGELOG.rst

@@ -13,6 +13,10 @@ Change Log
 
 Unreleased
 
+[2.3.0] - 2025-04-29
+---------------------
+* feat: updated the xpert client to use the new endpoint
+
 [2.2.1] - 2025-05-05
 ---------------------
 * chore: Upgrade python requirements

taxonomy/__init__.py

@@ -15,4 +15,4 @@
 # 2. MINOR version when you add functionality in a backwards compatible manner, and
 # 3. PATCH version when you make backwards compatible bug fixes.
 # More details can be found at https://semver.org/
-__version__ = '2.2.1'
+__version__ = '2.3.0'

taxonomy/openai/client.py

@@ -9,23 +9,30 @@
 log = logging.getLogger(__name__)
 
 
-def chat_completion(prompt):
+def chat_completion(prompt, system_message=settings.XPERT_DEFAULT_SYSTEM_MESSAGE):
     """
-    Pass message list to chat endpoint, as defined by the CHAT_COMPLETION_API setting.
+    Pass message list to chat endpoint, as defined by the CHAT_COMPLETION_API_V2 setting.
     Arguments:
         prompt (str): chatGPT prompt
+        system_message (str): system message to be used in the chat
     """
-    completion_endpoint = settings.CHAT_COMPLETION_API
-    completion_endpoint_key = settings.CHAT_COMPLETION_API_KEY
-    headers = {'Content-Type': 'application/json', 'x-api-key': completion_endpoint_key}
+    completion_endpoint = settings.CHAT_COMPLETION_API_V2
+    headers = {'Content-Type': 'application/json'}
     connect_timeout = getattr(settings, 'CHAT_COMPLETION_API_CONNECT_TIMEOUT', 1)
     read_timeout = getattr(settings, 'CHAT_COMPLETION_API_READ_TIMEOUT', 15)
-    body = {'message_list': [{'role': 'assistant', 'content': prompt},]}
+    body = {
+        'messages': [{'role': 'assistant', 'content': prompt},],
+        'client_id': settings.XPERT_CLIENT_ID,
+        'system_message': system_message,
+    }
     response = requests.post(
         completion_endpoint,
         headers=headers,
         data=json.dumps(body),
         timeout=(connect_timeout, read_timeout)
     )
-    chat = response.json().get('content')
+    if isinstance(response.json(), dict):
+        chat = response.json().get('content')
+    else:
+        chat = response.json()[0].get('content')
     return chat

test_settings.py

@@ -114,8 +114,9 @@ def root(*args):
 SKILLS_IGNORED_THRESHOLD = 10
 SKILLS_IGNORED_RATIO_THRESHOLD = 0.8
 
-CHAT_COMPLETION_API = 'http://test.chat.ai'
-CHAT_COMPLETION_API_KEY = 'test chat completion api key'
+CHAT_COMPLETION_API_V2 = 'http://test.chat.ai/v2'
+XPERT_CLIENT_ID = 'test client id'
+XPERT_DEFAULT_SYSTEM_MESSAGE = 'test system prompt'
 
 JOB_DESCRIPTION_PROMPT = 'Generate a description for {job_name} job role.'
 JOB_TO_JOB_DESCRIPTION_PROMPT = 'How can a {current_job_name} switch to {future_job_name} job role.'

tests/openai/test_client.py

@@ -16,7 +16,7 @@ class TestChatCompletionClient(TaxonomyTestCase):
     @responses.activate
     def test_client(self):
         """
-        Test that the chat completion client works as expected.
+        Test that the chat completion client works as expected when an object is returned.
         """
         chat_prompt = 'how many courses are offered by edx in the data science area'
         expected_chat_response = {
@@ -25,8 +25,26 @@ def test_client(self):
         }
         responses.add(
             method=responses.POST,
-            url=settings.CHAT_COMPLETION_API,
+            url=settings.CHAT_COMPLETION_API_V2,
             json=expected_chat_response,
         )
         chat_response = chat_completion(chat_prompt)
         self.assertEqual(chat_response, expected_chat_response['content'])
+
+    @responses.activate
+    def test_client_with_list_response(self):
+        """
+        Test that the chat completion client works as expected when a list is returned.
+        """
+        chat_prompt = 'how many courses are offered by edx in the data science area'
+        expected_chat_response = [{
+            "role": "assistant",
+            "content": "edx offers 500 courses in the data science area"
+        }]
+        responses.add(
+            method=responses.POST,
+            url=settings.CHAT_COMPLETION_API_V2,
+            json=expected_chat_response,
+        )
+        chat_response = chat_completion(chat_prompt)
+        self.assertEqual(chat_response, expected_chat_response[0]['content'])