検索ハイライト

検索ハイライトは、各検索結果の通常の Web サイト説明を、query に関連するページ内の本文箇所に置き換えます。これは /v2/search でデフォルトで有効になっており、追加のパラメータ、出力形式、または scrapeOptions は必要ありません。

ハイライトでは、検索結果の URL、タイトル、掲載位置、ランキングが保持されます。Web 検索結果では、ハイライトされたテキストは description に返されます。ニュース検索結果では、snippet に返されます。

通常どおり Search を使用すると、関連するページコンテンツが利用可能な場合、Firecrawl はハイライトを返します。

from firecrawl import Firecrawl

firecrawl = Firecrawl(api_key="fc-YOUR-API-KEY")

results = firecrawl.search(
    query="how does firecrawl handle javascript rendering",
    limit=5,
)

for result in results.web or []:
    print(result.description)

firecrawl_search MCPツールでも、デフォルトでハイライトが返されます。

{
  "query": "how does firecrawl handle javascript rendering",
  "limit": 5
}

ハイライト は既存のdescriptionフィールドを使用するため、レスポンスの形式は通常の検索レスポンスと変わりません。

{
  "success": true,
  "data": {
    "web": [
      {
        "url": "https://www.firecrawl.dev/blog/javascript-web-scraping",
        "title": "Web Scraping With JavaScript: Step-by-Step Guide",
        "description": "# Web Scraping With JavaScript: Step-by-Step Guide\n## When should you use scraping APIs instead of DIY tools?\n### Setting up Firecrawl\n```\nnpm install firecrawl\n```\n\n```\nFIRECRAWL_API_KEY=fc-your-api-key-here\n```\n\n### Solving the JavaScript quotes problem\nYou describe what you want, and Firecrawl handles extraction and validation.",
        "position": 1
      }
    ]
  }
}

ハイライト には、該当ページのコンテンツに見出し、リスト、表、コードなどが含まれている場合、Markdown が含まれることがあります。その構造を保持したい場合は、このフィールドを Markdown としてレンダリングまたは処理してください。

各 Web サイトについて、highlights の代わりに通常の説明文やスニペットを返したい場合は、highlights を false に設定します。

results = firecrawl.search(
    query="Firecrawl search API",
    highlights=False,
)

• Web: 利用可能な場合、description は query に関連するページコンテンツに置き換えられます。
• News: 利用可能な場合、snippet は query に関連するページコンテンツに置き換えられます。
• Images: 画像結果は変更されずに返されます。
• Search with scraping: ハイライトは検索結果の description または snippet に反映されます。scrapeOptions で要求した content は別途返され、置き換えられません。
• Zero Data Retention: ZDR 検索では、Web サイトの通常の description と snippet が保持されます。

すべての Search パラメータと完全な レスポンス schema については、Search APIリファレンスを参照してください。