Destaques da Busca

Os Destaques da Busca substituem a descrição simples do site de cada resultado por trechos da página relevantes para a sua consulta. Eles vêm ativados por padrão em /v2/search; nenhum parâmetro, formato de saída ou scrapeOptions adicional é necessário.

Os Destaques preservam a URL, o título, a posição e a classificação do resultado de busca. Para resultados da web, o texto destacado é retornado em description; para resultados de notícias, ele é retornado em snippet.

Use Search normalmente, e o Firecrawl retornará destaques quando houver conteúdo relevante da página disponível.

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)

A ferramenta MCP firecrawl_search também retorna destaques por padrão:

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

destaques usam os campos de descrição já existentes, então a estrutura da resposta permanece a mesma de uma resposta de busca normal.

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

destaques podem conter Markdown quando o conteúdo relevante da página inclui títulos, listas, tabelas ou código. Renderize ou processe o campo como Markdown se quiser preservar essa estrutura.

Defina highlights como false quando quiser receber a descrição simples ou o snippet de cada site.

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

• Web: Substitui description por conteúdo da página relevante para a query, quando disponível.
• Notícias: Substitui snippet por conteúdo da página relevante para a query, quando disponível.
• Images: Os resultados de imagem são retornados sem alterações.
• Busca com scraping: Os destaques afetam a descrição ou o snippet da busca. O conteúdo solicitado por scrapeOptions é retornado separadamente e não é substituído.
• Zero Data Retention: As buscas com ZDR mantêm as descrições e os snippets originais dos websites.

Para cada parâmetro de busca e o esquema completo da resposta, consulte a referência da API de Search.