# Agent ## `autogen.Agent` Bases: `Protocol` (In preview) A protocol for Agent. An agent can communicate with other agents and perform actions. Different agents can differ in what actions they perform in the `receive` method. ### `name property` ``` name ``` The name of the agent. ### `description property` ``` description ``` The description of the agent. Used for the agent's introduction in a group chat setting. ### `send` ``` send(message, recipient, request_reply=None) ``` Send a message to another agent. | PARAMETER | DESCRIPTION | | --- | --- | | `message` | the message to send. If a dict, it should be a JSON-serializable and follows the OpenAI's ChatCompletion schema.
**TYPE:** `dict or str` | | `recipient` | the recipient of the message.
**TYPE:** `Agent` | | `request_reply` | whether to request a reply from the recipient.
**TYPE:** `bool` **DEFAULT:** `None` | Source code in `autogen/agentchat/agent.py` | | | | --- | --- | | ```
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
``` | ```
def send(
self,
message: dict[str, Any] | str,
recipient: "Agent",
request_reply: bool | None = None,
) -> None:
"""Send a message to another agent.
Args:
message (dict or str): the message to send. If a dict, it should be
a JSON-serializable and follows the OpenAI's ChatCompletion schema.
recipient (Agent): the recipient of the message.
request_reply (bool): whether to request a reply from the recipient.
"""
...
``` | ### `a_send async` ``` a_send(message, recipient, request_reply=None) ``` (Async) Send a message to another agent. Source code in `autogen/agentchat/agent.py` | | | | --- | --- | | ```
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
``` | ```
async def a_send(
self,
message: dict[str, Any] | str,
recipient: "Agent",
request_reply: bool | None = None,
) -> None:
"""(Async) Send a message to another agent.
Args:
message (dict or str): the message to send. If a dict, it should be
a JSON-serializable and follows the OpenAI's ChatCompletion schema.
recipient (Agent): the recipient of the message.
request_reply (bool): whether to request a reply from the recipient.
"""
...
``` | ### `receive` ``` receive(message, sender, request_reply=None) ``` Receive a message from another agent. | PARAMETER | DESCRIPTION | | --- | --- | | `message` | the message received. If a dict, it should be a JSON-serializable and follows the OpenAI's ChatCompletion schema.
**TYPE:** `dict or str` | | `sender` | the sender of the message.
**TYPE:** `Agent` | | `request_reply` | whether the sender requests a reply.
**TYPE:** `bool` **DEFAULT:** `None` | Source code in `autogen/agentchat/agent.py` | | | | --- | --- | | ```
73
74
75
76
77
78
79
80
81
82
83
84
85
86
``` | ```
def receive(
self,
message: dict[str, Any] | str,
sender: "Agent",
request_reply: bool | None = None,
) -> None:
"""Receive a message from another agent.
Args:
message (dict or str): the message received. If a dict, it should be
a JSON-serializable and follows the OpenAI's ChatCompletion schema.
sender (Agent): the sender of the message.
request_reply (bool): whether the sender requests a reply.
"""
``` | ### `a_receive async` ``` a_receive(message, sender, request_reply=None) ``` (Async) Receive a message from another agent. Source code in `autogen/agentchat/agent.py` | | | | --- | --- | | ```
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
``` | ```
async def a_receive(
self,
message: dict[str, Any] | str,
sender: "Agent",
request_reply: bool | None = None,
) -> None:
"""(Async) Receive a message from another agent.
Args:
message (dict or str): the message received. If a dict, it should be
a JSON-serializable and follows the OpenAI's ChatCompletion schema.
sender (Agent): the sender of the message.
request_reply (bool): whether the sender requests a reply.
"""
...
``` | ### `generate_reply` ``` generate_reply(messages=None, sender=None) ``` Generate a reply based on the received messages. | PARAMETER | DESCRIPTION | | --- | --- | | `messages` | a list of messages received from other agents. The messages are dictionaries that are JSON-serializable and follows the OpenAI's ChatCompletion schema.
**TYPE:** `list[dict[str, Any]]` **DEFAULT:** `None` | | `sender` | sender of an Agent instance.
**TYPE:** `Optional[Agent]` **DEFAULT:** `None` | | RETURNS | DESCRIPTION | | --- | --- | | `str | dict[str, Any] | None` | str or dict or None: the generated reply. If None, no reply is generated. | Source code in `autogen/agentchat/agent.py` | | | | --- | --- | | ```
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
``` | ```
def generate_reply(
self,
messages: list[dict[str, Any]] | None = None,
sender: Optional["Agent"] = None,
) -> str | dict[str, Any] | None:
"""Generate a reply based on the received messages.
Args:
messages (list[dict[str, Any]]): a list of messages received from other agents.
The messages are dictionaries that are JSON-serializable and
follows the OpenAI's ChatCompletion schema.
sender: sender of an Agent instance.
Returns:
str or dict or None: the generated reply. If None, no reply is generated.
"""
``` | ### `a_generate_reply async` ``` a_generate_reply(messages=None, sender=None) ``` (Async) Generate a reply based on the received messages. | RETURNS | DESCRIPTION | | --- | --- | | `str | dict[str, Any] | None` | str or dict or None: the generated reply. If None, no reply is generated. | Source code in `autogen/agentchat/agent.py` | | | | --- | --- | | ```
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
``` | ```
async def a_generate_reply(
self,
messages: list[dict[str, Any]] | None = None,
sender: Optional["Agent"] = None,
) -> str | dict[str, Any] | None:
"""(Async) Generate a reply based on the received messages.
Args:
messages (list[dict[str, Any]]): a list of messages received from other agents.
The messages are dictionaries that are JSON-serializable and
follows the OpenAI's ChatCompletion schema.
sender: sender of an Agent instance.
Returns:
str or dict or None: the generated reply. If None, no reply is generated.
"""
...
``` | ### `set_ui_tools` ``` set_ui_tools(tools) ``` Set the UI tools for the agent. | PARAMETER | DESCRIPTION | | --- | --- | | `tools` | a list of UI tools to set.
**TYPE:** `list[Tool]` | Source code in `autogen/agentchat/agent.py` | | | | --- | --- | | ```
139
140
141
142
143
144
145
``` | ```
def set_ui_tools(self, tools: list[Tool]) -> None:
"""Set the UI tools for the agent.
Args:
tools: a list of UI tools to set.
"""
...
``` | ### `unset_ui_tools` ``` unset_ui_tools(tools) ``` Unset the UI tools for the agent. | PARAMETER | DESCRIPTION | | --- | --- | | `tools` | a list of UI tools to set.
**TYPE:** `list[Tool]` | Source code in `autogen/agentchat/agent.py` | | | | --- | --- | | ```
147
148
149
150
151
152
153
``` | ```
def unset_ui_tools(self, tools: list[Tool]) -> None:
"""Unset the UI tools for the agent.
Args:
tools: a list of UI tools to set.
"""
...
``` |