跳转到主要内容

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",
            ),
        ),
    )
)