跳转到主要内容

​
RagTool

​
描述

RagTool 旨在通过 CrewAI 的原生 RAG 系统，利用检索增强生成（RAG）的力量来回答问题。它提供了一个动态知识库，可以查询该知识库以从各种数据源中检索相关信息。此工具对于需要访问大量信息并提供上下文相关答案的应用程序特别有用。

​
示例

以下示例演示了如何初始化该工具并将其用于不同的数据源
代码
from crewai_tools import RagTool

# Create a RAG tool with default settings
rag_tool = RagTool()

# Add content from a file
rag_tool.add(data_type="file", path="path/to/your/document.pdf")

# Add content from a web page
rag_tool.add(data_type="web_page", url="https://example.com")

# Define an agent with the RagTool
@agent
def knowledge_expert(self) -> Agent:
    '''
    This agent uses the RagTool to answer questions about the knowledge base.
    '''
    return Agent(
        config=self.agents_config["knowledge_expert"],
        allow_delegation=False,
        tools=[rag_tool]
    )

​
支持的数据源

RagTool 可用于多种数据源，包括
  • 📰 PDF 文件
  • 📊 CSV 文件
  • 📃 JSON 文件
  • 📝 文本
  • 📁 目录/文件夹
  • 🌐 HTML 网页
  • 📽️ YouTube 频道
  • 📺 YouTube 视频
  • 📚 文档网站
  • 📝 MDX 文件
  • 📄 DOCX 文件
  • 🧾 XML 文件
  • 📬 Gmail
  • 📝 GitHub 仓库
  • 🐘 PostgreSQL 数据库
  • 🐬 MySQL 数据库
  • 🤖 Slack 对话
  • 💬 Discord 消息
  • 🗨️ Discourse 论坛
  • 📝 Substack 时事通讯
  • 🐝 Beehiiv 内容
  • 💾 Dropbox 文件
  • 🖼️ 图像
  • ⚙️ 自定义数据源

​
参数

RagTool 接受以下参数
  • summarize：可选。是否对检索到的内容进行总结。默认为 False。
  • adapter：可选。知识库的自定义适配器。如果未提供，将使用 CrewAIRagAdapter。
  • config：可选。底层 CrewAI RAG 系统的配置。

​
添加内容

您可以使用 add 方法向知识库添加内容
代码
# Add a PDF file
rag_tool.add(data_type="file", path="path/to/your/document.pdf")

# Add a web page
rag_tool.add(data_type="web_page", url="https://example.com")

# Add a YouTube video
rag_tool.add(data_type="youtube_video", url="https://www.youtube.com/watch?v=VIDEO_ID")

# Add a directory of files
rag_tool.add(data_type="directory", path="path/to/your/directory")

​
代理集成示例

以下是如何将 RagTool 与 CrewAI 代理集成
代码
from crewai import Agent
from crewai.project import agent
from crewai_tools import RagTool

# Initialize the tool and add content
rag_tool = RagTool()
rag_tool.add(data_type="web_page", url="https://docs.crewai.org.cn")
rag_tool.add(data_type="file", path="company_data.pdf")

# Define an agent with the RagTool
@agent
def knowledge_expert(self) -> Agent:
    return Agent(
        config=self.agents_config["knowledge_expert"],
        allow_delegation=False,
        tools=[rag_tool]
    )

​
高级配置

您可以通过提供配置字典来自定义 RagTool 的行为
代码
from crewai_tools import RagTool

# Create a RAG tool with custom configuration
config = {
    "vectordb": {
        "provider": "qdrant",
        "config": {
            "collection_name": "my-collection"
        }
    },
    "embedding_model": {
        "provider": "openai",
        "config": {
            "model": "text-embedding-3-small"
        }
    }
}

rag_tool = RagTool(config=config, summarize=True)

​
结论

RagTool 提供了一种强大的方式来从各种数据源创建和查询知识库。通过利用检索增强生成，它使代理能够高效地访问和检索相关信息，从而增强其提供准确和上下文恰当响应的能力。
⌘我