Skip to content

Commit 1db2430

Browse files
committed
fix(docs): name the input that gates Firecrawl search scrape output
The previous wording ended each description with "for which the Search operation exposes no visible input", a relative clause that attaches ambiguously and never tells the reader what controls the field. Name scrapeOptions and note that it is hidden.
1 parent b13c7dc commit 1db2430

3 files changed

Lines changed: 11 additions & 11 deletions

File tree

apps/docs/content/docs/en/integrations/firecrawl.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -167,11 +167,11 @@ Search for information on the web using Firecrawl
167167
|`title` | string | Search result title from search engine |
168168
|`description` | string | Search result description/snippet from search engine |
169169
|`url` | string | URL of the search result |
170-
|`markdown` | string | Page content in markdown; returned only when scraping was requested, for which the Search operation exposes no visible input |
171-
|`html` | string | Processed HTML content; returned only when "html" is among the requested scrape formats, for which the Search operation exposes no visible input |
172-
|`rawHtml` | string | Unprocessed raw HTML; returned only when "rawHtml" is among the requested scrape formats, for which the Search operation exposes no visible input |
173-
|`links` | array | Links found on the page; returned only when "links" is among the requested scrape formats, for which the Search operation exposes no visible input |
174-
|`screenshot` | string | Screenshot URL \(expires after 24 hours\); returned only when "screenshot" is among the requested scrape formats, for which the Search operation exposes no visible input |
170+
|`markdown` | string | Page content in markdown; returned only when scraping was requested via the hidden scrapeOptions input |
171+
|`html` | string | Processed HTML content; returned only when "html" is among the scrape formats requested via the hidden scrapeOptions input |
172+
|`rawHtml` | string | Unprocessed raw HTML; returned only when "rawHtml" is among the scrape formats requested via the hidden scrapeOptions input |
173+
|`links` | array | Links found on the page; returned only when "links" is among the scrape formats requested via the hidden scrapeOptions input |
174+
|`screenshot` | string | Screenshot URL \(expires after 24 hours\); returned only when "screenshot" is among the scrape formats requested via the hidden scrapeOptions input |
175175
|`metadata` | object | Metadata about the search result page |
176176
|`title` | string | Page title |
177177
|`description` | string | Page meta description |

apps/sim/tools/firecrawl/types.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -136,32 +136,32 @@ export const SEARCH_RESULT_OUTPUT_PROPERTIES = {
136136
markdown: {
137137
type: 'string',
138138
description:
139-
'Page content in markdown; returned only when scraping was requested, for which the Search operation exposes no visible input',
139+
'Page content in markdown; returned only when scraping was requested via the hidden scrapeOptions input',
140140
optional: true,
141141
},
142142
html: {
143143
type: 'string',
144144
description:
145-
'Processed HTML content; returned only when "html" is among the requested scrape formats, for which the Search operation exposes no visible input',
145+
'Processed HTML content; returned only when "html" is among the scrape formats requested via the hidden scrapeOptions input',
146146
optional: true,
147147
},
148148
rawHtml: {
149149
type: 'string',
150150
description:
151-
'Unprocessed raw HTML; returned only when "rawHtml" is among the requested scrape formats, for which the Search operation exposes no visible input',
151+
'Unprocessed raw HTML; returned only when "rawHtml" is among the scrape formats requested via the hidden scrapeOptions input',
152152
optional: true,
153153
},
154154
links: {
155155
type: 'array',
156156
description:
157-
'Links found on the page; returned only when "links" is among the requested scrape formats, for which the Search operation exposes no visible input',
157+
'Links found on the page; returned only when "links" is among the scrape formats requested via the hidden scrapeOptions input',
158158
optional: true,
159159
items: { type: 'string', description: 'URL found on the page' },
160160
},
161161
screenshot: {
162162
type: 'string',
163163
description:
164-
'Screenshot URL (expires after 24 hours); returned only when "screenshot" is among the requested scrape formats, for which the Search operation exposes no visible input',
164+
'Screenshot URL (expires after 24 hours); returned only when "screenshot" is among the scrape formats requested via the hidden scrapeOptions input',
165165
optional: true,
166166
},
167167
metadata: SEARCH_METADATA_OUTPUT,

apps/sim/tools/generated/tool-outputs.ts

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)