Camel.agents.chat agent

​

ChatAgent

class ChatAgent(BaseAgent):

Class for managing conversations of CAMEL Chat Agents.

Parameters:

• system_message (Union[BaseMessage, str], optional): The system message for the chat agent. (default: :obj:None) model (Union[BaseModelBackend, Tuple[str, str], str, ModelType, Tuple[ModelPlatformType, ModelType], List[BaseModelBackend], List[str], List[ModelType], List[Tuple[str, str]], List[Tuple[ModelPlatformType, ModelType]]], optional): The model backend(s) to use. Can be a single instance, a specification (string, enum, tuple), or a list of instances or specifications to be managed by ModelManager. If a list of specifications (not BaseModelBackend instances) is provided, they will be instantiated using ModelFactory. (default: :obj:ModelPlatformType.DEFAULT with ModelType.DEFAULT)
• memory (AgentMemory, optional): The agent memory for managing chat messages. If None, a :obj:ChatHistoryMemory will be used. (default: :obj:None)
• message_window_size (int, optional): The maximum number of previous messages to include in the context window. If None, no windowing is performed. (default: :obj:None)
• token_limit (int, optional): The maximum number of tokens in a context. The context will be automatically pruned to fulfill the limitation. If None, it will be set according to the backend model. (default: :obj:None)
• output_language (str, optional): The language to be output by the agent. (default: :obj:None)
• tools (Optional[List[Union[FunctionTool, Callable]]], optional): List of available :obj:FunctionTool or :obj:Callable. (default: :obj:None) external_tools (Optional[List[Union[FunctionTool, Callable, Dict[str, Any]]]], optional): List of external tools (:obj:FunctionTool or :obj:Callable or :obj:Dict[str, Any]) bind to one chat agent. When these tools are called, the agent will directly return the request instead of processing it. (default: :obj:None)
• response_terminators (List[ResponseTerminator], optional): List of :obj:ResponseTerminator bind to one chat agent. (default: :obj:None)
• scheduling_strategy (str): name of function that defines how to select the next model in ModelManager. (default: :str:round_robin)
• single_iteration (bool): Whether to let the agent perform only one model calling at each step. (default: :obj:False)
• agent_id (str, optional): The ID of the agent. If not provided, a random UUID will be generated. (default: :obj:None)
• stop_event (Optional[threading.Event], optional): Event to signal termination of the agent’s operation. When set, the agent will terminate its execution. (default: :obj:None)

​

init

def __init__(
    self,
    system_message: Optional[Union[BaseMessage, str]] = None,
    model: Optional[Union[BaseModelBackend, ModelManager, Tuple[str, str], str, ModelType, Tuple[ModelPlatformType, ModelType], List[BaseModelBackend], List[str], List[ModelType], List[Tuple[str, str]], List[Tuple[ModelPlatformType, ModelType]]]] = None,
    memory: Optional[AgentMemory] = None,
    message_window_size: Optional[int] = None,
    token_limit: Optional[int] = None,
    output_language: Optional[str] = None,
    tools: Optional[List[Union[FunctionTool, Callable]]] = None,
    external_tools: Optional[List[Union[FunctionTool, Callable, Dict[str, Any]]]] = None,
    response_terminators: Optional[List[ResponseTerminator]] = None,
    scheduling_strategy: str = 'round_robin',
    single_iteration: bool = False,
    agent_id: Optional[str] = None,
    stop_event: Optional[threading.Event] = None
):

​

reset

def reset(self):

Resets the :obj:ChatAgent to its initial state.

​

_resolve_models

def _resolve_models(
    self,
    model: Optional[Union[BaseModelBackend, Tuple[str, str], str, ModelType, Tuple[ModelPlatformType, ModelType], List[BaseModelBackend], List[str], List[ModelType], List[Tuple[str, str]], List[Tuple[ModelPlatformType, ModelType]]]]
):

Resolves model specifications into model backend instances.

