Skip to content

Commit ef17d5f

Browse files
waleedlatif1waleedlatif1
committed
fix(docs): correct output rows that cite inputs Sim does not send
mistral_parse: the PR removed the includeImageBase64 input row but left the image_base64 output citing include_image_base64=true, so the page referenced an input it no longer documents. includeImageBase64 is visibility: 'hidden' with no subBlock, mapper or canonicalParamId, so it is annotated the same way Pulse's html and figures were. The sibling rows are a stronger defect: table_format, extract_header and extract_footer appear nowhere in the repo - not as tool params, not in the request body parser.ts builds - so tables/header/footer cited options Sim never sends. Worded accordingly rather than as hidden inputs. pulse structured_output cited 'if schema was provided', but there is no schema or structuredOutput param in the tool, in pulseParseInputSchema, or in the outgoing body, so the field is always null. No output field is deleted - removing one changes the block's output schema and could break saved workflow references.
1 parent 1cb3f8f commit ef17d5f

8 files changed

Lines changed: 17 additions & 17 deletions

File tree

‎apps/docs/content/docs/en/integrations/mistral_parse.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,15 @@ Parse PDF documents using Mistral OCR API
5959
| ↳ `top_left_y` | number | Top-left Y coordinate in pixels |
6060
| ↳ `bottom_right_x` | number | Bottom-right X coordinate in pixels |
6161
| ↳ `bottom_right_y` | number | Bottom-right Y coordinate in pixels |
62-
| ↳ `image_base64` | string | Base64-encoded image data \(when include_image_base64=true\) |
62+
| ↳ `image_base64` | string | Base64-encoded image data; returned only when the hidden includeImageBase64 input is enabled |
6363
| ↳ `dimensions` | object | Page dimensions |
6464
| ↳ `dpi` | number | Dots per inch |
6565
| ↳ `height` | number | Page height in pixels |
6666
| ↳ `width` | number | Page width in pixels |
67-
| ↳ `tables` | array | Extracted tables as HTML/markdown \(when table_format is set\). Referenced via placeholders like \[tbl-0.html\] |
67+
| ↳ `tables` | array | Extracted tables as HTML/markdown, referenced via placeholders like \[tbl-0.html\]. Sim sends no table-extraction option, so this is empty |
6868
| ↳ `hyperlinks` | array | Array of URL strings detected in the page \(e.g., \["https://...", "mailto:..."\]\) |
69-
| ↳ `header` | string | Page header content \(when extract_header=true\) |
70-
| ↳ `footer` | string | Page footer content \(when extract_footer=true\) |
69+
| ↳ `header` | string | Page header content. Sim sends no header-extraction option, so this is not returned |
70+
| ↳ `footer` | string | Page footer content. Sim sends no footer-extraction option, so this is not returned |
7171
| `model` | string | Mistral OCR model identifier \(e.g., mistral-ocr-latest\) |
7272
| `usage_info` | object | Usage and processing statistics |
7373
| ↳ `pages_processed` | number | Total number of pages processed |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Parse documents (PDF, images, Office docs) using Pulse OCR API
6161
| `bounding_boxes` | json | Bounding box layout information |
6262
| `extraction_url` | string | URL for extraction results \(for large documents\) |
6363
| `html` | string | HTML content; returned only when the hidden returnHtml input is enabled |
64-
| `structured_output` | json | Structured output if schema was provided |
64+
| `structured_output` | json | Structured output; Sim exposes no input for supplying a schema, so this is always null |
6565
| `chunks` | json | Chunked content if chunking was enabled |
6666
| `figures` | json | Extracted figures; returned only when the hidden extractFigure input is enabled |
6767

‎apps/sim/blocks/blocks/pulse.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ export const PulseBlock: BlockConfig<PulseParserOutput> = {
141141
bounding_boxes: { type: 'json', description: 'Bounding box layout information' },
142142
extraction_url: { type: 'string', description: 'URL for extraction results (large documents)' },
143143
html: { type: 'string', description: 'HTML content if requested' },
144-
structured_output: { type: 'json', description: 'Structured output if schema was provided' },
144+
structured_output: { type: 'json', description: 'Structured output; Sim exposes no input for supplying a schema, so this is always null' },
145145
chunks: { type: 'json', description: 'Chunked content if chunking was enabled' },
146146
figures: { type: 'json', description: 'Extracted figures if figure extraction was enabled' },
147147
},

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

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

