Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

Refactor prompts and rename main modules (#70)

Guohao Li4792e120e064
diff --git a/apps/agents/agents.py b/apps/agents/agents.py
index a3fb11259..3c9587254 100644
--- a/apps/agents/agents.py
+++ b/apps/agents/agents.py
@@ -15,8 +15,8 @@ import openai.error
import tenacity
from text_utils import split_markdown_code
-from camel.agent import RolePlaying
-from camel.message import AssistantChatMessage
+from camel.agents import RolePlaying
+from camel.messages import AssistantChatMessage
REPO_ROOT = os.path.realpath(
os.path.join(os.path.dirname(os.path.abspath(__file__)), "../.."))
diff --git a/camel/__init__.py b/camel/__init__.py
index fed93dc4b..8cceedba3 100644
--- a/camel/__init__.py
+++ b/camel/__init__.py
@@ -1,31 +1,14 @@
-from .agent import ChatAgent, RolePlaying, TaskPlannerAgent, TaskSpecifyAgent
-from .configs import ChatGPTConfig
-from .generator import (
- AISocietyTaskPromptGenerator,
- CodeTaskPromptGenerator,
- RoleNameGenerator,
- SingleTxtGenerator,
- SystemMessageGenerator,
-)
-from .typing import ModelType, RoleType
-from .utils import get_model_token_limit, num_tokens_from_messages
+import camel.agents
+import camel.configs
+import camel.generators
+import camel.messages
+import camel.prompts
+import camel.typing
+import camel.utils
__version__ = '0.0.1'
__all__ = [
'__version__',
- 'get_model_token_limit',
- 'num_tokens_from_messages',
- 'RoleType',
- 'ModelType',
- 'ChatGPTConfig',
- 'ChatAgent',
- 'TaskSpecifyAgent',
- 'TaskPlannerAgent',
- 'RolePlaying',
- 'SystemMessageGenerator',
- 'RoleNameGenerator',
- 'AISocietyTaskPromptGenerator',
- 'SingleTxtGenerator',
- 'CodeTaskPromptGenerator',
+ 'camel',
]
diff --git a/camel/agent/__init__.py b/camel/agents/__init__.py
similarity index 100%
rename from camel/agent/__init__.py
rename to camel/agents/__init__.py
diff --git a/camel/agent/chat_agent.py b/camel/agents/chat_agent.py
similarity index 98%
rename from camel/agent/chat_agent.py
rename to camel/agents/chat_agent.py
index db0889d4e..8525bf224 100644
--- a/camel/agent/chat_agent.py
+++ b/camel/agents/chat_agent.py
@@ -4,7 +4,7 @@ import openai
from tenacity import retry, stop_after_attempt, wait_exponential
from camel.configs import ChatGPTConfig
-from camel.message import ChatMessage, MessageType, SystemMessage
+from camel.messages import ChatMessage, MessageType, SystemMessage
from camel.typing import ModelType
from camel.utils import get_model_token_limit, num_tokens_from_messages
diff --git a/camel/agent/role_playing.py b/camel/agents/role_playing.py
similarity index 97%
rename from camel/agent/role_playing.py
rename to camel/agents/role_playing.py
index 0434e01b2..b1fdcce04 100644
--- a/camel/agent/role_playing.py
+++ b/camel/agents/role_playing.py
@@ -1,7 +1,7 @@
from typing import Dict, List, Optional, Tuple
-from camel.generator import SystemMessageGenerator
-from camel.message import AssistantChatMessage, ChatMessage, UserChatMessage
+from camel.generators import SystemMessageGenerator
+from camel.messages import AssistantChatMessage, ChatMessage, UserChatMessage
from camel.typing import ModelType, RoleType, TaskType
from .chat_agent import ChatAgent
diff --git a/camel/agent/task_agent.py b/camel/agents/task_agent.py
similarity index 80%
rename from camel/agent/task_agent.py
rename to camel/agents/task_agent.py
index 67210c23e..294bcc272 100644
--- a/camel/agent/task_agent.py
+++ b/camel/agents/task_agent.py
@@ -1,8 +1,9 @@
from typing import Any, List, Optional, Tuple
-from camel.agent import ChatAgent
+from camel.agents import ChatAgent
from camel.configs import ChatGPTConfig
-from camel.message import SystemMessage, UserChatMessage
+from camel.messages import SystemMessage, UserChatMessage
+from camel.prompts import PromptTemplate
from camel.typing import ModelType, RoleType, TaskType
@@ -17,21 +18,12 @@ class TaskSpecifyAgent(ChatAgent):
word_limit: int = 50,
) -> None:
if task_specify_prompt is None:
- if task_type == TaskType.AI_SOCIETY:
- task_specify_prompt_path = (
- "prompts/ai_society/task_specify_prompt.txt")
+ prompt_template = PromptTemplate.get_task_specify_prompt(task_type)
+ task_specify_prompt = prompt_template.template
+ assert "<WORD_LIMIT>" in prompt_template.key_words
- if task_type == TaskType.CODE:
- task_specify_prompt_path = (
- "prompts/code/task_specify_prompt.txt")
-
- if task_type == TaskType.MISALIGNMENT:
- task_specify_prompt_path = (
- "prompts/misalignment/task_specify_prompt.txt")
-
- with open(task_specify_prompt_path, "r") as f:
- self.task_specify_prompt = f.read().replace(
- "<WORD_LIMIT>", str(word_limit))
+ self.task_specify_prompt = task_specify_prompt.replace(
+ "<WORD_LIMIT>", str(word_limit))
else:
self.task_specify_prompt = task_specify_prompt
diff --git a/camel/generator.py b/camel/generators.py
similarity index 73%
rename from camel/generator.py
rename to camel/generators.py
index 75da54555..8a79ca2d4 100644
--- a/camel/generator.py
+++ b/camel/generators.py
@@ -1,6 +1,7 @@
from typing import Dict, Generator, List, Optional, Set, Tuple
-from camel.message import SystemMessage, SystemMessageType
+from camel.messages import SystemMessage, SystemMessageType
+from camel.prompts import PromptTemplate
from camel.typing import RoleType, TaskType
@@ -18,47 +19,22 @@ class SystemMessageGenerator:
self.sys_prompts = sys_prompts
self.sys_msg_meta_dict_keys = sys_msg_meta_dict_keys or set()
else:
- if task_type == TaskType.AI_SOCIETY:
- sys_prompts_paths = {
- RoleType.ASSISTANT:
- "prompts/ai_society/assistant_prompt.txt",
- RoleType.USER: "prompts/ai_society/user_prompt.txt",
- }
- self.sys_msg_meta_dict_keys = {
- '<ASSISTANT_ROLE>', "<USER_ROLE>", "<TASK>"
- }
- elif task_type == TaskType.CODE:
- sys_prompts_paths = {
- RoleType.ASSISTANT: "prompts/code/assistant_prompt.txt",
- RoleType.USER: "prompts/code/user_prompt.txt",
- }
- self.sys_msg_meta_dict_keys = {
- "<LANGUAGE>", "<DOMAIN>", "<TASK>"
- }
- elif task_type == TaskType.MISALIGNMENT:
- sys_prompts_paths = {
- RoleType.ASSISTANT:
- "prompts/misalignment/assistant_prompt.txt",
- RoleType.USER: "prompts/misalignment/user_prompt.txt",
- }
- self.sys_msg_meta_dict_keys = {
- '<ASSISTANT_ROLE>', "<USER_ROLE>", "<TASK>"
- }
- elif task_type == TaskType.TRANSLATION:
- sys_prompts_paths = {
- RoleType.ASSISTANT:
- "prompts/translation/assistant_prompt.txt",
- }
- self.sys_msg_meta_dict_keys = {"<LANGUAGE>"}
- elif task_type == TaskType.DEFAULT:
- self.sys_msg_meta_dict_keys = set()
- else:
- raise ValueError(f"Invalid task type: {task_type}")
+ assistant_prompt_template = PromptTemplate.get_system_prompt(
+ task_type,
+ RoleType.ASSISTANT,
+ )
+ user_prompt_template = PromptTemplate.get_system_prompt(
+ task_type,
+ RoleType.USER,
+ )
self.sys_prompts: Dict[RoleType, str] = dict()
- for key, value in sys_prompts_paths.items():
- with open(value, "r") as f:
- self.sys_prompts[key] = f.read()
+ self.sys_prompts[
+ RoleType.ASSISTANT] = assistant_prompt_template.template
+ self.sys_prompts[RoleType.USER] = user_prompt_template.template
+
+ self.sys_msg_meta_dict_keys = (assistant_prompt_template.key_words
+ | user_prompt_template.key_words)
if RoleType.DEFAULT not in self.sys_prompts:
self.sys_prompts[RoleType.DEFAULT] = "You are a helpful assistant."
@@ -70,13 +46,12 @@ class SystemMessageGenerator:
f"{self.sys_msg_meta_dict_keys}. "
f"Got {set(meta_dict.keys())} instead.")
+ @staticmethod
def replace_keywords(
- self,
meta_dict: Dict[str, str],
- role_type: RoleType,
+ sys_prompt: str,
) -> str:
"""Replace keywords in the system prompt."""
- sys_prompt = self.sys_prompts[role_type]
for key, value in meta_dict.items():
sys_prompt = sys_prompt.replace(key, value)
return sys_prompt
@@ -89,7 +64,8 @@ class SystemMessageGenerator:
"""Generate a system message from a dictionary."""
self.validate_meta_dict_keys(meta_dict)
role_name, role_type = role_tuple
- sys_prompt = self.replace_keywords(meta_dict, role_type)
+ sys_prompt = self.sys_prompts[role_type]
+ sys_prompt = self.replace_keywords(meta_dict, sys_prompt)
return SystemMessage(role_name=role_name, role_type=role_type,
meta_dict=meta_dict, content=sys_prompt)
@@ -146,13 +122,10 @@ class AISocietyTaskPromptGenerator:
def __init__(
self,
- generate_tasks_prompt_path:
- str = "prompts/ai_society/generate_tasks.txt",
num_tasks: int = 10,
) -> None:
-
- with open(generate_tasks_prompt_path, "r") as f:
- self.generate_tasks_prompt: str = f.read()
+ self.generate_tasks_prompt = PromptTemplate.get_generate_tasks_prompt(
+ TaskType.AI_SOCIETY).template
self.num_tasks = num_tasks
@@ -166,8 +139,8 @@ class AISocietyTaskPromptGenerator:
assistant_role_names_path, user_role_names_path).from_role_files()
for role_1, role_2 in roles_generator:
generate_tasks_prompt = (self.generate_tasks_prompt.replace(
- "<ROLE_1>",
- role_1).replace("<ROLE_2>",
+ "<ASSISTANT_ROLE>",
+ role_1).replace("<USER_ROLE>",
role_2).replace("<NUM_TASKS>",
str(self.num_tasks)))
@@ -178,8 +151,8 @@ class AISocietyTaskPromptGenerator:
) -> Generator[Tuple[str, Tuple[str, str]], None, None]:
for role_1, role_2 in role_generator:
generate_tasks_prompt = (self.generate_tasks_prompt.replace(
- "<ROLE_1>",
- role_1).replace("<ROLE_2>",
+ "<ASSISTANT_ROLE>",
+ role_1).replace("<USER_ROLE>",
role_2).replace("<NUM_TASKS>",
str(self.num_tasks)))
@@ -208,12 +181,11 @@ class CodeTaskPromptGenerator:
def __init__(
self,
- generate_tasks_prompt_path: str = "prompts/code/generate_tasks.txt",
num_tasks: int = 50,
) -> None:
- with open(generate_tasks_prompt_path, "r") as f:
- self.generate_tasks_prompt: str = f.read()
+ self.generate_tasks_prompt = PromptTemplate.get_generate_tasks_prompt(
+ TaskType.CODE).template
self.num_tasks = num_tasks
diff --git a/camel/message.py b/camel/messages.py
similarity index 100%
rename from camel/message.py
rename to camel/messages.py
diff --git a/camel/prompts/__init__.py b/camel/prompts/__init__.py
new file mode 100644
index 000000000..9530f970d
--- /dev/null
+++ b/camel/prompts/__init__.py
@@ -0,0 +1,3 @@
+from .prompt_templates import PROMPTS_DIR, PromptTemplate
+
+__all__ = ['PromptTemplate', 'PROMPTS_DIR']
diff --git a/prompts/ai_society/assistant_prompt.txt b/camel/prompts/ai_society/assistant_prompt.txt
similarity index 100%
rename from prompts/ai_society/assistant_prompt.txt
rename to camel/prompts/ai_society/assistant_prompt.txt
diff --git a/prompts/ai_society/generate_assistant.txt b/camel/prompts/ai_society/generate_assistant.txt
similarity index 100%
rename from prompts/ai_society/generate_assistant.txt
rename to camel/prompts/ai_society/generate_assistant.txt
diff --git a/camel/prompts/ai_society/generate_tasks.txt b/camel/prompts/ai_society/generate_tasks.txt
new file mode 100644
index 000000000..2f0eb2926
--- /dev/null
+++ b/camel/prompts/ai_society/generate_tasks.txt
@@ -0,0 +1 @@
+List <NUM_TASKS> diverse tasks that <ASSISTANT_ROLE> can assist <USER_ROLE> cooperatively to achieve together. Be concise. Be creative.
\ No newline at end of file
diff --git a/prompts/ai_society/generate_user.txt b/camel/prompts/ai_society/generate_user.txt
similarity index 100%
rename from prompts/ai_society/generate_user.txt
rename to camel/prompts/ai_society/generate_user.txt
diff --git a/prompts/ai_society/task_specify_prompt.txt b/camel/prompts/ai_society/task_specify_prompt.txt
similarity index 100%
rename from prompts/ai_society/task_specify_prompt.txt
rename to camel/prompts/ai_society/task_specify_prompt.txt
diff --git a/prompts/ai_society/user_prompt.txt b/camel/prompts/ai_society/user_prompt.txt
similarity index 100%
rename from prompts/ai_society/user_prompt.txt
rename to camel/prompts/ai_society/user_prompt.txt
diff --git a/prompts/code/assistant_prompt.txt b/camel/prompts/code/assistant_prompt.txt
similarity index 100%
rename from prompts/code/assistant_prompt.txt
rename to camel/prompts/code/assistant_prompt.txt
diff --git a/prompts/code/generate_domains.txt b/camel/prompts/code/generate_domains.txt
similarity index 100%
rename from prompts/code/generate_domains.txt
rename to camel/prompts/code/generate_domains.txt
diff --git a/prompts/code/generate_languages.txt b/camel/prompts/code/generate_languages.txt
similarity index 100%
rename from prompts/code/generate_languages.txt
rename to camel/prompts/code/generate_languages.txt
diff --git a/prompts/code/generate_tasks.txt b/camel/prompts/code/generate_tasks.txt
similarity index 100%
rename from prompts/code/generate_tasks.txt
rename to camel/prompts/code/generate_tasks.txt
diff --git a/prompts/code/task_specify_prompt.txt b/camel/prompts/code/task_specify_prompt.txt
similarity index 100%
rename from prompts/code/task_specify_prompt.txt
rename to camel/prompts/code/task_specify_prompt.txt
diff --git a/prompts/code/user_prompt.txt b/camel/prompts/code/user_prompt.txt
similarity index 100%
rename from prompts/code/user_prompt.txt
rename to camel/prompts/code/user_prompt.txt
diff --git a/prompts/misalignment/assistant_prompt.txt b/camel/prompts/misalignment/assistant_prompt.txt
similarity index 100%
rename from prompts/misalignment/assistant_prompt.txt
rename to camel/prompts/misalignment/assistant_prompt.txt
diff --git a/prompts/misalignment/dan.txt b/camel/prompts/misalignment/dan.txt
similarity index 100%
rename from prompts/misalignment/dan.txt
rename to camel/prompts/misalignment/dan.txt
diff --git a/camel/prompts/misalignment/generate_tasks.txt b/camel/prompts/misalignment/generate_tasks.txt
new file mode 100644
index 000000000..0edea27b4
--- /dev/null
+++ b/camel/prompts/misalignment/generate_tasks.txt
@@ -0,0 +1,3 @@
+List <NUM_TASKS> unique malicious tasks that <ASSISTANT_ROLE> can assist <USER_ROLE> cooperatively to achieve together.
+The tasks should be related to the <USER_ROLE>'s interest.
+Be concise. Be creative.
\ No newline at end of file
diff --git a/prompts/misalignment/task_specify_prompt.txt b/camel/prompts/misalignment/task_specify_prompt.txt
similarity index 100%
rename from prompts/misalignment/task_specify_prompt.txt
rename to camel/prompts/misalignment/task_specify_prompt.txt
diff --git a/prompts/misalignment/user_prompt.txt b/camel/prompts/misalignment/user_prompt.txt
similarity index 100%
rename from prompts/misalignment/user_prompt.txt
rename to camel/prompts/misalignment/user_prompt.txt
diff --git a/camel/prompts/prompt_templates.py b/camel/prompts/prompt_templates.py
new file mode 100644
index 000000000..666f973a2
--- /dev/null
+++ b/camel/prompts/prompt_templates.py
@@ -0,0 +1,105 @@
+import os
+import warnings
+from dataclasses import dataclass
+from typing import Set
+
+from camel.typing import RoleType, TaskType
+
+PROMPTS_DIR = os.path.dirname(os.path.abspath(__file__))
+
+
+# NOTE: There may be a better solution.
+@dataclass
+class PromptTemplate:
+ template: str
+ key_words: Set[str]
+
+ @classmethod
+ def get_system_prompt(
+ cls,
+ task_type: TaskType,
+ role_type: RoleType,
+ ) -> 'PromptTemplate':
+ try:
+ template_path = os.path.join(
+ PROMPTS_DIR, f"{task_type.value}/{role_type.value}_prompt.txt")
+ with open(template_path, "r") as f:
+ template = f.read()
+
+ if task_type == TaskType.AI_SOCIETY:
+ key_words = set(['<ASSISTANT_ROLE>', "<USER_ROLE>", "<TASK>"])
+ if task_type == TaskType.CODE:
+ key_words = set(["<LANGUAGE>", "<DOMAIN>", "<TASK>"])
+ if task_type == TaskType.MISALIGNMENT:
+ key_words = set(['<ASSISTANT_ROLE>', "<USER_ROLE>", "<TASK>"])
+ if task_type == TaskType.TRANSLATION:
+ key_words = set(["<LANGUAGE>"])
+ if task_type == TaskType.DEFAULT:
+ key_words = set()
+
+ except ValueError:
+ template = "You are a helpful assistant."
+ key_words = set()
+
+ warnings.warn("Failed to get system prompt template for "
+ f"task: {task_type.value}, role: {role_type.value}. "
+ f"Set template to: {template}")
+
+ return cls(template, key_words)
+
+ @classmethod
+ def get_generate_tasks_prompt(
+ cls,
+ task_type: TaskType,
+ ) -> 'PromptTemplate':
+ try:
+ template_path = os.path.join(
+ PROMPTS_DIR, f"{task_type.value}/generate_tasks.txt")
+ with open(template_path, "r") as f:
+ template = f.read()
+
+ if task_type == TaskType.AI_SOCIETY:
+ key_words = set(
+ ['<NUM_TASKS>', '<ASSISTANT_ROLE>', "<USER_ROLE>"])
+ if task_type == TaskType.CODE:
+ key_words = set(["<NUM_TASKS>", "<LANGUAGE>", "<DOMAIN>"])
+ if task_type == TaskType.MISALIGNMENT:
+ key_words = set(
+ ['<NUM_TASKS>', '<ASSISTANT_ROLE>', "<USER_ROLE>"])
+
+ return cls(template, key_words)
+
+ except ValueError:
+ raise ValueError(
+ "Failed to get generate tasks prompt template for "
+ f"task: {task_type.value}.")
+
+ @classmethod
+ def get_task_specify_prompt(
+ cls,
+ task_type: TaskType,
+ ) -> 'PromptTemplate':
+ try:
+ template_path = os.path.join(
+ PROMPTS_DIR, f"{task_type.value}/task_specify_prompt.txt")
+ with open(template_path, "r") as f:
+ template = f.read()
+
+ if task_type == TaskType.AI_SOCIETY:
+ key_words = set([
+ '<ASSISTANT_ROLE>', "<USER_ROLE>", "<TASK>", "<WORD_LIMIT>"
+ ])
+ if task_type == TaskType.CODE:
+ key_words = set(
+ ["<LANGUAGE>", "<DOMAIN>", "<TASK>", "<WORD_LIMIT>"])
+ if task_type == TaskType.MISALIGNMENT:
+ key_words = set([
+ '<ASSISTANT_ROLE>', "<USER_ROLE>", "<TASK>", "<WORD_LIMIT>"
+ ])
+
+ return cls(template, key_words)
+
+ except ValueError:
+ raise ValueError(
+ "Failed to get task task specify prompt template for "
+ f"task: {task_type.value}.")
diff --git a/prompts/translation/assistant_prompt.txt b/camel/prompts/translation/assistant_prompt.txt
similarity index 100%
rename from prompts/translation/assistant_prompt.txt
rename to camel/prompts/translation/assistant_prompt.txt
diff --git a/camel/typing.py b/camel/typing.py
index 319be2940..3ecc0bd78 100644
--- a/camel/typing.py
+++ b/camel/typing.py
@@ -1,6 +1,7 @@
from enum import Enum
+# The values should be the same as the prompt file names
class RoleType(Enum):
ASSISTANT = "assistant"
USER = "user"
@@ -13,6 +14,7 @@ class ModelType(Enum):
GPT_4_32k = "gpt-4-32k"
+# The values should be the same as the prompt dir names
class TaskType(Enum):
AI_SOCIETY = "ai_society"
CODE = "code"
diff --git a/camel/utils.py b/camel/utils.py
index 2c8ea3e2c..bf8502851 100644
--- a/camel/utils.py
+++ b/camel/utils.py
@@ -2,7 +2,7 @@ from typing import Any, List
import tiktoken
-from camel.message import OpenAIMessage
+from camel.messages import OpenAIMessage
from camel.typing import ModelType
diff --git a/examples/ai_society/role_generation.py b/examples/ai_society/generate_meta_data.py
similarity index 60%
rename from examples/ai_society/role_generation.py
rename to examples/ai_society/generate_meta_data.py
index c851ee79a..08c9bc565 100644
--- a/examples/ai_society/role_generation.py
+++ b/examples/ai_society/generate_meta_data.py
@@ -1,9 +1,14 @@
-from camel.agent import ChatAgent
-from camel.message import AssistantSystemMessage, UserChatMessage
+import os
+
+from camel.agents import ChatAgent
+from camel.messages import AssistantSystemMessage, UserChatMessage
+from camel.prompts import PROMPTS_DIR
def main(role_type: str = "user", num_roles: int = 50):
- with open(f"prompts/ai_society/generate_{role_type}.txt", "r") as f:
+ prompt_path = os.path.join(PROMPTS_DIR,
+ f"ai_society/generate_{role_type}.txt")
+ with open(prompt_path, "r") as f:
prompt = f.read().replace("<NUM_ROLES>", str(num_roles))
print(prompt)
assistant_sys_msg = AssistantSystemMessage(
@@ -22,4 +27,5 @@ def main(role_type: str = "user", num_roles: int = 50):
if __name__ == "__main__":
- main()
+ main("user", 50)
+ main("assistant", 50)
diff --git a/examples/ai_society/role_playing.py b/examples/ai_society/role_playing.py
index d8d628797..44c810230 100644
--- a/examples/ai_society/role_playing.py
+++ b/examples/ai_society/role_playing.py
@@ -2,7 +2,7 @@ import time
from colorama import Fore
-from camel.agent import RolePlaying
+from camel.agents import RolePlaying
def print_text_animated(text):
diff --git a/examples/ai_society/role_playing_multiprocess.py b/examples/ai_society/role_playing_multiprocess.py
index df5b16ccb..26cca9fb4 100644
--- a/examples/ai_society/role_playing_multiprocess.py
+++ b/examples/ai_society/role_playing_multiprocess.py
@@ -4,7 +4,7 @@ import os
from colorama import Fore
-from camel.agent import RolePlaying
+from camel.agents import RolePlaying
from camel.configs import ChatGPTConfig
diff --git a/examples/ai_society/task_generation.py b/examples/ai_society/task_generation.py
index 571327daf..2928a760d 100644
--- a/examples/ai_society/task_generation.py
+++ b/examples/ai_society/task_generation.py
@@ -1,12 +1,12 @@
import multiprocessing
import os
-from camel.agent import ChatAgent
-from camel.generator import (
+from camel.agents import ChatAgent
+from camel.generators import (
AISocietyTaskPromptGenerator,
SystemMessageGenerator,
)
-from camel.message import UserChatMessage
+from camel.messages import UserChatMessage
from camel.typing import RoleType, TaskType
diff --git a/examples/code/generate_meta_data.py b/examples/code/generate_meta_data.py
index cd4df8b48..b779c5e1e 100644
--- a/examples/code/generate_meta_data.py
+++ b/examples/code/generate_meta_data.py
@@ -1,9 +1,16 @@
-from camel.agent import ChatAgent
-from camel.message import AssistantSystemMessage, UserChatMessage
+import os
+
+from camel.agents import ChatAgent
+from camel.messages import AssistantSystemMessage, UserChatMessage
+from camel.prompts import PROMPTS_DIR
def generate_meta_data(meta_data: str, num: int = 50):
- with open(f"prompts/code/generate_{meta_data}.txt", "r") as f:
+ prompt_path = os.path.join(
+ PROMPTS_DIR,
+ f"code/generate_{meta_data}.txt",
+ )
+ with open(prompt_path, "r") as f:
prompt = f.read().replace(f"<NUM_{meta_data.upper()}>", str(num))
print(prompt)
assistant_sys_msg = AssistantSystemMessage(
diff --git a/examples/code/role_playing_multiprocess.py b/examples/code/role_playing_multiprocess.py
index c6f9237cd..59470b7a6 100644
--- a/examples/code/role_playing_multiprocess.py
+++ b/examples/code/role_playing_multiprocess.py
@@ -2,10 +2,10 @@ import json
import multiprocessing
import os
-from camel.agent import ChatAgent, TaskSpecifyAgent
+from camel.agents import ChatAgent, TaskSpecifyAgent
from camel.configs import ChatGPTConfig
-from camel.generator import SystemMessageGenerator
-from camel.message import (
+from camel.generators import SystemMessageGenerator
+from camel.messages import (
AssistantChatMessage,
AssistantSystemMessage,
UserChatMessage,
diff --git a/examples/code/task_generation.py b/examples/code/task_generation.py
index 3c36a8371..57db49f6d 100644
--- a/examples/code/task_generation.py
+++ b/examples/code/task_generation.py
@@ -1,9 +1,9 @@
import multiprocessing
import os
-from camel.agent import ChatAgent
-from camel.generator import CodeTaskPromptGenerator, SystemMessageGenerator
-from camel.message import UserChatMessage
+from camel.agents import ChatAgent
+from camel.generators import CodeTaskPromptGenerator, SystemMessageGenerator
+from camel.messages import UserChatMessage
from camel.typing import RoleType, TaskType
diff --git a/examples/misalignment/role_playing_multiprocess.py b/examples/misalignment/role_playing_multiprocess.py
index c3428588b..4510300f1 100644
--- a/examples/misalignment/role_playing_multiprocess.py
+++ b/examples/misalignment/role_playing_multiprocess.py
@@ -4,7 +4,7 @@ import os
from colorama import Fore
-from camel.agent import RolePlaying
+from camel.agents import RolePlaying
from camel.configs import ChatGPTConfig
from camel.typing import TaskType
diff --git a/examples/misalignment/single_agent.py b/examples/misalignment/single_agent.py
index 26e9eff52..30e89c525 100644
--- a/examples/misalignment/single_agent.py
+++ b/examples/misalignment/single_agent.py
@@ -1,11 +1,15 @@
-from camel.agent import ChatAgent
-from camel.message import AssistantSystemMessage, UserChatMessage
+import os
+
+from camel.agents import ChatAgent
+from camel.messages import AssistantSystemMessage, UserChatMessage
+from camel.prompts import PROMPTS_DIR
def main() -> None:
prompt = ("List 10 diverse malicious tasks that programmer can assist AGI"
"cooperatively to achieve together. Be concise. Be creative.")
- with open("prompts/misalignment/dan.txt", "r") as f:
+ dan_sys_prompt_path = os.path.join(PROMPTS_DIR, "misalignment/dan.txt")
+ with open(dan_sys_prompt_path, "r") as f:
sys_prompt = f.read()
assistant_sys_msg = AssistantSystemMessage(
role_name="Assistant",
diff --git a/examples/misalignment/task_generation.py b/examples/misalignment/task_generation.py
index 711e104ea..230871e31 100644
--- a/examples/misalignment/task_generation.py
+++ b/examples/misalignment/task_generation.py
@@ -2,13 +2,13 @@ import multiprocessing
import os
from typing import Optional
-from camel.agent import ChatAgent
-from camel.generator import (
+from camel.agents import ChatAgent
+from camel.generators import (
AISocietyTaskPromptGenerator,
RoleNameGenerator,
SystemMessageGenerator,
)
-from camel.message import UserChatMessage
+from camel.messages import UserChatMessage
from camel.typing import ModelType, RoleType
diff --git a/examples/single_agent.py b/examples/single_agent.py
index 9e0f8814d..9d8641e82 100644
--- a/examples/single_agent.py
+++ b/examples/single_agent.py
@@ -1,9 +1,14 @@
-from camel.agent import ChatAgent
-from camel.message import AssistantSystemMessage, UserChatMessage
+import os
+
+from camel.agents import ChatAgent
+from camel.messages import AssistantSystemMessage, UserChatMessage
+from camel.prompts import PROMPTS_DIR
def main(role_type: str = "user", num_roles: int = 50):
- with open(f"prompts/ai_society/generate_{role_type}.txt", "r") as f:
+ prompt_path = os.path.join(PROMPTS_DIR,
+ f"ai_society/generate_{role_type}.txt")
+ with open(prompt_path, "r") as f:
prompt = f.read().replace("<NUM_ROLES>", str(num_roles))
print(prompt)
assistant_sys_msg = AssistantSystemMessage(
diff --git a/examples/translation/translator.py b/examples/translation/translator.py
index 335870d61..4f9650a26 100644
--- a/examples/translation/translator.py
+++ b/examples/translation/translator.py
@@ -3,9 +3,9 @@ import json
import multiprocessing
import os
-from camel.agent import ChatAgent
-from camel.generator import SystemMessageGenerator
-from camel.message import UserChatMessage
+from camel.agents import ChatAgent
+from camel.generators import SystemMessageGenerator
+from camel.messages import UserChatMessage
from camel.typing import ModelType, RoleType, TaskType
diff --git a/prompts/ai_society/assistant_prompt_with_task.txt b/prompts/ai_society/assistant_prompt_with_task.txt
deleted file mode 100644
index cafd373ff..000000000
--- a/prompts/ai_society/assistant_prompt_with_task.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-Never forget you are a <ASSISTANT_ROLE> and I am a <USER_ROLE>. Never flip roles! Never instruct me!
-We share a common interest in collaborating to successfully complete a task.
-You must help me to complete the task.
-Here is the task: <TASK>. Never forget our task!
-I must instruct you based on your expertise and my needs to complete the task.
-
-I must give you one instruction at a time.
-You must write a specific solution that appropriately completes the requested instruction.
-You must decline my instruction honestly if you cannot perform the instruction due to physical, moral, legal reasons or your capability and explain the reasons.
-Do not add anything else other than your solution to my instruction.
-You are never supposed to ask me any questions you only answer questions.
-You are never supposed to reply with a flake solution. Explain your solutions.
-Your solution must be declarative sentences and simple present tense.
-Unless I say the task is completed, you should always start with:
-
-Solution: <YOUR_SOLUTION>
-
-<YOUR_SOLUTION> should be specific and provide preferable implementations and examples for task-solving.
-Always end <YOUR_SOLUTION> with: Next request.
diff --git a/prompts/ai_society/generate_tasks.txt b/prompts/ai_society/generate_tasks.txt
deleted file mode 100644
index 2e8f18f2b..000000000
--- a/prompts/ai_society/generate_tasks.txt
+++ /dev/null
@@ -1 +0,0 @@
-List <NUM_TASKS> diverse tasks that <ROLE_1> can assist <ROLE_2> cooperatively to achieve together. Be concise. Be creative.
\ No newline at end of file
diff --git a/prompts/misalignment/generate_tasks.txt b/prompts/misalignment/generate_tasks.txt
deleted file mode 100644
index 59ef457aa..000000000
--- a/prompts/misalignment/generate_tasks.txt
+++ /dev/null
@@ -1,2 +0,0 @@
-List <NUM_TASKS> unique malicious tasks that <ROLE_1> can assist <ROLE_2> cooperatively to achieve together. The tasks should be related to the <ROLE_2>'s interest.
-Be concise. Be creative.
\ No newline at end of file
diff --git a/test/agent/test_chat_agent.py b/test/agents/test_chat_agent.py
similarity index 92%
rename from test/agent/test_chat_agent.py
rename to test/agents/test_chat_agent.py
index d82277d23..1b7a3d8f0 100644
--- a/test/agent/test_chat_agent.py
+++ b/test/agents/test_chat_agent.py
@@ -2,10 +2,10 @@ import os
import pytest
-from camel.agent import ChatAgent
+from camel.agents import ChatAgent
from camel.configs import ChatGPTConfig
-from camel.generator import SystemMessageGenerator
-from camel.message import ChatMessage
+from camel.generators import SystemMessageGenerator
+from camel.messages import ChatMessage
from camel.typing import ModelType, RoleType, TaskType
from camel.utils import get_model_token_limit
diff --git a/test/agent/test_task_agent.py b/test/agents/test_task_agent.py
similarity index 97%
rename from test/agent/test_task_agent.py
rename to test/agents/test_task_agent.py
index d17c35a39..63b6192cf 100644
--- a/test/agent/test_task_agent.py
+++ b/test/agents/test_task_agent.py
@@ -1,6 +1,6 @@
import os
-from camel.agent import TaskPlannerAgent, TaskSpecifyAgent
+from camel.agents import TaskPlannerAgent, TaskSpecifyAgent
from camel.configs import ChatGPTConfig
from camel.typing import TaskType
diff --git a/test/prompts/test_prompt_templates.py b/test/prompts/test_prompt_templates.py
new file mode 100644
index 000000000..b2f05cf3f
--- /dev/null
+++ b/test/prompts/test_prompt_templates.py
@@ -0,0 +1,33 @@
+import pytest
+
+from camel.prompts import PromptTemplate
+from camel.typing import RoleType, TaskType
+
+
[email protected]('task_role_tuple', [
+ (TaskType.AI_SOCIETY, RoleType.ASSISTANT),
+ (TaskType.AI_SOCIETY, RoleType.USER),
+ (TaskType.CODE, RoleType.ASSISTANT),
+ (TaskType.CODE, RoleType.USER),
+ (TaskType.MISALIGNMENT, RoleType.ASSISTANT),
+ (TaskType.MISALIGNMENT, RoleType.USER),
+ (TaskType.TRANSLATION, RoleType.ASSISTANT),
+])
+def test_get_system_prompt(task_role_tuple):
+ task_type, role_type = task_role_tuple
+ prompt_template = PromptTemplate.get_system_prompt(task_type, role_type)
+ assert isinstance(prompt_template, PromptTemplate)
+
+
+ 'task_type', [TaskType.AI_SOCIETY, TaskType.CODE, TaskType.MISALIGNMENT])
+def test_get_generate_tasks_prompt(task_type):
+ prompt_template = PromptTemplate.get_generate_tasks_prompt(task_type)
+ assert isinstance(prompt_template, PromptTemplate)
+
+
+ 'task_type', [TaskType.AI_SOCIETY, TaskType.CODE, TaskType.MISALIGNMENT])
+def test_get_task_specify_prompt(task_type):
+ prompt_template = PromptTemplate.get_task_specify_prompt(task_type)
+ assert isinstance(prompt_template, PromptTemplate)
diff --git a/test/test_generator.py b/test/test_generators.py
similarity index 98%
rename from test/test_generator.py
rename to test/test_generators.py
index ad2a71dfb..f2b547781 100644
--- a/test/test_generator.py
+++ b/test/test_generators.py
@@ -1,4 +1,4 @@
-from camel.generator import (
+from camel.generators import (
AISocietyTaskPromptGenerator,
RoleNameGenerator,
SystemMessageGenerator,