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]"
Parameters:

  • name (str) – 代理的名称

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

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

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

DEFAULT_DESCRIPTION = 'An agent that can handle local files.'#
DEFAULT_SYSTEM_MESSAGES = [SystemMessage(content='\n        You are a helpful AI Assistant.\n        When given a user query, use available functions to help the user with their request.', type='SystemMessage')]#
classmethod _from_config(config: FileSurferConfig) → 自我[源代码]#

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

Parameters:

config (T) – 配置对象。

Returns:

Self – 组件的新实例。

_to_config() → FileSurferConfig[源代码]#

导出配置，该配置将用于创建一个与此实例配置相匹配的组件新实例。

Returns:

T – 组件的配置。

component_config_schema#

FileSurferConfig的别名

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

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

async on_messages(messages: Sequence[Annotated[TextMessage | MultiModalMessage | StopMessage | 工具调用摘要信息 | HandoffMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')]], cancellation_token: CancellationToken) → 响应[源代码]#

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

注意

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

async on_reset(cancellation_token: CancellationToken) → 无[源代码]#

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

property produced_message_types: Sequence[类型[Annotated[TextMessage | MultiModalMessage | StopMessage | 工具调用摘要信息 | HandoffMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')]]]#

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