跳转到主要内容

DOCXSearchTool

我们仍在努力改进工具,因此未来可能会出现意外行为或变更。

描述

DOCXSearchTool 是一款 RAG 工具,专为在 DOCX 文档内进行语义搜索而设计。它使用户能够通过基于查询的搜索,有效地从 DOCX 文件中搜索和提取相关信息。该工具在数据分析、信息管理和研究任务中非常宝贵,简化了在大型文档集合中查找特定信息的过程。

安装

在您的终端中运行以下命令来安装 crewai_tools 包。
uv pip install docx2txt 'crewai[tools]'

示例

以下示例演示了如何初始化 DOCXSearchTool,以在任何 DOCX 文件的内容中进行搜索,或使用特定的 DOCX 文件路径进行搜索。
代码
from crewai_tools import DOCXSearchTool

# Initialize the tool to search within any DOCX file's content
tool = DOCXSearchTool()

# OR

# Initialize the tool with a specific DOCX file, 
# so the agent can only search the content of the specified DOCX file
tool = DOCXSearchTool(docx='path/to/your/document.docx')

参数

可以使用以下参数自定义 DOCXSearchTool 的行为。
参数类型描述
docx字符串可选。一个参数,用于指定您要搜索的 DOCX 文件的路径。如果在初始化期间未提供,该工具允许稍后指定任何 DOCX 文件的内容路径进行搜索。

自定义模型和嵌入

默认情况下,该工具使用 OpenAI 进行嵌入和摘要。要自定义模型,您可以使用如下所示的配置字典:
代码
tool = DOCXSearchTool(
    config=dict(
        llm=dict(
            provider="ollama", # or google, openai, anthropic, llama2, ...
            config=dict(
                model="llama2",
                # temperature=0.5,
                # top_p=1,
                # stream=true,
            ),
        ),
        embedder=dict(
            provider="google", # or openai, ollama, ...
            config=dict(
                model="models/embedding-001",
                task_type="retrieval_document",
                # title="Embeddings",
            ),
        ),
    )
)