跳到主要内容

DOCXSearchTool

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

描述

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

安装

通过在终端中运行以下命令安装 crewai_tools 包:

pip install 'crewai[tools]'

示例

以下示例演示了如何初始化 DOCXSearchTool 来搜索任何 DOCX 文件的内容,或者使用特定的 DOCX 文件路径进行搜索。

from crewai_tools import DOCXSearchTool

# 初始化工具以搜索任何 DOCX 文件的内容
tool = DOCXSearchTool()

# 或者

# 使用特定的 DOCX 文件初始化工具,这样代理就只能搜索指定 DOCX 文件的内容
tool = DOCXSearchTool(docx='path/to/your/document.docx')

参数

  • docx: 可选的指向要搜索的特定 DOCX 文档的文件路径。如果在初始化期间未提供,工具允许稍后指定要搜索的任何 DOCX 文件的内容路径。

自定义模型和嵌入

默认情况下,该工具在嵌入和摘要方面使用 OpenAI。要自定义模型,可以使用以下配置字典:

tool = DOCXSearchTool(
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",
),
),
)
)