关于 spellcheck
spellcheck 是 Brave Search API 的拼写检查接口,供搜索应用或需要清理文本查询的工具使用。它会结合查询上下文返回更正建议,可在搜索前单独调用。
主要功能
- 01检查查询拼写
- 02根据上下文生成更正建议
- 03支持多种语言和国家设置
- 04无建议时返回空结果
适用场景
- 01搜索前清理查询文本
- 02在界面展示“是否要找”建议
- 03批量规范化用户输入
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ brave/ brave-search-skills --skill spellcheck安装后在 Claude Code 中输入/spellcheck确认已加载。
详细介绍
拼写检查
需要 API 密钥:请前往 https://api.search.brave.com 获取
套餐:包含在 Spellcheck 套餐中。请参阅 https://api-dashboard.search.brave.com/app/subscriptions/subscribe
快速开始(cURL)
curl -s "https://api.search.brave.com/res/v1/spellcheck/search" \
-H "Accept: application/json" \
-H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}" \
-G \
--data-urlencode "q=artifical inteligence" \
--data-urlencode "lang=en" \
--data-urlencode "country=US"
端点
GET https://api.search.brave.com/res/v1/spellcheck/search
身份验证:X-Subscription-Token: <API_KEY> 请求头
参数
| 参数 | 类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
q | string | 是 | — | 要进行拼写检查的查询(1-400 个字符,最多 50 个词) |
lang | string | 否 | en | 语言偏好(至少 2 个字符的语言代码,例如 en、fr、de、pt-br、zh-hans)。支持 51 种代码 |
country | string | 否 | US | 搜索国家/地区(2 个字母的国家/地区代码或 ALL) |
响应字段
| 字段 | 类型 | 描述 |
|---|---|---|
type | string | 始终为 "spellcheck" |
query.original | string | 提交的原始查询 |
results | array | 拼写更正建议。如果没有找到需要更正的内容,则可能为空 |
results[].query | string | 更正后的查询 |
响应示例
{
"type": "spellcheck",
"query": {
"original": "artifical inteligence"
},
"results": [
{
"query": "artificial intelligence"
}
]
}
使用场景
- 搜索前清理查询:在决定调用哪个搜索端点之前检查拼写
- “您是否想搜索?”界面:执行搜索前向用户显示更正建议
- 批量查询规范化:批量清理用户输入
备注
- 内置替代方案:Web Search 和 LLM Context 默认启用
spellcheck=true— 仅在需要于搜索前进行更正时使用此独立端点 - 上下文感知:更正会考虑完整的查询上下文,而非仅考虑单个词
评论
支持 Markdown