Skip to content

Commit 762fbbd

Browse files
waleedlatif1waleedlatif1
authored
fix(docs): resolve missing tool outputs for spread-inherited V2 tools (#4020)
* fix(docs): resolve missing tool outputs for spread-inherited V2 tools * fix(docs): add word boundary to baseToolRegex to prevent false matches * fix(docs): remove unnecessary case-insensitive flag from baseToolRegex
1 parent c89a95d commit 762fbbd

File tree

8 files changed

+319
-282
lines changed

8 files changed

+319
-282
lines changed

‎apps/docs/content/docs/en/tools/extend.mdx‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,13 @@ Integrate Extend AI into the workflow. Parse and extract structured content from
3434

3535
#### Output
3636

37-
This tool does not produce any outputs.
37+
| Parameter | Type | Description |
38+
| --------- | ---- | ----------- |
39+
| `id` | string | Unique identifier for the parser run |
40+
| `status` | string | Processing status |
41+
| `chunks` | json | Parsed document content chunks |
42+
| `blocks` | json | Block-level document elements with type and content |
43+
| `pageCount` | number | Number of pages processed |
44+
| `creditsUsed` | number | API credits consumed |
3845

3946

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

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,27 @@ Integrate Mistral Parse into the workflow. Can extract text from uploaded PDF do
5454
| Parameter | Type | Description |
5555
| --------- | ---- | ----------- |
5656
| `pages` | array | Array of page objects from Mistral OCR |
57-
| `model` | string | Mistral OCR model identifier |
58-
| `usage_info` | json | Usage statistics from the API |
59-
| `document_annotation` | string | Structured annotation data |
57+
| ↳ `index` | number | Page index \(zero-based\) |
58+
| ↳ `markdown` | string | Extracted markdown content |
59+
| ↳ `images` | array | Images extracted from this page with bounding boxes |
60+
| ↳ `id` | string | Image identifier \(e.g., img-0.jpeg\) |
61+
| ↳ `top_left_x` | number | Top-left X coordinate in pixels |
62+
| ↳ `top_left_y` | number | Top-left Y coordinate in pixels |
63+
| ↳ `bottom_right_x` | number | Bottom-right X coordinate in pixels |
64+
| ↳ `bottom_right_y` | number | Bottom-right Y coordinate in pixels |
65+
| ↳ `image_base64` | string | Base64-encoded image data \(when include_image_base64=true\) |
66+
| ↳ `dimensions` | object | Page dimensions |
67+
| ↳ `dpi` | number | Dots per inch |
68+
| ↳ `height` | number | Page height in pixels |
69+
| ↳ `width` | number | Page width in pixels |
70+
| ↳ `tables` | array | Extracted tables as HTML/markdown \(when table_format is set\). Referenced via placeholders like \[tbl-0.html\] |
71+
| ↳ `hyperlinks` | array | Array of URL strings detected in the page \(e.g., \["https://...", "mailto:..."\]\) |
72+
| ↳ `header` | string | Page header content \(when extract_header=true\) |
73+
| ↳ `footer` | string | Page footer content \(when extract_footer=true\) |
74+
| `model` | string | Mistral OCR model identifier \(e.g., mistral-ocr-latest\) |
75+
| `usage_info` | object | Usage and processing statistics |
76+
| ↳ `pages_processed` | number | Total number of pages processed |
77+
| ↳ `doc_size_bytes` | number | Document file size in bytes |
78+
| `document_annotation` | string | Structured annotation data as JSON string \(when applicable\) |
6079

6180

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

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,16 @@ Integrate Pulse into the workflow. Extract text from PDF documents, images, and
5656

5757
#### Output
5858

59-
This tool does not produce any outputs.
59+
| Parameter | Type | Description |
60+
| --------- | ---- | ----------- |
61+
| `markdown` | string | Extracted content in markdown format |
62+
| `page_count` | number | Number of pages in the document |
63+
| `job_id` | string | Unique job identifier |
64+
| `bounding_boxes` | json | Bounding box layout information |
65+
| `extraction_url` | string | URL for extraction results \(for large documents\) |
66+
| `html` | string | HTML content if requested |
67+
| `structured_output` | json | Structured output if schema was provided |
68+
| `chunks` | json | Chunked content if chunking was enabled |
69+
| `figures` | json | Extracted figures if figure extraction was enabled |
6070

6171

‎apps/docs/content/docs/en/tools/reducto.mdx‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,13 @@ Integrate Reducto Parse into the workflow. Can extract text from uploaded PDF do
5050

5151
#### Output
5252

53-
This tool does not produce any outputs.
53+
| Parameter | Type | Description |
54+
| --------- | ---- | ----------- |
55+
| `job_id` | string | Unique identifier for the processing job |
56+
| `duration` | number | Processing time in seconds |
57+
| `usage` | json | Resource consumption data |
58+
| `result` | json | Parsed document content with chunks and blocks |
59+
| `pdf_url` | string | Storage URL of converted PDF |
60+
| `studio_link` | string | Link to Reducto studio interface |
5461

5562

‎apps/docs/content/docs/en/tools/stt.mdx‎

Lines changed: 61 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,17 @@ Transcribe audio and video files to text using leading AI providers. Supports mu
6969

7070
#### Output
7171

72-
This tool does not produce any outputs.
72+
| Parameter | Type | Description |
73+
| --------- | ---- | ----------- |
74+
| `transcript` | string | Full transcribed text |
75+
| `segments` | array | Timestamped segments |
76+
| ↳ `text` | string | Transcribed text for this segment |
77+
| ↳ `start` | number | Start time in seconds |
78+
| ↳ `end` | number | End time in seconds |
79+
| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) |
80+
| ↳ `confidence` | number | Confidence score \(0-1\) |
81+
| `language` | string | Detected or specified language |
82+
| `duration` | number | Audio duration in seconds |
7383

