跳到主要内容

agentchat.chat

ChatResult

@dataclass
class ChatResult()

(实验性)聊天结果。几乎肯定会被更改。

chat_id

聊天ID

聊天记录

聊天记录。

摘要

从聊天中获取的摘要。

成本

聊天的成本。 每种使用类型的值是一个字典,包含该特定类型的成本信息。

  • "usage_including_cached_inference": 关于总使用量的成本信息,包括缓存推理中的令牌。
  • "usage_excluding_cached_inference": 关于使用的token成本信息,不包括缓存中的tokens。不大于"usage_including_cached_inference"。

用户输入

聊天中请求的人类输入列表。

initiate_chats

def initiate_chats(chat_queue: List[Dict[str, Any]]) -> List[ChatResult]

初始化一个聊天列表。

参数:

  • chat_queue List[Dict] - 包含聊天信息的字典列表。

    每个字典应包含用于 ConversableAgent.initiate_chat 的输入参数。例如:

    • "sender" - 发送者代理。
    • "recipient" - 接收代理。
    • "clear_history" (bool) - 是否清除与代理的聊天记录。默认值为 True。
    • "silent" (bool 或 None) - (实验性) 是否在此对话中打印消息。默认为 False。
    • "cache" (Cache 或 None) - 用于此对话的缓存客户端。默认值为 None。
    • "max_turns" (int or None) - 聊天的最多轮次。如果为None,聊天将一直持续直到满足终止条件。默认值为None。
    • "summary_method" (str 或 callable) - 一个字符串或可调用对象,用于指定从聊天中获取摘要的方法。默认为 DEFAULT_summary_method,即 "last_msg"。
    • "summary_args" (字典) - 传递给summary_method的参数字典。默认是{}
    • "message" (str, callable 或 None) - 如果为 None,将调用 input() 来获取初始消息。
    • **context - 传递给聊天的额外上下文信息。
    • "carryover" - 它可用于指定要传递给此聊天的继承信息。如果提供了,我们将在generate_init_message中生成初始聊天消息时将此继承信息与“message”内容结合。
    • "finished_chat_indexes_to_exclude_from_carryover" - 可以通过指定finished_chats列表中的索引列表来使用它, 以排除那些摘要用于延续。如果未提供'finished_chat_indexes_to_exclude_from_carryover'或为空列表, 则将取所有已完成聊天的摘要。

返回:

  • (list) - 一个对应chat_queue中已完成聊天的ChatResult对象列表。

a_initiate_chats

async def a_initiate_chats(
chat_queue: List[Dict[str, Any]]) -> Dict[int, ChatResult]

(异步)发起一系列聊天。

参数:

  • 请参考initiate_chats

返回:

  • (Dict): 一个包含ChatId: ChatResult的字典,对应于chat_queue中已完成的聊天。