autogen_ext.agents.file_surfer#

class FileSurfer(name: str, model_client: ChatCompletionClient, description: str = DEFAULT_DESCRIPTION, base_path: str = os.getcwd())[源代码]#

基类: BaseChatAgent, Component[FileSurferConfig]

一个由 MagenticOne 使用的代理，充当本地文件预览器。 FileSurfer 可以打开和读取各种常见文件类型，并可以浏览本地文件层次结构。

安装

pip install "autogen-ext[file-surfer]"
参数:

  • name (str) – 代理的名称

  • model_client (ChatCompletionClient) – 要使用的模型（必须启用工具使用）

  • description (str) – 团队使用的代理描述。默认为 DEFAULT_DESCRIPTION

  • base_path (str) – 文件浏览器使用的基本路径。默认为当前工作目录。

DEFAULT_DESCRIPTION = '一个可以处理本地文件的代理。'#
DEFAULT_SYSTEM_MESSAGES = [SystemMessage(content='\n        你是一个有用的 AI 助手。\n        当被给予用户查询时，使用可用功能帮助用户满足他们的请求。', type='SystemMessage')]#
classmethod _from_config(config: FileSurferConfig) → Self[源代码]#

从配置对象创建一个组件的新实例。

参数:

config (T) – 配置对象。

返回:

Self – 组件的新实例。

_to_config() → FileSurferConfig[源代码]#

转储配置，该配置需要创建一个与此实例的配置匹配的组件的新实例。

返回:

T – 组件的配置。

component_config_schema#

别名 FileSurferConfig

component_provider_override: ClassVar[str | None] = 'autogen_ext.agents.file_surfer.FileSurfer'#

覆盖组件的提供程序字符串。这应该用于防止内部模块名称成为模块名称的一部分。

async on_messages(messages: Sequence[BaseChatMessage], cancellation_token: CancellationToken) → Response[源代码]#

处理传入消息并返回响应。

注意

代理是有状态的，传递给此方法的消息应该是自上次调用此方法以来的新消息。 代理应在此方法的调用之间保持其状态。 例如，如果代理需要记住以前的消息以响应当前消息，它应该将以前的消息存储在代理状态中。

async on_reset(cancellation_token: CancellationToken) → None[source]#

将代理重置到其初始化状态。

property produced_message_types: Sequence[type[BaseChatMessage]]#

代理在 Response.chat_message 字段中生成的消息类型。它们必须是 BaseChatMessage 类型。