7484
### `stt_deepgram`
7585

@@ -89,7 +99,18 @@ This tool does not produce any outputs.
8999

90100
#### Output
91101

92-
This tool does not produce any outputs.
102+
| Parameter | Type | Description |
103+
| --------- | ---- | ----------- |
104+
| `transcript` | string | Full transcribed text |
105+
| `segments` | array | Timestamped segments with speaker labels |
106+
| ↳ `text` | string | Transcribed text for this segment |
107+
| ↳ `start` | number | Start time in seconds |
108+
| ↳ `end` | number | End time in seconds |
109+
| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) |
110+
| ↳ `confidence` | number | Confidence score \(0-1\) |
111+
| `language` | string | Detected or specified language |
112+
| `duration` | number | Audio duration in seconds |
113+
| `confidence` | number | Overall confidence score |
93114

94115
### `stt_elevenlabs`
95116

@@ -108,7 +129,13 @@ This tool does not produce any outputs.
108129

109130
#### Output
110131

111-
This tool does not produce any outputs.
132+
| Parameter | Type | Description |
133+
| --------- | ---- | ----------- |
134+
| `transcript` | string | Full transcribed text |
135+
| `segments` | array | Timestamped segments |
136+
| `language` | string | Detected or specified language |
137+
| `duration` | number | Audio duration in seconds |
138+
| `confidence` | number | Overall confidence score |
112139

113140
### `stt_assemblyai`
114141

@@ -132,7 +159,30 @@ This tool does not produce any outputs.
132159

133160
#### Output
134161

135-
This tool does not produce any outputs.
162+
| Parameter | Type | Description |
163+
| --------- | ---- | ----------- |
164+
| `transcript` | string | Full transcribed text |
165+
| `segments` | array | Timestamped segments with speaker labels |
166+
| ↳ `text` | string | Transcribed text for this segment |
167+
| ↳ `start` | number | Start time in seconds |
168+
| ↳ `end` | number | End time in seconds |
169+
| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) |
170+
| ↳ `confidence` | number | Confidence score \(0-1\) |
171+
| `language` | string | Detected or specified language |
172+
| `duration` | number | Audio duration in seconds |
173+
| `confidence` | number | Overall confidence score |
174+
| `sentiment` | array | Sentiment analysis results |
175+
| ↳ `text` | string | Text that was analyzed |
176+
| ↳ `sentiment` | string | Sentiment \(POSITIVE, NEGATIVE, NEUTRAL\) |
177+
| ↳ `confidence` | number | Confidence score |
178+
| ↳ `start` | number | Start time in milliseconds |
179+
| ↳ `end` | number | End time in milliseconds |
180+
| `entities` | array | Detected entities |
181+
| ↳ `entity_type` | string | Entity type \(e.g., person_name, location, organization\) |
182+
| ↳ `text` | string | Entity text |
183+
| ↳ `start` | number | Start time in milliseconds |
184+
| ↳ `end` | number | End time in milliseconds |
185+
| `summary` | string | Auto-generated summary |
136186

