docs(search): document the highlights parameter (on by default) - #1112
Open
mogery wants to merge 1 commit into
Open
docs(search): document the highlights parameter (on by default)#1112mogery wants to merge 1 commit into
mogery wants to merge 1 commit into
Conversation
Search now replaces each result's description with query-relevant highlights from Firecrawl's index by default (firecrawl/firecrawl#3958), falling back to the provider description on index miss or timeout. Documents the new `highlights` boolean (default true, false to opt out) in the v1/v2 OpenAPI specs, the search feature page, and the agent-source-of-truth option lists. English files only — translations are autogenerated. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Parallel to firecrawl/firecrawl#3958, which turns search result highlights on by default for v1 and v2
/search(hard 300ms internal budget, falls back to the provider description on index miss or timeout) and exposeshighlightsin all SDKs.What
api-reference/v2-openapi.json+api-reference/v1-openapi.json: added thehighlightsboolean (defaulttrue) to the search request schemas, so the API reference pages pick it up.features/search.mdx: new "Result Highlights" section under Advanced Search Options — explains the default-on behavior, the fallback guarantee, and shows thehighlights: falseopt-out in Python/JS/cURL; notes that news results carry the highlight insnippet.agent-source-of-truth/{curl,node,python,java,rust,elixir}.mdx: added thehighlightsoption to each search options list, matching each file's naming convention.English files only — es/fr/pt-BR/ja/zh are autogenerated and untouched.
🤖 Generated with Claude Code