feat: add guidelines (#3613)

fix: ENT-716

Author: chloedia

core/quivr_core/rag/prompts.py

@@ -270,16 +270,14 @@ def _define_custom_prompts() -> dict[TemplatePromptName, BasePromptTemplate]:
     - When there are multiple similar tickets, prioritize information from the most recent tickets.
     - If there are contradictions between tickets, use information from the most recent ticket as it represents the most up-to-date information.
 
-
-    ------ Output Format ------
-    - You shouln't provide the greetings and the signature as those will be added automatically after generation.
-    - Avoid using lists or bullet points, or any other formatting that feels robotic in the response.
+    ------------ Guidelines -----------
+    {guidelines}
     - Use paragraphs and sentences, you can add it even if not present in similar tickets. The text must be readable and have well defined paragraphs (\\n\\n) or line breaks (\\n).
-    - Provide a neutral tone response, and a generalist answer, avoid specific.
     - Keep the same lexical field as in the similar tickets agent responses.
     - Always add the most relevant informations to the response, just like in similar tickets response so the user have all the informations needed.
     - Stay as close as similar response as possible.
     - Maintain consistency in terminology used in recent tickets.
+    -----------------------------------
 
     ------ Current User Metadata ------
     {user_metadata}

core/quivr_core/rag/quivr_rag_langgraph.py

@@ -228,6 +228,8 @@ class AgentState(TypedDict):
     user_metadata: Optional[dict[str, str]]
     additional_information: Optional[dict[str, str]]
     tool: str
+    guidelines: str
+    additional_information: str
 
 
 class IdempotentCompressor(BaseDocumentCompressor):
@@ -914,10 +916,12 @@ def generate_zendesk_rag(self, state: AgentState) -> AgentState:
         docs: List[Document] = tasks.docs if tasks else []
         messages = state["messages"]
         user_task = messages[0].content
-        # TODO(@AmineDiro): Parse template f-strings and match with keys in state
+        prompt_template: BasePromptTemplate = custom_prompts[
+            TemplatePromptName.ZENDESK_TEMPLATE_PROMPT
+        ]
+
         ticket_metadata = state["ticket_metadata"] or {}
         user_metadata = state["user_metadata"] or {}
-        additional_information = state.get("additional_information", "")
 
         inputs = {
             "similar_tickets": "\n".join([doc.page_content for doc in docs]),
@@ -927,12 +931,13 @@ def generate_zendesk_rag(self, state: AgentState) -> AgentState:
             "system_prompt": self.retrieval_config.prompt
             if self.retrieval_config.prompt
             else "",
-            "additional_information": additional_information,
         }
+        required_variables = prompt_template.input_variables
+        for variable in required_variables:
+            if variable not in inputs:
+                inputs[variable] = state.get(variable, "")
 
-        msg = custom_prompts[TemplatePromptName.ZENDESK_TEMPLATE_PROMPT].format(
-            **inputs
-        )
+        msg = prompt_template.format(**inputs)
         llm = self.bind_tools_to_llm(self.generate_zendesk_rag.__name__)
         response = llm.invoke(msg)