DirectorySearchTool

实验性:DirectorySearchTool 正在持续开发中。功能可能会演变,在我们完善该工具时可能会出现意外行为。

描述

DirectorySearchTool 能够对指定目录的内容进行语义搜索,利用检索增强生成 (RAG) 方法高效地浏览文件。它设计灵活,允许用户在运行时动态指定搜索目录,或在初始设置时设置固定目录。

安装

要使用 DirectorySearchTool,首先安装 crewai_tools 包。在你的终端中执行以下命令:

pip install 'crewai[tools]'

初始化和使用

crewai_tools 包导入 DirectorySearchTool 即可开始使用。你可以在初始化时不安指定目录,从而在运行时设置搜索目录。另外,也可以使用预定义的目录初始化该工具。

代码
from crewai_tools import DirectorySearchTool

# For dynamic directory specification at runtime
tool = DirectorySearchTool()

# For fixed directory searches
tool = DirectorySearchTool(directory='/path/to/directory')

参数

  • directory: 一个字符串参数,用于指定搜索目录。在初始化时是可选的,但如果未初始设置,则搜索时必须提供。

自定义模型和嵌入

DirectorySearchTool 默认使用 OpenAI 进行嵌入和摘要。这些设置的自定义选项包括更改模型提供商和配置,为高级用户增强了灵活性。

代码
tool = DirectorySearchTool(
    config=dict(
        llm=dict(
            provider="ollama", # Options include ollama, google, anthropic, llama2, and more
            config=dict(
                model="llama2",
                # Additional configurations here
            ),
        ),
        embedder=dict(
            provider="google", # or openai, ollama, ...
            config=dict(
                model="models/embedding-001",
                task_type="retrieval_document",
                # title="Embeddings",
            ),
        ),
    )
)