TXTSearchTool

!!! note "实验性质" 我们仍在努力改进工具，因此未来可能会出现意外行为或更改。

描述

该工具用于在文本文件的内容中执行 RAG（检索增强生成）搜索。它允许在指定文本文件的内容中进行语义搜索，根据提供的查询快速提取信息或查找特定文本部分，因此对于快速提取信息或根据提供的查询查找特定文本部分非常有价值。

安装

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

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