137187
### `stt_gemini`
138188

@@ -151,6 +201,12 @@ This tool does not produce any outputs.
151201

152202
#### Output
153203

154-
This tool does not produce any outputs.
204+
| Parameter | Type | Description |
205+
| --------- | ---- | ----------- |
206+
| `transcript` | string | Full transcribed text |
207+
| `segments` | array | Timestamped segments |
208+
| `language` | string | Detected or specified language |
209+
| `duration` | number | Audio duration in seconds |
210+
| `confidence` | number | Overall confidence score |
155211

156212

‎apps/docs/content/docs/en/tools/textract.mdx‎

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,39 @@ Integrate AWS Textract into your workflow to extract text, tables, forms, and ke
5656

5757
#### Output
5858

59-
This tool does not produce any outputs.
59+
| Parameter | Type | Description |
60+
| --------- | ---- | ----------- |
61+
| `blocks` | array | Array of Block objects containing detected text, tables, forms, and other elements |
62+
| ↳ `BlockType` | string | Type of block \(PAGE, LINE, WORD, TABLE, CELL, KEY_VALUE_SET, etc.\) |
63+
| ↳ `Id` | string | Unique identifier for the block |
64+
| ↳ `Text` | string | The text content \(for LINE and WORD blocks\) |
65+
| ↳ `TextType` | string | Type of text \(PRINTED or HANDWRITING\) |
66+
| ↳ `Confidence` | number | Confidence score \(0-100\) |
67+
| ↳ `Page` | number | Page number |
68+
| ↳ `Geometry` | object | Location and bounding box information |
69+
| ↳ `BoundingBox` | object | Height as ratio of document height |
70+
| ↳ `Height` | number | Height as ratio of document height |
71+
| ↳ `Left` | number | Left position as ratio of document width |
72+
| ↳ `Top` | number | Top position as ratio of document height |
73+
| ↳ `Width` | number | Width as ratio of document width |
74+
| ↳ `Polygon` | array | Polygon coordinates |
75+
| ↳ `X` | number | X coordinate |
76+
| ↳ `Y` | number | Y coordinate |
77+
| ↳ `Relationships` | array | Relationships to other blocks |
78+
| ↳ `Type` | string | Relationship type \(CHILD, VALUE, ANSWER, etc.\) |
79+
| ↳ `Ids` | array | IDs of related blocks |
80+
| ↳ `EntityTypes` | array | Entity types for KEY_VALUE_SET \(KEY or VALUE\) |
81+
| ↳ `SelectionStatus` | string | For checkboxes: SELECTED or NOT_SELECTED |
82+
| ↳ `RowIndex` | number | Row index for table cells |
83+
| ↳ `ColumnIndex` | number | Column index for table cells |
84+
| ↳ `RowSpan` | number | Row span for merged cells |
85+
| ↳ `ColumnSpan` | number | Column span for merged cells |
86+
| ↳ `Query` | object | Query information for QUERY blocks |
87+
| ↳ `Text` | string | Query text |
88+
| ↳ `Alias` | string | Query alias |
89+
| ↳ `Pages` | array | Pages to search |
90+
| `documentMetadata` | object | Metadata about the analyzed document |
91+
| ↳ `pages` | number | Number of pages in the document |
92+
| `modelVersion` | string | Version of the Textract model used for processing |
6093

6194

‎apps/docs/content/docs/en/tools/vision.mdx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@ Integrate Vision into the workflow. Can analyze images with vision models.
4747

4848
#### Output
4949

50-
This tool does not produce any outputs.
50+
| Parameter | Type | Description |
51+
| --------- | ---- | ----------- |
52+
| `content` | string | The analyzed content and description of the image |
53+
| `model` | string | The vision model that was used for analysis |
54+
| `tokens` | number | Total tokens used for the analysis |
55+
| `usage` | object | Detailed token usage breakdown |
56+
| ↳ `input_tokens` | number | Tokens used for input processing |
57+
| ↳ `output_tokens` | number | Tokens used for response generation |
58+
| ↳ `total_tokens` | number | Total tokens consumed |
5159

5260

0 commit comments

Comments
 (0)