@mastra/core 1.9.0 → 1.10.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 (438) hide show
  1. package/CHANGELOG.md +202 -0
  2. package/dist/agent/agent.d.ts +22 -3
  3. package/dist/agent/agent.d.ts.map +1 -1
  4. package/dist/agent/index.cjs +13 -13
  5. package/dist/agent/index.js +2 -2
  6. package/dist/agent/message-list/index.cjs +18 -18
  7. package/dist/agent/message-list/index.js +1 -1
  8. package/dist/agent/message-list/message-list.d.ts.map +1 -1
  9. package/dist/{chunk-IOY7Y5GV.js → chunk-3VVNJPTO.js} +602 -187
  10. package/dist/chunk-3VVNJPTO.js.map +1 -0
  11. package/dist/{chunk-VDKWYUGC.cjs → chunk-5WBEMKE2.cjs} +7 -3
  12. package/dist/chunk-5WBEMKE2.cjs.map +1 -0
  13. package/dist/{chunk-H5S4PS44.cjs → chunk-76Q75VI4.cjs} +602 -187
  14. package/dist/chunk-76Q75VI4.cjs.map +1 -0
  15. package/dist/{chunk-ZBESCKPX.cjs → chunk-7AHCLTZZ.cjs} +1572 -36
  16. package/dist/chunk-7AHCLTZZ.cjs.map +1 -0
  17. package/dist/{chunk-SEKQJ447.js → chunk-ACAILOJE.js} +166 -68
  18. package/dist/chunk-ACAILOJE.js.map +1 -0
  19. package/dist/{chunk-YIJZBU54.cjs → chunk-BCSVBOAN.cjs} +240 -463
  20. package/dist/chunk-BCSVBOAN.cjs.map +1 -0
  21. package/dist/{chunk-ZVWVQ6MG.js → chunk-CY4ZWL2X.js} +8 -3
  22. package/dist/chunk-CY4ZWL2X.js.map +1 -0
  23. package/dist/{chunk-ET7GXCHS.js → chunk-DIKRJVK6.js} +5 -5
  24. package/dist/{chunk-ET7GXCHS.js.map → chunk-DIKRJVK6.js.map} +1 -1
  25. package/dist/{chunk-P6ZX7OKT.cjs → chunk-E6I5LBDM.cjs} +7 -7
  26. package/dist/{chunk-P6ZX7OKT.cjs.map → chunk-E6I5LBDM.cjs.map} +1 -1
  27. package/dist/{chunk-BFV3GSGS.js → chunk-FT5Q6XTK.js} +1546 -22
  28. package/dist/chunk-FT5Q6XTK.js.map +1 -0
  29. package/dist/{chunk-K54LFB4P.js → chunk-FXOWXS4O.js} +3 -3
  30. package/dist/{chunk-K54LFB4P.js.map → chunk-FXOWXS4O.js.map} +1 -1
  31. package/dist/{chunk-QNXY3J6B.cjs → chunk-GCRPNAAR.cjs} +22 -19
  32. package/dist/chunk-GCRPNAAR.cjs.map +1 -0
  33. package/dist/{chunk-5M3RMO7U.js → chunk-GTA5BKXZ.js} +8 -8
  34. package/dist/{chunk-5M3RMO7U.js.map → chunk-GTA5BKXZ.js.map} +1 -1
  35. package/dist/{chunk-G5R2755Q.cjs → chunk-HAIQ57YB.cjs} +53 -20
  36. package/dist/chunk-HAIQ57YB.cjs.map +1 -0
  37. package/dist/{chunk-3ZBLD2Y4.cjs → chunk-HH76UOJL.cjs} +2 -2
  38. package/dist/{chunk-3ZBLD2Y4.cjs.map → chunk-HH76UOJL.cjs.map} +1 -1
  39. package/dist/{chunk-HAGCXIBX.cjs → chunk-HNYQITSV.cjs} +9 -9
  40. package/dist/{chunk-HAGCXIBX.cjs.map → chunk-HNYQITSV.cjs.map} +1 -1
  41. package/dist/{chunk-GJTLWOKJ.js → chunk-HQA3IBLZ.js} +51 -18
  42. package/dist/chunk-HQA3IBLZ.js.map +1 -0
  43. package/dist/{chunk-4BXXAZ75.js → chunk-HQTHWVAK.js} +15 -7
  44. package/dist/chunk-HQTHWVAK.js.map +1 -0
  45. package/dist/{chunk-CCLV5CAA.js → chunk-JGOH7RWL.js} +7 -3
  46. package/dist/chunk-JGOH7RWL.js.map +1 -0
  47. package/dist/{chunk-Y6TGIUGL.js → chunk-LSF5WJ6G.js} +2 -2
  48. package/dist/{chunk-Y6TGIUGL.js.map → chunk-LSF5WJ6G.js.map} +1 -1
  49. package/dist/{chunk-D6HO5QAM.cjs → chunk-M26GEN4C.cjs} +14 -9
  50. package/dist/chunk-M26GEN4C.cjs.map +1 -0
  51. package/dist/{chunk-4P35AVPE.cjs → chunk-MEMYFFOL.cjs} +256 -157
  52. package/dist/chunk-MEMYFFOL.cjs.map +1 -0
  53. package/dist/{chunk-BQ355Z3O.js → chunk-NUZWQA4J.js} +4 -4
  54. package/dist/{chunk-BQ355Z3O.js.map → chunk-NUZWQA4J.js.map} +1 -1
  55. package/dist/{chunk-JIRB5LX4.js → chunk-OHX36YXF.js} +5 -3
  56. package/dist/chunk-OHX36YXF.js.map +1 -0
  57. package/dist/{chunk-PKORY4ZZ.cjs → chunk-OOTLMVNN.cjs} +107 -7
  58. package/dist/chunk-OOTLMVNN.cjs.map +1 -0
  59. package/dist/{chunk-D4M6E4OQ.cjs → chunk-OWZ6QT24.cjs} +16 -8
  60. package/dist/chunk-OWZ6QT24.cjs.map +1 -0
  61. package/dist/{chunk-6OHS6ZQ3.js → chunk-PDJCIONR.js} +8 -8
  62. package/dist/{chunk-6OHS6ZQ3.js.map → chunk-PDJCIONR.js.map} +1 -1
  63. package/dist/{chunk-WU2P7XOU.cjs → chunk-PP4G2TZZ.cjs} +20 -20
  64. package/dist/{chunk-WU2P7XOU.cjs.map → chunk-PP4G2TZZ.cjs.map} +1 -1
  65. package/dist/{chunk-VWAK25TU.js → chunk-SBBWRNZA.js} +10 -7
  66. package/dist/chunk-SBBWRNZA.js.map +1 -0
  67. package/dist/{chunk-TU4YMXOQ.js → chunk-TJIFNVPX.js} +6 -6
  68. package/dist/{chunk-TU4YMXOQ.js.map → chunk-TJIFNVPX.js.map} +1 -1
  69. package/dist/{chunk-V5YNS2QO.cjs → chunk-XJNQHPBJ.cjs} +15 -15
  70. package/dist/{chunk-V5YNS2QO.cjs.map → chunk-XJNQHPBJ.cjs.map} +1 -1
  71. package/dist/{chunk-MVYP55NA.js → chunk-YC6Z75K2.js} +113 -336
  72. package/dist/chunk-YC6Z75K2.js.map +1 -0
  73. package/dist/{chunk-3ZF7IC6Q.cjs → chunk-YZMSJKAK.cjs} +5 -3
  74. package/dist/chunk-YZMSJKAK.cjs.map +1 -0
  75. package/dist/{chunk-L3WDI7HP.cjs → chunk-Z2X5VTYJ.cjs} +65 -65
  76. package/dist/{chunk-L3WDI7HP.cjs.map → chunk-Z2X5VTYJ.cjs.map} +1 -1
  77. package/dist/{chunk-BN5MV2QK.cjs → chunk-Z52OAJ73.cjs} +4 -4
  78. package/dist/{chunk-BN5MV2QK.cjs.map → chunk-Z52OAJ73.cjs.map} +1 -1
  79. package/dist/{chunk-WYPSC6CO.js → chunk-ZBU6P4JV.js} +104 -4
  80. package/dist/chunk-ZBU6P4JV.js.map +1 -0
  81. package/dist/datasets/experiment/index.d.ts.map +1 -1
  82. package/dist/datasets/experiment/scorer.d.ts.map +1 -1
  83. package/dist/datasets/index.cjs +17 -17
  84. package/dist/datasets/index.js +2 -2
  85. package/dist/di/index.cjs +4 -4
  86. package/dist/di/index.js +1 -1
  87. package/dist/docs/SKILL.md +1 -1
  88. package/dist/docs/assets/SOURCE_MAP.json +443 -384
  89. package/dist/docs/references/docs-agents-agent-approval.md +61 -31
  90. package/dist/docs/references/docs-agents-supervisor-agents.md +1 -1
  91. package/dist/docs/references/docs-memory-observational-memory.md +9 -0
  92. package/dist/docs/references/docs-memory-semantic-recall.md +17 -1
  93. package/dist/docs/references/docs-workspace-skills.md +7 -5
  94. package/dist/docs/references/reference-agents-agent.md +20 -20
  95. package/dist/docs/references/reference-agents-generate.md +200 -66
  96. package/dist/docs/references/reference-agents-generateLegacy.md +77 -35
  97. package/dist/docs/references/reference-agents-getDefaultGenerateOptions.md +4 -6
  98. package/dist/docs/references/reference-agents-getDefaultOptions.md +4 -6
  99. package/dist/docs/references/reference-agents-getDefaultStreamOptions.md +4 -6
  100. package/dist/docs/references/reference-agents-getDescription.md +1 -1
  101. package/dist/docs/references/reference-agents-getInstructions.md +4 -6
  102. package/dist/docs/references/reference-agents-getLLM.md +6 -8
  103. package/dist/docs/references/reference-agents-getMemory.md +4 -6
  104. package/dist/docs/references/reference-agents-getModel.md +4 -6
  105. package/dist/docs/references/reference-agents-getTools.md +5 -7
  106. package/dist/docs/references/reference-agents-getVoice.md +4 -6
  107. package/dist/docs/references/reference-agents-listAgents.md +4 -6
  108. package/dist/docs/references/reference-agents-listScorers.md +4 -6
  109. package/dist/docs/references/reference-agents-listTools.md +4 -6
  110. package/dist/docs/references/reference-agents-listWorkflows.md +4 -6
  111. package/dist/docs/references/reference-agents-network.md +69 -23
  112. package/dist/docs/references/reference-ai-sdk-chat-route.md +7 -7
  113. package/dist/docs/references/reference-ai-sdk-network-route.md +3 -3
  114. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-stream.md +9 -9
  115. package/dist/docs/references/reference-ai-sdk-with-mastra.md +12 -12
  116. package/dist/docs/references/reference-ai-sdk-workflow-route.md +3 -3
  117. package/dist/docs/references/reference-auth-auth0.md +6 -6
  118. package/dist/docs/references/reference-auth-clerk.md +5 -5
  119. package/dist/docs/references/reference-auth-firebase.md +7 -7
  120. package/dist/docs/references/reference-auth-jwt.md +1 -1
  121. package/dist/docs/references/reference-auth-supabase.md +4 -4
  122. package/dist/docs/references/reference-auth-workos.md +6 -6
  123. package/dist/docs/references/reference-core-addGateway.md +2 -2
  124. package/dist/docs/references/reference-core-getAgent.md +2 -2
  125. package/dist/docs/references/reference-core-getAgentById.md +2 -2
  126. package/dist/docs/references/reference-core-getDeployer.md +1 -1
  127. package/dist/docs/references/reference-core-getGateway.md +2 -2
  128. package/dist/docs/references/reference-core-getGatewayById.md +2 -2
  129. package/dist/docs/references/reference-core-getLogger.md +1 -1
  130. package/dist/docs/references/reference-core-getMCPServer.md +2 -2
  131. package/dist/docs/references/reference-core-getMCPServerById.md +3 -3
  132. package/dist/docs/references/reference-core-getMemory.md +2 -2
  133. package/dist/docs/references/reference-core-getScorer.md +2 -2
  134. package/dist/docs/references/reference-core-getScorerById.md +2 -2
  135. package/dist/docs/references/reference-core-getServer.md +1 -1
  136. package/dist/docs/references/reference-core-getStorage.md +1 -1
  137. package/dist/docs/references/reference-core-getStoredAgentById.md +18 -20
  138. package/dist/docs/references/reference-core-getTelemetry.md +1 -1
  139. package/dist/docs/references/reference-core-getVector.md +2 -2
  140. package/dist/docs/references/reference-core-getWorkflow.md +3 -3
  141. package/dist/docs/references/reference-core-listAgents.md +1 -1
  142. package/dist/docs/references/reference-core-listGateways.md +1 -1
  143. package/dist/docs/references/reference-core-listLogs.md +9 -11
  144. package/dist/docs/references/reference-core-listLogsByRunId.md +9 -9
  145. package/dist/docs/references/reference-core-listMCPServers.md +1 -1
  146. package/dist/docs/references/reference-core-listMemory.md +1 -1
  147. package/dist/docs/references/reference-core-listScorers.md +1 -1
  148. package/dist/docs/references/reference-core-listStoredAgents.md +9 -11
  149. package/dist/docs/references/reference-core-listVectors.md +1 -1
  150. package/dist/docs/references/reference-core-listWorkflows.md +2 -2
  151. package/dist/docs/references/reference-core-mastra-class.md +17 -17
  152. package/dist/docs/references/reference-core-mastra-model-gateway.md +15 -15
  153. package/dist/docs/references/reference-core-setLogger.md +2 -4
  154. package/dist/docs/references/reference-core-setStorage.md +1 -1
  155. package/dist/docs/references/reference-datasets-addItem.md +20 -4
  156. package/dist/docs/references/reference-datasets-addItems.md +8 -2
  157. package/dist/docs/references/reference-datasets-compareExperiments.md +15 -3
  158. package/dist/docs/references/reference-datasets-create.md +6 -6
  159. package/dist/docs/references/reference-datasets-dataset.md +1 -1
  160. package/dist/docs/references/reference-datasets-delete.md +2 -2
  161. package/dist/docs/references/reference-datasets-deleteExperiment.md +2 -2
  162. package/dist/docs/references/reference-datasets-deleteItem.md +2 -2
  163. package/dist/docs/references/reference-datasets-deleteItems.md +2 -2
  164. package/dist/docs/references/reference-datasets-get.md +2 -2
  165. package/dist/docs/references/reference-datasets-getDetails.md +9 -9
  166. package/dist/docs/references/reference-datasets-getExperiment.md +2 -2
  167. package/dist/docs/references/reference-datasets-getItem.md +3 -3
  168. package/dist/docs/references/reference-datasets-getItemHistory.md +22 -2
  169. package/dist/docs/references/reference-datasets-list.md +7 -3
  170. package/dist/docs/references/reference-datasets-listExperimentResults.md +34 -4
  171. package/dist/docs/references/reference-datasets-listExperiments.md +41 -3
  172. package/dist/docs/references/reference-datasets-listItems.md +18 -6
  173. package/dist/docs/references/reference-datasets-listVersions.md +23 -3
  174. package/dist/docs/references/reference-datasets-startExperiment.md +62 -12
  175. package/dist/docs/references/reference-datasets-startExperimentAsync.md +5 -1
  176. package/dist/docs/references/reference-datasets-update.md +6 -6
  177. package/dist/docs/references/reference-datasets-updateItem.md +5 -5
  178. package/dist/docs/references/reference-evals-answer-relevancy.md +11 -11
  179. package/dist/docs/references/reference-evals-answer-similarity.md +17 -19
  180. package/dist/docs/references/reference-evals-bias.md +10 -10
  181. package/dist/docs/references/reference-evals-completeness.md +3 -3
  182. package/dist/docs/references/reference-evals-content-similarity.md +6 -6
  183. package/dist/docs/references/reference-evals-context-precision.md +4 -4
  184. package/dist/docs/references/reference-evals-create-scorer.md +47 -49
  185. package/dist/docs/references/reference-evals-faithfulness.md +11 -11
  186. package/dist/docs/references/reference-evals-hallucination.md +17 -21
  187. package/dist/docs/references/reference-evals-keyword-coverage.md +4 -4
  188. package/dist/docs/references/reference-evals-mastra-scorer.md +14 -14
  189. package/dist/docs/references/reference-evals-run-evals.md +16 -16
  190. package/dist/docs/references/reference-evals-scorer-utils.md +3 -3
  191. package/dist/docs/references/reference-evals-textual-difference.md +3 -3
  192. package/dist/docs/references/reference-evals-tone-consistency.md +3 -3
  193. package/dist/docs/references/reference-evals-toxicity.md +8 -8
  194. package/dist/docs/references/reference-harness-harness-class.md +34 -42
  195. package/dist/docs/references/reference-logging-pino-logger.md +5 -5
  196. package/dist/docs/references/reference-memory-deleteMessages.md +2 -2
  197. package/dist/docs/references/reference-memory-memory-class.md +12 -14
  198. package/dist/docs/references/reference-memory-observational-memory.md +102 -94
  199. package/dist/docs/references/reference-observability-tracing-configuration.md +27 -10
  200. package/dist/docs/references/reference-observability-tracing-exporters-console-exporter.md +4 -7
  201. package/dist/docs/references/reference-processors-batch-parts-processor.md +8 -10
  202. package/dist/docs/references/reference-processors-language-detector.md +14 -16
  203. package/dist/docs/references/reference-processors-message-history-processor.md +7 -9
  204. package/dist/docs/references/reference-processors-moderation-processor.md +13 -15
  205. package/dist/docs/references/reference-processors-pii-detector.md +14 -16
  206. package/dist/docs/references/reference-processors-processor-interface.md +62 -62
  207. package/dist/docs/references/reference-processors-prompt-injection-detector.md +11 -13
  208. package/dist/docs/references/reference-processors-semantic-recall-processor.md +14 -16
  209. package/dist/docs/references/reference-processors-system-prompt-scrubber.md +12 -14
  210. package/dist/docs/references/reference-processors-token-limiter-processor.md +11 -13
  211. package/dist/docs/references/reference-processors-tool-call-filter.md +5 -7
  212. package/dist/docs/references/reference-processors-tool-search-processor.md +9 -11
  213. package/dist/docs/references/reference-processors-unicode-normalizer.md +8 -10
  214. package/dist/docs/references/reference-processors-working-memory-processor.md +14 -18
  215. package/dist/docs/references/reference-rag-database-config.md +11 -7
  216. package/dist/docs/references/reference-rag-embeddings.md +12 -12
  217. package/dist/docs/references/reference-server-mastra-server.md +10 -10
  218. package/dist/docs/references/reference-server-register-api-route.md +13 -13
  219. package/dist/docs/references/reference-storage-cloudflare-d1.md +5 -5
  220. package/dist/docs/references/reference-storage-composite.md +9 -9
  221. package/dist/docs/references/reference-storage-lance.md +3 -3
  222. package/dist/docs/references/reference-storage-libsql.md +2 -2
  223. package/dist/docs/references/reference-storage-mongodb.md +5 -5
  224. package/dist/docs/references/reference-storage-mssql.md +2 -2
  225. package/dist/docs/references/reference-storage-postgresql.md +25 -25
  226. package/dist/docs/references/reference-storage-upstash.md +3 -3
  227. package/dist/docs/references/reference-streaming-ChunkType.md +251 -59
  228. package/dist/docs/references/reference-streaming-agents-MastraModelOutput.md +86 -16
  229. package/dist/docs/references/reference-streaming-agents-streamLegacy.md +79 -39
  230. package/dist/docs/references/reference-streaming-workflows-resumeStream.md +18 -8
  231. package/dist/docs/references/reference-streaming-workflows-stream.md +21 -9
  232. package/dist/docs/references/reference-streaming-workflows-timeTravelStream.md +4 -4
  233. package/dist/docs/references/reference-tools-create-tool.md +25 -21
  234. package/dist/docs/references/reference-tools-graph-rag-tool.md +16 -18
  235. package/dist/docs/references/reference-tools-mcp-client.md +38 -27
  236. package/dist/docs/references/reference-tools-mcp-server.md +45 -45
  237. package/dist/docs/references/reference-tools-vector-query-tool.md +34 -22
  238. package/dist/docs/references/reference-vectors-libsql.md +31 -31
  239. package/dist/docs/references/reference-vectors-mongodb.md +32 -32
  240. package/dist/docs/references/reference-vectors-pg.md +60 -44
  241. package/dist/docs/references/reference-vectors-upstash.md +25 -25
  242. package/dist/docs/references/reference-voice-composite-voice.md +10 -10
  243. package/dist/docs/references/reference-voice-mastra-voice.md +20 -20
  244. package/dist/docs/references/reference-voice-voice.addInstructions.md +1 -1
  245. package/dist/docs/references/reference-voice-voice.addTools.md +1 -1
  246. package/dist/docs/references/reference-voice-voice.connect.md +3 -3
  247. package/dist/docs/references/reference-voice-voice.events.md +11 -11
  248. package/dist/docs/references/reference-voice-voice.listen.md +9 -9
  249. package/dist/docs/references/reference-voice-voice.on.md +2 -2
  250. package/dist/docs/references/reference-voice-voice.speak.md +11 -11
  251. package/dist/docs/references/reference-workflows-run-methods-cancel.md +2 -2
  252. package/dist/docs/references/reference-workflows-run-methods-restart.md +17 -5
  253. package/dist/docs/references/reference-workflows-run-methods-resume.md +23 -9
  254. package/dist/docs/references/reference-workflows-run-methods-start.md +22 -8
  255. package/dist/docs/references/reference-workflows-run-methods-startAsync.md +12 -6
  256. package/dist/docs/references/reference-workflows-run-methods-timeTravel.md +29 -13
  257. package/dist/docs/references/reference-workflows-run.md +12 -12
  258. package/dist/docs/references/reference-workflows-step.md +24 -26
  259. package/dist/docs/references/reference-workflows-workflow-methods-branch.md +2 -2
  260. package/dist/docs/references/reference-workflows-workflow-methods-commit.md +1 -1
  261. package/dist/docs/references/reference-workflows-workflow-methods-create-run.md +4 -4
  262. package/dist/docs/references/reference-workflows-workflow-methods-dountil.md +3 -3
  263. package/dist/docs/references/reference-workflows-workflow-methods-dowhile.md +3 -3
  264. package/dist/docs/references/reference-workflows-workflow-methods-foreach.md +9 -9
  265. package/dist/docs/references/reference-workflows-workflow-methods-map.md +2 -2
  266. package/dist/docs/references/reference-workflows-workflow-methods-parallel.md +2 -2
  267. package/dist/docs/references/reference-workflows-workflow-methods-sleep.md +2 -2
  268. package/dist/docs/references/reference-workflows-workflow-methods-sleepUntil.md +2 -2
  269. package/dist/docs/references/reference-workflows-workflow-methods-then.md +2 -2
  270. package/dist/docs/references/reference-workflows-workflow.md +40 -50
  271. package/dist/docs/references/reference-workspace-filesystem.md +22 -22
  272. package/dist/docs/references/reference-workspace-local-filesystem.md +35 -35
  273. package/dist/docs/references/reference-workspace-local-sandbox.md +26 -26
  274. package/dist/docs/references/reference-workspace-sandbox.md +8 -8
  275. package/dist/docs/references/reference-workspace-workspace-class.md +30 -34
  276. package/dist/editor/types.d.ts +1 -0
  277. package/dist/editor/types.d.ts.map +1 -1
  278. package/dist/evals/index.cjs +20 -20
  279. package/dist/evals/index.js +3 -3
  280. package/dist/evals/scoreTraces/index.cjs +5 -5
  281. package/dist/evals/scoreTraces/index.js +2 -2
  282. package/dist/harness/harness.d.ts.map +1 -1
  283. package/dist/harness/index.cjs +25 -21
  284. package/dist/harness/index.cjs.map +1 -1
  285. package/dist/harness/index.js +15 -11
  286. package/dist/harness/index.js.map +1 -1
  287. package/dist/index.cjs +2 -2
  288. package/dist/index.js +1 -1
  289. package/dist/integration/index.cjs +2 -2
  290. package/dist/integration/index.js +1 -1
  291. package/dist/llm/index.cjs +12 -12
  292. package/dist/llm/index.js +3 -3
  293. package/dist/llm/model/model.d.ts.map +1 -1
  294. package/dist/llm/model/model.loop.d.ts.map +1 -1
  295. package/dist/llm/model/provider-types.generated.d.ts +5 -1
  296. package/dist/loop/index.cjs +14 -14
  297. package/dist/loop/index.js +1 -1
  298. package/dist/loop/workflows/agentic-loop/index.d.ts.map +1 -1
  299. package/dist/mastra/index.cjs +2 -2
  300. package/dist/mastra/index.js +1 -1
  301. package/dist/memory/index.cjs +14 -14
  302. package/dist/memory/index.js +1 -1
  303. package/dist/models-dev-2FJK72J2.cjs +12 -0
  304. package/dist/{models-dev-UVWCKPA2.cjs.map → models-dev-2FJK72J2.cjs.map} +1 -1
  305. package/dist/models-dev-CMQG6EMO.js +3 -0
  306. package/dist/{models-dev-W3LXZTEB.js.map → models-dev-CMQG6EMO.js.map} +1 -1
  307. package/dist/processor-provider/index.cjs +10 -10
  308. package/dist/processor-provider/index.js +1 -1
  309. package/dist/processors/index.cjs +42 -42
  310. package/dist/processors/index.js +1 -1
  311. package/dist/processors/processors/skills.d.ts +9 -42
  312. package/dist/processors/processors/skills.d.ts.map +1 -1
  313. package/dist/provider-registry-EHOAWHFE.cjs +40 -0
  314. package/dist/{provider-registry-4HLP2JRR.cjs.map → provider-registry-EHOAWHFE.cjs.map} +1 -1
  315. package/dist/provider-registry-LVP6T63V.js +3 -0
  316. package/dist/{provider-registry-K3DWQSMH.js.map → provider-registry-LVP6T63V.js.map} +1 -1
  317. package/dist/provider-registry.json +12 -4
  318. package/dist/relevance/index.cjs +3 -3
  319. package/dist/relevance/index.js +1 -1
  320. package/dist/request-context/index.cjs +4 -4
  321. package/dist/request-context/index.d.ts.map +1 -1
  322. package/dist/request-context/index.js +1 -1
  323. package/dist/storage/base.d.ts +34 -1
  324. package/dist/storage/base.d.ts.map +1 -1
  325. package/dist/storage/constants.cjs +56 -56
  326. package/dist/storage/constants.js +1 -1
  327. package/dist/storage/domains/agents/filesystem.d.ts +28 -0
  328. package/dist/storage/domains/agents/filesystem.d.ts.map +1 -0
  329. package/dist/storage/domains/agents/index.d.ts +1 -0
  330. package/dist/storage/domains/agents/index.d.ts.map +1 -1
  331. package/dist/storage/domains/experiments/inmemory.d.ts.map +1 -1
  332. package/dist/storage/domains/mcp-clients/filesystem.d.ts +28 -0
  333. package/dist/storage/domains/mcp-clients/filesystem.d.ts.map +1 -0
  334. package/dist/storage/domains/mcp-clients/index.d.ts +1 -0
  335. package/dist/storage/domains/mcp-clients/index.d.ts.map +1 -1
  336. package/dist/storage/domains/mcp-servers/filesystem.d.ts +28 -0
  337. package/dist/storage/domains/mcp-servers/filesystem.d.ts.map +1 -0
  338. package/dist/storage/domains/mcp-servers/index.d.ts +1 -0
  339. package/dist/storage/domains/mcp-servers/index.d.ts.map +1 -1
  340. package/dist/storage/domains/prompt-blocks/filesystem.d.ts +28 -0
  341. package/dist/storage/domains/prompt-blocks/filesystem.d.ts.map +1 -0
  342. package/dist/storage/domains/prompt-blocks/index.d.ts +1 -0
  343. package/dist/storage/domains/prompt-blocks/index.d.ts.map +1 -1
  344. package/dist/storage/domains/scorer-definitions/filesystem.d.ts +28 -0
  345. package/dist/storage/domains/scorer-definitions/filesystem.d.ts.map +1 -0
  346. package/dist/storage/domains/scorer-definitions/index.d.ts +1 -0
  347. package/dist/storage/domains/scorer-definitions/index.d.ts.map +1 -1
  348. package/dist/storage/domains/skills/filesystem.d.ts +28 -0
  349. package/dist/storage/domains/skills/filesystem.d.ts.map +1 -0
  350. package/dist/storage/domains/skills/index.d.ts +1 -0
  351. package/dist/storage/domains/skills/index.d.ts.map +1 -1
  352. package/dist/storage/domains/workspaces/filesystem.d.ts +28 -0
  353. package/dist/storage/domains/workspaces/filesystem.d.ts.map +1 -0
  354. package/dist/storage/domains/workspaces/index.d.ts +1 -0
  355. package/dist/storage/domains/workspaces/index.d.ts.map +1 -1
  356. package/dist/storage/filesystem-db.d.ts +82 -0
  357. package/dist/storage/filesystem-db.d.ts.map +1 -0
  358. package/dist/storage/filesystem-versioned.d.ts +148 -0
  359. package/dist/storage/filesystem-versioned.d.ts.map +1 -0
  360. package/dist/storage/filesystem.d.ts +39 -0
  361. package/dist/storage/filesystem.d.ts.map +1 -0
  362. package/dist/storage/git-history.d.ts +68 -0
  363. package/dist/storage/git-history.d.ts.map +1 -0
  364. package/dist/storage/index.cjs +208 -160
  365. package/dist/storage/index.d.ts +4 -0
  366. package/dist/storage/index.d.ts.map +1 -1
  367. package/dist/storage/index.js +2 -2
  368. package/dist/storage/types.d.ts +1 -0
  369. package/dist/storage/types.d.ts.map +1 -1
  370. package/dist/stream/RunOutput.d.ts +1 -1
  371. package/dist/stream/aisdk/v5/output-helpers.d.ts +6 -6
  372. package/dist/stream/base/output.d.ts +3 -3
  373. package/dist/stream/base/schema.d.ts +1 -1
  374. package/dist/stream/index.cjs +11 -11
  375. package/dist/stream/index.js +2 -2
  376. package/dist/test-utils/llm-mock.cjs +4 -4
  377. package/dist/test-utils/llm-mock.js +1 -1
  378. package/dist/tool-loop-agent/index.cjs +4 -4
  379. package/dist/tool-loop-agent/index.js +1 -1
  380. package/dist/tools/index.cjs +6 -6
  381. package/dist/tools/index.js +1 -1
  382. package/dist/tools/is-vercel-tool.cjs +2 -2
  383. package/dist/tools/is-vercel-tool.js +1 -1
  384. package/dist/tools/tool-builder/builder.d.ts.map +1 -1
  385. package/dist/tools/tool.d.ts +6 -0
  386. package/dist/tools/tool.d.ts.map +1 -1
  387. package/dist/tools/types.d.ts +27 -0
  388. package/dist/tools/types.d.ts.map +1 -1
  389. package/dist/utils.cjs +23 -23
  390. package/dist/utils.js +1 -1
  391. package/dist/vector/index.cjs +9 -9
  392. package/dist/vector/index.js +2 -2
  393. package/dist/workflows/evented/index.cjs +10 -10
  394. package/dist/workflows/evented/index.js +1 -1
  395. package/dist/workflows/index.cjs +25 -25
  396. package/dist/workflows/index.js +1 -1
  397. package/dist/workspace/index.cjs +70 -66
  398. package/dist/workspace/index.d.ts +1 -0
  399. package/dist/workspace/index.d.ts.map +1 -1
  400. package/dist/workspace/index.js +1 -1
  401. package/dist/workspace/sandbox/execa.d.ts +9 -0
  402. package/dist/workspace/sandbox/execa.d.ts.map +1 -0
  403. package/dist/workspace/sandbox/local-process-manager.d.ts.map +1 -1
  404. package/dist/workspace/skills/index.d.ts +1 -0
  405. package/dist/workspace/skills/index.d.ts.map +1 -1
  406. package/dist/workspace/skills/tools.d.ts +36 -0
  407. package/dist/workspace/skills/tools.d.ts.map +1 -0
  408. package/dist/workspace/tools/execute-command.d.ts.map +1 -1
  409. package/dist/workspace/tools/output-helpers.d.ts +4 -3
  410. package/dist/workspace/tools/output-helpers.d.ts.map +1 -1
  411. package/package.json +9 -9
  412. package/src/llm/model/provider-types.generated.d.ts +5 -1
  413. package/dist/chunk-3ZF7IC6Q.cjs.map +0 -1
  414. package/dist/chunk-4BXXAZ75.js.map +0 -1
  415. package/dist/chunk-4P35AVPE.cjs.map +0 -1
  416. package/dist/chunk-BFV3GSGS.js.map +0 -1
  417. package/dist/chunk-CCLV5CAA.js.map +0 -1
  418. package/dist/chunk-D4M6E4OQ.cjs.map +0 -1
  419. package/dist/chunk-D6HO5QAM.cjs.map +0 -1
  420. package/dist/chunk-G5R2755Q.cjs.map +0 -1
  421. package/dist/chunk-GJTLWOKJ.js.map +0 -1
  422. package/dist/chunk-H5S4PS44.cjs.map +0 -1
  423. package/dist/chunk-IOY7Y5GV.js.map +0 -1
  424. package/dist/chunk-JIRB5LX4.js.map +0 -1
  425. package/dist/chunk-MVYP55NA.js.map +0 -1
  426. package/dist/chunk-PKORY4ZZ.cjs.map +0 -1
  427. package/dist/chunk-QNXY3J6B.cjs.map +0 -1
  428. package/dist/chunk-SEKQJ447.js.map +0 -1
  429. package/dist/chunk-VDKWYUGC.cjs.map +0 -1
  430. package/dist/chunk-VWAK25TU.js.map +0 -1
  431. package/dist/chunk-WYPSC6CO.js.map +0 -1
  432. package/dist/chunk-YIJZBU54.cjs.map +0 -1
  433. package/dist/chunk-ZBESCKPX.cjs.map +0 -1
  434. package/dist/chunk-ZVWVQ6MG.js.map +0 -1
  435. package/dist/models-dev-UVWCKPA2.cjs +0 -12
  436. package/dist/models-dev-W3LXZTEB.js +0 -3
  437. package/dist/provider-registry-4HLP2JRR.cjs +0 -40
  438. package/dist/provider-registry-K3DWQSMH.js +0 -3
