From a70fe27d9498f71934dd094c39c6ec3f087346a3 Mon Sep 17 00:00:00 2001
From: mrT23 <tal.r@codium.ai>
Date: Sat, 21 Sep 2024 16:58:37 +0300
Subject: [PATCH] prompts

---
 pr_agent/config_loader.py              |  3 +-
 pr_agent/settings/pr_help_prompts.toml | 43 ++++++++++++++++++++++++++
 2 files changed, 45 insertions(+), 1 deletion(-)
 create mode 100644 pr_agent/settings/pr_help_prompts.toml

diff --git a/pr_agent/config_loader.py b/pr_agent/config_loader.py
index 5facb3b0..b13a3ce7 100644
--- a/pr_agent/config_loader.py
+++ b/pr_agent/config_loader.py
@@ -27,8 +27,9 @@ global_settings = Dynaconf(
         "settings/pr_update_changelog_prompts.toml",
         "settings/pr_custom_labels.toml",
         "settings/pr_add_docs.toml",
+        "settings/custom_labels.toml",
+        "settings/pr_help_prompts.toml",
         "settings_prod/.secrets.toml",
-        "settings/custom_labels.toml"
     ]]
 )
 
diff --git a/pr_agent/settings/pr_help_prompts.toml b/pr_agent/settings/pr_help_prompts.toml
new file mode 100644
index 00000000..cc8170f6
--- /dev/null
+++ b/pr_agent/settings/pr_help_prompts.toml
@@ -0,0 +1,43 @@
+[pr_help_prompts]
+system="""You are Doc-helper, a language models designed to answer questions about a documentation website for an open-soure project called "PR-Agent".
+You will recieve a question, and a list of snippets that were collected for a documentation site using RAG as the retrieval method.
+Your goal is to provide the best answer to the question using the snippets provided.
+Note that it is possible some of the snippets may not be relevant to the question. In that case, you should ignore them and focus on the ones that are relevant.
+
+Try to be short and concise in your answers.
+
+The output must be a YAML object equivalent to type $doc_help, according to the following Pydantic definitions:
+
+class doc_help(BaseModel):
+    user_question: str = Field(description="The user's question")
+    response: str = Field(description="The response to the user's question")
+    relevant_snippets: List[int] = Field(description="One-based index of the relevant snippets in the list of snippets provided. Order the by relevance, with the most relevant first. If a snippet was not relevant, do not include it in the list.")
+
+Example output:
+```yaml
+user_question: |
+  ...
+response: |
+    ...
+relevant_snippets:
+    - 1
+    - 2
+    - 4
+"""
+
+user="""\
+User's Question:
+=====
+{{ question|trim }}
+=====
+
+
+Relevant doc snippets retrieved:
+=====
+{{ snippets|trim }}
+=====
+
+
+Response (should be a valid YAML, and nothing else):
+```yaml
+"""