DirectorySearchTool

实验性

DirectorySearchTool正在持续开发中。功能和特性可能会演变，随着我们优化工具，可能会出现意外行为。

描述

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

安装

要使用DirectorySearchTool，首先安装crewai_tools包。在终端执行以下命令：

pip install 'crewai[tools]'

初始化和使用

从crewai_tools包中导入DirectorySearchTool开始。可以不指定目录初始化工具，从而在运行时设置搜索目录。或者，工具可以初始化为预定义目录。

from crewai_tools import DirectorySearchTool

# 运行时动态指定目录
tool = DirectorySearchTool()

# 固定目录搜索
tool = DirectorySearchTool(directory='/path/to/directory')

参数

• directory：一个字符串参数，指定搜索目录。初始化时可选，但如果未初始设置，搜索时必填。

自定义模型和嵌入

DirectorySearchTool默认使用OpenAI进行嵌入和总结。这些设置的定制选项包括更改模型提供商和配置，为高级用户提供更大的灵活性。

tool = DirectorySearchTool(
    config=dict(
        llm=dict(
            provider="ollama", # 选项包括ollama、google、anthropic、llama2等
            config=dict(
                model="llama2",
                # 在此添加额外配置
            ),
        ),
        embedder=dict(
            provider="google", # 或openai、ollama等
            config=dict(
                model="models/embedding-001",
                task_type="retrieval_document",
                # title="嵌入",
            ),
        ),
    )
)
                # Additional configurations here
            ),
        ),
        embedder=dict(
            provider="google", # 或 openai, ollama, ...
            config=dict(
                model="models/embedding-001",
                task_type="retrieval_document",
                # title="Embeddings",
            ),
        ),
    )
)