跳转至

SerperDevTool 文档

实验性

我们仍在改进工具，因此未来可能会有意外行为或变化。

描述

此工具旨在对互联网上的文本内容进行指定查询的语义搜索。它利用 serper.dev API 获取并显示基于用户提供的查询的最相关搜索结果。

安装

要将此工具集成到您的项目中，请按照以下安装说明操作： 

pip install 'crewai[tools]'

示例

以下示例演示了如何初始化工具并使用给定查询执行搜索：

from crewai_tools import SerperDevTool

# 初始化工具以具备互联网搜索能力
tool = SerperDevTool()

开始使用步骤

要有效使用 SerperDevTool，请按照以下步骤操作：

  1. 包安装：确认 crewai[tools] 包已安装在您的 Python 环境中。
  2. API 密钥获取：通过在 serper.dev 注册免费账户获取 serper.dev API 密钥。
  3. 环境配置：将您获得的 API 密钥存储在名为 SERPER_API_KEY 的环境变量中，以便工具使用。

参数

SerperDevTool 配备了多个参数，这些参数将传递给 API：

  • search_url：搜索 API 的 URL 端点。（默认为 https://google.serper.dev/search）

  • country：可选。指定搜索结果的国家。

  • location：可选。指定搜索结果的位置。
  • locale：可选。指定搜索结果的区域设置。

country、location、locale 和 search_url 的值可以在 Serper Playground 上找到。

带参数的示例

以下示例演示了如何使用带附加参数的工具：

from crewai_tools import SerperDevTool

tool = SerperDevTool(
    search_url="https://google.serper.dev/scholar",
    n_results=2,
)

print(tool.run(search_query="ChatGPT"))

# 使用工具：搜索互联网

# 搜索结果：标题：ChatGPT 在公共卫生中的作用
# 链接：https://link.springer.com/article/10.1007/s10439-023-03172-7
# 摘要：… ChatGPT 在公共卫生中的作用。在本概述中，我们将探讨 ChatGPT 在
# ---
# 标题：ChatGPT 在全球变暖中的潜在用途
# 链接：https://link.springer.com/article/10.1007/s10439-023-03171-8
# 摘要：… 像 ChatGPT 这样的工具，有潜力在推进我们对气候的理解方面发挥关键作用
# ---

from crewai_tools import SerperDevTool

tool = SerperDevTool(
    country="fr",
    locale="fr",
    location="Paris, Paris, Ile-de-France, France",
    n_results=2,
)

print(tool.run(search_query="Jeux Olympiques"))

# 使用工具：搜索互联网

# 搜索结果：标题：巴黎2024年奥运会 - 新闻、日程、结果
# 链接：https://olympics.com/fr/paris-2024
# 摘要：巴黎2024年奥运会有哪些运动项目？· 田径 · 划船 · 羽毛球 · 篮球 · 三人篮球 · 拳击 · Breaking · 皮划艇 ...
# ---
# 标题：巴黎2024年奥运会和残奥会官方票务
# 链接：https://tickets.paris2024.org/
# 摘要：请在巴黎2024年官方票务网站上独家购买您的门票，参与世界上最大的体育赛事。
# ---

结论

通过将 SerperDevTool 集成到 Python 项目中，用户能够直接从应用程序中进行实时、相关的互联网搜索。更新的参数允许更定制化和本地化的搜索结果。遵循提供的设置和使用指南，将此工具集成到项目中变得简单直接。