suggest

โดย brave

ใช้สำหรับการเติมข้อความค้นหา/คำแนะนำอัตโนมัติ รวดเร็ว (<100ms) ส่งคืนข้อความค้นหาที่แนะนำขณะที่ผู้ใช้พิมพ์ รองรับคำแนะนำแบบละเอียดพร้อมข้อมูลเอนทิตี ทนทานต่อการพิมพ์ผิด

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

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

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

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

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
qstringYesSuggest 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)

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

Skills เพิ่มเติมจาก brave

pr
brave
Create a pull request for the current branch using `gh`.
official
add-best-practice
brave
เพิ่มแนวปฏิบัติที่ดีที่สุดใหม่ลงในเอกสารที่เหมาะสม ตรวจสอบรายการซ้ำ
official
check-upstream-flake
brave
ตรวจสอบว่าการทดสอบที่ล้มเหลวเป็นความผิดพลาดต้นทางที่รู้จักใน LUCI Analysis ของ Chromium หรือไม่
official
clean-branches
brave
ลบสาขาในเครื่องที่ PR ถูกรวมเข้ากับต้นทางแล้ว ตรวจสอบ PR ของ GitHub
official
fix-bp-docs
brave
ตรวจสอบและแก้ไขเอกสารแนวทางปฏิบัติที่ดีที่สุดสำหรับการอ้างอิงที่ล้าสมัย ข้อมูลซ้ำซ้อน และสิ่งที่ล้าสมัย
official
force-push-downstream
brave
บังคับพุชสาขาและสาขาปลายน้ำทั้งหมดไปยัง origin ตรวจจับอัตโนมัติ
official
impl-review
brave
นำข้อเสนอแนะจากการตรวจสอบไปปรับใช้กับ Pull Request โดยเช็คเอาท์สาขาและนำไปใช้
official
make-ci-green
brave
เรียกใช้ CI jobs ที่ล้มเหลวอีกครั้งสำหรับ PR brave/brave-core ตรวจจับขั้นตอนที่ล้มเหลวและ
official