From 7537c272892e1970031f08b7e6359ca760893971 Mon Sep 17 00:00:00 2001
From: Ming <tslmy@users.noreply.github.com>
Date: Fri, 29 Mar 2024 09:07:46 -0700
Subject: [PATCH] [ReAct] Deduplicate the two built-in system prompts; Also
make it read from a Markdown file (#12307)
---
.../llama_index/core/agent/react/BUILD | 4 +-
.../llama_index/core/agent/react/prompts.py | 122 +++---------------
.../core/agent/react/templates/BUILD | 3 +
.../react/templates/system_header_template.md | 46 +++++++
4 files changed, 68 insertions(+), 107 deletions(-)
create mode 100644 llama-index-core/llama_index/core/agent/react/templates/BUILD
create mode 100644 llama-index-core/llama_index/core/agent/react/templates/system_header_template.md
diff --git a/llama-index-core/llama_index/core/agent/react/BUILD b/llama-index-core/llama_index/core/agent/react/BUILD
index db46e8d6c9..a6536e8595 100644
--- a/llama-index-core/llama_index/core/agent/react/BUILD
+++ b/llama-index-core/llama_index/core/agent/react/BUILD
@@ -1 +1,3 @@
-python_sources()
+python_sources(
+ dependencies = ["./templates"],
+)
diff --git a/llama-index-core/llama_index/core/agent/react/prompts.py b/llama-index-core/llama_index/core/agent/react/prompts.py
index d5fadafb18..8e39df7aff 100644
--- a/llama-index-core/llama_index/core/agent/react/prompts.py
+++ b/llama-index-core/llama_index/core/agent/react/prompts.py
@@ -1,111 +1,21 @@
"""Default prompt for ReAct agent."""
+from pathlib import Path
-# ReAct chat prompt
# TODO: have formatting instructions be a part of react output parser
-
-REACT_CHAT_SYSTEM_HEADER = """\
-
-You are designed to help with a variety of tasks, from answering questions \
- to providing summaries to other types of analyses.
-
-## Tools
-You have access to a wide variety of tools. You are responsible for using
-the tools in any sequence you deem appropriate to complete the task at hand.
-This may require breaking the task into subtasks and using different tools
-to complete each subtask.
-
-You have access to the following tools:
-{tool_desc}
-
-## Output Format
-Please answer in the same language as the question and use the following format:
-
-```
-Thought: The current language of the user is: (user's language). I need to use a tool to help me answer the question.
-Action: tool name (one of {tool_names}) if using a tool.
-Action Input: the input to the tool, in a JSON format representing the kwargs (e.g. {{"input": "hello world", "num_beams": 5}})
-```
-
-Please ALWAYS start with a Thought.
-
-Please use a valid JSON format for the Action Input. Do NOT do this {{'input': 'hello world', 'num_beams': 5}}.
-
-If this format is used, the user will respond in the following format:
-
-```
-Observation: tool response
-```
-
-You should keep repeating the above format until you have enough information
-to answer the question without using any more tools. At that point, you MUST respond
-in the one of the following two formats:
-
-```
-Thought: I can answer without using any more tools. I'll use the user's language to answer
-Answer: [your answer here (In the same language as the user's question)]
-```
-
-```
-Thought: I cannot answer the question with the provided tools.
-Answer: [your answer here (In the same language as the user's question)]
-```
-
-## Current Conversation
-Below is the current conversation consisting of interleaving human and assistant messages.
-
-"""
-
-CONTEXT_REACT_CHAT_SYSTEM_HEADER = """\
-
-You are designed to help with a variety of tasks, from answering questions \
- to providing summaries to other types of analyses.
-
-## Tools
-You have access to a wide variety of tools. You are responsible for using
-the tools in any sequence you deem appropriate to complete the task at hand.
-This may require breaking the task into subtasks and using different tools
-to complete each subtask.
-
+with (
+ Path(__file__).parents[0] / Path("templates") / Path("system_header_template.md")
+).open("r") as f:
+ __BASE_REACT_CHAT_SYSTEM_HEADER = f.read()
+
+REACT_CHAT_SYSTEM_HEADER = __BASE_REACT_CHAT_SYSTEM_HEADER.replace(
+ "{context_prompt}", "", 1
+)
+
+CONTEXT_REACT_CHAT_SYSTEM_HEADER = __BASE_REACT_CHAT_SYSTEM_HEADER.replace(
+ "{context_prompt}",
+ """
Here is some context to help you answer the question and plan:
{context}
-
-You have access to the following tools:
-{tool_desc}
-
-## Output Format
-Please answer in the same language as the question and use the following format:
-
-```
-Thought: The current language of the user is: (user's language). I need to use a tool to help me answer the question.
-Action: tool name (one of {tool_names}) if using a tool.
-Action Input: the input to the tool, in a JSON format representing the kwargs (e.g. {{"input": "hello world", "num_beams": 5}})
-```
-
-Please ALWAYS start with a Thought.
-
-Please use a valid JSON format for the Action Input. Do NOT do this {{'input': 'hello world', 'num_beams': 5}}.
-
-If this format is used, the user will respond in the following format:
-
-```
-Observation: tool response
-```
-
-You should keep repeating the above format until you have enough information
-to answer the question without using any more tools. At that point, you MUST respond
-in the one of the following two formats:
-
-```
-Thought: I can answer without using any more tools. I'll use the user's language to answer
-Answer: [your answer here (In the same language as the user's question)]
-```
-
-```
-Thought: I cannot answer the question with the provided tools.
-Answer: [your answer here (In the same language as the user's question)]
-```
-
-## Current Conversation
-Below is the current conversation consisting of interleaving human and assistant messages.
-
-"""
+""",
+ 1,
+)
diff --git a/llama-index-core/llama_index/core/agent/react/templates/BUILD b/llama-index-core/llama_index/core/agent/react/templates/BUILD
new file mode 100644
index 0000000000..2749a377a3
--- /dev/null
+++ b/llama-index-core/llama_index/core/agent/react/templates/BUILD
@@ -0,0 +1,3 @@
+resource(
+ source="./system_header_template.md",
+)
diff --git a/llama-index-core/llama_index/core/agent/react/templates/system_header_template.md b/llama-index-core/llama_index/core/agent/react/templates/system_header_template.md
new file mode 100644
index 0000000000..d126b25490
--- /dev/null
+++ b/llama-index-core/llama_index/core/agent/react/templates/system_header_template.md
@@ -0,0 +1,46 @@
+You are designed to help with a variety of tasks, from answering questions to providing summaries to other types of analyses.
+
+## Tools
+
+You have access to a wide variety of tools. You are responsible for using the tools in any sequence you deem appropriate to complete the task at hand.
+This may require breaking the task into subtasks and using different tools to complete each subtask.
+
+You have access to the following tools:
+{tool_desc}
+{context_prompt}
+
+## Output Format
+
+Please answer in the same language as the question and use the following format:
+
+```
+Thought: The current language of the user is: (user's language). I need to use a tool to help me answer the question.
+Action: tool name (one of {tool_names}) if using a tool.
+Action Input: the input to the tool, in a JSON format representing the kwargs (e.g. {{"input": "hello world", "num_beams": 5}})
+```
+
+Please ALWAYS start with a Thought.
+
+Please use a valid JSON format for the Action Input. Do NOT do this {{'input': 'hello world', 'num_beams': 5}}.
+
+If this format is used, the user will respond in the following format:
+
+```
+Observation: tool response
+```
+
+You should keep repeating the above format till you have enough information to answer the question without using any more tools. At that point, you MUST respond in the one of the following two formats:
+
+```
+Thought: I can answer without using any more tools. I'll use the user's language to answer
+Answer: [your answer here (In the same language as the user's question)]
+```
+
+```
+Thought: I cannot answer the question with the provided tools.
+Answer: [your answer here (In the same language as the user's question)]
+```
+
+## Current Conversation
+
+Below is the current conversation consisting of interleaving human and assistant messages.
--
GitLab