Update functions.py

functions.py

@@ -7,8 +7,7 @@ import os
 openai.api_key = os.getenv("OPENAI_API_KEY") 
 
 COMPLETIONS_MODEL = "gpt-4o-mini"# "gpt-3.5-turbo-instruct" used earlier .
-# EMBEDDING_MODEL = "text-embedding-3-small" 
-EMBEDDING_MODEL = "text-embedding-3-large"
+EMBEDDING_MODEL = "text-embedding-3-large" # "text-embedding-3-small" 
 
 COMPLETIONS_API_PARAMS = {
     # We use temperature of 0.0 because it gives the most predictable, factual answer.
@@ -90,13 +89,26 @@ def answer_query_with_context(
     document_embeddings: dict[(str, str), np.array],
     show_prompt: bool = False
 ) -> str:
+    """
+    Generates a response to a user's query using the most relevant service description.
+
+    This function constructs a prompt by attaching the most relevant service description to the user's query,
+    sends this prompt to the language model to generate a response, and appends additional service-related 
+    information to this response.
+
+    Parameters:
+        query (str): The user's input question.
+        df (pd.DataFrame): A DataFrame containing service descriptions and links.
+        document_embeddings (dict): A dictionary mapping service identifiers to their embeddings.
+        show_prompt (bool, optional): If True, displays the constructed prompt (for debugging). Defaults to False.
+
+    Returns:
+        str: The final response from the chatbot, including the generated answer and additional service details.
+    """
+    # Construct the prompt and retrieve the service link
+    prompt, link = construct_prompt(query, document_embeddings, df)
     
-    prompt, link = construct_prompt(
-        query,
-        document_embeddings,
-        df
-    )
-    
+    # Get the response from the language model
     response = openai.ChatCompletion.create(
         model = COMPLETIONS_MODEL, # "gpt-3.5-turbo",
         messages=[
@@ -105,10 +117,15 @@ def answer_query_with_context(
         ]
     )
     
-    end_message = "\n\nPlease check out the relevant HMC service catalogue for more details: "+ link 
-    end_message += """\n\nIf not satisfied with the answer, please email helpdesk@hmc.edu, call 909.607.7777 or visit the Helpdesk located on the Sprague first floor. """
-    end_message += """Helpdesk representatives are also available for a remote chat session during normal hours on Monday - Friday, 8:00 AM - 5:00 PM PST via https://helpdesk.hmc.edu"""
-    reply = response["choices"][0]["message"]["content"] + end_message
+    # Append additional service-related information
+    end_message = (
+        f"\n\nPlease check out the relevant HMC service catalogue for more details: {link} "
+        "\n\nIf not satisfied with the answer, please email helpdesk@hmc.edu, call 909.607.7777, "
+        "or visit the Helpdesk located on the Sprague first floor. "
+        "Helpdesk representatives are also available for a remote chat session during normal hours (Monday - Friday, "
+        "8:00 AM - 5:00 PM PST) via https://helpdesk.hmc.edu"
+    )
+    
+    reply = response + end_message
 
     return reply
-