This method handles various input formats for model specifications and returns the appropriate model backend(s).

Parameters:

• model: Model specification in various formats including single model, list of models, or model type specifications.

Returns:

Union[BaseModelBackend, List[BaseModelBackend]]: Resolved model backend(s).

​

_resolve_model_list

def _resolve_model_list(self, model_list: list):

Resolves a list of model specifications into model backend instances.

Parameters:

• model_list (list): List of model specifications in various formats.

Returns:

Union[BaseModelBackend, List[BaseModelBackend]]: Resolved model backend(s).

​

system_message

def system_message(self):

Returns the system message for the agent.

​

tool_dict

def tool_dict(self):

Returns a dictionary of internal tools.

​

output_language

def output_language(self):

Returns the output language for the agent.

​

output_language

def output_language(self, value: str):

Set the output language for the agent.

Note that this will clear the message history.

​

_get_full_tool_schemas

def _get_full_tool_schemas(self):

Returns a list of tool schemas of all tools, including internal and external tools.

​

_get_external_tool_names

def _get_external_tool_names(self):

Returns a set of external tool names.

​

add_tool

def add_tool(self, tool: Union[FunctionTool, Callable]):

Add a tool to the agent.

​

add_tools

def add_tools(self, tools: List[Union[FunctionTool, Callable]]):

Add a list of tools to the agent.

​

add_external_tool

def add_external_tool(self, tool: Union[FunctionTool, Callable, Dict[str, Any]]):

​

remove_tool

def remove_tool(self, tool_name: str):

Remove a tool from the agent by name.

Parameters:

• tool_name (str): The name of the tool to remove.

Returns:

bool: Whether the tool was successfully removed.

​

remove_tools

def remove_tools(self, tool_names: List[str]):

Remove a list of tools from the agent by name.

​

remove_external_tool

def remove_external_tool(self, tool_name: str):

Remove an external tool from the agent by name.

Parameters:

• tool_name (str): The name of the tool to remove.

Returns:

bool: Whether the tool was successfully removed.

​

update_memory

def update_memory(
    self,
    message: BaseMessage,
    role: OpenAIBackendRole,
    timestamp: Optional[float] = None
):

Updates the agent memory with a new message.

Parameters:

• message (BaseMessage): The new message to add to the stored messages.
• role (OpenAIBackendRole): The backend role type.
• timestamp (Optional[float], optional): Custom timestamp for the memory record. If None, current timestamp will be used. (default: :obj:None)

​

load_memory

def load_memory(self, memory: AgentMemory):

Load the provided memory into the agent.

Parameters:

• memory (AgentMemory): The memory to load into the agent.

Returns:

None

​

load_memory_from_path

def load_memory_from_path(self, path: str):

Loads memory records from a JSON file filtered by this agent’s ID.

Parameters:

• path (str): The file path to a JSON memory file that uses JsonStorage.

​

save_memory

def save_memory(self, path: str):

Retrieves the current conversation data from memory and writes it into a JSON file using JsonStorage.

Parameters:

• path (str): Target file path to store JSON data.

​

clear_memory

def clear_memory(self):

Returns:

None

​

_generate_system_message_for_output_language

def _generate_system_message_for_output_language(self):

Returns:

BaseMessage: The new system message.

​

init_messages

def init_messages(self):

Initializes the stored messages list with the current system message.

​

record_message

def record_message(self, message: BaseMessage):

Records the externally provided message into the agent memory as if it were an answer of the :obj:ChatAgent from the backend. Currently, the choice of the critic is submitted with this method.

Parameters:

• message (BaseMessage): An external message to be recorded in the memory.

​

_try_format_message

def _try_format_message(self, message: BaseMessage, response_format: Type[BaseModel]):

Returns:

bool: Whether the message is formatted successfully (or no format is needed).

​

_format_response_if_needed

def _format_response_if_needed(
    self,
    response: ModelResponse,
    response_format: Optional[Type[BaseModel]] = None
):

