跳转到主要内容

​
BraveSearchTool

​
描述

该工具旨在使用 Brave Search API 进行网页搜索。它允许您使用指定的查询在互联网上搜索并检索相关结果。该工具支持自定义结果数量和特定国家/地区的搜索。

​
安装

要将此工具整合到您的项目中，请遵循以下安装说明： 
pip install 'crewai[tools]'

​
开始步骤

要有效使用 BraveSearchTool，请遵循以下步骤：
  1. 包安装：确认您的 Python 环境中已安装 crewai[tools] 包。
  2. API 密钥获取：在 https://api.search.brave.com/app/keys 获取 Brave Search API 密钥（登录以生成密钥）。
  3. 环境配置：将您获得的 API 密钥存储在名为 BRAVE_API_KEY 的环境变量中，以便工具使用。

​
示例

以下示例演示了如何初始化该工具并使用给定查询执行搜索：
代码
from crewai_tools import BraveSearchTool

# Initialize the tool for internet searching capabilities
tool = BraveSearchTool()

# Execute a search
results = tool.run(search_query="CrewAI agent framework")
print(results)

​
参数

BraveSearchTool 接受以下参数：
  • search_query：必需。您希望用于在互联网上搜索的查询。
  • country：可选。指定搜索结果的国家/地区。默认为空字符串。
  • n_results：可选。要返回的搜索结果数量。默认为 10。
  • save_file：可选。是否将搜索结果保存到文件。默认为 False。

​
带参数示例

这是一个演示如何使用带有附加参数的工具的示例：
代码
from crewai_tools import BraveSearchTool

# Initialize the tool with custom parameters
tool = BraveSearchTool(
    country="US",
    n_results=5,
    save_file=True
)

# Execute a search
results = tool.run(search_query="Latest AI developments")
print(results)

​
代理集成示例

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

# Initialize the tool
brave_search_tool = BraveSearchTool()

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

​
结论

通过将 BraveSearchTool 集成到 Python 项目中，用户能够直接从其应用程序中进行实时、相关的互联网搜索。该工具为强大的 Brave Search API 提供了一个简单的接口，使其可以轻松地以编程方式检索和处理搜索结果。通过遵循所提供的设置和使用指南，将此工具整合到项目中将变得简单直接。
⌘我