mirror of
https://github.com/microsoft/FLAML.git
synced 2026-02-09 02:09:16 +08:00
0fe284b21f
* typographical corrections in the descriptions, comment improvements, general formatting for consistency * consistent indentation for better readability, improved comments, typographical corrections * updated docstrings for better clarity, added type hint for **kwargs, typographical corrections (no functionality changes) * Fix format --------- Co-authored-by: Li Jiang <bnujli@gmail.com>
71 lines
2.4 KiB
Python
71 lines
2.4 KiB
Python
from typing import Dict, List, Optional, Union
|
|
|
|
|
|
class Agent:
|
|
"""(In preview) An abstract class for AI agent.
|
|
|
|
An agent can communicate with other agents and perform actions.
|
|
Different agents can differ in what actions they perform in the `receive` method.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
name: str,
|
|
):
|
|
"""
|
|
Args:
|
|
name (str): name of the agent.
|
|
"""
|
|
# a dictionary of conversations, default value is list
|
|
self._name = name
|
|
|
|
@property
|
|
def name(self):
|
|
"""Get the name of the agent."""
|
|
return self._name
|
|
|
|
def send(self, message: Union[Dict, str], recipient: "Agent", request_reply: Optional[bool] = None):
|
|
"""(Abstract method) Send a message to another agent."""
|
|
|
|
async def a_send(self, message: Union[Dict, str], recipient: "Agent", request_reply: Optional[bool] = None):
|
|
"""(Abstract async method) Send a message to another agent."""
|
|
|
|
def receive(self, message: Union[Dict, str], sender: "Agent", request_reply: Optional[bool] = None):
|
|
"""(Abstract method) Receive a message from another agent."""
|
|
|
|
async def a_receive(self, message: Union[Dict, str], sender: "Agent", request_reply: Optional[bool] = None):
|
|
"""(Abstract async method) Receive a message from another agent."""
|
|
|
|
def reset(self):
|
|
"""(Abstract method) Reset the agent."""
|
|
|
|
def generate_reply(
|
|
self,
|
|
messages: Optional[List[Dict]] = None,
|
|
sender: Optional["Agent"] = None,
|
|
**kwargs,
|
|
) -> Union[str, Dict, None]:
|
|
"""(Abstract method) Generate a reply based on the received messages.
|
|
|
|
Args:
|
|
messages (list[dict]): a list of messages received.
|
|
sender: sender of an Agent instance.
|
|
Returns:
|
|
str or dict or None: the generated reply. If None, no reply is generated.
|
|
"""
|
|
|
|
async def a_generate_reply(
|
|
self,
|
|
messages: Optional[List[Dict]] = None,
|
|
sender: Optional["Agent"] = None,
|
|
**kwargs,
|
|
) -> Union[str, Dict, None]:
|
|
"""(Abstract async method) Generate a reply based on the received messages.
|
|
|
|
Args:
|
|
messages (list[dict]): a list of messages received.
|
|
sender: sender of an Agent instance.
|
|
Returns:
|
|
str or dict or None: the generated reply. If None, no reply is generated.
|
|
"""
|