Skip to content

Commit b8632d2

Browse files
committed
fix(docs): note the hidden inputs that gate Pulse html and figures output
extractFigure and returnHtml are visibility: 'hidden' with no subBlock, and parser.ts:135-144 only forwards them when defined, so neither output can be produced today. Say so on the output rows rather than deleting them, since removing an output field would break saved block references. chunks is left alone: chunking/chunkSize are user-only with real subBlocks.
1 parent 3ede8d5 commit b8632d2

3 files changed

Lines changed: 6 additions & 5 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ Parse documents (PDF, images, Office docs) using Pulse OCR API
6060
| `job_id` | string | Unique job identifier |
6161
| `bounding_boxes` | json | Bounding box layout information |
6262
| `extraction_url` | string | URL for extraction results \(for large documents\) |
63-
| `html` | string | HTML content if requested |
63+
| `html` | string | HTML content; returned only when the hidden returnHtml input is enabled |
6464
| `structured_output` | json | Structured output if schema was provided |
6565
| `chunks` | json | Chunked content if chunking was enabled |
66-
| `figures` | json | Extracted figures if figure extraction was enabled |
66+
| `figures` | json | Extracted figures; returned only when the hidden extractFigure input is enabled |
6767

6868

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

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

apps/sim/tools/pulse/parser.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ export const pulseParserTool: InternalToolConfig<PulseParserInput, PulseParserOu
224224
},
225225
html: {
226226
type: 'string',
227-
description: 'HTML content if requested',
227+
description: 'HTML content; returned only when the hidden returnHtml input is enabled',
228228
optional: true,
229229
},
230230
structured_output: {
@@ -239,7 +239,8 @@ export const pulseParserTool: InternalToolConfig<PulseParserInput, PulseParserOu
239239
},
240240
figures: {
241241
type: 'json',
242-
description: 'Extracted figures if figure extraction was enabled',
242+
description:
243+
'Extracted figures; returned only when the hidden extractFigure input is enabled',
243244
optional: true,
244245
},
245246
},

0 commit comments

Comments
 (0)