Perplexity 搜索
OpenClaw 支持将 Perplexity Search API 作为 web_search 提供商。它会返回包含 title、url 和 snippet 字段的结构化结果。
为保持兼容性,OpenClaw 还支持旧版 Perplexity Sonar/OpenRouter 配置。如果你使用 OPENROUTER_API_KEY、在 plugins.entries.perplexity.config.webSearch.apiKey 中使用 sk-or-... 密钥,或设置 plugins.entries.perplexity.config.webSearch.baseUrl / model,该提供商会切换到 chat-completions 路径,并返回带引用的 AI 合成答案,而不是结构化的 Search API 结果。
安装插件¶
安装官方插件:
安装会自动应用到正在运行的 Gateway;否则会在下次启动时生效。参见 应用更改并检查。
获取 Perplexity API 密钥¶
- 在 perplexity.ai/settings/api 创建 Perplexity 账户。
- 在仪表板中生成 API 密钥。
- 将密钥存储在配置中,或在 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.baseUrlplugins.entries.perplexity.config.webSearch.model
配置示例¶
原生 Perplexity Search API¶
{
plugins: {
entries: {
perplexity: {
config: {
webSearch: {
apiKey: "pplx-...",
},
},
},
},
},
tools: {
web: {
search: {
provider: "perplexity",
},
},
},
}
OpenRouter / Sonar 兼容性¶
{
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.json 的 plugins.entries.perplexity.config.webSearch.apiKey 下。该字段也接受 SecretRef 对象。
通过环境变量: 在 Gateway 进程环境中设置 PERPLEXITY_API_KEY 或 OPENROUTER_API_KEY。对于 Gateway 安装,请将其放在 ~/.openclaw/.env(或你的服务环境中)。参见 环境变量。
如果已配置 provider: "perplexity",且 Perplexity 密钥 SecretRef 未解析且没有环境变量回退,启动/重新加载会快速失败。
工具参数¶
这些参数适用于原生 Perplexity Search API 路径。
querystring (path) 必填- 搜索查询。
countnumber (path) 默认值:5- 要返回的结果数量(1-10)。
countrystring (path)- 两位 ISO 国家代码(例如
US、DE)。 languagestring (path)- ISO 639-1 语言代码(例如
en、de、fr)。 freshness'day' | 'week' | 'month' | 'year' (path)- 时间过滤器 -
day表示 24 小时。 date_afterstring (path)- 仅返回在此日期之后发布的结果(
YYYY-MM-DD)。 date_beforestring (path)- 仅返回在此日期之前发布的结果(
YYYY-MM-DD)。 domain_filterstring[] (path)- 域名允许列表/拒绝列表数组(最多 20 个)。
max_tokensnumber (path) 默认值:25000- 总内容预算(最大 1000000)。
max_tokens_per_pagenumber (path) 默认值:2048- 每页 Token 限制。
对于旧版 Sonar/OpenRouter 兼容路径:
- 接受
query、count和freshness。 - 在那里,
count仅用于兼容;响应仍然是一个带引用的合成答案,而不是 N 个结果列表。 - 仅 Search API 支持的过滤器(
country、language、date_after、date_before、domain_filter、max_tokens、max_tokens_per_page)会返回明确错误。
示例:
// Country and language-specific search
await web_search({
query: "renewable energy",
country: "DE",
language: "de",
});
// Recent results (past week)
await web_search({
query: "AI news",
freshness: "week",
});
// Date range search
await web_search({
query: "AI developments",
date_after: "2024-01-01",
date_before: "2024-06-30",
});
// Domain filtering (allowlist)
await web_search({
query: "climate research",
domain_filter: ["nature.com", "science.org", ".edu"],
});
// Domain filtering (denylist - prefix with -)
await web_search({
query: "product reviews",
domain_filter: ["-reddit.com", "-pinterest.com"],
});
// More content extraction
await web_search({
query: "detailed AI research",
max_tokens: 50000,
max_tokens_per_page: 4096,
});
域名过滤规则¶
- 每个过滤器最多 20 个域名。
- 不能在同一请求中混合允许列表和拒绝列表条目。
- 拒绝列表条目使用
-前缀(例如["-reddit.com"])。
说明¶
- Perplexity Search API 返回结构化网页搜索结果(
title、url、snippet)。 - OpenRouter,或显式设置
plugins.entries.perplexity.config.webSearch.baseUrl/model,会将 Perplexity 切换回 Sonar chat completions 以保持兼容。 - Sonar/OpenRouter 兼容性返回一个带引用的合成答案,而不是结构化结果行。
- 结果默认缓存 15 分钟(可通过
cacheTtlMinutes配置)。
相关¶
所有提供商和自动检测规则。
带国家和语言过滤器的结构化结果。
带内容提取的神经搜索。
Perplexity 网页搜索的提供商设置、认证和配置键。
官方 Perplexity Search API 快速入门与参考。
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 cl/openclaw