mcpField
S
suggest

suggest

github.com/brave开发1921.1k 次安装11 周前更新
代码仓库

关于 suggest

Suggest 是 Brave Search API 的自动补全端点，可为部分查询返回补全建议。开发者可设置语言、国家和结果数量，也可启用富信息模式获取实体详情。

主要功能

  1. 01自动补全查询内容
  2. 02设置语言、国家和结果数量
  3. 03可选实体详情和图片
  4. 04为拼写错误的查询提供建议

适用场景

  1. 01构建输入即搜界面
  2. 02在 RAG 搜索前扩展部分查询
  3. 03在结果界面展示实体预览
  4. 04为拼写错误的输入提供建议

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/brave/brave-search-skills --skill suggest

安装后在 Claude Code 中输入/suggest确认已加载。

详细介绍

建议 / 自动补全

需要 API 密钥：在 https://api.search.brave.com 获取

套餐：包含在 Suggest 套餐中。参见 https://api-dashboard.search.brave.com/app/subscriptions/subscribe

快速开始（cURL）

基本建议
curl -s "https://api.search.brave.com/res/v1/suggest/search?q=how+to+" \
  -H "Accept: application/json" \
  -H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"
包含所有参数
curl -s "https://api.search.brave.com/res/v1/suggest/search" \
  -H "Accept: application/json" \
  -H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}" \
  -G \
  --data-urlencode "q=albert" \
  --data-urlencode "country=US" \
  --data-urlencode "lang=en" \
  --data-urlencode "count=10" \
  --data-urlencode "rich=true"

端点

GET https://api.search.brave.com/res/v1/suggest/search

身份验证：X-Subscription-Token: <API_KEY> 请求头

可选请求头：

  • Accept-Encoding: gzip — 启用响应压缩

参数

参数类型必填默认值描述
qstring是—建议搜索查询（1-400 个字符，最多 50 个单词）
langstring否en语言偏好（至少 2 个字符的语言代码，例如 fr、de、zh-hans）
countrystring否US搜索国家/地区（2 个字母的国家/地区代码或 ALL）
countint否5建议数量（1-20）。实际结果可能更少
richbool否false添加实体信息（标题、描述、图片）。需要付费 Search 套餐

响应字段

字段类型描述
typestring始终为 "suggest"
query.originalstring原始建议搜索查询
resultsarray建议列表（可能为空）
results[].querystring建议的查询补全内容
results[].is_entitybool?建议的增强查询是否为实体（仅限 rich 模式）
results[].titlestring?建议的查询所对应的增强标题（仅限 rich 模式）
results[].descriptionstring?建议的查询所对应的增强描述（仅限 rich 模式）
results[].imgstring?建议的查询所对应的增强图片 URL（仅限 rich 模式）

值为 null 的字段不会包含在响应中。非 rich 模式的结果仅包含 query 字段。

Rich 响应示例（rich=true）
{
  "type": "suggest",
  "query": { "original": "albert" },
  "results": [
    {
      "query": "albert einstein",
      "is_entity": true,
      "title": "Albert Einstein",
      "description": "German-born theoretical physicist",
      "img": "https://imgs.search.brave.com/..."
    },
    { "query": "albert einstein quotes", "is_entity": false }
  ]
}

使用场景

  • 边输入边搜索的界面：实时自动补全下拉列表。防抖时间设为 150-300ms。
  • RAG 查询优化：调用 web-search 或 llm-context 前，扩展不完整或含糊的查询。
  • 实体检测：使用 rich=true 检测实体，并获取标题、描述和图片以制作预览卡片。
  • 支持拼写错误的输入：从拼写错误的输入中获取准确建议，无需单独进行拼写检查。

注意事项

  • 延迟：专为低于 100ms 的响应时间设计
  • 国家/地区和语言：用于提示建议结果的相关性，而非严格筛选
  • 拼写错误处理：建议可处理常见拼写错误，无需单独进行拼写检查

评论

支持 Markdown