Update helper/utils.py

helper/utils.py

@@ -129,40 +129,42 @@ def list_to_nums(sentences: List[str]) -> List[List[float]]:
     return embeddings
 
 
-def call_gpt4(prompt: str) -> str:
+def call_gpt(prompt: str, content: str) -> str:
     """
-    Sends a prompt to the GPT-4 model and retrieves a response.
+    Sends a structured conversation context including a system prompt, user prompt,
+    and additional background content to the GPT-3.5-turbo model for a response.
     
-    This function interacts with the OpenAI API, specifically using
-    the gpt-3.5-turbo model to generate a conversational response.
-    It simulates a conversation by providing system messages,
-    past interactions, and the latest user query.
+    This function is responsible for generating an AI-powered response by interacting
+    with the OpenAI API. It puts together a preset system message, a formatted user query,
+    and additional background information before requesting the completion from the model.
     
     Args:
-    - prompt (str): The message from the user for which the GPT model will generate a response.
+        prompt (str): The main question or topic that the user wants to address.
+        content (str): Additional background information or details relevant to the prompt.
     
     Returns:
-    - str: The content of the message generated by the GPT model in response to the prompt.
+        str: The generated response from the GPT model based on the given prompts and content.
     
-    Note: This function assumes that 'client' is an instance of OpenAI's client object
-          that has been properly authenticated and initialized elsewhere in your code.
+    Note: 'client' is assumed to be an already created and authenticated instance of the OpenAI
+          client, which should be set up prior to calling this function.
     """
     
-    # Interact with the OpenAI API to get a response for the prompt provided
+    # Generates a response from the model based on the interactive messages provided
     response = client.chat.completions.create(
-        model="gpt-3.5-turbo",  # Specifies the AI model to use for the response
-        messages=[  # Constructs the context and the prompt for the AI
+        model="gpt-3.5-turbo",  # The AI model being queried for a response
+        messages=[
+            # System message defining the assistant's role
             {"role": "system", "content": "You are a helpful assistant."},
-            {"role": "user", "content": "Who won the world series in 2020?"},
-            {
-                "role": "assistant",
-                "content": "The Los Angeles Dodgers won the World Series in 2020."
-            },
-            {"role": "user", "content": "Where was it played?"}
+            # User message containing the prompt
+            {"role": "user", "content": f"I want to ask you a question: {prompt}"},
+            # Assistant message asking for background content
+            {"role": "assistant", "content": "What is the background content?"},
+            # User providing the background content
+            {"role": "user", "content": content},
         ]
     )
-    
-    # Return the AI's response to the user's most recent prompt
+
+    # Extracts and returns the response content from the model's completion
     return response.choices[0].message.content