Skip to content

Commit 35c54d9

Browse files
author
camel-docs-bot
committed
Auto-update documentation after merge [skip ci]
1 parent 746db0f commit 35c54d9

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

docs/mintlify/key_modules/societies.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ icon: people-group
7070
<tr><td>extend_sys_msg_meta_dicts</td><td>List[Dict]</td><td>Extra metadata for system messages</td></tr>
7171
<tr><td>extend_task_specify_meta_dict</td><td>Dict</td><td>Extra metadata for task specification</td></tr>
7272
<tr><td>output_language</td><td>str</td><td>Target output language</td></tr>
73+
<tr><td>assistant_agent</td><td>ChatAgent</td><td>Custom ChatAgent to use as assistant (optional)</td></tr>
74+
<tr><td>user_agent</td><td>ChatAgent</td><td>Custom ChatAgent to use as user (optional)</td></tr>
7375
</tbody>
7476
</table>
7577
</Accordion>

docs/mintlify/reference/camel.societies.role_playing.mdx

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ Role playing between two agents.
3232
- **extend_task_specify_meta_dict** (Dict, optional): A dict to extend the task specify meta dict with. (default: :obj:`None`)
3333
- **output_language** (str, optional): The language to be output by the agents. (default: :obj:`None`)
3434
- **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`)
35+
- **assistant_agent** (ChatAgent, optional): A pre-configured ChatAgent to use as the assistant. If provided, this will override the creation of a new assistant agent. (default: :obj:`None`)
36+
- **user_agent** (ChatAgent, optional): A pre-configured ChatAgent to use as the user. If provided, this will override the creation of a new user agent. (default: :obj:`None`)
3537

3638
<a id="camel.societies.role_playing.RolePlaying.__init__"></a>
3739

@@ -130,25 +132,29 @@ message, and a list of system message meta dicts.
130132
```python
131133
def _init_agents(
132134
self,
133-
init_assistant_sys_msg: BaseMessage,
134-
init_user_sys_msg: BaseMessage,
135+
init_assistant_sys_msg: Optional[BaseMessage],
136+
init_user_sys_msg: Optional[BaseMessage],
135137
assistant_agent_kwargs: Optional[Dict] = None,
136138
user_agent_kwargs: Optional[Dict] = None,
137139
output_language: Optional[str] = None,
138-
stop_event: Optional[threading.Event] = None
140+
stop_event: Optional[threading.Event] = None,
141+
assistant_agent: Optional[ChatAgent] = None,
142+
user_agent: Optional[ChatAgent] = None
139143
):
140144
```
141145

142146
Initialize assistant and user agents with their system messages.
143147

144148
**Parameters:**
145149

146-
- **init_assistant_sys_msg** (BaseMessage): Assistant agent's initial system message.
147-
- **init_user_sys_msg** (BaseMessage): User agent's initial system message.
150+
- **init_assistant_sys_msg** (Optional[BaseMessage]): Assistant agent's initial system message.
151+
- **init_user_sys_msg** (Optional[BaseMessage]): User agent's initial system message.
148152
- **assistant_agent_kwargs** (Dict, optional): Additional arguments to pass to the assistant agent. (default: :obj:`None`)
149153
- **user_agent_kwargs** (Dict, optional): Additional arguments to pass to the user agent. (default: :obj:`None`)
150154
- **output_language** (str, optional): The language to be output by the agents. (default: :obj:`None`)
151155
- **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`)
156+
- **assistant_agent** (ChatAgent, optional): A pre-configured ChatAgent to use as the assistant. If provided, this will override the creation of a new assistant agent. (default: :obj:`None`)
157+
- **user_agent** (ChatAgent, optional): A pre-configured ChatAgent to use as the user. If provided, this will override the creation of a new user agent. (default: :obj:`None`)
152158

153159
<a id="camel.societies.role_playing.RolePlaying._init_critic"></a>
154160

@@ -175,7 +181,7 @@ is not specified, set it to improve task performance.
175181
- **sys_msg_generator** (SystemMessageGenerator): A system message generator for agents.
176182
- **sys_msg_meta_dicts** (list): A list of system message meta dicts.
177183
- **critic_role_name** (str): The name of the role played by the critic.
178-
- **critic_criteria** (str, optional): Critic criteria for the critic agent. If not specified, set the criteria to improve task performance. (default: :obj:`None`)
184+
- **critic_criteria** (str, optional): Critic criteria for the critic agent. If not specified, set it to improve task performance. (default: :obj:`None`)
179185
- **critic_kwargs** (Dict, optional): Additional arguments to pass to the critic. (default: :obj:`None`)
180186

181187
<a id="camel.societies.role_playing.RolePlaying._reduce_message_options"></a>

0 commit comments

Comments
 (0)