Format the response if needed.

This function won’t format the response under the following cases:

1. The response format is None (not provided)
2. The response is empty

​

step

def step(
    self,
    input_message: Union[BaseMessage, str],
    response_format: Optional[Type[BaseModel]] = None
):

Executes a single step in the chat session, generating a response to the input message.

Parameters:

• input_message (Union[BaseMessage, str]): The input message for the agent. If provided as a BaseMessage, the role is adjusted to user to indicate an external message.
• response_format (Optional[Type[BaseModel]], optional): A Pydantic model defining the expected structure of the response. Used to generate a structured response if provided. (default: :obj:None)

Returns:

ChatAgentResponse: Contains output messages, a termination status flag, and session information.

​

chat_history

def chat_history(self):

​

_create_token_usage_tracker

def _create_token_usage_tracker(self):

Returns:

Dict[str, int]: A dictionary for tracking token usage.

​

_update_token_usage_tracker

def _update_token_usage_tracker(self, tracker: Dict[str, int], usage_dict: Dict[str, int]):

Updates a token usage tracker with values from a usage dictionary.

Parameters:

• tracker (Dict[str, int]): The token usage tracker to update.
• usage_dict (Dict[str, int]): The usage dictionary with new values.

​

_convert_to_chatagent_response

def _convert_to_chatagent_response(
    self,
    response: ModelResponse,
    tool_call_records: List[ToolCallingRecord],
    num_tokens: int,
    external_tool_call_requests: Optional[List[ToolCallRequest]],
    step_api_prompt_tokens: int = 0,
    step_api_completion_tokens: int = 0,
    step_api_total_tokens: int = 0
):

Parse the final model response into the chat agent response.

​

_record_final_output

def _record_final_output(self, output_messages: List[BaseMessage]):

Log final messages or warnings about multiple responses.

​

_get_model_response

def _get_model_response(
    self,
    openai_messages: List[OpenAIMessage],
    num_tokens: int,
    response_format: Optional[Type[BaseModel]] = None,
    tool_schemas: Optional[List[Dict[str, Any]]] = None
):

Internal function for agent step model response.

​

_sanitize_messages_for_logging

def _sanitize_messages_for_logging(self, messages):

Sanitize OpenAI messages for logging by replacing base64 image data with a simple message and a link to view the image.

Parameters:

• messages (List[OpenAIMessage]): The OpenAI messages to sanitize.

Returns:

List[OpenAIMessage]: The sanitized OpenAI messages.

​

_step_get_info

def _step_get_info(
    self,
    output_messages: List[BaseMessage],
    finish_reasons: List[str],
    usage_dict: Dict[str, int],
    response_id: str,
    tool_calls: List[ToolCallingRecord],
    num_tokens: int,
    external_tool_call_requests: Optional[List[ToolCallRequest]] = None
):

Process the output of a chat step and gather information about the step.

This method checks for termination conditions, updates the agent’s state, and collects information about the chat step, including tool calls and termination reasons.

Parameters:

• output_messages (List[BaseMessage]): The messages generated in this step.
• finish_reasons (List[str]): The reasons for finishing the generation for each message.
• usage_dict (Dict[str, int]): Dictionary containing token usage information.
• response_id (str): The ID of the response from the model.
• tool_calls (List[ToolCallingRecord]): Records of function calls made during this step.
• num_tokens (int): The number of tokens used in this step.
• external_tool_call_request (Optional[ToolCallRequest]): The request for external tool call.

Returns:

Dict[str, Any]: A dictionary containing information about the chat step, including termination status, reasons, and tool call information.

Note: This method iterates over all response terminators and checks if any of them signal termination. If a terminator signals termination, the agent’s state is updated accordingly, and the termination reason is recorded.

​

_handle_batch_response

def _handle_batch_response(self, response: ChatCompletion):

Process a batch response from the model and extract the necessary information.

Parameters:

• response (ChatCompletion): Model response.

Returns:

_ModelResponse: parsed model response.

​

_handle_stream_response

def _handle_stream_response(self, response: Stream[ChatCompletionChunk], prompt_tokens: int):

Process a stream response from the model and extract the necessary information.

Parameters:

• response (dict): Model response.
• prompt_tokens (int): Number of input prompt tokens.

Returns:

_ModelResponse: a parsed model response.

​

_handle_chunk

def _handle_chunk(
    self,
    chunk: ChatCompletionChunk,
    content_dict: defaultdict,
    finish_reasons_dict: defaultdict,
    output_messages: List[BaseMessage]
):

Handle a chunk of the model response.

​

_step_terminate

def _step_terminate(
    self,
    num_tokens: int,
    tool_calls: List[ToolCallingRecord],
    termination_reason: str
):

Create a response when the agent execution is terminated.

This method is called when the agent needs to terminate its execution due to various reasons such as token limit exceeded, or other termination conditions. It creates a response with empty messages but includes termination information in the info dictionary.

Parameters:

• num_tokens (int): Number of tokens in the messages.
• tool_calls (List[ToolCallingRecord]): List of information objects of functions called in the current step.
• termination_reason (str): String describing the reason for termination.

Returns:

ChatAgentResponse: A response object with empty message list, terminated flag set to True, and an info dictionary containing termination details, token counts, and tool call information.

​

_execute_tool

def _execute_tool(self, tool_call_request: ToolCallRequest):

Execute the tool with arguments following the model’s response.

Parameters:

• tool_call_request (_ToolCallRequest): The tool call request.

Returns:

FunctionCallingRecord: A struct for logging information about this function call.

​

_record_tool_calling

def _record_tool_calling(
    self,
    func_name: str,
    args: Dict[str, Any],
    result: Any,
    tool_call_id: str
):

Record the tool calling information in the memory, and return the tool calling record.

​

get_usage_dict

def get_usage_dict(self, output_messages: List[BaseMessage], prompt_tokens: int):

Get usage dictionary when using the stream mode.

Parameters:

• output_messages (list): List of output messages.
• prompt_tokens (int): Number of input prompt tokens.

Returns:

dict: Usage dictionary.

​

add_model_scheduling_strategy

def add_model_scheduling_strategy(self, name: str, strategy_fn: Callable):

Add a scheduling strategy method provided by user to ModelManger.

Parameters:

• name (str): The name of the strategy.
• strategy_fn (Callable): The scheduling strategy function.

​

clone

def clone(self, with_memory: bool = False):

Creates a new instance of :obj:ChatAgent with the same configuration as the current instance.

Parameters:

• with_memory (bool): Whether to copy the memory (conversation history) to the new agent. If True, the new agent will have the same conversation history. If False, the new agent will have a fresh memory with only the system message. (default: :obj:False)

Returns:

ChatAgent: A new instance of :obj:ChatAgent with the same configuration.

​

repr

def __repr__(self):

Returns:

str: The string representation of the :obj:ChatAgent.

​

to_mcp

def to_mcp(
    self,
    name: str = 'CAMEL-ChatAgent',
    description: str = 'A helpful assistant using the CAMEL AI framework.',
    dependencies: Optional[List[str]] = None,
    host: str = 'localhost',
    port: int = 8000
):

Expose this ChatAgent as an MCP server.

Parameters:

• name (str): Name of the MCP server. (default: :obj:CAMEL-ChatAgent)
• description (Optional[List[str]]): Description of the agent. If None, a generic description is used. (default: :obj:A helpful assistant using the CAMEL AI framework.)
• dependencies (Optional[List[str]]): Additional dependencies for the MCP server. (default: :obj:None)
• host (str): Host to bind to for HTTP transport. (default: :obj:localhost)
• port (int): Port to bind to for HTTP transport. (default: :obj:8000)

Returns:

FastMCP: An MCP server instance that can be run.