@@ -4,27 +4,27 @@ The PgVector class provides vector search using [PostgreSQL](https://www.postgre
4
4
 
5
5
  ## Constructor Options
6
6
 
7
- **connectionString?:** (`string`): PostgreSQL connection URL
7
+ **connectionString** (`string`): PostgreSQL connection URL
8
8
 
9
- **host?:** (`string`): PostgreSQL server host
9
+ **host** (`string`): PostgreSQL server host
10
10
 
11
- **port?:** (`number`): PostgreSQL server port
11
+ **port** (`number`): PostgreSQL server port
12
12
 
13
- **database?:** (`string`): PostgreSQL database name
13
+ **database** (`string`): PostgreSQL database name
14
14
 
15
- **user?:** (`string`): PostgreSQL user
15
+ **user** (`string`): PostgreSQL user
16
16
 
17
- **password?:** (`string`): PostgreSQL password
17
+ **password** (`string`): PostgreSQL password
18
18
 
19
- **ssl?:** (`boolean | ConnectionOptions`): Enable SSL or provide custom SSL configuration
19
+ **ssl** (`boolean | ConnectionOptions`): Enable SSL or provide custom SSL configuration
20
20
 
21
- **schemaName?:** (`string`): The name of the schema you want the vector store to use. Will use the default schema if not provided.
21
+ **schemaName** (`string`): The name of the schema you want the vector store to use. Will use the default schema if not provided.
22
22
 
23
- **max?:** (`number`): Maximum number of pool connections (default: 20)
23
+ **max** (`number`): Maximum number of pool connections (default: 20)
24
24
 
25
- **idleTimeoutMillis?:** (`number`): Idle connection timeout in milliseconds (default: 30000)
25
+ **idleTimeoutMillis** (`number`): Idle connection timeout in milliseconds (default: 30000)
26
26
 
27
- **pgPoolOptions?:** (`PoolConfig`): Additional pg pool configuration options
27
+ **pgPoolOptions** (`PoolConfig`): Additional pg pool configuration options
28
28
 
29
29
  ## Constructor Examples
30
30
 
@@ -72,23 +72,35 @@ const vectorStore = new PgVector({
72
72
 
73
73
  ### createIndex()
74
74
 
75
- **indexName:** (`string`): Name of the index to create
75
+ **indexName** (`string`): Name of the index to create
76
76
 
77
- **dimension:** (`number`): Vector dimension (must match your embedding model)
77
+ **dimension** (`number`): Vector dimension (must match your embedding model)
78
78
 
79
- **metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
79
+ **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
80
80
 
81
- **indexConfig?:** (`IndexConfig`): Index configuration (Default: `{ type: 'ivfflat' }`)
81
+ **indexConfig** (`IndexConfig`): Index configuration (Default: `{ type: 'ivfflat' }`)
82
82
 
83
- **buildIndex?:** (`boolean`): Whether to build the index (Default: `true`)
83
+ **buildIndex** (`boolean`): Whether to build the index (Default: `true`)
84
84
 
85
85
  #### IndexConfig
86
86
 
87
- **type:** (`'flat' | 'hnsw' | 'ivfflat'`): stringflat:flatSequential scan (no index) that performs exhaustive search.ivfflat:ivfflatClusters vectors into lists for approximate search.hnsw:hnswGraph-based index offering fast search times and high recall. (Default: `ivfflat`)
87
+ **type** (`'flat' | 'hnsw' | 'ivfflat'`): Index type (Default: `ivfflat`)
88
88
 
89
- **ivf?:** (`IVFConfig`): objectlists?:numberNumber of lists. If not specified, automatically calculated based on dataset size. (Minimum 100, Maximum 4000)
89
+ **type.flat** (`flat`): Sequential scan (no index) that performs exhaustive search.
90
90
 
91
- **hnsw?:** (`HNSWConfig`): objectm?:numberMaximum number of connections per node (default: 8)efConstruction?:numberBuild-time complexity (default: 32)
91
+ **type.ivfflat** (`ivfflat`): Clusters vectors into lists for approximate search.
92
+
93
+ **type.hnsw** (`hnsw`): Graph-based index offering fast search times and high recall.
94
+
95
+ **ivf** (`IVFConfig`): IVF configuration
96
+
97
+ **ivf.lists** (`number`): Number of lists. If not specified, automatically calculated based on dataset size. (Minimum 100, Maximum 4000)
98
+
99
+ **hnsw** (`HNSWConfig`): HNSW configuration
100
+
101
+ **hnsw\.m** (`number`): Maximum number of connections per node (default: 8)
102
+
103
+ **hnsw\.efConstruction** (`number`): Build-time complexity (default: 32)
92
104
 
93
105
  #### Memory Requirements
94
106
 
@@ -102,29 +114,33 @@ Higher M values or efConstruction values will increase memory requirements signi
102
114
 
103
115
  ### upsert()
104
116
 
105
- **indexName:** (`string`): Name of the index to upsert vectors into
117
+ **indexName** (`string`): Name of the index to upsert vectors into
106
118
 
107
- **vectors:** (`number[][]`): Array of embedding vectors
119
+ **vectors** (`number[][]`): Array of embedding vectors
108
120
 
109
- **metadata?:** (`Record<string, any>[]`): Metadata for each vector
121
+ **metadata** (`Record<string, any>[]`): Metadata for each vector
110
122
 
111
- **ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
123
+ **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
112
124
 
113
125
  ### query()
114
126
 
115
- **indexName:** (`string`): Name of the index to query
127
+ **indexName** (`string`): Name of the index to query
128
+
129
+ **queryVector** (`number[]`): Query vector
130
+
131
+ **topK** (`number`): Number of results to return (Default: `10`)
116
132
 
117
- **queryVector:** (`number[]`): Query vector
133
+ **filter** (`Record<string, any>`): Metadata filters
118
134
 
119
- **topK?:** (`number`): Number of results to return (Default: `10`)
135
+ **includeVector** (`boolean`): Whether to include the vector in the result (Default: `false`)
120
136
 
121
- **filter?:** (`Record<string, any>`): Metadata filters
137
+ **minScore** (`number`): Minimum similarity score threshold (Default: `0`)
122
138
 
123
- **includeVector?:** (`boolean`): Whether to include the vector in the result (Default: `false`)
139
+ **options** (`{ ef?: number; probes?: number }`): Additional options for HNSW and IVF indexes
124
140
 
125
- **minScore?:** (`number`): Minimum similarity score threshold (Default: `0`)
141
+ **options.ef** (`number`): HNSW search parameter
126
142
 
127
- **options?:** (`{ ef?: number; probes?: number }`): objectef?:numberHNSW search parameterprobes?:numberIVF search parameter
143
+ **options.probes** (`number`): IVF search parameter
128
144
 
129
145
  ### listIndexes()
130
146
 
@@ -132,7 +148,7 @@ Returns an array of index names as strings.
132
148
 
133
149
  ### describeIndex()
134
150
 
135
- **indexName:** (`string`): Name of the index to describe
151
+ **indexName** (`string`): Name of the index to describe
136
152
 
137
153
  Returns:
138
154
 
@@ -153,19 +169,19 @@ interface PGIndexStats {
153
169
 
154
170
  ### deleteIndex()
155
171
 
156
- **indexName:** (`string`): Name of the index to delete
172
+ **indexName** (`string`): Name of the index to delete
157
173
 
158
174
  ### updateVector()
159
175
 
160
176
  Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
161
177
 
162
- **indexName:** (`string`): Name of the index containing the vector
178
+ **indexName** (`string`): Name of the index containing the vector
163
179
 
164
- **id?:** (`string`): ID of the vector to update (mutually exclusive with filter)
180
+ **id** (`string`): ID of the vector to update (mutually exclusive with filter)
165
181
 
166
- **filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
182
+ **filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
167
183
 
168
- **update:** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
184
+ **update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
169
185
 
170
186
  Updates an existing vector by ID or filter. At least one of vector or metadata must be provided in the update object.
171
187
 
@@ -192,9 +208,9 @@ await pgVector.updateVector({
192
208
 
193
209
  ### deleteVector()
194
210
 
195
- **indexName:** (`string`): Name of the index containing the vector
211
+ **indexName** (`string`): Name of the index containing the vector
196
212
 
197
- **id:** (`string`): ID of the vector to delete
213
+ **id** (`string`): ID of the vector to delete
198
214
 
199
215
  Deletes a single vector by ID from the specified index.
200
216
 
@@ -206,11 +222,11 @@ await pgVector.deleteVector({ indexName: 'my_vectors', id: 'vector123' })
206
222
 
207
223
  Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
208
224
 
209
- **indexName:** (`string`): Name of the index containing the vectors to delete
225
+ **indexName** (`string`): Name of the index containing the vectors to delete
210
226
 
211
- **ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
227
+ **ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
212
228
 
213
- **filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
229
+ **filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
214
230
 
215
231
  ### disconnect()
216
232
 
@@ -218,11 +234,11 @@ Closes the database connection pool. Should be called when done using the store.
218
234
 
219
235
  ### buildIndex()
220
236
 
221
- **indexName:** (`string`): Name of the index to define
237
+ **indexName** (`string`): Name of the index to define
222
238
 
223
- **metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
239
+ **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
224
240
 
225
- **indexConfig:** (`IndexConfig`): Configuration for the index type and parameters
241
+ **indexConfig** (`IndexConfig`): Configuration for the index type and parameters
226
242
 
227
243
  Builds or rebuilds an index with specified metric and configuration. Will drop any existing index before creating the new one.
228
244
 
@@ -4,9 +4,9 @@ The UpstashVector class provides vector search using [Upstash Vector](https://up
4
4
 
5
5
  ## Constructor Options
6
6
 
7
- **url:** (`string`): Upstash Vector database URL
7
+ **url** (`string`): Upstash Vector database URL
8
8
 
9
- **token:** (`string`): Upstash Vector API token
9
+ **token** (`string`): Upstash Vector API token
10
10
 
11
11
  ## Methods
12
12
 
@@ -14,41 +14,41 @@ The UpstashVector class provides vector search using [Upstash Vector](https://up
14
14
 
15
15
  Note: This method is a no-op for Upstash as indexes are created automatically.
16
16
 
17
- **indexName:** (`string`): Name of the index to create
17
+ **indexName** (`string`): Name of the index to create
18
18
 
19
- **dimension:** (`number`): Vector dimension (must match your embedding model)
19
+ **dimension** (`number`): Vector dimension (must match your embedding model)
20
20
 
21
- **metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
21
+ **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
22
22
 
23
23
  ### upsert()
24
24
 
25
- **indexName:** (`string`): Name of the index to upsert into
25
+ **indexName** (`string`): Name of the index to upsert into
26
26
 
27
- **vectors:** (`number[][]`): Array of embedding vectors
27
+ **vectors** (`number[][]`): Array of embedding vectors
28
28
 
29
- **sparseVectors?:** (`{ indices: number[], values: number[] }[]`): Array of sparse vectors for hybrid search. Each sparse vector must have matching indices and values arrays.
29
+ **sparseVectors** (`{ indices: number[], values: number[] }[]`): Array of sparse vectors for hybrid search. Each sparse vector must have matching indices and values arrays.
30
30
 
31
- **metadata?:** (`Record<string, any>[]`): Metadata for each vector
31
+ **metadata** (`Record<string, any>[]`): Metadata for each vector
32
32
 
33
- **ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
33
+ **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
34
34
 
35
35
  ### query()
36
36
 
37
- **indexName:** (`string`): Name of the index to query
37
+ **indexName** (`string`): Name of the index to query
38
38
 
39
- **queryVector:** (`number[]`): Query vector to find similar vectors
39
+ **queryVector** (`number[]`): Query vector to find similar vectors
40
40
 
41
- **sparseVector?:** (`{ indices: number[], values: number[] }`): Optional sparse vector for hybrid search. Must have matching indices and values arrays.
41
+ **sparseVector** (`{ indices: number[], values: number[] }`): Optional sparse vector for hybrid search. Must have matching indices and values arrays.
42
42
 
43
- **topK?:** (`number`): Number of results to return (Default: `10`)
43
+ **topK** (`number`): Number of results to return (Default: `10`)
44
44
 
45
- **filter?:** (`Record<string, any>`): Metadata filters for the query
45
+ **filter** (`Record<string, any>`): Metadata filters for the query
46
46
 
47
- **includeVector?:** (`boolean`): Whether to include vectors in the results (Default: `false`)
47
+ **includeVector** (`boolean`): Whether to include vectors in the results (Default: `false`)
48
48
 
49
- **fusionAlgorithm?:** (`FusionAlgorithm`): Algorithm used to combine dense and sparse search results in hybrid search (e.g., RRF - Reciprocal Rank Fusion)
49
+ **fusionAlgorithm** (`FusionAlgorithm`): Algorithm used to combine dense and sparse search results in hybrid search (e.g., RRF - Reciprocal Rank Fusion)
50
50
 
51
- **queryMode?:** (`QueryMode`): Search mode: 'DENSE' for dense-only, 'SPARSE' for sparse-only, or 'HYBRID' for combined search
51
+ **queryMode** (`QueryMode`): Search mode: 'DENSE' for dense-only, 'SPARSE' for sparse-only, or 'HYBRID' for combined search
52
52
 
53
53
  ### listIndexes()
54
54
 
@@ -56,7 +56,7 @@ Returns an array of index names (namespaces) as strings.
56
56
 
57
57
  ### describeIndex()
58
58
 
59
- **indexName:** (`string`): Name of the index to describe
59
+ **indexName** (`string`): Name of the index to describe
60
60
 
61
61
  Returns:
62
62
 
@@ -70,15 +70,15 @@ interface IndexStats {
70
70
 
71
71
  ### deleteIndex()
72
72
 
73
- **indexName:** (`string`): Name of the index (namespace) to delete
73
+ **indexName** (`string`): Name of the index (namespace) to delete
74
74
 
75
75
  ### updateVector()
76
76
 
77
- **indexName:** (`string`): Name of the index to update
77
+ **indexName** (`string`): Name of the index to update
78
78
 
79
- **id:** (`string`): ID of the item to update
79
+ **id** (`string`): ID of the item to update
80
80
 
81
- **update:** (`object`): Update object containing vector, sparse vector, and/or metadata
81
+ **update** (`object`): Update object containing vector, sparse vector, and/or metadata
82
82
 
83
83
  The `update` object can have the following properties:
84
84
 
@@ -88,9 +88,9 @@ The `update` object can have the following properties:
88
88
 
89
89
  ### deleteVector()
90
90
 
91
- **indexName:** (`string`): Name of the index from which to delete the item
91
+ **indexName** (`string`): Name of the index from which to delete the item
92
92
 
93
- **id:** (`string`): ID of the item to delete
93
+ **id** (`string`): ID of the item to delete
94
94
 
95
95
  Attempts to delete an item by its ID from the specified index. Logs an error message if the deletion fails.
96
96
 
@@ -6,13 +6,13 @@ CompositeVoice supports both Mastra voice providers and AI SDK model providers
6
6
 
7
7
  ## Constructor Parameters
8
8
 
9
- **config:** (`object`): Configuration object for the composite voice service
9
+ **config** (`object`): Configuration object for the composite voice service
10
10
 
11
- **config.input?:** (`MastraVoice | TranscriptionModel`): Voice provider or AI SDK transcription model to use for speech-to-text operations. AI SDK models are automatically wrapped.
11
+ **config.input** (`MastraVoice | TranscriptionModel`): Voice provider or AI SDK transcription model to use for speech-to-text operations. AI SDK models are automatically wrapped.
12
12
 
13
- **config.output?:** (`MastraVoice | SpeechModel`): Voice provider or AI SDK speech model to use for text-to-speech operations. AI SDK models are automatically wrapped.
13
+ **config.output** (`MastraVoice | SpeechModel`): Voice provider or AI SDK speech model to use for text-to-speech operations. AI SDK models are automatically wrapped.
14
14
 
15
- **config.realtime?:** (`MastraVoice`): Voice provider to use for real-time speech-to-speech operations
15
+ **config.realtime** (`MastraVoice`): Voice provider to use for real-time speech-to-speech operations
16
16
 
17
17
  ## Methods
18
18
 
@@ -20,9 +20,9 @@ CompositeVoice supports both Mastra voice providers and AI SDK model providers
20
20
 
21
21
  Converts text to speech using the configured speaking provider.
22
22
 
23
- **input:** (`string | NodeJS.ReadableStream`): Text to convert to speech
23
+ **input** (`string | NodeJS.ReadableStream`): Text to convert to speech
24
24
 
25
- **options?:** (`object`): Provider-specific options passed to the speaking provider
25
+ **options** (`object`): Provider-specific options passed to the speaking provider
26
26
 
27
27
  Notes:
28
28
 
@@ -34,9 +34,9 @@ Notes:
34
34
 
35
35
  Converts speech to text using the configured listening provider.
36
36
 
37
- **audioStream:** (`NodeJS.ReadableStream`): Audio stream to convert to text
37
+ **audioStream** (`NodeJS.ReadableStream`): Audio stream to convert to text
38
38
 
39
- **options?:** (`object`): Provider-specific options passed to the listening provider
39
+ **options** (`object`): Provider-specific options passed to the listening provider
40
40
 
41
41
  Notes:
42
42
 
@@ -48,9 +48,9 @@ Notes:
48
48
 
49
49
  Returns a list of available voices from the speaking provider, where each node contains:
50
50
 
51
- **voiceId:** (`string`): Unique identifier for the voice
51
+ **voiceId** (`string`): Unique identifier for the voice
52
52
 
53
- **key?:** (`value`): Additional voice properties that vary by provider (e.g., name, language)
53
+ **key** (`value`): Additional voice properties that vary by provider (e.g., name, language)
54
54
 
55
55
  Notes:
56
56
 
@@ -79,31 +79,31 @@ class MyVoiceProvider extends MastraVoice {
79
79
 
80
80
  ## Constructor Parameters
81
81
 
82
- **config?:** (`VoiceConfig`): Configuration object for the voice service
82
+ **config** (`VoiceConfig`): Configuration object for the voice service
83
83
 
84
- **config.speechModel?:** (`BuiltInModelConfig`): Configuration for the text-to-speech model
84
+ **config.speechModel** (`BuiltInModelConfig`): Configuration for the text-to-speech model
85
85
 
86
- **config.listeningModel?:** (`BuiltInModelConfig`): Configuration for the speech-to-text model
86
+ **config.speechModel.name** (`string`): Name of the model to use
87
87
 
88
- **config.speaker?:** (`string`): Default speaker/voice ID to use
88
+ **config.speechModel.apiKey** (`string`): API key for the model service
89
89
 
90
- **config.name?:** (`string`): Name for the voice provider instance
90
+ **config.listeningModel** (`BuiltInModelConfig`): Configuration for the speech-to-text model
91
91
 
92
- **config.realtimeConfig?:** (`object`): Configuration for real-time speech-to-speech capabilities
92
+ **config.listeningModel.name** (`string`): Name of the model to use
93
93
 
94
- ### BuiltInModelConfig
94
+ **config.listeningModel.apiKey** (`string`): API key for the model service
95
95
 
96
- **name:** (`string`): Name of the model to use
96
+ **config.speaker** (`string`): Default speaker/voice ID to use
97
97
 
98
- **apiKey?:** (`string`): API key for the model service
98
+ **config.name** (`string`): Name for the voice provider instance
99
99
 
100
- ### RealtimeConfig
100
+ **config.realtimeConfig** (`object`): Configuration for real-time speech-to-speech capabilities
101
101
 
102
- **model?:** (`string`): Model to use for real-time speech-to-speech capabilities
102
+ **config.realtimeConfig.model** (`string`): Model to use for real-time speech-to-speech capabilities
103
103
 
104
- **apiKey?:** (`string`): API key for the real-time service
104
+ **config.realtimeConfig.apiKey** (`string`): API key for the real-time service
105
105
 
106
- **options?:** (`unknown`): Provider-specific options for real-time capabilities
106
+ **config.realtimeConfig.options** (`unknown`): Provider-specific options for real-time capabilities
107
107
 
108
108
  ## Abstract Methods
109
109
 
@@ -281,21 +281,21 @@ Purpose:
281
281
 
282
282
  The MastraVoice class includes an event system for real-time communication. Standard event types include:
283
283
 
284
- **speaking:** (`{ text: string; audioStream?: NodeJS.ReadableStream; audio?: Int16Array }`): Emitted when the voice provider is speaking, contains audio data
284
+ **speaking** (`{ text: string; audioStream?: NodeJS.ReadableStream; audio?: Int16Array }`): Emitted when the voice provider is speaking, contains audio data
285
285
 
286
- **writing:** (`{ text: string, role: string }`): Emitted when text is transcribed from speech
286
+ **writing** (`{ text: string, role: string }`): Emitted when text is transcribed from speech
287
287
 
288
- **error:** (`{ message: string; code?: string; details?: unknown }`): Emitted when an error occurs
288
+ **error** (`{ message: string; code?: string; details?: unknown }`): Emitted when an error occurs
289
289
 
290
290
  ## Protected Properties
291
291
 
292
- **listeningModel?:** (`BuiltInModelConfig | undefined`): Configuration for the speech-to-text model
292
+ **listeningModel** (`BuiltInModelConfig | undefined`): Configuration for the speech-to-text model
293
293
 
294
- **speechModel?:** (`BuiltInModelConfig | undefined`): Configuration for the text-to-speech model
294
+ **speechModel** (`BuiltInModelConfig | undefined`): Configuration for the text-to-speech model
295
295
 
296
- **speaker?:** (`string | undefined`): Default speaker/voice ID
296
+ **speaker** (`string | undefined`): Default speaker/voice ID
297
297
 
298
- **realtimeConfig?:** (`{ model?: string; apiKey?: string; options?: unknown } | undefined`): Configuration for real-time speech-to-speech capabilities
298
+ **realtimeConfig** (`{ model?: string; apiKey?: string; options?: unknown } | undefined`): Configuration for real-time speech-to-speech capabilities
299
299
 
300
300
  ## Telemetry Support
301
301
 
@@ -39,7 +39,7 @@ await voice.connect()
39
39
 
40
40
  ## Parameters
41
41
 
42
- **instructions:** (`string`): Instructions to guide the voice model's behavior
42
+ **instructions** (`string`): Instructions to guide the voice model's behavior
43
43
 
44
44
  ## Return Value
45
45
 
@@ -50,7 +50,7 @@ await voice.connect()
50
50
 
51
51
  ## Parameters
52
52
 
53
- **tools:** (`ToolsInput`): Object containing tool definitions that can be called by the voice model
53
+ **tools** (`ToolsInput`): Object containing tool definitions that can be called by the voice model
54
54
 
55
55
  ## Return Value
56
56
 
@@ -46,7 +46,7 @@ await voice.connect({
46
46
 
47
47
  ## Parameters
48
48
 
49
- **options?:** (`Record<string, unknown>`): Provider-specific connection options
49
+ **options** (`Record<string, unknown>`): Provider-specific connection options
50
50
 
51
51
  ## Return Value
52
52
 
@@ -58,9 +58,9 @@ Each real-time voice provider may support different options for the `connect()`
58
58
 
59
59
  ### OpenAI Realtime
60
60
 
61
- **options.timeout?:** (`number`): Connection timeout in milliseconds (Default: `30000`)
61
+ **options.timeout** (`number`): Connection timeout in milliseconds (Default: `30000`)
62
62
 
63
- **options.reconnect?:** (`boolean`): Whether to automatically reconnect on connection loss (Default: `false`)
63
+ **options.reconnect** (`boolean`): Whether to automatically reconnect on connection loss (Default: `false`)
64
64
 
65
65
  ## Using with CompositeVoice
66
66
 
@@ -6,27 +6,27 @@ Voice providers emit various events during real-time voice interactions. These e
6
6
 
7
7
  These events are commonly implemented across real-time voice providers:
8
8
 
9
- **error:** (`Error`): Emitted when an error occurs during voice processing or when audio data format is unsupported
9
+ **error** (`Error`): Emitted when an error occurs during voice processing or when audio data format is unsupported
10
10
 
11
- **session.created:** (`object`): Emitted when a new session is created with the OpenAI service
11
+ **session.created** (`object`): Emitted when a new session is created with the OpenAI service
12
12
 
13
- **session.updated:** (`object`): Emitted when the session configuration is updated
13
+ **session.updated** (`object`): Emitted when the session configuration is updated
14
14
 
15
- **response.created:** (`object`): Emitted when a new response is created by the AI assistant
15
+ **response.created** (`object`): Emitted when a new response is created by the AI assistant
16
16
 
17
- **response.done:** (`object`): Emitted when the AI assistant has completed its response
17
+ **response.done** (`object`): Emitted when the AI assistant has completed its response
18
18
 
19
- **speaker:** (`StreamWithId`): Emitted with a new audio stream that can be piped to an audio output
19
+ **speaker** (`StreamWithId`): Emitted with a new audio stream that can be piped to an audio output
20
20
 
21
- **writing:** (`object`): Emitted when text is being transcribed (user) or generated (assistant)
21
+ **writing** (`object`): Emitted when text is being transcribed (user) or generated (assistant)
22
22
 
23
- **speaking:** (`object`): Emitted when audio data is available from the voice provider
23
+ **speaking** (`object`): Emitted when audio data is available from the voice provider
24
24
 
25
- **speaking.done:** (`object`): Emitted when the voice provider has finished speaking
25
+ **speaking.done** (`object`): Emitted when the voice provider has finished speaking
26
26
 
27
- **tool-call-start:** (`object`): Emitted when the AI assistant starts executing a tool
27
+ **tool-call-start** (`object`): Emitted when the AI assistant starts executing a tool
28
28
 
29
- **tool-call-result:** (`object`): Emitted when a tool execution is complete with its result
29
+ **tool-call-result** (`object`): Emitted when a tool execution is complete with its result
30
30
 
31
31
  ## Notes
32
32
 
@@ -4,9 +4,9 @@ The `listen()` method is a core function available in all Mastra voice providers
4
4
 
5
5
  ## Parameters
6
6
 
7
- **audioStream:** (`NodeJS.ReadableStream`): Audio stream to transcribe. This can be a file stream or a microphone stream.
7
+ **audioStream** (`NodeJS.ReadableStream`): Audio stream to transcribe. This can be a file stream or a microphone stream.
8
8
 
9
- **options?:** (`object`): Provider-specific options for speech recognition
9
+ **options** (`object`): Provider-specific options for speech recognition
10
10
 
11
11
  ## Return Value
12
12
 
@@ -22,23 +22,23 @@ Each voice provider may support additional options specific to their implementat
22
22
 
23
23
  ### OpenAI
24
24
 
25
- **options.filetype?:** (`string`): Audio file format (e.g., 'mp3', 'wav', 'm4a') (Default: `'mp3'`)
25
+ **options.filetype** (`string`): Audio file format (e.g., 'mp3', 'wav', 'm4a') (Default: `'mp3'`)
26
26
 
27
- **options.prompt?:** (`string`): Text to guide the model's transcription
27
+ **options.prompt** (`string`): Text to guide the model's transcription
28
28
 
29
- **options.language?:** (`string`): Language code (e.g., 'en', 'fr', 'de')
29
+ **options.language** (`string`): Language code (e.g., 'en', 'fr', 'de')
30
30
 
31
31
  ### Google
32
32
 
33
- **options.stream?:** (`boolean`): Whether to use streaming recognition (Default: `false`)
33
+ **options.stream** (`boolean`): Whether to use streaming recognition (Default: `false`)
34
34
 
35
- **options.config?:** (`object`): Recognition configuration from Google Cloud Speech-to-Text API (Default: `{ encoding: 'LINEAR16', languageCode: 'en-US' }`)
35
+ **options.config** (`object`): Recognition configuration from Google Cloud Speech-to-Text API (Default: `{ encoding: 'LINEAR16', languageCode: 'en-US' }`)
36
36
 
37
37
  ### Deepgram
38
38
 
39
- **options.model?:** (`string`): Deepgram model to use for transcription (Default: `'nova-2'`)
39
+ **options.model** (`string`): Deepgram model to use for transcription (Default: `'nova-2'`)
40
40
 
41
- **options.language?:** (`string`): Language code for transcription (Default: `'en'`)
41
+ **options.language** (`string`): Language code for transcription (Default: `'en'`)
42
42
 
43
43
  ## Usage Example
44
44
 
@@ -48,9 +48,9 @@ voice.on('error', ({ message, code, details }) => {
48
48
 
49
49
  ## Parameters
50
50
 
51
- **event:** (`string`): Name of the event to listen for. See the \[Voice Events]\(./voice.events) documentation for a list of available events.
51
+ **event** (`string`): Name of the event to listen for. See the \[Voice Events]\(./voice.events) documentation for a list of available events.
52
52
 
53
- **callback:** (`function`): Callback function that will be called when the event occurs. The callback signature depends on the specific event.
53
+ **callback** (`function`): Callback function that will be called when the event occurs. The callback signature depends on the specific event.
54
54
 
55
55
  ## Return Value
56
56
 
@@ -4,11 +4,11 @@ The `speak()` method is a core function available in all Mastra voice providers
4
4
 
5
5
  ## Parameters
6
6
 
7
- **input:** (`string | NodeJS.ReadableStream`): Text to convert to speech. Can be a string or a readable stream of text.
7
+ **input** (`string | NodeJS.ReadableStream`): Text to convert to speech. Can be a string or a readable stream of text.
8
8
 
9
- **options?:** (`object`): Options for speech synthesis
9
+ **options** (`object`): Options for speech synthesis
10
10
 
11
- **options.speaker?:** (`string`): Voice ID to use for this specific request. Overrides the default speaker set in the constructor.
11
+ **options.speaker** (`string`): Voice ID to use for this specific request. Overrides the default speaker set in the constructor.
12
12
 
13
13
  ## Return Value
14
14
 
@@ -23,27 +23,27 @@ Each voice provider may support additional options specific to their implementat
23
23
 
24
24
  ### OpenAI
25
25
 
26
- **options.speed?:** (`number`): Speech speed multiplier. Values between 0.25 and 4.0 are supported. (Default: `1.0`)
26
+ **options.speed** (`number`): Speech speed multiplier. Values between 0.25 and 4.0 are supported. (Default: `1.0`)
27
27
 
28
28
  ### ElevenLabs
29
29
 
30
- **options.stability?:** (`number`): Voice stability. Higher values result in more stable, less expressive speech. (Default: `0.5`)
30
+ **options.stability** (`number`): Voice stability. Higher values result in more stable, less expressive speech. (Default: `0.5`)
31
31
 
32
- **options.similarity\_boost?:** (`number`): Voice clarity and similarity to the original voice. (Default: `0.75`)
32
+ **options.similarity\_boost** (`number`): Voice clarity and similarity to the original voice. (Default: `0.75`)
33
33
 
34
34
  ### Google
35
35
 
36
- **options.languageCode?:** (`string`): Language code for the voice (e.g., 'en-US').
36
+ **options.languageCode** (`string`): Language code for the voice (e.g., 'en-US').
37
37
 
38
- **options.audioConfig?:** (`object`): Audio configuration options from Google Cloud Text-to-Speech API. (Default: `{ audioEncoding: 'LINEAR16' }`)
38
+ **options.audioConfig** (`object`): Audio configuration options from Google Cloud Text-to-Speech API. (Default: `{ audioEncoding: 'LINEAR16' }`)
39
39
 
40
40
  ### Murf
41
41
 
42
- **options.properties.rate?:** (`number`): Speech rate multiplier.
42
+ **options.properties.rate** (`number`): Speech rate multiplier.
43
43
 
44
- **options.properties.pitch?:** (`number`): Voice pitch adjustment.
44
+ **options.properties.pitch** (`number`): Voice pitch adjustment.
45
45
 
46
- **options.properties.format?:** (`'MP3' | 'WAV' | 'FLAC' | 'ALAW' | 'ULAW'`): Output audio format.
46
+ **options.properties.format** (`'MP3' | 'WAV' | 'FLAC' | 'ALAW' | 'ULAW'`): Output audio format.
47
47
 
48
48
  ## Usage Example
49
49
 
@@ -15,11 +15,11 @@ await run.cancel()
15
15
 
16
16
  ## Parameters
17
17
 
18
- **No parameters:** (`void`): This method takes no parameters
18
+ **No parameters** (`void`): This method takes no parameters
19
19
 
20
20
  ## Returns
21
21
 
22
- **result:** (`Promise<{ message: string }>`): A promise that resolves with { message: 'Workflow run canceled' } when cancellation succeeds
22
+ **result** (`Promise<{ message: string }>`): A promise that resolves with { message: 'Workflow run canceled' } when cancellation succeeds
23
23
 
24
24
  ## How cancellation works
25
25