快速开始

Perplexity 搜索

OpenClaw 支持将 Perplexity Search API 用作 web_search 提供商。它返回包含 titleurlsnippet 字段的结构化结果。

为保持兼容性,OpenClaw 还支持旧版 Perplexity Sonar/OpenRouter 设置。如果你使用 OPENROUTER_API_KEY、在 plugins.entries.perplexity.config.webSearch.apiKey 中使用 sk-or-... 密钥,或设置 plugins.entries.perplexity.config.webSearch.baseUrl / model,提供商将切换到聊天补全路径,并返回带引用的 AI 综合回答,而不是结构化的 Search API 结果。

安装插件

安装官方插件,然后重启 Gateway 网关:

bash
openclaw plugins install @openclaw/perplexity-pluginopenclaw gateway restart

获取 Perplexity API 密钥

  1. perplexity.ai/settings/api 创建 Perplexity 账户。
  2. 在控制面板中生成 API 密钥。
  3. 将密钥存储在配置中,或在 Gateway 网关环境中设置 PERPLEXITY_API_KEY

OpenRouter 兼容性

如果你已使用 OpenRouter 调用 Perplexity Sonar,请保留 provider: "perplexity",并在 Gateway 网关环境中设置 OPENROUTER_API_KEY,或在 plugins.entries.perplexity.config.webSearch.apiKey 中存储 sk-or-... 密钥。

可选兼容性控制项:

  • plugins.entries.perplexity.config.webSearch.baseUrl
  • plugins.entries.perplexity.config.webSearch.model

配置示例

原生 Perplexity Search API

json5
{  plugins: {    entries: {      perplexity: {        config: {          webSearch: {            apiKey: "pplx-...",          },        },      },    },  },  tools: {    web: {      search: {        provider: "perplexity",      },    },  },}

OpenRouter / Sonar 兼容模式

json5
{  plugins: {    entries: {      perplexity: {        config: {          webSearch: {            apiKey: "<openrouter-api-key>",            baseUrl: "https://openrouter.ai/api/v1",            model: "perplexity/sonar-pro",          },        },      },    },  },  tools: {    web: {      search: {        provider: "perplexity",      },    },  },}

密钥设置位置

**通过配置:**运行 openclaw configure --section web。该命令会将密钥存储到 ~/.openclaw/openclaw.jsonplugins.entries.perplexity.config.webSearch.apiKey 下。该字段也接受 SecretRef 对象。

**通过环境:**在 Gateway 网关进程环境中设置 PERPLEXITY_API_KEYOPENROUTER_API_KEY。对于 Gateway 网关安装,请将其放入 ~/.openclaw/.env(或你的服务环境)中。请参阅环境变量

如果已配置 provider: "perplexity",但 Perplexity 密钥 SecretRef 无法解析且没有环境变量回退,启动或重新加载将快速失败。

工具参数

以下参数适用于原生 Perplexity Search API 路径。

querystringrequired

搜索查询。

countnumberdefault: 5

要返回的结果数量(1-10)。

countrystring

两字母 ISO 国家/地区代码(例如 USDE)。

languagestring

ISO 639-1 语言代码(例如 endefr)。

freshness'day' | 'week' | 'month' | 'year'

时间筛选条件——day 表示 24 小时。

date_afterstring

仅返回在此日期之后发布的结果(YYYY-MM-DD)。

date_beforestring

仅返回在此日期之前发布的结果(YYYY-MM-DD)。

domain_filterstring[]

域名允许列表/拒绝列表数组(最多 20 个)。

max_tokensnumberdefault: 25000

内容总预算(最多 1000000)。

max_tokens_per_pagenumberdefault: 2048

每页 token 上限。

对于旧版 Sonar/OpenRouter 兼容路径:

  • 接受 querycountfreshness
  • 在该路径中,count 仅用于兼容;响应仍是一个带引用的综合回答,而不是包含 N 个结果的列表。
  • 仅限 Search API 的筛选条件(countrylanguagedate_afterdate_beforedomain_filtermax_tokensmax_tokens_per_page)会返回明确错误。

示例:

javascript
// 针对特定国家/地区和语言的搜索await web_search({  query: "renewable energy",  country: "DE",  language: "de",}); // 最近的结果(过去一周)await web_search({  query: "AI news",  freshness: "week",}); // 按日期范围搜索await web_search({  query: "AI developments",  date_after: "2024-01-01",  date_before: "2024-06-30",}); // 域名筛选(允许列表)await web_search({  query: "climate research",  domain_filter: ["nature.com", "science.org", ".edu"],}); // 域名筛选(拒绝列表——添加 - 前缀)await web_search({  query: "product reviews",  domain_filter: ["-reddit.com", "-pinterest.com"],}); // 提取更多内容await web_search({  query: "detailed AI research",  max_tokens: 50000,  max_tokens_per_page: 4096,});

域名筛选规则

  • 每个筛选条件最多包含 20 个域名。
  • 同一请求中不能混合允许列表和拒绝列表条目。
  • 对拒绝列表条目使用 - 前缀(例如 ["-reddit.com"])。

注意事项

  • Perplexity Search API 返回结构化 Web 搜索结果(titleurlsnippet)。
  • 使用 OpenRouter,或显式设置 plugins.entries.perplexity.config.webSearch.baseUrl / model,会将 Perplexity 切换回 Sonar 聊天补全以保持兼容性。
  • Sonar/OpenRouter 兼容模式返回一个带引用的综合回答,而不是结构化结果行。
  • 默认情况下,结果会缓存 15 分钟(可通过 cacheTtlMinutes 配置)。

相关内容

Was this useful?
On this page

On this page