DirectoryReadTool

!!! note "实验性质" 我们仍在努力改进工具，因此未来可能会出现意外行为或更改。

描述

DirectoryReadTool 是一个强大的实用工具，旨在提供目录内容的全面列表。它可以递归地浏览指定目录，为用户提供所有文件的详细枚举，包括子目录中的文件。这个工具对于需要对目录结构进行彻底清点或验证目录中文件组织的任务至关重要。

安装

要在项目中使用 DirectoryReadTool，请安装 crewai_tools 包。如果此包尚未包含在您的环境中，您可以使用以下 pip 命令安装它：

pip install 'crewai[tools]'

此命令将安装 crewai_tools 包的最新版本，从而可以访问 DirectoryReadTool 和其他实用工具。

示例

使用 DirectoryReadTool 很简单。以下代码片段演示了如何设置并使用该工具来列出指定目录的内容：

from crewai_tools import DirectoryReadTool

# 初始化工具，以便代理程序在执行过程中了解任何目录的内容
tool = DirectoryReadTool()

# 或者

# 使用特定目录初始化工具，以便代理程序只能读取指定目录的内容
tool = DirectoryReadTool(directory='/path/to/your/directory')

参数

DirectoryReadTool 需要最少的配置即可使用。该工具的基本参数如下：

• directory：可选。指定要列出其内容的目录路径的参数。它接受绝对路径和相对路径，指导工具到达所需目录以进行内容列表。