关于 local-descriptions
local-descriptions 是 Brave Search API 的地点描述接口,供需要为本地搜索结果补充文字介绍的应用使用。它根据搜索结果中的 POI ID 返回 AI 生成的 Markdown 描述;部分地点可能没有描述。
主要功能
- 01按 POI ID 获取地点描述
- 02返回 AI 生成的 Markdown
- 03支持一次查询多个地点
- 04描述可能为空
适用场景
- 01为商家搜索结果补充介绍
- 02为旅行规划添加地点背景
- 03结合结构化地点资料生成概览
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ brave/ brave-search-skills --skill local-descriptions安装后在 Claude Code 中输入/local-descriptions确认已加载。
详细介绍
本地描述(搜索 API)
需要 API 密钥:请在 https://api.search.brave.com 获取
套餐:包含在 Search 套餐中。请参阅 https://api-dashboard.search.brave.com/app/subscriptions/subscribe
两步流程:此端点需要先通过搜索获取 POI ID。
- 通过
local-place-search获取 POI ID,或使用web-search并设置result_filter=locations(locations.results[].id)- 将这些 ID 传递给此端点,以获取 AI 生成的描述
快速开始(cURL)
获取 POI 描述
curl -s "https://api.search.brave.com/res/v1/local/descriptions?ids=loc4CQWMJWLD4VBEBZ62XQLJTGK6YCJEEJDNAAAAAAA%3D" \
-H "Accept: application/json" \
-H "Accept-Encoding: gzip" \
-H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"
多个 POI
curl -s "https://api.search.brave.com/res/v1/local/descriptions" \
-H "Accept: application/json" \
-H "Accept-Encoding: gzip" \
-H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}" \
-G \
--data-urlencode "ids=loc4CQWMJWLD4VBEBZ62XQLJTGK6YCJEEJDNAAAAAAA=" \
--data-urlencode "ids=loc4HTAVTJKP4RBEBZCEMBI3NG26YD4II4PATIHPDYI="
注意:POI ID 是在网页搜索 locations.results[].id 中返回的不透明字符串。其有效期约为 8 小时。上方的示例 ID 仅用于说明——请通过设置 result_filter=locations 的 web-search 获取最新 ID。
端点
GET https://api.search.brave.com/res/v1/local/descriptions
身份验证:X-Subscription-Token: <API_KEY> 请求头
参数
| 参数 | 类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
ids | string[] | 是 | — | 网页搜索 locations.results[].id 中的 POI ID(1-20 个,重复传入:?ids=a&ids=b) |
响应格式
响应字段
| 字段 | 类型 | 描述 |
|---|---|---|
type | string | 始终为 "local_descriptions" |
results | array | 描述对象列表(条目可能为 null) |
results[].type | string | 始终为 "local_description" |
results[].id | string | 与请求匹配的 POI 标识符 |
results[].description | string? | AI 生成的 Markdown 描述;不可用时为 null |
响应示例
{
"type": "local_descriptions",
"results": [
{
"type": "local_description",
"id": "loc4CQWMJWLD4VBEBZ62XQLJTGK6YCJEEJDNAAAAAAA=",
"description": "### Overview\nA cozy neighborhood cafe known for its **artisanal coffee**..."
}
]
}
获取 POI ID
local-place-search 会直接返回 POI ID。也可以通过设置 result_filter=locations 使用 Web Search API(web-search)获取:
# 1. Search for local businesses
curl -s "https://api.search.brave.com/res/v1/web/search?q=restaurants+san+francisco&result_filter=locations" \
-H "Accept: application/json" \
-H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"
# 2. Extract POI IDs from locations.results[].id
# 3. Use those IDs with local/pois and local/descriptions
使用场景
- 本地商家概览:与
local-pois搭配,同时获取结构化数据(营业时间、评分)和叙述性描述 - 旅行/旅游信息增强:为 POI 添加描述性背景信息,用于旅行规划或目的地指南
- 增强搜索结果:用 AI 生成的本地商家摘要补充网页搜索结果
备注
- 始终使用 Markdown:描述使用
###标题、项目符号列表、粗体/斜体——始终采用 Markdown 格式 - 旅行指南风格:通常为 200-400 个词,介绍 POI 的特色
- AI 生成:描述基于网页搜索上下文由 AI 生成,并非摘自商家资料
- 可用性:并非所有 POI 都有描述,
description可能为null - ID 上限:每次请求最多 20 个 ID
评论
支持 Markdown