‎apps/sim/tools/mistral/parser.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ export const mistralParserV2Tool: InternalToolConfig<MistralParserInput, Mistral
466466
},
467467
image_base64: {
468468
type: 'string',
469-
description: 'Base64-encoded image data (when include_image_base64=true)',
469+
description: 'Base64-encoded image data; returned only when the hidden includeImageBase64 input is enabled',
470470
optional: true,
471471
},
472472
},
@@ -484,7 +484,7 @@ export const mistralParserV2Tool: InternalToolConfig<MistralParserInput, Mistral
484484
tables: {
485485
type: 'array',
486486
description:
487-
'Extracted tables as HTML/markdown (when table_format is set). Referenced via placeholders like [tbl-0.html]',
487+
'Extracted tables as HTML/markdown, referenced via placeholders like [tbl-0.html]. Sim sends no table-extraction option, so this is empty',
488488
},
489489
hyperlinks: {
490490
type: 'array',
@@ -497,12 +497,12 @@ export const mistralParserV2Tool: InternalToolConfig<MistralParserInput, Mistral
497497
},
498498
header: {
499499
type: 'string',
500-
description: 'Page header content (when extract_header=true)',
500+
description: 'Page header content. Sim sends no header-extraction option, so this is not returned',
501501
optional: true,
502502
},
503503
footer: {
504504
type: 'string',
505-
description: 'Page footer content (when extract_footer=true)',
505+
description: 'Page footer content. Sim sends no footer-extraction option, so this is not returned',
506506
optional: true,
507507
},
508508
},

‎apps/sim/tools/mistral/types.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const MISTRAL_OCR_IMAGE_OUTPUT_PROPERTIES = {
1818
bottom_right_y: { type: 'number', description: 'Bottom-right Y coordinate in pixels' },
1919
image_base64: {
2020
type: 'string',
21-
description: 'Base64-encoded image data (when include_image_base64=true)',
21+
description: 'Base64-encoded image data; returned only when the hidden includeImageBase64 input is enabled',
2222
optional: true,
2323
},
2424
} as const satisfies Record<string, OutputProperty>
@@ -58,7 +58,7 @@ export const MISTRAL_OCR_PAGE_OUTPUT_PROPERTIES = {
5858
dimensions: MISTRAL_OCR_DIMENSIONS_OUTPUT,
5959
tables: {
6060
type: 'array',
61-
description: 'Extracted tables as HTML/markdown (when table_format is set)',
61+
description: 'Extracted tables as HTML/markdown, referenced via placeholders like [tbl-0.html]. Sim sends no table-extraction option, so this is empty',
6262
},
6363
hyperlinks: {
6464
type: 'array',
@@ -67,12 +67,12 @@ export const MISTRAL_OCR_PAGE_OUTPUT_PROPERTIES = {
6767
},
6868
header: {
6969
type: 'string',
70-
description: 'Page header content (when extract_header=true)',
70+
description: 'Page header content. Sim sends no header-extraction option, so this is not returned',
7171
optional: true,
7272
},
7373
footer: {
7474
type: 'string',
75-
description: 'Page footer content (when extract_footer=true)',
75+
description: 'Page footer content. Sim sends no footer-extraction option, so this is not returned',
7676
optional: true,
7777
},
7878
} as const satisfies Record<string, OutputProperty>

‎apps/sim/tools/pulse/parser.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ export const pulseParserTool: InternalToolConfig<PulseParserInput, PulseParserOu
229229
},
230230
structured_output: {
231231
type: 'json',
232-
description: 'Structured output if schema was provided',
232+
description: 'Structured output; Sim exposes no input for supplying a schema, so this is always null',
233233
optional: true,
234234
},
235235
chunks: {

‎apps/sim/tools/pulse/types.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ interface PulseParserOutputData {
101101
/** HTML content if requested */
102102
html?: string
103103

104-
/** Structured output if schema was provided */
104+
/** Structured output; Sim exposes no input for supplying a schema, so this is always null. */
105105
structured_output?: Record<string, unknown>
106106

107107
/** Chunked content if chunking was enabled */

0 commit comments

Comments
 (0)