Skip to content

Commit 5e34848

Browse files
author
camel-docs-bot
committed
Auto-update documentation after merge [skip ci]
1 parent 104da63 commit 5e34848

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

docs/mintlify/reference/camel.agents.chat_agent.mdx

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -672,6 +672,41 @@ def init_messages(self):
672672
Initializes the stored messages list with the current system
673673
message.
674674

675+
<a id="camel.agents.chat_agent.ChatAgent.update_system_message"></a>
676+
677+
### update_system_message
678+
679+
```python
680+
def update_system_message(
681+
self,
682+
system_message: Union[BaseMessage, str],
683+
reset_memory: bool = True
684+
):
685+
```
686+
687+
Update the system message.
688+
It will reset conversation with new system message.
689+
690+
**Parameters:**
691+
692+
- **system_message** (Union[BaseMessage, str]): The new system message. Can be either a BaseMessage object or a string. If a string is provided, it will be converted into a BaseMessage object.
693+
- **reset_memory** (bool): Whether to reinitialize conversation messages after updating the system message. Defaults to True.
694+
695+
<a id="camel.agents.chat_agent.ChatAgent.append_to_system_message"></a>
696+
697+
### append_to_system_message
698+
699+
```python
700+
def append_to_system_message(self, content: str, reset_memory: bool = True):
701+
```
702+
703+
Append additional context to existing system message.
704+
705+
**Parameters:**
706+
707+
- **content** (str): The additional system message.
708+
- **reset_memory** (bool): Whether to reinitialize conversation messages after appending additional context. Defaults to True.
709+
675710
<a id="camel.agents.chat_agent.ChatAgent.reset_to_original_system_message"></a>
676711

677712
### reset_to_original_system_message

docs/mintlify/reference/camel.messages.base.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,31 @@ Create a new assistant message.
8888

8989
BaseMessage: The new assistant message.
9090

91+
<a id="camel.messages.base.BaseMessage.make_system_message"></a>
92+
93+
### make_system_message
94+
95+
```python
96+
def make_system_message(
97+
cls,
98+
content: str,
99+
role_name: str = 'System',
100+
meta_dict: Optional[Dict[str, str]] = None
101+
):
102+
```
103+
104+
Create a new system message.
105+
106+
**Parameters:**
107+
108+
- **content** (str): The content of the system message.
109+
- **role_name** (str): The name of the system role. (default: :obj:`"System"`)
110+
- **meta_dict** (Optional[Dict[str, str]]): Additional metadata dictionary for the message.
111+
112+
**Returns:**
113+
114+
BaseMessage: The new system message.
115+
91116
<a id="camel.messages.base.BaseMessage.create_new_instance"></a>
92117

93118
### create_new_instance

0 commit comments

Comments
 (0)