@mastra/core 1.6.0 → 1.7.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (452) hide show
  1. package/CHANGELOG.md +117 -0
  2. package/dist/agent/agent.d.ts +6 -0
  3. package/dist/agent/agent.d.ts.map +1 -1
  4. package/dist/agent/index.cjs +8 -8
  5. package/dist/agent/index.js +1 -1
  6. package/dist/{chunk-IHDE4CJV.js → chunk-6NRSTTAS.js} +80 -11
  7. package/dist/chunk-6NRSTTAS.js.map +1 -0
  8. package/dist/{chunk-4WG5K4CK.js → chunk-6RTFK6XW.js} +7 -7
  9. package/dist/{chunk-4WG5K4CK.js.map → chunk-6RTFK6XW.js.map} +1 -1
  10. package/dist/{chunk-AYHSPIT6.cjs → chunk-7UAJ6LMR.cjs} +820 -259
  11. package/dist/chunk-7UAJ6LMR.cjs.map +1 -0
  12. package/dist/{chunk-EEU5NHHU.js → chunk-DFCRXDVK.js} +3 -3
  13. package/dist/{chunk-EEU5NHHU.js.map → chunk-DFCRXDVK.js.map} +1 -1
  14. package/dist/{chunk-5K45E5VE.js → chunk-GPJGPARM.js} +3 -2
  15. package/dist/chunk-GPJGPARM.js.map +1 -0
  16. package/dist/{chunk-VJWRJWSC.cjs → chunk-HYU6AULN.cjs} +85 -15
  17. package/dist/chunk-HYU6AULN.cjs.map +1 -0
  18. package/dist/{chunk-DGS2KGDI.js → chunk-HZ33YLNC.js} +6 -5
  19. package/dist/chunk-HZ33YLNC.js.map +1 -0
  20. package/dist/{chunk-3U3XFMGJ.cjs → chunk-N435UBEN.cjs} +13 -8
  21. package/dist/chunk-N435UBEN.cjs.map +1 -0
  22. package/dist/{chunk-5VQPSWPG.cjs → chunk-NAUBU4SI.cjs} +48 -48
  23. package/dist/{chunk-5VQPSWPG.cjs.map → chunk-NAUBU4SI.cjs.map} +1 -1
  24. package/dist/{chunk-MWGGSA5Q.js → chunk-NHYSIYTD.js} +10 -5
  25. package/dist/chunk-NHYSIYTD.js.map +1 -0
  26. package/dist/{chunk-RZNHRIM7.cjs → chunk-OL4P6TXG.cjs} +5 -5
  27. package/dist/{chunk-RZNHRIM7.cjs.map → chunk-OL4P6TXG.cjs.map} +1 -1
  28. package/dist/{chunk-XWZAKKFT.cjs → chunk-S3JIVN4S.cjs} +14 -14
  29. package/dist/{chunk-XWZAKKFT.cjs.map → chunk-S3JIVN4S.cjs.map} +1 -1
  30. package/dist/{chunk-TVPANHLE.cjs → chunk-SBOHDNIZ.cjs} +3 -2
  31. package/dist/chunk-SBOHDNIZ.cjs.map +1 -0
  32. package/dist/{chunk-LNKS4TJ6.cjs → chunk-T4KRCLC3.cjs} +8 -7
  33. package/dist/chunk-T4KRCLC3.cjs.map +1 -0
  34. package/dist/{chunk-RHKNKJNM.js → chunk-WBVBORCZ.js} +4 -4
  35. package/dist/{chunk-RHKNKJNM.js.map → chunk-WBVBORCZ.js.map} +1 -1
  36. package/dist/{chunk-YM6245EM.js → chunk-WR5RUKVK.js} +3 -3
  37. package/dist/{chunk-YM6245EM.js.map → chunk-WR5RUKVK.js.map} +1 -1
  38. package/dist/{chunk-TL2TTA4X.cjs → chunk-YQG7NBPR.cjs} +9 -9
  39. package/dist/{chunk-TL2TTA4X.cjs.map → chunk-YQG7NBPR.cjs.map} +1 -1
  40. package/dist/{chunk-XB3DA67Q.js → chunk-ZSBM2SVU.js} +818 -259
  41. package/dist/chunk-ZSBM2SVU.js.map +1 -0
  42. package/dist/datasets/experiment/scorer.d.ts.map +1 -1
  43. package/dist/datasets/index.cjs +17 -17
  44. package/dist/datasets/index.js +2 -2
  45. package/dist/evals/index.cjs +20 -20
  46. package/dist/evals/index.js +3 -3
  47. package/dist/evals/scoreTraces/index.cjs +7 -6
  48. package/dist/evals/scoreTraces/index.cjs.map +1 -1
  49. package/dist/evals/scoreTraces/index.js +4 -3
  50. package/dist/evals/scoreTraces/index.js.map +1 -1
  51. package/dist/evals/scoreTraces/scoreTracesWorkflow.d.ts.map +1 -1
  52. package/dist/harness/harness.d.ts +21 -1
  53. package/dist/harness/harness.d.ts.map +1 -1
  54. package/dist/harness/index.cjs +422 -5
  55. package/dist/harness/index.cjs.map +1 -1
  56. package/dist/harness/index.d.ts +2 -1
  57. package/dist/harness/index.d.ts.map +1 -1
  58. package/dist/harness/index.js +418 -3
  59. package/dist/harness/index.js.map +1 -1
  60. package/dist/harness/types.d.ts +151 -0
  61. package/dist/harness/types.d.ts.map +1 -1
  62. package/dist/index.cjs +2 -2
  63. package/dist/index.js +1 -1
  64. package/dist/loop/index.cjs +12 -12
  65. package/dist/loop/index.js +1 -1
  66. package/dist/loop/test-utils/tools.d.ts.map +1 -1
  67. package/dist/loop/workflows/agentic-loop/index.d.ts.map +1 -1
  68. package/dist/mastra/hooks.d.ts.map +1 -1
  69. package/dist/mastra/index.cjs +2 -2
  70. package/dist/mastra/index.js +1 -1
  71. package/dist/memory/index.cjs +14 -14
  72. package/dist/memory/index.js +1 -1
  73. package/dist/processor-provider/index.cjs +10 -10
  74. package/dist/processor-provider/index.js +1 -1
  75. package/dist/processors/index.cjs +45 -41
  76. package/dist/processors/index.js +1 -1
  77. package/dist/processors/processors/index.d.ts +1 -0
  78. package/dist/processors/processors/index.d.ts.map +1 -1
  79. package/dist/processors/processors/workspace-instructions.d.ts +50 -0
  80. package/dist/processors/processors/workspace-instructions.d.ts.map +1 -0
  81. package/dist/relevance/index.cjs +3 -3
  82. package/dist/relevance/index.js +1 -1
  83. package/dist/storage/constants.cjs +56 -56
  84. package/dist/storage/constants.d.ts.map +1 -1
  85. package/dist/storage/constants.js +1 -1
  86. package/dist/storage/index.cjs +160 -160
  87. package/dist/storage/index.js +2 -2
  88. package/dist/storage/types.d.ts +2 -0
  89. package/dist/storage/types.d.ts.map +1 -1
  90. package/dist/stream/aisdk/v5/compat/prepare-tools.d.ts.map +1 -1
  91. package/dist/stream/index.cjs +8 -8
  92. package/dist/stream/index.js +1 -1
  93. package/dist/tool-loop-agent/index.cjs +4 -4
  94. package/dist/tool-loop-agent/index.js +1 -1
  95. package/dist/vector/index.cjs +7 -7
  96. package/dist/vector/index.js +1 -1
  97. package/dist/workflows/evented/index.cjs +10 -10
  98. package/dist/workflows/evented/index.js +1 -1
  99. package/dist/workflows/index.cjs +25 -25
  100. package/dist/workflows/index.js +1 -1
  101. package/dist/workspace/constants/index.d.ts +2 -0
  102. package/dist/workspace/constants/index.d.ts.map +1 -1
  103. package/dist/workspace/errors.d.ts +1 -1
  104. package/dist/workspace/errors.d.ts.map +1 -1
  105. package/dist/workspace/filesystem/composite-filesystem.d.ts +4 -1
  106. package/dist/workspace/filesystem/composite-filesystem.d.ts.map +1 -1
  107. package/dist/workspace/filesystem/file-write-lock.d.ts +35 -0
  108. package/dist/workspace/filesystem/file-write-lock.d.ts.map +1 -0
  109. package/dist/workspace/filesystem/filesystem.d.ts +5 -1
  110. package/dist/workspace/filesystem/filesystem.d.ts.map +1 -1
  111. package/dist/workspace/filesystem/index.d.ts +1 -0
  112. package/dist/workspace/filesystem/index.d.ts.map +1 -1
  113. package/dist/workspace/filesystem/local-filesystem.d.ts +17 -1
  114. package/dist/workspace/filesystem/local-filesystem.d.ts.map +1 -1
  115. package/dist/workspace/index.cjs +72 -64
  116. package/dist/workspace/index.d.ts +3 -2
  117. package/dist/workspace/index.d.ts.map +1 -1
  118. package/dist/workspace/index.js +1 -1
  119. package/dist/workspace/lifecycle.d.ts +1 -9
  120. package/dist/workspace/lifecycle.d.ts.map +1 -1
  121. package/dist/workspace/sandbox/index.d.ts +2 -0
  122. package/dist/workspace/sandbox/index.d.ts.map +1 -1
  123. package/dist/workspace/sandbox/local-process-manager.d.ts +18 -0
  124. package/dist/workspace/sandbox/local-process-manager.d.ts.map +1 -0
  125. package/dist/workspace/sandbox/local-sandbox.d.ts +49 -35
  126. package/dist/workspace/sandbox/local-sandbox.d.ts.map +1 -1
  127. package/dist/workspace/sandbox/mastra-sandbox.d.ts +45 -11
  128. package/dist/workspace/sandbox/mastra-sandbox.d.ts.map +1 -1
  129. package/dist/workspace/sandbox/native-sandbox/bubblewrap.d.ts +2 -3
  130. package/dist/workspace/sandbox/native-sandbox/bubblewrap.d.ts.map +1 -1
  131. package/dist/workspace/sandbox/native-sandbox/seatbelt.d.ts +2 -3
  132. package/dist/workspace/sandbox/native-sandbox/seatbelt.d.ts.map +1 -1
  133. package/dist/workspace/sandbox/native-sandbox/wrapper.d.ts +4 -5
  134. package/dist/workspace/sandbox/native-sandbox/wrapper.d.ts.map +1 -1
  135. package/dist/workspace/sandbox/process-manager/index.d.ts +4 -0
  136. package/dist/workspace/sandbox/process-manager/index.d.ts.map +1 -0
  137. package/dist/workspace/sandbox/process-manager/process-handle.d.ts +107 -0
  138. package/dist/workspace/sandbox/process-manager/process-handle.d.ts.map +1 -0
  139. package/dist/workspace/sandbox/process-manager/process-manager.d.ts +59 -0
  140. package/dist/workspace/sandbox/process-manager/process-manager.d.ts.map +1 -0
  141. package/dist/workspace/sandbox/process-manager/types.d.ts +24 -0
  142. package/dist/workspace/sandbox/process-manager/types.d.ts.map +1 -0
  143. package/dist/workspace/sandbox/sandbox.d.ts +38 -2
  144. package/dist/workspace/sandbox/sandbox.d.ts.map +1 -1
  145. package/dist/workspace/sandbox/types.d.ts +9 -2
  146. package/dist/workspace/sandbox/types.d.ts.map +1 -1
  147. package/dist/workspace/sandbox/utils.d.ts +7 -0
  148. package/dist/workspace/sandbox/utils.d.ts.map +1 -0
  149. package/dist/workspace/tools/execute-command.d.ts +53 -2
  150. package/dist/workspace/tools/execute-command.d.ts.map +1 -1
  151. package/dist/workspace/tools/get-process-output.d.ts +6 -0
  152. package/dist/workspace/tools/get-process-output.d.ts.map +1 -0
  153. package/dist/workspace/tools/index.d.ts +4 -1
  154. package/dist/workspace/tools/index.d.ts.map +1 -1
  155. package/dist/workspace/tools/kill-process.d.ts +4 -0
  156. package/dist/workspace/tools/kill-process.d.ts.map +1 -0
  157. package/dist/workspace/tools/output-helpers.d.ts +21 -0
  158. package/dist/workspace/tools/output-helpers.d.ts.map +1 -0
  159. package/dist/workspace/tools/tools.d.ts.map +1 -1
  160. package/dist/workspace/types.d.ts +31 -0
  161. package/dist/workspace/types.d.ts.map +1 -1
  162. package/dist/workspace/utils.d.ts +11 -0
  163. package/dist/workspace/utils.d.ts.map +1 -0
  164. package/dist/workspace/workspace.d.ts +36 -0
  165. package/dist/workspace/workspace.d.ts.map +1 -1
  166. package/package.json +2 -2
  167. package/dist/chunk-3U3XFMGJ.cjs.map +0 -1
  168. package/dist/chunk-5K45E5VE.js.map +0 -1
  169. package/dist/chunk-AYHSPIT6.cjs.map +0 -1
  170. package/dist/chunk-DGS2KGDI.js.map +0 -1
  171. package/dist/chunk-IHDE4CJV.js.map +0 -1
  172. package/dist/chunk-LNKS4TJ6.cjs.map +0 -1
  173. package/dist/chunk-MWGGSA5Q.js.map +0 -1
  174. package/dist/chunk-TVPANHLE.cjs.map +0 -1
  175. package/dist/chunk-VJWRJWSC.cjs.map +0 -1
  176. package/dist/chunk-XB3DA67Q.js.map +0 -1
  177. package/dist/docs/SKILL.md +0 -301
  178. package/dist/docs/assets/SOURCE_MAP.json +0 -1413
  179. package/dist/docs/references/docs-agents-adding-voice.md +0 -353
  180. package/dist/docs/references/docs-agents-agent-approval.md +0 -377
  181. package/dist/docs/references/docs-agents-agent-memory.md +0 -212
  182. package/dist/docs/references/docs-agents-guardrails.md +0 -382
  183. package/dist/docs/references/docs-agents-network-approval.md +0 -275
  184. package/dist/docs/references/docs-agents-networks.md +0 -290
  185. package/dist/docs/references/docs-agents-overview.md +0 -309
  186. package/dist/docs/references/docs-agents-processors.md +0 -632
  187. package/dist/docs/references/docs-agents-structured-output.md +0 -271
  188. package/dist/docs/references/docs-agents-using-tools.md +0 -214
  189. package/dist/docs/references/docs-evals-custom-scorers.md +0 -519
  190. package/dist/docs/references/docs-evals-overview.md +0 -146
  191. package/dist/docs/references/docs-evals-running-in-ci.md +0 -106
  192. package/dist/docs/references/docs-mcp-overview.md +0 -370
  193. package/dist/docs/references/docs-mcp-publishing-mcp-server.md +0 -95
  194. package/dist/docs/references/docs-memory-memory-processors.md +0 -316
  195. package/dist/docs/references/docs-memory-observational-memory.md +0 -246
  196. package/dist/docs/references/docs-memory-overview.md +0 -45
  197. package/dist/docs/references/docs-memory-semantic-recall.md +0 -272
  198. package/dist/docs/references/docs-memory-storage.md +0 -261
  199. package/dist/docs/references/docs-memory-working-memory.md +0 -400
  200. package/dist/docs/references/docs-observability-datasets-overview.md +0 -188
  201. package/dist/docs/references/docs-observability-datasets-running-experiments.md +0 -266
  202. package/dist/docs/references/docs-observability-logging.md +0 -99
  203. package/dist/docs/references/docs-observability-overview.md +0 -70
  204. package/dist/docs/references/docs-observability-tracing-bridges-otel.md +0 -209
  205. package/dist/docs/references/docs-observability-tracing-exporters-arize.md +0 -274
  206. package/dist/docs/references/docs-observability-tracing-exporters-braintrust.md +0 -111
  207. package/dist/docs/references/docs-observability-tracing-exporters-cloud.md +0 -129
  208. package/dist/docs/references/docs-observability-tracing-exporters-datadog.md +0 -187
  209. package/dist/docs/references/docs-observability-tracing-exporters-default.md +0 -211
  210. package/dist/docs/references/docs-observability-tracing-exporters-laminar.md +0 -100
  211. package/dist/docs/references/docs-observability-tracing-exporters-langfuse.md +0 -217
  212. package/dist/docs/references/docs-observability-tracing-exporters-langsmith.md +0 -202
  213. package/dist/docs/references/docs-observability-tracing-exporters-otel.md +0 -479
  214. package/dist/docs/references/docs-observability-tracing-exporters-posthog.md +0 -148
  215. package/dist/docs/references/docs-observability-tracing-overview.md +0 -1114
  216. package/dist/docs/references/docs-rag-chunking-and-embedding.md +0 -183
  217. package/dist/docs/references/docs-rag-graph-rag.md +0 -215
  218. package/dist/docs/references/docs-rag-overview.md +0 -72
  219. package/dist/docs/references/docs-rag-retrieval.md +0 -521
  220. package/dist/docs/references/docs-rag-vector-databases.md +0 -648
  221. package/dist/docs/references/docs-server-auth-auth0.md +0 -222
  222. package/dist/docs/references/docs-server-auth-clerk.md +0 -132
  223. package/dist/docs/references/docs-server-auth-composite-auth.md +0 -234
  224. package/dist/docs/references/docs-server-auth-custom-auth-provider.md +0 -513
  225. package/dist/docs/references/docs-server-auth-firebase.md +0 -272
  226. package/dist/docs/references/docs-server-auth-jwt.md +0 -110
  227. package/dist/docs/references/docs-server-auth-simple-auth.md +0 -178
  228. package/dist/docs/references/docs-server-auth-supabase.md +0 -117
  229. package/dist/docs/references/docs-server-auth-workos.md +0 -190
  230. package/dist/docs/references/docs-server-custom-adapters.md +0 -374
  231. package/dist/docs/references/docs-server-custom-api-routes.md +0 -267
  232. package/dist/docs/references/docs-server-mastra-client.md +0 -243
  233. package/dist/docs/references/docs-server-mastra-server.md +0 -71
  234. package/dist/docs/references/docs-server-middleware.md +0 -228
  235. package/dist/docs/references/docs-server-request-context.md +0 -478
  236. package/dist/docs/references/docs-streaming-events.md +0 -247
  237. package/dist/docs/references/docs-streaming-tool-streaming.md +0 -178
  238. package/dist/docs/references/docs-streaming-workflow-streaming.md +0 -109
  239. package/dist/docs/references/docs-voice-overview.md +0 -979
  240. package/dist/docs/references/docs-voice-speech-to-speech.md +0 -103
  241. package/dist/docs/references/docs-voice-speech-to-text.md +0 -80
  242. package/dist/docs/references/docs-voice-text-to-speech.md +0 -84
  243. package/dist/docs/references/docs-workflows-agents-and-tools.md +0 -170
  244. package/dist/docs/references/docs-workflows-control-flow.md +0 -823
  245. package/dist/docs/references/docs-workflows-error-handling.md +0 -360
  246. package/dist/docs/references/docs-workflows-human-in-the-loop.md +0 -213
  247. package/dist/docs/references/docs-workflows-overview.md +0 -372
  248. package/dist/docs/references/docs-workflows-snapshots.md +0 -238
  249. package/dist/docs/references/docs-workflows-suspend-and-resume.md +0 -205
  250. package/dist/docs/references/docs-workflows-time-travel.md +0 -309
  251. package/dist/docs/references/docs-workflows-workflow-state.md +0 -181
  252. package/dist/docs/references/docs-workspace-filesystem.md +0 -162
  253. package/dist/docs/references/docs-workspace-overview.md +0 -239
  254. package/dist/docs/references/docs-workspace-sandbox.md +0 -63
  255. package/dist/docs/references/docs-workspace-search.md +0 -219
  256. package/dist/docs/references/docs-workspace-skills.md +0 -126
  257. package/dist/docs/references/guides-agent-frameworks-ai-sdk.md +0 -140
  258. package/dist/docs/references/reference-agents-agent.md +0 -142
  259. package/dist/docs/references/reference-agents-generate.md +0 -174
  260. package/dist/docs/references/reference-agents-generateLegacy.md +0 -176
  261. package/dist/docs/references/reference-agents-getDefaultGenerateOptions.md +0 -36
  262. package/dist/docs/references/reference-agents-getDefaultOptions.md +0 -34
  263. package/dist/docs/references/reference-agents-getDefaultStreamOptions.md +0 -36
  264. package/dist/docs/references/reference-agents-getDescription.md +0 -21
  265. package/dist/docs/references/reference-agents-getInstructions.md +0 -34
  266. package/dist/docs/references/reference-agents-getLLM.md +0 -37
  267. package/dist/docs/references/reference-agents-getMemory.md +0 -34
  268. package/dist/docs/references/reference-agents-getModel.md +0 -34
  269. package/dist/docs/references/reference-agents-getTools.md +0 -29
  270. package/dist/docs/references/reference-agents-getVoice.md +0 -34
  271. package/dist/docs/references/reference-agents-listAgents.md +0 -35
  272. package/dist/docs/references/reference-agents-listScorers.md +0 -34
  273. package/dist/docs/references/reference-agents-listTools.md +0 -34
  274. package/dist/docs/references/reference-agents-listWorkflows.md +0 -34
  275. package/dist/docs/references/reference-agents-network.md +0 -134
  276. package/dist/docs/references/reference-ai-sdk-chat-route.md +0 -82
  277. package/dist/docs/references/reference-ai-sdk-network-route.md +0 -74
  278. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-stream.md +0 -232
  279. package/dist/docs/references/reference-ai-sdk-with-mastra.md +0 -59
  280. package/dist/docs/references/reference-ai-sdk-workflow-route.md +0 -79
  281. package/dist/docs/references/reference-auth-auth0.md +0 -73
  282. package/dist/docs/references/reference-auth-clerk.md +0 -36
  283. package/dist/docs/references/reference-auth-firebase.md +0 -80
  284. package/dist/docs/references/reference-auth-jwt.md +0 -26
  285. package/dist/docs/references/reference-auth-supabase.md +0 -33
  286. package/dist/docs/references/reference-auth-workos.md +0 -84
  287. package/dist/docs/references/reference-client-js-agents.md +0 -438
  288. package/dist/docs/references/reference-configuration.md +0 -749
  289. package/dist/docs/references/reference-core-addGateway.md +0 -42
  290. package/dist/docs/references/reference-core-getAgent.md +0 -21
  291. package/dist/docs/references/reference-core-getAgentById.md +0 -21
  292. package/dist/docs/references/reference-core-getDeployer.md +0 -22
  293. package/dist/docs/references/reference-core-getGateway.md +0 -38
  294. package/dist/docs/references/reference-core-getGatewayById.md +0 -41
  295. package/dist/docs/references/reference-core-getLogger.md +0 -22
  296. package/dist/docs/references/reference-core-getMCPServer.md +0 -45
  297. package/dist/docs/references/reference-core-getMCPServerById.md +0 -53
  298. package/dist/docs/references/reference-core-getMemory.md +0 -50
  299. package/dist/docs/references/reference-core-getScorer.md +0 -54
  300. package/dist/docs/references/reference-core-getScorerById.md +0 -54
  301. package/dist/docs/references/reference-core-getServer.md +0 -22
  302. package/dist/docs/references/reference-core-getStorage.md +0 -22
  303. package/dist/docs/references/reference-core-getStoredAgentById.md +0 -89
  304. package/dist/docs/references/reference-core-getTelemetry.md +0 -22
  305. package/dist/docs/references/reference-core-getVector.md +0 -22
  306. package/dist/docs/references/reference-core-getWorkflow.md +0 -40
  307. package/dist/docs/references/reference-core-listAgents.md +0 -21
  308. package/dist/docs/references/reference-core-listGateways.md +0 -40
  309. package/dist/docs/references/reference-core-listLogs.md +0 -38
  310. package/dist/docs/references/reference-core-listLogsByRunId.md +0 -36
  311. package/dist/docs/references/reference-core-listMCPServers.md +0 -51
  312. package/dist/docs/references/reference-core-listMemory.md +0 -56
  313. package/dist/docs/references/reference-core-listScorers.md +0 -29
  314. package/dist/docs/references/reference-core-listStoredAgents.md +0 -93
  315. package/dist/docs/references/reference-core-listVectors.md +0 -22
  316. package/dist/docs/references/reference-core-listWorkflows.md +0 -21
  317. package/dist/docs/references/reference-core-mastra-class.md +0 -66
  318. package/dist/docs/references/reference-core-mastra-model-gateway.md +0 -153
  319. package/dist/docs/references/reference-core-setLogger.md +0 -26
  320. package/dist/docs/references/reference-core-setStorage.md +0 -27
  321. package/dist/docs/references/reference-datasets-addItem.md +0 -35
  322. package/dist/docs/references/reference-datasets-addItems.md +0 -33
  323. package/dist/docs/references/reference-datasets-compareExperiments.md +0 -48
  324. package/dist/docs/references/reference-datasets-create.md +0 -49
  325. package/dist/docs/references/reference-datasets-dataset.md +0 -78
  326. package/dist/docs/references/reference-datasets-datasets-manager.md +0 -84
  327. package/dist/docs/references/reference-datasets-delete.md +0 -23
  328. package/dist/docs/references/reference-datasets-deleteExperiment.md +0 -25
  329. package/dist/docs/references/reference-datasets-deleteItem.md +0 -25
  330. package/dist/docs/references/reference-datasets-deleteItems.md +0 -27
  331. package/dist/docs/references/reference-datasets-get.md +0 -29
  332. package/dist/docs/references/reference-datasets-getDetails.md +0 -45
  333. package/dist/docs/references/reference-datasets-getExperiment.md +0 -28
  334. package/dist/docs/references/reference-datasets-getItem.md +0 -31
  335. package/dist/docs/references/reference-datasets-getItemHistory.md +0 -29
  336. package/dist/docs/references/reference-datasets-list.md +0 -29
  337. package/dist/docs/references/reference-datasets-listExperimentResults.md +0 -37
  338. package/dist/docs/references/reference-datasets-listExperiments.md +0 -31
  339. package/dist/docs/references/reference-datasets-listItems.md +0 -44
  340. package/dist/docs/references/reference-datasets-listVersions.md +0 -31
  341. package/dist/docs/references/reference-datasets-startExperiment.md +0 -60
  342. package/dist/docs/references/reference-datasets-startExperimentAsync.md +0 -41
  343. package/dist/docs/references/reference-datasets-update.md +0 -46
  344. package/dist/docs/references/reference-datasets-updateItem.md +0 -36
  345. package/dist/docs/references/reference-evals-answer-relevancy.md +0 -105
  346. package/dist/docs/references/reference-evals-answer-similarity.md +0 -99
  347. package/dist/docs/references/reference-evals-bias.md +0 -120
  348. package/dist/docs/references/reference-evals-completeness.md +0 -137
  349. package/dist/docs/references/reference-evals-content-similarity.md +0 -101
  350. package/dist/docs/references/reference-evals-context-precision.md +0 -196
  351. package/dist/docs/references/reference-evals-create-scorer.md +0 -270
  352. package/dist/docs/references/reference-evals-faithfulness.md +0 -114
  353. package/dist/docs/references/reference-evals-hallucination.md +0 -220
  354. package/dist/docs/references/reference-evals-keyword-coverage.md +0 -128
  355. package/dist/docs/references/reference-evals-mastra-scorer.md +0 -123
  356. package/dist/docs/references/reference-evals-run-evals.md +0 -138
  357. package/dist/docs/references/reference-evals-scorer-utils.md +0 -330
  358. package/dist/docs/references/reference-evals-textual-difference.md +0 -113
  359. package/dist/docs/references/reference-evals-tone-consistency.md +0 -119
  360. package/dist/docs/references/reference-evals-toxicity.md +0 -123
  361. package/dist/docs/references/reference-harness-harness-class.md +0 -645
  362. package/dist/docs/references/reference-logging-pino-logger.md +0 -117
  363. package/dist/docs/references/reference-memory-deleteMessages.md +0 -40
  364. package/dist/docs/references/reference-memory-memory-class.md +0 -147
  365. package/dist/docs/references/reference-memory-observational-memory.md +0 -565
  366. package/dist/docs/references/reference-observability-tracing-bridges-otel.md +0 -131
  367. package/dist/docs/references/reference-observability-tracing-configuration.md +0 -178
  368. package/dist/docs/references/reference-observability-tracing-exporters-console-exporter.md +0 -138
  369. package/dist/docs/references/reference-observability-tracing-exporters-datadog.md +0 -116
  370. package/dist/docs/references/reference-observability-tracing-instances.md +0 -109
  371. package/dist/docs/references/reference-observability-tracing-interfaces.md +0 -749
  372. package/dist/docs/references/reference-observability-tracing-processors-sensitive-data-filter.md +0 -144
  373. package/dist/docs/references/reference-observability-tracing-spans.md +0 -224
  374. package/dist/docs/references/reference-processors-batch-parts-processor.md +0 -61
  375. package/dist/docs/references/reference-processors-language-detector.md +0 -81
  376. package/dist/docs/references/reference-processors-message-history-processor.md +0 -85
  377. package/dist/docs/references/reference-processors-moderation-processor.md +0 -104
  378. package/dist/docs/references/reference-processors-pii-detector.md +0 -107
  379. package/dist/docs/references/reference-processors-processor-interface.md +0 -525
  380. package/dist/docs/references/reference-processors-prompt-injection-detector.md +0 -71
  381. package/dist/docs/references/reference-processors-semantic-recall-processor.md +0 -123
  382. package/dist/docs/references/reference-processors-system-prompt-scrubber.md +0 -80
  383. package/dist/docs/references/reference-processors-token-limiter-processor.md +0 -113
  384. package/dist/docs/references/reference-processors-tool-call-filter.md +0 -85
  385. package/dist/docs/references/reference-processors-tool-search-processor.md +0 -113
  386. package/dist/docs/references/reference-processors-unicode-normalizer.md +0 -62
  387. package/dist/docs/references/reference-processors-working-memory-processor.md +0 -154
  388. package/dist/docs/references/reference-rag-database-config.md +0 -264
  389. package/dist/docs/references/reference-rag-embeddings.md +0 -92
  390. package/dist/docs/references/reference-server-mastra-server.md +0 -298
  391. package/dist/docs/references/reference-server-register-api-route.md +0 -249
  392. package/dist/docs/references/reference-storage-cloudflare-d1.md +0 -218
  393. package/dist/docs/references/reference-storage-composite.md +0 -235
  394. package/dist/docs/references/reference-storage-lance.md +0 -131
  395. package/dist/docs/references/reference-storage-libsql.md +0 -135
  396. package/dist/docs/references/reference-storage-mongodb.md +0 -262
  397. package/dist/docs/references/reference-storage-mssql.md +0 -155
  398. package/dist/docs/references/reference-storage-overview.md +0 -121
  399. package/dist/docs/references/reference-storage-postgresql.md +0 -529
  400. package/dist/docs/references/reference-storage-upstash.md +0 -160
  401. package/dist/docs/references/reference-streaming-ChunkType.md +0 -292
  402. package/dist/docs/references/reference-streaming-agents-MastraModelOutput.md +0 -182
  403. package/dist/docs/references/reference-streaming-agents-streamLegacy.md +0 -142
  404. package/dist/docs/references/reference-streaming-workflows-observeStream.md +0 -42
  405. package/dist/docs/references/reference-streaming-workflows-resumeStream.md +0 -61
  406. package/dist/docs/references/reference-streaming-workflows-stream.md +0 -88
  407. package/dist/docs/references/reference-streaming-workflows-timeTravelStream.md +0 -142
  408. package/dist/docs/references/reference-templates-overview.md +0 -194
  409. package/dist/docs/references/reference-tools-create-tool.md +0 -237
  410. package/dist/docs/references/reference-tools-graph-rag-tool.md +0 -185
  411. package/dist/docs/references/reference-tools-mcp-client.md +0 -962
  412. package/dist/docs/references/reference-tools-mcp-server.md +0 -1275
  413. package/dist/docs/references/reference-tools-vector-query-tool.md +0 -459
  414. package/dist/docs/references/reference-vectors-libsql.md +0 -305
  415. package/dist/docs/references/reference-vectors-mongodb.md +0 -295
  416. package/dist/docs/references/reference-vectors-pg.md +0 -408
  417. package/dist/docs/references/reference-vectors-upstash.md +0 -294
  418. package/dist/docs/references/reference-voice-composite-voice.md +0 -121
  419. package/dist/docs/references/reference-voice-mastra-voice.md +0 -313
  420. package/dist/docs/references/reference-voice-voice.addInstructions.md +0 -56
  421. package/dist/docs/references/reference-voice-voice.addTools.md +0 -67
  422. package/dist/docs/references/reference-voice-voice.connect.md +0 -94
  423. package/dist/docs/references/reference-voice-voice.events.md +0 -37
  424. package/dist/docs/references/reference-voice-voice.listen.md +0 -164
  425. package/dist/docs/references/reference-voice-voice.on.md +0 -111
  426. package/dist/docs/references/reference-voice-voice.speak.md +0 -157
  427. package/dist/docs/references/reference-workflows-run-methods-cancel.md +0 -86
  428. package/dist/docs/references/reference-workflows-run-methods-restart.md +0 -33
  429. package/dist/docs/references/reference-workflows-run-methods-resume.md +0 -59
  430. package/dist/docs/references/reference-workflows-run-methods-start.md +0 -58
  431. package/dist/docs/references/reference-workflows-run-methods-startAsync.md +0 -67
  432. package/dist/docs/references/reference-workflows-run-methods-timeTravel.md +0 -142
  433. package/dist/docs/references/reference-workflows-run.md +0 -59
  434. package/dist/docs/references/reference-workflows-step.md +0 -119
  435. package/dist/docs/references/reference-workflows-workflow-methods-branch.md +0 -25
  436. package/dist/docs/references/reference-workflows-workflow-methods-commit.md +0 -17
  437. package/dist/docs/references/reference-workflows-workflow-methods-create-run.md +0 -63
  438. package/dist/docs/references/reference-workflows-workflow-methods-dountil.md +0 -25
  439. package/dist/docs/references/reference-workflows-workflow-methods-dowhile.md +0 -25
  440. package/dist/docs/references/reference-workflows-workflow-methods-foreach.md +0 -118
  441. package/dist/docs/references/reference-workflows-workflow-methods-map.md +0 -93
  442. package/dist/docs/references/reference-workflows-workflow-methods-parallel.md +0 -21
  443. package/dist/docs/references/reference-workflows-workflow-methods-sleep.md +0 -35
  444. package/dist/docs/references/reference-workflows-workflow-methods-sleepUntil.md +0 -35
  445. package/dist/docs/references/reference-workflows-workflow-methods-then.md +0 -21
  446. package/dist/docs/references/reference-workflows-workflow.md +0 -157
  447. package/dist/docs/references/reference-workspace-filesystem.md +0 -202
  448. package/dist/docs/references/reference-workspace-local-filesystem.md +0 -327
  449. package/dist/docs/references/reference-workspace-local-sandbox.md +0 -285
  450. package/dist/docs/references/reference-workspace-sandbox.md +0 -81
  451. package/dist/docs/references/reference-workspace-workspace-class.md +0 -226
  452. package/dist/docs/references/reference.md +0 -276
