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