DirectorySearchTool

实验性: DirectorySearchTool 正在持续开发中。功能和特性可能会有所变化,随着我们不断完善该工具,可能会出现意外行为。

描述

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

安装

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

pip install 'crewai[tools]'

初始化和使用

crewai_tools包中导入DirectorySearchTool以开始。您可以在不指定目录的情况下初始化该工具,从而在运行时设置搜索目录。或者,该工具可以使用预定义的目录进行初始化。

Code
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 进行嵌入和摘要生成。这些设置的自定义选项包括更改模型提供者和配置,从而为高级用户提供更大的灵活性。

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

这个页面有帮助吗?