@@ -1,823 +0,0 @@
1
- # Control Flow
2
-
3
- Workflows run a sequence of predefined tasks, and you can control how that flow is executed. Tasks are divided into **steps**, which can be executed in different ways depending on your requirements. They can run sequentially, in parallel, or follow different paths based on conditions.
4
-
5
- Each step connects to the next in the workflow through defined schemas that keep data controlled and consistent.
6
-
7
- ## Core principles
8
-
9
- - The first step’s `inputSchema` must match the workflow’s `inputSchema`.
10
- - The final step’s `outputSchema` must match the workflow’s `outputSchema`.
11
- - Each step’s `outputSchema` must match the next step’s `inputSchema`.
12
- - If it doesn’t, use [Input data mapping](#input-data-mapping) to transform the data into the required shape.
13
-
14
- ## Chaining steps with `.then()`
15
-
16
- Use `.then()` to run steps in order, allowing each step to access the result of the step before it.
17
-
18
- ![Chaining steps with .then()](/assets/images/workflows-control-flow-then-bde5e0fbefe5c64c19a8c3471c0e8439.jpg)
19
-
20
- ```typescript
21
- const step1 = createStep({
22
- inputSchema: z.object({
23
- message: z.string()
24
- }),
25
- outputSchema: z.object({
26
- formatted: z.string()
27
- })
28
- });
29
-
30
- const step2 = createStep({
31
- inputSchema: z.object({
32
- formatted: z.string()
33
- }),
34
- outputSchema: z.object({
35
- emphasized: z.string()
36
- })
37
- });
38
-
39
- export const testWorkflow = createWorkflow({
40
- inputSchema: z.object({
41
- message: z.string()
42
- }),
43
- outputSchema: z.object({
44
- emphasized: z.string()
45
- })
46
- })
47
- .then(step1)
48
- .then(step2)
49
- .commit();
50
- ```
51
-
52
- ## Simultaneous steps with `.parallel()`
53
-
54
- Use `.parallel()` to run steps at the same time. All parallel steps must complete before the workflow continues to the next step. Each step's `id` is used when defining a following step's `inputSchema` and becomes the key on the `inputData` object used to access the previous step's values. The outputs of parallel steps can then be referenced or combined by a following step.
55
-
56
- ![Concurrent steps with .parallel()](/assets/images/workflows-control-flow-parallel-8e7fe60f1c4daa510431b37c973f6f8d.jpg)
57
-
58
- ```typescript
59
- const step1 = createStep({
60
- id: "step-1",
61
- });
62
-
63
- const step2 = createStep({
64
- id: "step-2",
65
- });
66
-
67
- const step3 = createStep({
68
- id: "step-3",
69
- inputSchema: z.object({
70
- "step-1": z.object({
71
- formatted: z.string()
72
- }),
73
- "step-2": z.object({
74
- emphasized: z.string()
75
- })
76
- }),
77
- outputSchema: z.object({
78
- combined: z.string()
79
- }),
80
- execute: async ({ inputData }) => {
81
- const { formatted } = inputData["step-1"];
82
- const { emphasized } = inputData["step-2"];
83
- return {
84
- combined: `${formatted} | ${emphasized}`
85
- };
86
- }
87
- });
88
-
89
- export const testWorkflow = createWorkflow({
90
- inputSchema: z.object({
91
- message: z.string()
92
- }),
93
- outputSchema: z.object({
94
- combined: z.string()
95
- })
96
- })
97
- .parallel([step1, step2])
98
- .then(step3)
99
- .commit();
100
- ```
101
-
102
- > 📹 Watch: How to run steps in parallel and optimize your Mastra workflow → [YouTube (3 minutes)](https://youtu.be/GQJxve5Hki4)
103
-
104
- ### Output structure
105
-
106
- When steps run in parallel, the output is an object where each key is the step's `id` and the value is that step's output. This allows you to access each parallel step's result independently.
107
-
108
- ```typescript
109
- const step1 = createStep({
110
- id: "format-step",
111
- inputSchema: z.object({ message: z.string() }),
112
- outputSchema: z.object({ formatted: z.string() }),
113
- execute: async ({ inputData }) => ({
114
- formatted: inputData.message.toUpperCase()
115
- })
116
- });
117
-
118
- const step2 = createStep({
119
- id: "count-step",
120
- inputSchema: z.object({ message: z.string() }),
121
- outputSchema: z.object({ count: z.number() }),
122
- execute: async ({ inputData }) => ({
123
- count: inputData.message.length
124
- })
125
- });
126
-
127
- const step3 = createStep({
128
- id: "combine-step",
129
- // The inputSchema must match the structure of parallel outputs
130
- inputSchema: z.object({
131
- "format-step": z.object({ formatted: z.string() }),
132
- "count-step": z.object({ count: z.number() })
133
- }),
134
- outputSchema: z.object({ result: z.string() }),
135
- execute: async ({ inputData }) => {
136
- // Access each parallel step's output by its id
137
- const formatted = inputData["format-step"].formatted;
138
- const count = inputData["count-step"].count;
139
- return {
140
- result: `${formatted} (${count} characters)`
141
- };
142
- }
143
- });
144
-
145
- export const testWorkflow = createWorkflow({
146
- id: "parallel-output-example",
147
- inputSchema: z.object({ message: z.string() }),
148
- outputSchema: z.object({ result: z.string() })
149
- })
150
- .parallel([step1, step2])
151
- .then(step3)
152
- .commit();
153
-
154
- // When executed with { message: "hello" }
155
- // The parallel output structure will be:
156
- // {
157
- // "format-step": { formatted: "HELLO" },
158
- // "count-step": { count: 5 }
159
- // }
160
- ```
161
-
162
- **Key points:**
163
-
164
- - Each parallel step's output is keyed by its `id`
165
- - All parallel steps execute simultaneously
166
- - The next step receives an object containing all parallel step outputs
167
- - You must define the `inputSchema` of the following step to match this structure
168
-
169
- > **Info:** Visit [Choosing the right pattern](#choosing-the-right-pattern) to understand when to use `.parallel()` vs `.foreach()`.
170
-
171
- ## Conditional logic with `.branch()`
172
-
173
- Use `.branch()` to choose which step to run based on a condition. All steps in a branch need the same `inputSchema` and `outputSchema` because branching requires consistent schemas so workflows can follow different paths.
174
-
175
- ![Conditional branching with .branch()](/assets/images/workflows-control-flow-branch-1913ef107ba0198d73aa3c0a65145b7a.jpg)
176
-
177
- ```typescript
178
- const step1 = createStep({...})
179
-
180
- const stepA = createStep({
181
- inputSchema: z.object({
182
- value: z.number()
183
- }),
184
- outputSchema: z.object({
185
- result: z.string()
186
- })
187
- });
188
-
189
- const stepB = createStep({
190
- inputSchema: z.object({
191
- value: z.number()
192
- }),
193
- outputSchema: z.object({
194
- result: z.string()
195
- })
196
- });
197
-
198
- export const testWorkflow = createWorkflow({
199
- inputSchema: z.object({
200
- value: z.number()
201
- }),
202
- outputSchema: z.object({
203
- result: z.string()
204
- })
205
- })
206
- .then(step1)
207
- .branch([
208
- [async ({ inputData: { value } }) => value > 10, stepA],
209
- [async ({ inputData: { value } }) => value <= 10, stepB]
210
- ])
211
- .commit();
212
- ```
213
-
214
- ### Output structure
215
-
216
- When using conditional branching, only one branch executes based on which condition evaluates to `true` first. The output structure is similar to `.parallel()`, where the result is keyed by the executed step's `id`.
217
-
218
- ```typescript
219
- const step1 = createStep({
220
- id: "initial-step",
221
- inputSchema: z.object({ value: z.number() }),
222
- outputSchema: z.object({ value: z.number() }),
223
- execute: async ({ inputData }) => inputData
224
- });
225
-
226
- const highValueStep = createStep({
227
- id: "high-value-step",
228
- inputSchema: z.object({ value: z.number() }),
229
- outputSchema: z.object({ result: z.string() }),
230
- execute: async ({ inputData }) => ({
231
- result: `High value: ${inputData.value}`
232
- })
233
- });
234
-
235
- const lowValueStep = createStep({
236
- id: "low-value-step",
237
- inputSchema: z.object({ value: z.number() }),
238
- outputSchema: z.object({ result: z.string() }),
239
- execute: async ({ inputData }) => ({
240
- result: `Low value: ${inputData.value}`
241
- })
242
- });
243
-
244
- const finalStep = createStep({
245
- id: "final-step",
246
- // The inputSchema must account for either branch's output
247
- inputSchema: z.object({
248
- "high-value-step": z.object({ result: z.string() }).optional(),
249
- "low-value-step": z.object({ result: z.string() }).optional()
250
- }),
251
- outputSchema: z.object({ message: z.string() }),
252
- execute: async ({ inputData }) => {
253
- // Only one branch will have executed
254
- const result = inputData["high-value-step"]?.result ||
255
- inputData["low-value-step"]?.result;
256
- return { message: result };
257
- }
258
- });
259
-
260
- export const testWorkflow = createWorkflow({
261
- id: "branch-output-example",
262
- inputSchema: z.object({ value: z.number() }),
263
- outputSchema: z.object({ message: z.string() })
264
- })
265
- .then(step1)
266
- .branch([
267
- [async ({ inputData }) => inputData.value > 10, highValueStep],
268
- [async ({ inputData }) => inputData.value <= 10, lowValueStep]
269
- ])
270
- .then(finalStep)
271
- .commit();
272
-
273
- // When executed with { value: 15 }
274
- // Only the high-value-step executes, output structure:
275
- // {
276
- // "high-value-step": { result: "High value: 15" }
277
- // }
278
-
279
- // When executed with { value: 5 }
280
- // Only the low-value-step executes, output structure:
281
- // {
282
- // "low-value-step": { result: "Low value: 5" }
283
- // }
284
- ```
285
-
286
- **Key points:**
287
-
288
- - Only one branch executes based on condition evaluation order
289
- - The output is keyed by the executed step's `id`
290
- - Subsequent steps should handle all possible branch outputs
291
- - Use optional fields in the `inputSchema` when the next step needs to handle multiple possible branches
292
- - Conditions are evaluated in the order they're defined
293
-
294
- ## Input data mapping
295
-
296
- When using `.then()`, `.parallel()`, or `.branch()`, it is sometimes necessary to transform the output of a previous step to match the input of the next. In these cases you can use `.map()` to access the `inputData` and transform it to create a suitable data shape for the next step.
297
-
298
- ![Mapping with .map()](/assets/images/workflows-data-mapping-map-87fd84a06b4bbf4b93868a5db99ca179.jpg)
299
-
300
- ```typescript
301
- const step1 = createStep({...});
302
- const step2 = createStep({...});
303
-
304
- export const testWorkflow = createWorkflow({...})
305
- .then(step1)
306
- .map(async ({ inputData }) => {
307
- const { foo } = inputData;
308
- return {
309
- bar: `new ${foo}`,
310
- };
311
- })
312
- .then(step2)
313
- .commit();
314
- ```
315
-
316
- The `.map()` method provides additional helper functions for more complex mapping scenarios.
317
-
318
- **Available helper functions:**
319
-
320
- - [`getStepResult()`](https://mastra.ai/reference/workflows/workflow-methods/map): Access a specific step's full output
321
- - [`getInitData<any>()`](https://mastra.ai/reference/workflows/workflow-methods/map): Access the workflow's initial input data
322
- - [`mapVariable()`](https://mastra.ai/reference/workflows/workflow-methods/map): Use declarative object syntax to extract and rename fields
323
-
324
- ### Parallel and Branch outputs
325
-
326
- When working with `.parallel()` or `.branch()` outputs, you can use `.map()` to transform the data structure before passing it to the next step. This is especially useful when you need to flatten or restructure the output.
327
-
328
- ```typescript
329
- export const testWorkflow = createWorkflow({...})
330
- .parallel([step1, step2])
331
- .map(async ({ inputData }) => {
332
- // Transform the parallel output structure
333
- return {
334
- combined: `${inputData["step1"].value} - ${inputData["step2"].value}`
335
- };
336
- })
337
- .then(nextStep)
338
- .commit();
339
- ```
340
-
341
- You can also use the helper functions provided by `.map()`:
342
-
343
- ```typescript
344
- export const testWorkflow = createWorkflow({...})
345
- .branch([
346
- [condition1, stepA],
347
- [condition2, stepB]
348
- ])
349
- .map(async ({ inputData, getStepResult }) => {
350
- // Access specific step results
351
- const stepAResult = getStepResult("stepA");
352
- const stepBResult = getStepResult("stepB");
353
-
354
- // Return the result from whichever branch executed
355
- return stepAResult || stepBResult;
356
- })
357
- .then(nextStep)
358
- .commit();
359
- ```
360
-
361
- ## Looping steps
362
-
363
- Workflows support different looping methods that let you repeat steps until or while a condition is met, or iterate over arrays. Loops can be combined with other control methods like `.then()`.
364
-
365
- ### Looping with `.dountil()`
366
-
367
- Use `.dountil()` to run a step repeatedly until a condition becomes true.
368
-
369
- ![Repeating with .dountil()](/assets/images/workflows-control-flow-dountil-6b7b06e872f3bd878f69c716b0e38ae6.jpg)
370
-
371
- ```typescript
372
- const step1 = createStep({...});
373
-
374
- const step2 = createStep({
375
- execute: async ({ inputData }) => {
376
- const { number } = inputData;
377
- return {
378
- number: number + 1
379
- };
380
- }
381
- });
382
-
383
- export const testWorkflow = createWorkflow({})
384
- .then(step1)
385
- .dountil(step2, async ({ inputData: { number } }) => number > 10)
386
- .commit();
387
- ```
388
-
389
- ### Looping with `.dowhile()`
390
-
391
- Use `.dowhile()` to run a step repeatedly while a condition remains true.
392
-
393
- ![Repeating with .dowhile()](/assets/images/workflows-control-flow-dowhile-09bba2d43fb44352f458c144484326ed.jpg)
394
-
395
- ```typescript
396
- const step1 = createStep({...});
397
-
398
- const step2 = createStep({
399
- execute: async ({ inputData }) => {
400
- const { number } = inputData;
401
- return {
402
- number: number + 1
403
- };
404
- }
405
- });
406
-
407
- export const testWorkflow = createWorkflow({})
408
- .then(step1)
409
- .dowhile(step2, async ({ inputData: { number } }) => number < 10)
410
- .commit();
411
- ```
412
-
413
- ### Looping with `.foreach()`
414
-
415
- Use `.foreach()` to run the same step for each item in an array. The input must be of type `array` so the loop can iterate over its values, applying the step's logic to each one. See [Choosing the right pattern](#choosing-the-right-pattern) for guidance on when to use `.foreach()` vs other methods.
416
-
417
- ![Repeating with .foreach()](/assets/images/workflows-control-flow-foreach-a5b6f38d8797c4d1b7dca93879d709f7.jpg)
418
-
419
- ```typescript
420
- const step1 = createStep({
421
- inputSchema: z.string(),
422
- outputSchema: z.string(),
423
- execute: async ({ inputData }) => {
424
- return inputData.toUpperCase();
425
- }
426
- });
427
-
428
- const step2 = createStep({...});
429
-
430
- export const testWorkflow = createWorkflow({
431
- inputSchema: z.array(z.string()),
432
- outputSchema: z.array(z.string())
433
- })
434
- .foreach(step1)
435
- .then(step2)
436
- .commit();
437
- ```
438
-
439
- #### Output structure
440
-
441
- The `.foreach()` method always returns an array containing the output of each iteration. The order of outputs matches the order of inputs.
442
-
443
- ```typescript
444
- const addTenStep = createStep({
445
- id: "add-ten",
446
- inputSchema: z.object({ value: z.number() }),
447
- outputSchema: z.object({ value: z.number() }),
448
- execute: async ({ inputData }) => ({
449
- value: inputData.value + 10
450
- })
451
- });
452
-
453
- export const testWorkflow = createWorkflow({
454
- id: "foreach-output-example",
455
- inputSchema: z.array(z.object({ value: z.number() })),
456
- outputSchema: z.array(z.object({ value: z.number() }))
457
- })
458
- .foreach(addTenStep)
459
- .commit();
460
-
461
- // When executed with [{ value: 1 }, { value: 22 }, { value: 333 }]
462
- // Output: [{ value: 11 }, { value: 32 }, { value: 343 }]
463
- ```
464
-
465
- #### Concurrency limits
466
-
467
- Use `concurrency` to control the number of array items processed at the same time. The default is `1`, which runs steps sequentially. Increasing the value allows `.foreach()` to process multiple items simultaneously.
468
-
469
- ```typescript
470
- const step1 = createStep({...})
471
-
472
- export const testWorkflow = createWorkflow({...})
473
- .foreach(step1, { concurrency: 4 })
474
- .commit();
475
- ```
476
-
477
- #### Aggregating results after `.foreach()`
478
-
479
- Since `.foreach()` outputs an array, you can use `.then()` or `.map()` to aggregate or transform the results. The step following `.foreach()` receives the entire array as its input.
480
-
481
- ```typescript
482
- const processItemStep = createStep({
483
- id: "process-item",
484
- inputSchema: z.object({ value: z.number() }),
485
- outputSchema: z.object({ processed: z.number() }),
486
- execute: async ({ inputData }) => ({
487
- processed: inputData.value * 2
488
- })
489
- });
490
-
491
- const aggregateStep = createStep({
492
- id: "aggregate",
493
- // Input is an array of outputs from foreach
494
- inputSchema: z.array(z.object({ processed: z.number() })),
495
- outputSchema: z.object({ total: z.number() }),
496
- execute: async ({ inputData }) => ({
497
- // Sum all processed values
498
- total: inputData.reduce((sum, item) => sum + item.processed, 0)
499
- })
500
- });
501
-
502
- export const testWorkflow = createWorkflow({
503
- id: "foreach-aggregate-example",
504
- inputSchema: z.array(z.object({ value: z.number() })),
505
- outputSchema: z.object({ total: z.number() })
506
- })
507
- .foreach(processItemStep)
508
- .then(aggregateStep) // Receives the full array from foreach
509
- .commit();
510
-
511
- // When executed with [{ value: 1 }, { value: 2 }, { value: 3 }]
512
- // After foreach: [{ processed: 2 }, { processed: 4 }, { processed: 6 }]
513
- // After aggregate: { total: 12 }
514
- ```
515
-
516
- You can also use `.map()` to transform the array output:
517
-
518
- ```typescript
519
- export const testWorkflow = createWorkflow({...})
520
- .foreach(processItemStep)
521
- .map(async ({ inputData }) => ({
522
- // Transform the array into a different structure
523
- values: inputData.map(item => item.processed),
524
- count: inputData.length
525
- }))
526
- .then(nextStep)
527
- .commit();
528
- ```
529
-
530
- #### Chaining multiple `.foreach()` calls
531
-
532
- When you chain `.foreach()` calls, each operates on the array output of the previous step. This is useful when each item in your array needs to be transformed by multiple steps in sequence.
533
-
534
- ```typescript
535
- const chunkStep = createStep({
536
- id: "chunk",
537
- // Takes a document, returns an array of chunks
538
- inputSchema: z.object({ content: z.string() }),
539
- outputSchema: z.array(z.object({ chunk: z.string() })),
540
- execute: async ({ inputData }) => {
541
- // Split document into chunks
542
- const chunks = inputData.content.match(/.{1,100}/g) || [];
543
- return chunks.map(chunk => ({ chunk }));
544
- }
545
- });
546
-
547
- const embedStep = createStep({
548
- id: "embed",
549
- // Takes a single chunk, returns embedding
550
- inputSchema: z.object({ chunk: z.string() }),
551
- outputSchema: z.object({ embedding: z.array(z.number()) }),
552
- execute: async ({ inputData }) => ({
553
- embedding: [/* vector embedding */]
554
- })
555
- });
556
-
557
- // For a single document that produces multiple chunks:
558
- export const singleDocWorkflow = createWorkflow({
559
- id: "single-doc-rag",
560
- inputSchema: z.object({ content: z.string() }),
561
- outputSchema: z.array(z.object({ embedding: z.array(z.number()) }))
562
- })
563
- .then(chunkStep) // Returns array of chunks
564
- .foreach(embedStep) // Process each chunk -> array of embeddings
565
- .commit();
566
- ```
567
-
568
- For processing multiple documents where each produces multiple chunks, you have options:
569
-
570
- **Option 1: Process all documents in a single step with batching control**
571
-
572
- ```typescript
573
- const downloadAndChunkStep = createStep({
574
- id: "download-and-chunk",
575
- inputSchema: z.array(z.string()), // Array of URLs
576
- outputSchema: z.array(z.object({ chunk: z.string(), source: z.string() })),
577
- execute: async ({ inputData: urls }) => {
578
- // Control batching/parallelization within the step
579
- const allChunks = [];
580
- for (const url of urls) {
581
- const content = await fetch(url).then(r => r.text());
582
- const chunks = content.match(/.{1,100}/g) || [];
583
- allChunks.push(...chunks.map(chunk => ({ chunk, source: url })));
584
- }
585
- return allChunks;
586
- }
587
- });
588
-
589
- export const multiDocWorkflow = createWorkflow({...})
590
- .then(downloadAndChunkStep) // Returns flat array of all chunks
591
- .foreach(embedStep, { concurrency: 10 }) // Embed each chunk in parallel
592
- .commit();
593
- ```
594
-
595
- **Option 2: Use foreach for documents, aggregate chunks, then foreach for embeddings**
596
-
597
- ```typescript
598
- const downloadStep = createStep({
599
- id: "download",
600
- inputSchema: z.string(), // Single URL
601
- outputSchema: z.object({ content: z.string(), source: z.string() }),
602
- execute: async ({ inputData: url }) => ({
603
- content: await fetch(url).then(r => r.text()),
604
- source: url
605
- })
606
- });
607
-
608
- const chunkDocStep = createStep({
609
- id: "chunk-doc",
610
- inputSchema: z.object({ content: z.string(), source: z.string() }),
611
- outputSchema: z.array(z.object({ chunk: z.string(), source: z.string() })),
612
- execute: async ({ inputData }) => {
613
- const chunks = inputData.content.match(/.{1,100}/g) || [];
614
- return chunks.map(chunk => ({ chunk, source: inputData.source }));
615
- }
616
- });
617
-
618
- export const multiDocWorkflow = createWorkflow({
619
- id: "multi-doc-rag",
620
- inputSchema: z.array(z.string()), // Array of URLs
621
- outputSchema: z.array(z.object({ embedding: z.array(z.number()) }))
622
- })
623
- .foreach(downloadStep, { concurrency: 5 }) // Download docs in parallel
624
- .foreach(chunkDocStep) // Chunk each doc -> array of chunk arrays
625
- .map(async ({ inputData }) => {
626
- // Flatten nested arrays: [[chunks], [chunks]] -> [chunks]
627
- return inputData.flat();
628
- })
629
- .foreach(embedStep, { concurrency: 10 }) // Embed all chunks
630
- .commit();
631
- ```
632
-
633
- **Key points about chaining `.foreach()`:**
634
-
635
- - Each `.foreach()` operates on the array from the previous step
636
- - If a step inside `.foreach()` returns an array, the output becomes an array of arrays
637
- - Use `.map()` with `.flat()` to flatten nested arrays when needed
638
- - For complex RAG pipelines, Option 1 (handling batching in a single step) often provides better control
639
-
640
- #### Nested workflows inside foreach
641
-
642
- The step after `.foreach()` only executes after all iterations complete. If you need to run multiple sequential operations per item, use a nested workflow instead of chaining multiple `.foreach()` calls. This keeps all operations for each item together and makes the data flow clearer.
643
-
644
- ```typescript
645
- // Define a workflow that processes a single document
646
- const processDocumentWorkflow = createWorkflow({
647
- id: "process-document",
648
- inputSchema: z.object({ url: z.string() }),
649
- outputSchema: z.object({
650
- embeddings: z.array(z.array(z.number())),
651
- metadata: z.object({ url: z.string(), chunkCount: z.number() })
652
- })
653
- })
654
- .then(downloadStep) // Download the document
655
- .then(chunkStep) // Split into chunks
656
- .then(embedChunksStep) // Embed all chunks for this document
657
- .then(formatResultStep) // Format the final output
658
- .commit();
659
-
660
- // Use the nested workflow inside foreach
661
- export const batchProcessWorkflow = createWorkflow({
662
- id: "batch-process-documents",
663
- inputSchema: z.array(z.object({ url: z.string() })),
664
- outputSchema: z.array(z.object({
665
- embeddings: z.array(z.array(z.number())),
666
- metadata: z.object({ url: z.string(), chunkCount: z.number() })
667
- }))
668
- })
669
- .foreach(processDocumentWorkflow, { concurrency: 3 })
670
- .commit();
671
-
672
- // Each document goes through all 4 steps before the next document starts (with concurrency: 1)
673
- // With concurrency: 3, up to 3 documents process their full pipelines in parallel
674
- ```
675
-
676
- **Why use nested workflows:**
677
-
678
- - **Better parallelism**: With `concurrency: N`, multiple items run their full pipelines simultaneously. Chained `.foreach().foreach()` processes all items through step 1, waits, then all through step 2 - nested workflows let each item progress independently
679
- - All steps for one item complete together before results are collected
680
- - Cleaner than multiple `.foreach()` calls which create nested arrays
681
- - Each nested workflow execution is independent with its own data flow
682
- - Easier to test and reuse the per-item logic separately
683
-
684
- **How it works:**
685
-
686
- 1. The parent workflow passes each array item to an instance of the nested workflow
687
- 2. Each nested workflow runs its full step sequence for that item
688
- 3. With `concurrency > 1`, multiple nested workflows execute in parallel
689
- 4. The nested workflow's final output becomes one element in the result array
690
- 5. After all nested workflows complete, the next step in the parent receives the full array
691
-
692
- ## Choosing the right pattern
693
-
694
- Use this section as a reference for selecting the appropriate control flow method.
695
-
696
- ### Quick reference
697
-
698
- | Method | Purpose | Input | Output | Concurrency |
699
- | ------------------- | ---------------------------------- | ----- | --------------------- | ------------------------- |
700
- | `.then(step)` | Sequential processing | `T` | `U` | N/A (one at a time) |
701
- | `.parallel([a, b])` | Different operations on same input | `T` | `{ a: U, b: V }` | All run simultaneously |
702
- | `.foreach(step)` | Same operation on each array item | `T[]` | `U[]` | Configurable (default: 1) |
703
- | `.branch([...])` | Conditional path selection | `T` | `{ selectedStep: U }` | Only one branch runs |
704
-
705
- ### `.parallel()` vs `.foreach()`
706
-
707
- **Use `.parallel()` when you have one input that needs different processing:**
708
-
709
- ```typescript
710
- // Same user data processed differently in parallel
711
- workflow
712
- .parallel([validateStep, enrichStep, scoreStep])
713
- .then(combineResultsStep)
714
- ```
715
-
716
- **Use `.foreach()` when you have many inputs that need the same processing:**
717
-
718
- ```typescript
719
- // Multiple URLs each processed the same way
720
- workflow
721
- .foreach(downloadStep, { concurrency: 5 })
722
- .then(aggregateStep)
723
- ```
724
-
725
- ### When to use nested workflows
726
-
727
- **Inside `.foreach()`** - when each array item needs multiple sequential steps:
728
-
729
- ```typescript
730
- // Each document goes through a full pipeline
731
- const processDocWorkflow = createWorkflow({...})
732
- .then(downloadStep)
733
- .then(parseStep)
734
- .then(embedStep)
735
- .commit();
736
-
737
- workflow.foreach(processDocWorkflow, { concurrency: 3 })
738
- ```
739
-
740
- This is cleaner than chaining `.foreach().foreach()`, which creates nested arrays.
741
-
742
- **Inside `.parallel()`** - when a parallel branch needs its own multi-step pipeline:
743
-
744
- ```typescript
745
- const pipelineA = createWorkflow({...}).then(step1).then(step2).commit();
746
- const pipelineB = createWorkflow({...}).then(step3).then(step4).commit();
747
-
748
- workflow.parallel([pipelineA, pipelineB])
749
- ```
750
-
751
- ### Chaining patterns
752
-
753
- | Pattern | What happens | Common use case |
754
- | ---------------------- | --------------------------------- | ------------------------------------------------------ |
755
- | `.then().then()` | Sequential steps | Simple pipelines |
756
- | `.parallel().then()` | Run in parallel, then combine | Fan-out/fan-in |
757
- | `.foreach().then()` | Process all items, then aggregate | Map-reduce |
758
- | `.foreach().foreach()` | Creates array of arrays | Avoid - use nested workflow or `.map()` with `.flat()` |
759
- | `.foreach(workflow)` | Full pipeline per item | Multi-step processing per array item |
760
-
761
- ### Synchronization: when does the next step run?
762
-
763
- Both `.parallel()` and `.foreach()` are synchronization points. The next step in the workflow only executes after all parallel branches or all array iterations have completed.
764
-
765
- ```typescript
766
- workflow
767
- .parallel([stepA, stepB, stepC]) // All 3 run simultaneously
768
- .then(combineStep) // Waits for ALL 3 to finish before running
769
- .commit();
770
-
771
- workflow
772
- .foreach(processStep, { concurrency: 5 }) // Up to 5 items process at once
773
- .then(aggregateStep) // Waits for ALL items to finish before running
774
- .commit();
775
- ```
776
-
777
- This means:
778
-
779
- - `.parallel()` collects all branch outputs into an object, then passes it to the next step
780
- - `.foreach()` collects all iteration outputs into an array, then passes it to the next step
781
- - There is no way to "stream" results to the next step as they complete
782
-
783
- ### Concurrency behavior
784
-
785
- | Method | Behavior |
786
- | ------------------------------- | --------------------------------------------------------------- |
787
- | `.then()` | Sequential - one step at a time |
788
- | `.parallel()` | All branches run simultaneously (no limit option) |
789
- | `.foreach()` | Controlled via `{ concurrency: N }` - default is 1 (sequential) |
790
- | Nested workflow in `.foreach()` | Respects parent's concurrency setting |
791
-
792
- **Performance tip:** For I/O-bound operations in `.foreach()`, increase concurrency to process items in parallel:
793
-
794
- ```typescript
795
- // Process up to 10 items simultaneously
796
- workflow.foreach(fetchDataStep, { concurrency: 10 })
797
- ```
798
-
799
- ## Loop management
800
-
801
- Loop conditions can be implemented in different ways depending on how you want the loop to end. Common patterns include checking values returned in `inputData`, setting a maximum number of iterations, or aborting execution when a limit is reached.
802
-
803
- ### Aborting loops
804
-
805
- Use `iterationCount` to limit how many times a loop runs. If the count exceeds your threshold, throw an error to fail the step and stop the workflow.
806
-
807
- ```typescript
808
- const step1 = createStep({...});
809
-
810
- export const testWorkflow = createWorkflow({...})
811
- .dountil(step1, async ({ inputData: { userResponse, iterationCount } }) => {
812
- if (iterationCount >= 10) {
813
- throw new Error("Maximum iterations reached");
814
- }
815
- return userResponse === "yes";
816
- })
817
- .commit();
818
- ```
819
-
820
- ## Related
821
-
822
- - [Suspend & Resume](https://mastra.ai/docs/workflows/suspend-and-resume)
823
- - [Human-in-the-loop](https://mastra.ai/docs/workflows/human-in-the-loop)