Suggest

作者 brave62793e0c49ed無授權條款183 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫2 週前更新

USE FOR query autocomplete/suggestions. Fast (<100ms). Returns suggested queries as user types. Supports rich suggestions with entity info. Typo-resilient.

AI 產生的概覽

封裝 Brave Suggest API,在使用者輸入時回傳查詢自動完成建議。

功能
說明 Brave Suggest 端點、其驗證標頭、查詢參數與回應欄位。它展示如何要求基本或豐富建議,包括實體標題、描述與圖片資料。它也列出使用情境,例如邊輸入邊搜尋介面、檢索前的查詢精煉、實體偵測以及容錯輸入。
適用情境
適用於建置自動完成或邊輸入邊搜尋功能,或在網頁搜尋、檢索步驟之前擴展不完整或有歧義的查詢。也適合需要實體預覽或容錯建議的情境。
執行需求
需要 Brave Search API 金鑰並透過 X-Subscription-Token 標頭傳送,需要連線至 api.search.brave.com 的網路存取權,以及包含 Suggest 方案的訂閱;豐富建議需要付費 Search 方案。此技能不附帶指令碼。

Suggest / Autocomplete

Requires API Key: Get one at https://api.search.brave.com

Plan: Included in the Suggest plan. See https://api-dashboard.search.brave.com/app/subscriptions/subscribe

Quick Start (cURL)

Basic Suggestions

bash
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}"

With All Parameters

bash
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"

Endpoint

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

Authentication: X-Subscription-Token: <API_KEY> header

Optional Headers:

  • Accept-Encoding: gzip — Enable response compression

Parameters

ParameterTypeRequiredDefaultDescription
qstringYes—Suggest search query (1-400 chars, max 50 words)
langstringNoenLanguage preference (2+ char language code, e.g. fr, de, zh-hans)
countrystringNoUSSearch country (2-letter country code or ALL)
countintNo5Number of suggestions (1-20). Actual results may be fewer
richboolNofalseEnhance with entity info (title, description, image). Paid Search plan required

Response Fields

FieldTypeDescription
typestringAlways "suggest"
query.originalstringThe original suggest search query
resultsarrayList of suggestions (may be empty)
results[].querystringSuggested query completion
results[].is_entitybool?Whether the suggested enriched query is an entity (rich only)
results[].titlestring?The suggested query enriched title (rich only)
results[].descriptionstring?The suggested query enriched description (rich only)
results[].imgstring?The suggested query enriched image URL (rich only)

Fields with null values are excluded from the response. Non-rich results contain only the query field.

Rich Response Example (rich=true)

json
{  "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 }  ]}

Use Cases

  • Search-as-you-type UI: Real-time autocomplete dropdown. Debounce 150-300ms.
  • Query refinement for RAG: Expand partial/ambiguous queries before calling web-search or llm-context.
  • Entity detection: Use rich=true to detect entities with title, description, and image for preview cards.
  • Typo-tolerant input: Get clean suggestions from misspelled input without separate spellcheck.

Notes

  • Latency: Designed for <100ms response times
  • Country/lang: Hints for suggestion relevance, not strict filters
  • Typo handling: Suggestions handle common typos without separate spellcheck

來源與署名

來源:brave/brave-search-skills位於skills/suggest提交62793e0

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架