TXTSearchTool

实验性

我们仍在改进工具，因此未来可能会有意外行为或变化。

描述

此工具用于在文本文件内容中执行RAG（检索增强生成）搜索。它允许在指定文本文件的内容中进行语义搜索查询，使其成为快速提取信息或根据提供的查询找到特定文本段的宝贵资源。

安装

要使用TXTSearchTool，您首先需要安装crewai_tools包。这可以通过使用Python的包管理器pip来完成。打开您的终端或命令提示符，并输入以下命令：

pip install 'crewai[tools]'

此命令将下载并安装TXTSearchTool以及任何必要的依赖项。

示例

以下示例演示了如何使用TXTSearchTool在文本文件中进行搜索。此示例展示了使用特定文本文件初始化工具以及在该文件内容中进行后续搜索的过程。

from crewai_tools import TXTSearchTool

# 初始化工具以搜索代理在执行过程中了解到的任何文本文件的内容
tool = TXTSearchTool()

# 或者

# 使用特定文本文件初始化工具，以便代理可以在给定文本文件的内容中进行搜索
tool = TXTSearchTool(txt='path/to/text/file.txt')

参数

• txt (str): 可选. 您要搜索的文本文件路径。如果工具未使用特定文本文件初始化，则此参数是必需的；否则，搜索将在最初提供的文本文件内进行。

自定义模型和嵌入

默认情况下，该工具使用OpenAI进行嵌入和总结。要自定义模型，可以使用如下配置字典：

tool = TXTSearchTool(
    config=dict(
        llm=dict(
            provider="ollama", # 或 google, openai, anthropic, llama2, ...
            config=dict(
                model="llama2",
                # temperature=0.5,
                # top_p=1,
                # stream=true,
            ),
        ),
        embedder=dict(
            provider="google", # 或 openai, ollama, ...
            config=dict(
                model="models/embedding-001",
                task_type="retrieval_document",
                # title="Embeddings",
            ),
        ),
    )
)