@mastra/mcp-docs-server 0.13.37 → 0.13.39-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 (450) hide show
  1. package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +2 -0
  2. package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +2 -0
  3. package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +8 -8
  4. package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +2 -0
  5. package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +11 -11
  6. package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +16 -16
  7. package/.docs/organized/changelogs/%40mastra%2Fastra.md +10 -10
  8. package/.docs/organized/changelogs/%40mastra%2Fauth.md +6 -0
  9. package/.docs/organized/changelogs/%40mastra%2Fchroma.md +11 -11
  10. package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +10 -10
  11. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +38 -38
  12. package/.docs/organized/changelogs/%40mastra%2Fcloud.md +10 -10
  13. package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +10 -10
  14. package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +10 -10
  15. package/.docs/organized/changelogs/%40mastra%2Fcore.md +88 -88
  16. package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +11 -11
  17. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +28 -28
  18. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +27 -27
  19. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +27 -27
  20. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +27 -27
  21. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +59 -59
  22. package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +11 -11
  23. package/.docs/organized/changelogs/%40mastra%2Fevals.md +11 -11
  24. package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +6 -0
  25. package/.docs/organized/changelogs/%40mastra%2Flance.md +10 -10
  26. package/.docs/organized/changelogs/%40mastra%2Flibsql.md +11 -11
  27. package/.docs/organized/changelogs/%40mastra%2Floggers.md +11 -11
  28. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +25 -25
  29. package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +10 -10
  30. package/.docs/organized/changelogs/%40mastra%2Fmcp.md +11 -11
  31. package/.docs/organized/changelogs/%40mastra%2Fmemory.md +11 -11
  32. package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +10 -10
  33. package/.docs/organized/changelogs/%40mastra%2Fmssql.md +11 -11
  34. package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +10 -10
  35. package/.docs/organized/changelogs/%40mastra%2Fpg.md +10 -10
  36. package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +10 -10
  37. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +48 -48
  38. package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +11 -11
  39. package/.docs/organized/changelogs/%40mastra%2Frag.md +10 -10
  40. package/.docs/organized/changelogs/%40mastra%2Freact.md +24 -24
  41. package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +9 -0
  42. package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +6 -0
  43. package/.docs/organized/changelogs/%40mastra%2Fserver.md +40 -40
  44. package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +10 -10
  45. package/.docs/organized/changelogs/%40mastra%2Fupstash.md +10 -10
  46. package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +10 -10
  47. package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +10 -10
  48. package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +11 -11
  49. package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +11 -11
  50. package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +11 -11
  51. package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +11 -11
  52. package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +11 -1
  53. package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +10 -10
  54. package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +11 -11
  55. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +10 -10
  56. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +10 -10
  57. package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +11 -11
  58. package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +11 -11
  59. package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +10 -10
  60. package/.docs/organized/changelogs/create-mastra.md +11 -11
  61. package/.docs/organized/changelogs/mastra.md +34 -34
  62. package/.docs/raw/agents/adding-voice.mdx +20 -9
  63. package/.docs/raw/agents/agent-memory.mdx +55 -39
  64. package/.docs/raw/agents/guardrails.mdx +68 -61
  65. package/.docs/raw/agents/networks.mdx +50 -46
  66. package/.docs/raw/agents/overview.mdx +126 -89
  67. package/.docs/raw/agents/using-tools.mdx +14 -15
  68. package/.docs/raw/auth/auth0.mdx +28 -27
  69. package/.docs/raw/auth/clerk.mdx +22 -20
  70. package/.docs/raw/auth/firebase.mdx +42 -39
  71. package/.docs/raw/auth/index.mdx +1 -1
  72. package/.docs/raw/auth/jwt.mdx +18 -16
  73. package/.docs/raw/auth/supabase.mdx +20 -18
  74. package/.docs/raw/auth/workos.mdx +32 -26
  75. package/.docs/raw/community/contributing-templates.mdx +7 -7
  76. package/.docs/raw/community/discord.mdx +2 -2
  77. package/.docs/raw/community/licensing.mdx +1 -1
  78. package/.docs/raw/course/02-agent-tools-mcp/04-initializing-mcp-tools.md +2 -2
  79. package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -1
  80. package/.docs/raw/course/03-agent-memory/26-updating-mastra-export-comprehensive.md +0 -32
  81. package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +41 -22
  82. package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +48 -29
  83. package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +52 -24
  84. package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +86 -55
  85. package/.docs/raw/deployment/cloud-providers/index.mdx +16 -13
  86. package/.docs/raw/deployment/monorepo.mdx +32 -42
  87. package/.docs/raw/deployment/overview.mdx +15 -15
  88. package/.docs/raw/deployment/server-deployment.mdx +18 -23
  89. package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +16 -17
  90. package/.docs/raw/deployment/serverless-platforms/index.mdx +15 -12
  91. package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +14 -23
  92. package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +16 -23
  93. package/.docs/raw/deployment/web-framework.mdx +14 -14
  94. package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +130 -121
  95. package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +54 -43
  96. package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +51 -36
  97. package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +161 -120
  98. package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +60 -49
  99. package/.docs/raw/frameworks/servers/express.mdx +46 -45
  100. package/.docs/raw/frameworks/web-frameworks/astro.mdx +245 -162
  101. package/.docs/raw/frameworks/web-frameworks/next-js.mdx +112 -69
  102. package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +171 -130
  103. package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +94 -81
  104. package/.docs/raw/getting-started/installation.mdx +165 -134
  105. package/.docs/raw/getting-started/mcp-docs-server.mdx +36 -39
  106. package/.docs/raw/getting-started/project-structure.mdx +34 -42
  107. package/.docs/raw/getting-started/studio.mdx +42 -50
  108. package/.docs/raw/getting-started/templates.mdx +18 -15
  109. package/.docs/raw/index.mdx +9 -9
  110. package/.docs/raw/mastra-cloud/dashboard.mdx +12 -12
  111. package/.docs/raw/mastra-cloud/observability.mdx +9 -10
  112. package/.docs/raw/mastra-cloud/overview.mdx +17 -23
  113. package/.docs/raw/mastra-cloud/setting-up.mdx +33 -20
  114. package/.docs/raw/memory/conversation-history.mdx +2 -2
  115. package/.docs/raw/memory/overview.mdx +22 -24
  116. package/.docs/raw/memory/semantic-recall.mdx +16 -17
  117. package/.docs/raw/memory/storage/memory-with-libsql.mdx +27 -28
  118. package/.docs/raw/memory/storage/memory-with-pg.mdx +26 -26
  119. package/.docs/raw/memory/storage/memory-with-upstash.mdx +26 -27
  120. package/.docs/raw/memory/threads-and-resources.mdx +24 -21
  121. package/.docs/raw/memory/working-memory.mdx +27 -38
  122. package/.docs/raw/observability/ai-tracing/exporters/arize.mdx +30 -29
  123. package/.docs/raw/observability/ai-tracing/exporters/braintrust.mdx +8 -9
  124. package/.docs/raw/observability/ai-tracing/exporters/cloud.mdx +17 -16
  125. package/.docs/raw/observability/ai-tracing/exporters/default.mdx +37 -38
  126. package/.docs/raw/observability/ai-tracing/exporters/langfuse.mdx +18 -17
  127. package/.docs/raw/observability/ai-tracing/exporters/langsmith.mdx +14 -14
  128. package/.docs/raw/observability/ai-tracing/exporters/otel.mdx +56 -46
  129. package/.docs/raw/observability/ai-tracing/overview.mdx +151 -128
  130. package/.docs/raw/observability/ai-tracing/processors/sensitive-data-filter.mdx +57 -36
  131. package/.docs/raw/observability/logging.mdx +14 -17
  132. package/.docs/raw/observability/nextjs-tracing.mdx +5 -5
  133. package/.docs/raw/observability/otel-tracing.mdx +17 -18
  134. package/.docs/raw/observability/overview.mdx +15 -11
  135. package/.docs/raw/rag/chunking-and-embedding.mdx +10 -8
  136. package/.docs/raw/rag/overview.mdx +5 -5
  137. package/.docs/raw/rag/retrieval.mdx +125 -107
  138. package/.docs/raw/rag/vector-databases.mdx +232 -223
  139. package/.docs/raw/reference/agents/agent.mdx +56 -43
  140. package/.docs/raw/reference/agents/generate.mdx +367 -261
  141. package/.docs/raw/reference/agents/generateLegacy.mdx +260 -178
  142. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +7 -5
  143. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +7 -5
  144. package/.docs/raw/reference/agents/getDescription.mdx +3 -2
  145. package/.docs/raw/reference/agents/getInstructions.mdx +7 -5
  146. package/.docs/raw/reference/agents/getLLM.mdx +11 -7
  147. package/.docs/raw/reference/agents/getMemory.mdx +7 -5
  148. package/.docs/raw/reference/agents/getModel.mdx +7 -5
  149. package/.docs/raw/reference/agents/getScorers.mdx +7 -5
  150. package/.docs/raw/reference/agents/getTools.mdx +7 -5
  151. package/.docs/raw/reference/agents/getVoice.mdx +7 -5
  152. package/.docs/raw/reference/agents/getWorkflows.mdx +7 -5
  153. package/.docs/raw/reference/agents/listAgents.mdx +6 -4
  154. package/.docs/raw/reference/agents/listScorers.mdx +69 -0
  155. package/.docs/raw/reference/agents/listTools.mdx +69 -0
  156. package/.docs/raw/reference/agents/listWorkflows.mdx +69 -0
  157. package/.docs/raw/reference/agents/network.mdx +171 -116
  158. package/.docs/raw/reference/auth/auth0.mdx +18 -14
  159. package/.docs/raw/reference/auth/clerk.mdx +15 -12
  160. package/.docs/raw/reference/auth/firebase.mdx +23 -16
  161. package/.docs/raw/reference/auth/jwt.mdx +7 -6
  162. package/.docs/raw/reference/auth/supabase.mdx +13 -10
  163. package/.docs/raw/reference/auth/workos.mdx +17 -13
  164. package/.docs/raw/reference/cli/create-mastra.mdx +61 -44
  165. package/.docs/raw/reference/cli/mastra.mdx +11 -11
  166. package/.docs/raw/reference/client-js/agents.mdx +41 -44
  167. package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
  168. package/.docs/raw/reference/client-js/logs.mdx +2 -2
  169. package/.docs/raw/reference/client-js/mastra-client.mdx +28 -20
  170. package/.docs/raw/reference/client-js/memory.mdx +7 -3
  171. package/.docs/raw/reference/client-js/observability.mdx +10 -9
  172. package/.docs/raw/reference/client-js/telemetry.mdx +1 -1
  173. package/.docs/raw/reference/client-js/tools.mdx +2 -2
  174. package/.docs/raw/reference/client-js/vectors.mdx +1 -1
  175. package/.docs/raw/reference/client-js/workflows-legacy.mdx +1 -1
  176. package/.docs/raw/reference/client-js/workflows.mdx +8 -8
  177. package/.docs/raw/reference/core/getAgent.mdx +6 -5
  178. package/.docs/raw/reference/core/getAgentById.mdx +5 -4
  179. package/.docs/raw/reference/core/getAgents.mdx +3 -3
  180. package/.docs/raw/reference/core/getDeployer.mdx +4 -3
  181. package/.docs/raw/reference/core/getLogger.mdx +4 -3
  182. package/.docs/raw/reference/core/getLogs.mdx +10 -6
  183. package/.docs/raw/reference/core/getLogsByRunId.mdx +8 -5
  184. package/.docs/raw/reference/core/getMCPServer.mdx +8 -5
  185. package/.docs/raw/reference/core/getMCPServers.mdx +4 -3
  186. package/.docs/raw/reference/core/getMemory.mdx +4 -3
  187. package/.docs/raw/reference/core/getScorer.mdx +15 -12
  188. package/.docs/raw/reference/core/getScorerByName.mdx +13 -10
  189. package/.docs/raw/reference/core/getScorers.mdx +3 -2
  190. package/.docs/raw/reference/core/getServer.mdx +4 -3
  191. package/.docs/raw/reference/core/getStorage.mdx +4 -3
  192. package/.docs/raw/reference/core/getTelemetry.mdx +4 -3
  193. package/.docs/raw/reference/core/getVector.mdx +6 -4
  194. package/.docs/raw/reference/core/getVectors.mdx +4 -3
  195. package/.docs/raw/reference/core/getWorkflow.mdx +7 -4
  196. package/.docs/raw/reference/core/getWorkflows.mdx +5 -3
  197. package/.docs/raw/reference/core/listAgents.mdx +35 -0
  198. package/.docs/raw/reference/core/listLogs.mdx +96 -0
  199. package/.docs/raw/reference/core/listLogsByRunId.mdx +87 -0
  200. package/.docs/raw/reference/core/listScorers.mdx +43 -0
  201. package/.docs/raw/reference/core/listWorkflows.mdx +45 -0
  202. package/.docs/raw/reference/core/mastra-class.mdx +16 -16
  203. package/.docs/raw/reference/core/setLogger.mdx +6 -4
  204. package/.docs/raw/reference/core/setStorage.mdx +4 -4
  205. package/.docs/raw/reference/core/setTelemetry.mdx +4 -3
  206. package/.docs/raw/reference/deployer/cloudflare.mdx +11 -7
  207. package/.docs/raw/reference/deployer/deployer.mdx +2 -1
  208. package/.docs/raw/reference/deployer/netlify.mdx +4 -4
  209. package/.docs/raw/reference/deployer/vercel.mdx +6 -6
  210. package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -5
  211. package/.docs/raw/reference/evals/bias.mdx +4 -5
  212. package/.docs/raw/reference/evals/completeness.mdx +4 -5
  213. package/.docs/raw/reference/evals/content-similarity.mdx +4 -5
  214. package/.docs/raw/reference/evals/context-position.mdx +4 -5
  215. package/.docs/raw/reference/evals/context-precision.mdx +4 -5
  216. package/.docs/raw/reference/evals/context-relevancy.mdx +4 -5
  217. package/.docs/raw/reference/evals/contextual-recall.mdx +4 -5
  218. package/.docs/raw/reference/evals/faithfulness.mdx +4 -5
  219. package/.docs/raw/reference/evals/hallucination.mdx +4 -6
  220. package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -5
  221. package/.docs/raw/reference/evals/prompt-alignment.mdx +4 -6
  222. package/.docs/raw/reference/evals/summarization.mdx +4 -6
  223. package/.docs/raw/reference/evals/textual-difference.mdx +4 -5
  224. package/.docs/raw/reference/evals/tone-consistency.mdx +4 -7
  225. package/.docs/raw/reference/evals/toxicity.mdx +4 -5
  226. package/.docs/raw/reference/index.mdx +3 -3
  227. package/.docs/raw/reference/legacyWorkflows/after.mdx +5 -5
  228. package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +5 -5
  229. package/.docs/raw/reference/legacyWorkflows/commit.mdx +5 -5
  230. package/.docs/raw/reference/legacyWorkflows/createRun.mdx +4 -4
  231. package/.docs/raw/reference/legacyWorkflows/else.mdx +5 -5
  232. package/.docs/raw/reference/legacyWorkflows/events.mdx +7 -7
  233. package/.docs/raw/reference/legacyWorkflows/execute.mdx +4 -4
  234. package/.docs/raw/reference/legacyWorkflows/if.mdx +5 -5
  235. package/.docs/raw/reference/legacyWorkflows/resume.mdx +5 -5
  236. package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +6 -6
  237. package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +6 -6
  238. package/.docs/raw/reference/legacyWorkflows/start.mdx +6 -6
  239. package/.docs/raw/reference/legacyWorkflows/step-class.mdx +4 -4
  240. package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +4 -4
  241. package/.docs/raw/reference/legacyWorkflows/step-function.mdx +5 -5
  242. package/.docs/raw/reference/legacyWorkflows/step-options.mdx +6 -6
  243. package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +4 -4
  244. package/.docs/raw/reference/legacyWorkflows/suspend.mdx +4 -4
  245. package/.docs/raw/reference/legacyWorkflows/then.mdx +5 -5
  246. package/.docs/raw/reference/legacyWorkflows/until.mdx +4 -4
  247. package/.docs/raw/reference/legacyWorkflows/watch.mdx +3 -3
  248. package/.docs/raw/reference/legacyWorkflows/while.mdx +4 -4
  249. package/.docs/raw/reference/legacyWorkflows/workflow.mdx +7 -7
  250. package/.docs/raw/reference/memory/createThread.mdx +10 -10
  251. package/.docs/raw/reference/memory/deleteMessages.mdx +7 -5
  252. package/.docs/raw/reference/memory/getThreadById.mdx +6 -5
  253. package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +11 -10
  254. package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +10 -9
  255. package/.docs/raw/reference/memory/{Memory.mdx → memory-class.mdx} +55 -47
  256. package/.docs/raw/reference/memory/query.mdx +39 -25
  257. package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +9 -6
  258. package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +26 -22
  259. package/.docs/raw/reference/observability/ai-tracing/exporters/arize.mdx +16 -12
  260. package/.docs/raw/reference/observability/ai-tracing/exporters/braintrust.mdx +14 -14
  261. package/.docs/raw/reference/observability/ai-tracing/exporters/cloud-exporter.mdx +16 -11
  262. package/.docs/raw/reference/observability/ai-tracing/exporters/console-exporter.mdx +10 -6
  263. package/.docs/raw/reference/observability/ai-tracing/exporters/default-exporter.mdx +23 -15
  264. package/.docs/raw/reference/observability/ai-tracing/exporters/langfuse.mdx +6 -6
  265. package/.docs/raw/reference/observability/ai-tracing/exporters/langsmith.mdx +13 -13
  266. package/.docs/raw/reference/observability/ai-tracing/exporters/otel.mdx +44 -36
  267. package/.docs/raw/reference/observability/ai-tracing/interfaces.mdx +116 -107
  268. package/.docs/raw/reference/observability/ai-tracing/processors/sensitive-data-filter.mdx +37 -32
  269. package/.docs/raw/reference/observability/ai-tracing/span.mdx +29 -26
  270. package/.docs/raw/reference/observability/logging/pino-logger.mdx +13 -15
  271. package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +2 -2
  272. package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +3 -3
  273. package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +2 -1
  274. package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +1 -1
  275. package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +12 -14
  276. package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +4 -4
  277. package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +1 -1
  278. package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +4 -4
  279. package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +1 -1
  280. package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +2 -2
  281. package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +1 -1
  282. package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +1 -1
  283. package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +1 -1
  284. package/.docs/raw/reference/processors/batch-parts-processor.mdx +3 -4
  285. package/.docs/raw/reference/processors/language-detector.mdx +6 -8
  286. package/.docs/raw/reference/processors/moderation-processor.mdx +36 -11
  287. package/.docs/raw/reference/processors/pii-detector.mdx +34 -9
  288. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +6 -8
  289. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +14 -10
  290. package/.docs/raw/reference/processors/token-limiter-processor.mdx +3 -5
  291. package/.docs/raw/reference/processors/unicode-normalizer.mdx +3 -4
  292. package/.docs/raw/reference/rag/chunk.mdx +41 -23
  293. package/.docs/raw/reference/rag/database-config.mdx +56 -38
  294. package/.docs/raw/reference/rag/embeddings.mdx +1 -1
  295. package/.docs/raw/reference/rag/extract-params.mdx +1 -1
  296. package/.docs/raw/reference/rag/graph-rag.mdx +1 -1
  297. package/.docs/raw/reference/rag/metadata-filters.mdx +23 -26
  298. package/.docs/raw/reference/rag/rerank.mdx +1 -1
  299. package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -2
  300. package/.docs/raw/reference/scorers/answer-relevancy.mdx +35 -17
  301. package/.docs/raw/reference/scorers/answer-similarity.mdx +84 -68
  302. package/.docs/raw/reference/scorers/bias.mdx +22 -19
  303. package/.docs/raw/reference/scorers/completeness.mdx +21 -16
  304. package/.docs/raw/reference/scorers/content-similarity.mdx +12 -10
  305. package/.docs/raw/reference/scorers/context-precision.mdx +73 -64
  306. package/.docs/raw/reference/scorers/context-relevance.mdx +142 -126
  307. package/.docs/raw/reference/scorers/create-scorer.mdx +93 -61
  308. package/.docs/raw/reference/scorers/faithfulness.mdx +21 -13
  309. package/.docs/raw/reference/scorers/hallucination.mdx +17 -12
  310. package/.docs/raw/reference/scorers/keyword-coverage.mdx +32 -27
  311. package/.docs/raw/reference/scorers/mastra-scorer.mdx +39 -33
  312. package/.docs/raw/reference/scorers/noise-sensitivity.mdx +203 -152
  313. package/.docs/raw/reference/scorers/prompt-alignment.mdx +186 -132
  314. package/.docs/raw/reference/scorers/run-experiment.mdx +41 -32
  315. package/.docs/raw/reference/scorers/textual-difference.mdx +25 -26
  316. package/.docs/raw/reference/scorers/tone-consistency.mdx +29 -26
  317. package/.docs/raw/reference/scorers/tool-call-accuracy.mdx +180 -176
  318. package/.docs/raw/reference/scorers/toxicity.mdx +35 -31
  319. package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
  320. package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
  321. package/.docs/raw/reference/storage/dynamodb.mdx +1 -1
  322. package/.docs/raw/reference/storage/lance.mdx +1 -1
  323. package/.docs/raw/reference/storage/libsql.mdx +2 -2
  324. package/.docs/raw/reference/storage/mongodb.mdx +4 -5
  325. package/.docs/raw/reference/storage/mssql.mdx +8 -7
  326. package/.docs/raw/reference/storage/postgresql.mdx +35 -33
  327. package/.docs/raw/reference/storage/upstash.mdx +6 -5
  328. package/.docs/raw/reference/streaming/ChunkType.mdx +788 -314
  329. package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +265 -109
  330. package/.docs/raw/reference/streaming/agents/stream.mdx +375 -266
  331. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +233 -162
  332. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +4 -4
  333. package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +5 -5
  334. package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +25 -21
  335. package/.docs/raw/reference/streaming/workflows/stream.mdx +36 -27
  336. package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +37 -28
  337. package/.docs/raw/reference/templates/overview.mdx +16 -39
  338. package/.docs/raw/reference/tools/client.mdx +1 -1
  339. package/.docs/raw/reference/tools/create-tool.mdx +45 -35
  340. package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -2
  341. package/.docs/raw/reference/tools/graph-rag-tool.mdx +12 -12
  342. package/.docs/raw/reference/tools/mcp-client.mdx +78 -72
  343. package/.docs/raw/reference/tools/mcp-server.mdx +91 -78
  344. package/.docs/raw/reference/tools/vector-query-tool.mdx +48 -38
  345. package/.docs/raw/reference/vectors/astra.mdx +1 -1
  346. package/.docs/raw/reference/vectors/chroma.mdx +25 -19
  347. package/.docs/raw/reference/vectors/couchbase.mdx +4 -4
  348. package/.docs/raw/reference/vectors/lance.mdx +5 -6
  349. package/.docs/raw/reference/vectors/libsql.mdx +1 -1
  350. package/.docs/raw/reference/vectors/mongodb.mdx +1 -1
  351. package/.docs/raw/reference/vectors/opensearch.mdx +1 -1
  352. package/.docs/raw/reference/vectors/pg.mdx +8 -4
  353. package/.docs/raw/reference/vectors/pinecone.mdx +1 -1
  354. package/.docs/raw/reference/vectors/qdrant.mdx +1 -1
  355. package/.docs/raw/reference/vectors/s3vectors.mdx +35 -27
  356. package/.docs/raw/reference/vectors/turbopuffer.mdx +1 -1
  357. package/.docs/raw/reference/vectors/upstash.mdx +33 -25
  358. package/.docs/raw/reference/vectors/vectorize.mdx +1 -1
  359. package/.docs/raw/reference/voice/azure.mdx +1 -1
  360. package/.docs/raw/reference/voice/cloudflare.mdx +1 -1
  361. package/.docs/raw/reference/voice/composite-voice.mdx +1 -1
  362. package/.docs/raw/reference/voice/deepgram.mdx +1 -1
  363. package/.docs/raw/reference/voice/elevenlabs.mdx +1 -1
  364. package/.docs/raw/reference/voice/google-gemini-live.mdx +7 -5
  365. package/.docs/raw/reference/voice/google.mdx +1 -1
  366. package/.docs/raw/reference/voice/mastra-voice.mdx +1 -1
  367. package/.docs/raw/reference/voice/murf.mdx +1 -1
  368. package/.docs/raw/reference/voice/openai-realtime.mdx +1 -1
  369. package/.docs/raw/reference/voice/openai.mdx +1 -1
  370. package/.docs/raw/reference/voice/playai.mdx +1 -1
  371. package/.docs/raw/reference/voice/sarvam.mdx +1 -1
  372. package/.docs/raw/reference/voice/speechify.mdx +1 -1
  373. package/.docs/raw/reference/voice/voice.addInstructions.mdx +1 -1
  374. package/.docs/raw/reference/voice/voice.addTools.mdx +1 -1
  375. package/.docs/raw/reference/voice/voice.answer.mdx +1 -1
  376. package/.docs/raw/reference/voice/voice.close.mdx +1 -1
  377. package/.docs/raw/reference/voice/voice.connect.mdx +1 -1
  378. package/.docs/raw/reference/voice/voice.events.mdx +1 -1
  379. package/.docs/raw/reference/voice/voice.getSpeakers.mdx +23 -30
  380. package/.docs/raw/reference/voice/voice.listen.mdx +1 -1
  381. package/.docs/raw/reference/voice/voice.off.mdx +1 -1
  382. package/.docs/raw/reference/voice/voice.on.mdx +1 -1
  383. package/.docs/raw/reference/voice/voice.send.mdx +1 -1
  384. package/.docs/raw/reference/voice/voice.speak.mdx +1 -1
  385. package/.docs/raw/reference/voice/voice.updateConfig.mdx +1 -1
  386. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -3
  387. package/.docs/raw/reference/workflows/run-methods/resume.mdx +49 -34
  388. package/.docs/raw/reference/workflows/run-methods/start.mdx +43 -31
  389. package/.docs/raw/reference/workflows/run-methods/watch.mdx +7 -8
  390. package/.docs/raw/reference/workflows/run.mdx +7 -10
  391. package/.docs/raw/reference/workflows/step.mdx +16 -13
  392. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
  393. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
  394. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +7 -7
  395. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +2 -2
  396. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +2 -2
  397. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
  398. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +74 -3
  399. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
  400. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +5 -5
  401. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +3 -2
  402. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +3 -2
  403. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
  404. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +3 -3
  405. package/.docs/raw/reference/workflows/workflow.mdx +12 -23
  406. package/.docs/raw/scorers/custom-scorers.mdx +58 -48
  407. package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +6 -8
  408. package/.docs/raw/scorers/evals-old-api/overview.mdx +8 -8
  409. package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +9 -9
  410. package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +5 -5
  411. package/.docs/raw/scorers/off-the-shelf-scorers.mdx +3 -1
  412. package/.docs/raw/scorers/overview.mdx +23 -22
  413. package/.docs/raw/server-db/custom-api-routes.mdx +8 -8
  414. package/.docs/raw/server-db/mastra-client.mdx +56 -54
  415. package/.docs/raw/server-db/middleware.mdx +15 -11
  416. package/.docs/raw/server-db/production-server.mdx +5 -7
  417. package/.docs/raw/server-db/runtime-context.mdx +41 -38
  418. package/.docs/raw/server-db/storage.mdx +82 -87
  419. package/.docs/raw/streaming/events.mdx +24 -16
  420. package/.docs/raw/streaming/overview.mdx +17 -18
  421. package/.docs/raw/streaming/tool-streaming.mdx +9 -10
  422. package/.docs/raw/streaming/workflow-streaming.mdx +14 -12
  423. package/.docs/raw/tools-mcp/advanced-usage.mdx +2 -2
  424. package/.docs/raw/tools-mcp/mcp-overview.mdx +92 -102
  425. package/.docs/raw/tools-mcp/overview.mdx +10 -15
  426. package/.docs/raw/voice/overview.mdx +273 -250
  427. package/.docs/raw/voice/speech-to-speech.mdx +14 -12
  428. package/.docs/raw/voice/speech-to-text.mdx +2 -2
  429. package/.docs/raw/voice/text-to-speech.mdx +2 -2
  430. package/.docs/raw/workflows/agents-and-tools.mdx +27 -30
  431. package/.docs/raw/workflows/control-flow.mdx +213 -170
  432. package/.docs/raw/workflows/error-handling.mdx +15 -17
  433. package/.docs/raw/workflows/human-in-the-loop.mdx +39 -39
  434. package/.docs/raw/workflows/inngest-workflow.mdx +35 -31
  435. package/.docs/raw/workflows/overview.mdx +108 -56
  436. package/.docs/raw/workflows/snapshots.mdx +54 -36
  437. package/.docs/raw/workflows/suspend-and-resume.mdx +52 -65
  438. package/.docs/raw/workflows-legacy/control-flow.mdx +15 -17
  439. package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +3 -1
  440. package/.docs/raw/workflows-legacy/error-handling.mdx +8 -6
  441. package/.docs/raw/workflows-legacy/nested-workflows.mdx +6 -0
  442. package/.docs/raw/workflows-legacy/overview.mdx +28 -26
  443. package/.docs/raw/workflows-legacy/runtime-variables.mdx +4 -2
  444. package/.docs/raw/workflows-legacy/steps.mdx +5 -3
  445. package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +10 -8
  446. package/.docs/raw/workflows-legacy/variables.mdx +10 -8
  447. package/CHANGELOG.md +24 -0
  448. package/package.json +5 -5
  449. package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -148
  450. package/.docs/raw/workflows/input-data-mapping.mdx +0 -107
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Google Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: Google | Voice | Mastra Docs"
3
3
  description: "Documentation for the Google Voice implementation, providing text-to-speech and speech-to-text capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: MastraVoice | Voice Providers | Mastra Docs"
2
+ title: "Reference: MastraVoice | Voice | Mastra Docs"
3
3
  description: "Documentation for the MastraVoice abstract base class, which defines the core interface for all voice services in Mastra, including speech-to-speech capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Murf Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: Murf | Voice | Mastra Docs"
3
3
  description: "Documentation for the Murf voice implementation, providing text-to-speech capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: OpenAI Realtime Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: OpenAI Realtime Voice | Voice | Mastra Docs"
3
3
  description: "Documentation for the OpenAIRealtimeVoice class, providing real-time text-to-speech and speech-to-text capabilities via WebSockets."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: OpenAI Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: OpenAI | Voice | Mastra Docs"
3
3
  description: "Documentation for the OpenAIVoice class, providing text-to-speech and speech-to-text capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: PlayAI Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: PlayAI | Voice | Mastra Docs"
3
3
  description: "Documentation for the PlayAI voice implementation, providing text-to-speech capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Sarvam Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: Sarvam | Voice | Mastra Docs"
3
3
  description: "Documentation for the Sarvam class, providing text-to-speech and speech-to-text capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Speechify Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: Speechify | Voice | Mastra Docs"
3
3
  description: "Documentation for the Speechify voice implementation, providing text-to-speech capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.addInstructions() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.addInstructions() | Voice | Mastra Docs"
3
3
  description: "Documentation for the addInstructions() method available in voice providers, which adds instructions to guide the voice model's behavior."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.addTools() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.addTools() | Voice | Mastra Docs"
3
3
  description: "Documentation for the addTools() method available in voice providers, which equips voice models with function calling capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.answer() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.answer() | Voice | Mastra Docs"
3
3
  description: "Documentation for the answer() method available in real-time voice providers, which triggers the voice provider to generate a response."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.close() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.close() | Voice | Mastra Docs"
3
3
  description: "Documentation for the close() method available in voice providers, which disconnects from real-time voice services."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.connect() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.connect() | Voice | Mastra Docs"
3
3
  description: "Documentation for the connect() method available in real-time voice providers, which establishes a connection for speech-to-speech communication."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Voice Events | Voice Providers | Mastra Docs"
2
+ title: "Reference: Voice Events | Voice | Mastra Docs"
3
3
  description: "Documentation for events emitted by voice providers, particularly for real-time voice interactions."
4
4
  ---
5
5
 
@@ -3,7 +3,8 @@ title: "Reference: voice.getSpeakers() | Voice Providers | Mastra Docs"
3
3
  description: "Documentation for the getSpeakers() method available in voice providers, which retrieves available voice options."
4
4
  ---
5
5
 
6
- import { Tabs } from "nextra/components";
6
+ import Tabs from "@theme/Tabs";
7
+ import TabItem from "@theme/TabItem";
7
8
 
8
9
  # voice.getSpeakers()
9
10
 
@@ -58,16 +59,8 @@ This method does not accept any parameters.
58
59
 
59
60
  Different voice providers return different metadata for their voices:
60
61
 
61
- {/*
62
- LLM CONTEXT: This Tabs component shows the different metadata structures returned by various voice providers' getSpeakers() method.
63
- Each tab displays the specific properties and data types returned by that voice provider when listing available speakers/voices.
64
- The tabs help users understand what information is available for each provider and how to access voice-specific metadata.
65
- Each tab includes property tables showing voiceId and provider-specific metadata like name, language, gender, accent, etc.
66
- The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Murf, PlayAI, Sarvam, Speechify, and Azure.
67
- */}
68
-
69
- <Tabs items={["OpenAI", "OpenAI Realtime", "Deepgram", "ElevenLabs", "Google", "Murf", "PlayAI", "Sarvam", "Speechify", "Azure"]}>
70
- <Tabs.Tab label="OpenAI">
62
+ <Tabs>
63
+ <TabItem value="OpenAI">
71
64
  <PropertiesTable
72
65
  content={[
73
66
  {
@@ -77,9 +70,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
77
70
  }
78
71
  ]}
79
72
  />
80
- </Tabs.Tab>
73
+ </TabItem>
81
74
 
82
- <Tabs.Tab label="OpenAI Realtime">
75
+ <TabItem value="OpenAI Realtime">
83
76
  <PropertiesTable
84
77
  content={[
85
78
  {
@@ -90,9 +83,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
90
83
  },
91
84
  ]}
92
85
  />
93
- </Tabs.Tab>
86
+ </TabItem>
94
87
 
95
- <Tabs.Tab label="Deepgram">
88
+ <TabItem value="Deepgram">
96
89
  <PropertiesTable
97
90
  content={[
98
91
  {
@@ -107,9 +100,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
107
100
  },
108
101
  ]}
109
102
  />
110
- </Tabs.Tab>
103
+ </TabItem>
111
104
 
112
- <Tabs.Tab label="ElevenLabs">
105
+ <TabItem value="ElevenLabs">
113
106
  <PropertiesTable
114
107
  content={[
115
108
  {
@@ -129,9 +122,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
129
122
  },
130
123
  ]}
131
124
  />
132
- </Tabs.Tab>
125
+ </TabItem>
133
126
 
134
- <Tabs.Tab label="Google">
127
+ <TabItem value="Google">
135
128
  <PropertiesTable
136
129
  content={[
137
130
  {
@@ -147,9 +140,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
147
140
  },
148
141
  ]}
149
142
  />
150
- </Tabs.Tab>
143
+ </TabItem>
151
144
 
152
- <Tabs.Tab label="Azure">
145
+ <TabItem value="Azure">
153
146
  <PropertiesTable
154
147
  content={[
155
148
  {
@@ -169,9 +162,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
169
162
  },
170
163
  ]}
171
164
  />
172
- </Tabs.Tab>
165
+ </TabItem>
173
166
 
174
- <Tabs.Tab label="Murf">
167
+ <TabItem value="Murf">
175
168
  <PropertiesTable
176
169
  content={[
177
170
  {
@@ -197,9 +190,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
197
190
  },
198
191
  ]}
199
192
  />
200
- </Tabs.Tab>
193
+ </TabItem>
201
194
 
202
- <Tabs.Tab label="PlayAI">
195
+ <TabItem value="PlayAI">
203
196
  <PropertiesTable
204
197
  content={[
205
198
  {
@@ -237,9 +230,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
237
230
  },
238
231
  ]}
239
232
  />
240
- </Tabs.Tab>
233
+ </TabItem>
241
234
 
242
- <Tabs.Tab label="Speechify">
235
+ <TabItem value="Speechify">
243
236
  <PropertiesTable
244
237
  content={[
245
238
  {
@@ -259,9 +252,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
259
252
  },
260
253
  ]}
261
254
  />
262
- </Tabs.Tab>
255
+ </TabItem>
263
256
 
264
- <Tabs.Tab label="Sarvam">
257
+ <TabItem value="Sarvam">
265
258
  <PropertiesTable
266
259
  content={[
267
260
  {
@@ -286,7 +279,7 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
286
279
  }
287
280
  ]}
288
281
  />
289
- </Tabs.Tab>
282
+ </TabItem>
290
283
  </Tabs>
291
284
 
292
285
  ## Notes
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.listen() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.listen() | Voice | Mastra Docs"
3
3
  description: "Documentation for the listen() method available in all Mastra voice providers, which converts speech to text."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.off() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.off() | Voice | Mastra Docs"
3
3
  description: "Documentation for the off() method available in voice providers, which removes event listeners for voice events."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.on() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.on() | Voice | Mastra Docs"
3
3
  description: "Documentation for the on() method available in voice providers, which registers event listeners for voice events."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.send() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.send() | Voice | Mastra Docs"
3
3
  description: "Documentation for the send() method available in real-time voice providers, which streams audio data for continuous processing."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.speak() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.speak() | Voice | Mastra Docs"
3
3
  description: "Documentation for the speak() method available in all Mastra voice providers, which converts text to speech."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.updateConfig() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.updateConfig() | Voice | Mastra Docs"
3
3
  description: "Documentation for the updateConfig() method available in voice providers, which updates the configuration of a voice provider at runtime."
4
4
  ---
5
5
 
@@ -35,7 +35,8 @@ await run.cancel();
35
35
  {
36
36
  name: "result",
37
37
  type: "Promise<void>",
38
- description: "A promise that resolves when the workflow run has been cancelled",
38
+ description:
39
+ "A promise that resolves when the workflow run has been cancelled",
39
40
  },
40
41
  ]}
41
42
  />
@@ -54,5 +55,5 @@ try {
54
55
 
55
56
  ## Related
56
57
 
57
- - [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
58
- - [Workflow.createRunAsync()](../create-run.mdx)
58
+ - [Workflows overview](/docs/workflows/overview#running-workflows)
59
+ - [Workflow.createRunAsync()](../workflow-methods/create-run)
@@ -16,10 +16,11 @@ const result = await run.start({ inputData: { value: "initial data" } });
16
16
 
17
17
  if (result.status === "suspended") {
18
18
  const resumedResults = await run.resume({
19
- resumeData: { value: "resume data" }
19
+ resumeData: { value: "resume data" },
20
20
  });
21
21
  }
22
22
  ```
23
+
23
24
  ## Parameters
24
25
 
25
26
  <PropertiesTable
@@ -33,7 +34,8 @@ if (result.status === "suspended") {
33
34
  {
34
35
  name: "step",
35
36
  type: "Step<string, any, any, TResumeSchema, any, TEngineType> | [...Step<string, any, any, any, any, TEngineType>[], Step<string, any, any, TResumeSchema, any, TEngineType>] | string | string[]",
36
- description: "The step(s) to resume execution from. Can be a Step instance, array of Steps, step ID string, or array of step ID strings",
37
+ description:
38
+ "The step(s) to resume execution from. Can be a Step instance, array of Steps, step ID string, or array of step ID strings",
37
39
  isOptional: true,
38
40
  },
39
41
  {
@@ -52,17 +54,21 @@ if (result.status === "suspended") {
52
54
  name: "tracingContext",
53
55
  type: "TracingContext",
54
56
  isOptional: true,
55
- description: "AI tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
57
+ description:
58
+ "AI tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
56
59
  properties: [
57
60
  {
58
- parameters: [{
59
- name: "currentSpan",
60
- type: "AISpan",
61
- isOptional: true,
62
- description: "Current AI span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution."
63
- }]
64
- }
65
- ]
61
+ parameters: [
62
+ {
63
+ name: "currentSpan",
64
+ type: "AISpan",
65
+ isOptional: true,
66
+ description:
67
+ "Current AI span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.",
68
+ },
69
+ ],
70
+ },
71
+ ],
66
72
  },
67
73
  {
68
74
  name: "tracingOptions",
@@ -71,14 +77,17 @@ if (result.status === "suspended") {
71
77
  description: "Options for AI tracing configuration.",
72
78
  properties: [
73
79
  {
74
- parameters: [{
75
- name: "metadata",
76
- type: "Record<string, any>",
77
- isOptional: true,
78
- description: "Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags."
79
- }]
80
- }
81
- ]
80
+ parameters: [
81
+ {
82
+ name: "metadata",
83
+ type: "Record<string, any>",
84
+ isOptional: true,
85
+ description:
86
+ "Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.",
87
+ },
88
+ ],
89
+ },
90
+ ],
82
91
  },
83
92
  {
84
93
  name: "outputOptions",
@@ -87,14 +96,17 @@ if (result.status === "suspended") {
87
96
  description: "Options for AI tracing configuration.",
88
97
  properties: [
89
98
  {
90
- parameters: [{
91
- name: "includeState",
92
- type: "boolean",
93
- isOptional: true,
94
- description: "Whether to include the workflow run state in the result."
95
- }]
96
- }
97
- ]
99
+ parameters: [
100
+ {
101
+ name: "includeState",
102
+ type: "boolean",
103
+ isOptional: true,
104
+ description:
105
+ "Whether to include the workflow run state in the result.",
106
+ },
107
+ ],
108
+ },
109
+ ],
98
110
  },
99
111
  ]}
100
112
  />
@@ -106,13 +118,15 @@ if (result.status === "suspended") {
106
118
  {
107
119
  name: "result",
108
120
  type: "Promise<WorkflowResult<TState, TOutput, TSteps>>",
109
- description: "A promise that resolves to the workflow execution result containing step outputs and status",
121
+ description:
122
+ "A promise that resolves to the workflow execution result containing step outputs and status",
110
123
  },
111
124
  {
112
125
  name: "traceId",
113
126
  type: "string",
114
127
  isOptional: true,
115
- description: "The trace ID associated with this execution when AI tracing is enabled. Use this to correlate logs and debug execution flow.",
128
+ description:
129
+ "The trace ID associated with this execution when AI tracing is enabled. Use this to correlate logs and debug execution flow.",
116
130
  },
117
131
  ]}
118
132
  />
@@ -123,15 +137,16 @@ if (result.status === "suspended") {
123
137
  if (result.status === "suspended") {
124
138
  const resumedResults = await run.resume({
125
139
  step: result.suspended[0],
126
- resumeData: { value: "resume data" }
140
+ resumeData: { value: "resume data" },
127
141
  });
128
142
  }
129
143
  ```
144
+
130
145
  > **Note**: When exactly one step is suspended, you can omit the `step` parameter and the workflow will automatically resume that step. For workflows with multiple suspended steps, you must explicitly specify which step to resume.
131
146
 
132
147
  ## Related
133
148
 
134
- - [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
135
- - [Workflow.createRunAsync()](../create-run.mdx)
136
- - [Suspend and resume](../../../docs/workflows/suspend-and-resume.mdx)
137
- - [Human in the loop example](../../../examples/workflows/human-in-the-loop.mdx)
149
+ - [Workflows overview](/docs/workflows/overview#running-workflows)
150
+ - [Workflow.createRunAsync()](../workflow-methods/create-run)
151
+ - [Suspend and resume](/docs/workflows/suspend-and-resume)
152
+ - [Human in the loop example](/examples/workflows_legacy/human-in-the-loop)
@@ -45,17 +45,21 @@ const result = await run.start({
45
45
  name: "tracingContext",
46
46
  type: "TracingContext",
47
47
  isOptional: true,
48
- description: "AI tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
48
+ description:
49
+ "AI tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
49
50
  properties: [
50
51
  {
51
- parameters: [{
52
- name: "currentSpan",
53
- type: "AISpan",
54
- isOptional: true,
55
- description: "Current AI span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution."
56
- }]
57
- }
58
- ]
52
+ parameters: [
53
+ {
54
+ name: "currentSpan",
55
+ type: "AISpan",
56
+ isOptional: true,
57
+ description:
58
+ "Current AI span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.",
59
+ },
60
+ ],
61
+ },
62
+ ],
59
63
  },
60
64
  {
61
65
  name: "tracingOptions",
@@ -64,14 +68,17 @@ const result = await run.start({
64
68
  description: "Options for AI tracing configuration.",
65
69
  properties: [
66
70
  {
67
- parameters: [{
68
- name: "metadata",
69
- type: "Record<string, any>",
70
- isOptional: true,
71
- description: "Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags."
72
- }]
73
- }
74
- ]
71
+ parameters: [
72
+ {
73
+ name: "metadata",
74
+ type: "Record<string, any>",
75
+ isOptional: true,
76
+ description:
77
+ "Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.",
78
+ },
79
+ ],
80
+ },
81
+ ],
75
82
  },
76
83
  {
77
84
  name: "outputOptions",
@@ -80,14 +87,17 @@ const result = await run.start({
80
87
  description: "Options for AI tracing configuration.",
81
88
  properties: [
82
89
  {
83
- parameters: [{
84
- name: "includeState",
85
- type: "boolean",
86
- isOptional: true,
87
- description: "Whether to include the workflow run state in the result."
88
- }]
89
- }
90
- ]
90
+ parameters: [
91
+ {
92
+ name: "includeState",
93
+ type: "boolean",
94
+ isOptional: true,
95
+ description:
96
+ "Whether to include the workflow run state in the result.",
97
+ },
98
+ ],
99
+ },
100
+ ],
91
101
  },
92
102
  ]}
93
103
  />
@@ -99,13 +109,15 @@ const result = await run.start({
99
109
  {
100
110
  name: "result",
101
111
  type: "Promise<WorkflowResult<TState, TOutput, TSteps>>",
102
- description: "A promise that resolves to the workflow execution result containing step outputs and status",
112
+ description:
113
+ "A promise that resolves to the workflow execution result containing step outputs and status",
103
114
  },
104
115
  {
105
116
  name: "traceId",
106
117
  type: "string",
107
118
  isOptional: true,
108
- description: "The trace ID associated with this execution when AI tracing is enabled. Use this to correlate logs and debug execution flow.",
119
+ description:
120
+ "The trace ID associated with this execution when AI tracing is enabled. Use this to correlate logs and debug execution flow.",
109
121
  },
110
122
  ]}
111
123
  />
@@ -122,13 +134,13 @@ runtimeContext.set("variable", false);
122
134
 
123
135
  const result = await run.start({
124
136
  inputData: {
125
- value: "initial data"
137
+ value: "initial data",
126
138
  },
127
- runtimeContext
139
+ runtimeContext,
128
140
  });
129
141
  ```
130
142
 
131
143
  ## Related
132
144
 
133
- - [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
134
- - [Workflow.createRunAsync()](../create-run.mdx)
145
+ - [Workflows overview](/docs/workflows/overview#running-workflows)
146
+ - [Workflow.createRunAsync()](../workflow-methods/create-run)
@@ -26,20 +26,21 @@ const result = await run.start({ inputData: { value: "initial data" } });
26
26
  {
27
27
  name: "callback",
28
28
  type: "(event: WatchEvent) => void",
29
- description: "A callback function that is called whenever a step is completed or the workflow state changes. The event parameter contains: type ('watch'), payload (currentStep and workflowState), and eventTimestamp",
29
+ description:
30
+ "A callback function that is called whenever a step is completed or the workflow state changes. The event parameter contains: type ('watch'), payload (currentStep and workflowState), and eventTimestamp",
30
31
  isOptional: false,
31
32
  },
32
33
  {
33
34
  name: "type",
34
35
  type: "'watch' | 'watch-v2'",
35
- description: "The type of watch events to listen for. 'watch' for step completion events, 'watch-v2' for data stream events",
36
+ description:
37
+ "The type of watch events to listen for. 'watch' for step completion events, 'watch-v2' for data stream events",
36
38
  isOptional: true,
37
39
  defaultValue: "'watch'",
38
40
  },
39
41
  ]}
40
42
  />
41
43
 
42
-
43
44
  ## Returns
44
45
 
45
46
  <PropertiesTable
@@ -67,8 +68,6 @@ const result = await run.start({ inputData: { value: "initial data" } });
67
68
 
68
69
  ## Related
69
70
 
70
- ## Related
71
-
72
- - [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
73
- - [Workflow.createRunAsync()](../create-run.mdx)
74
- - [Watch Workflow](../../../docs/workflows/overview.mdx#watch-workflow)
71
+ - [Workflows overview](/docs/workflows/overview#running-workflows)
72
+ - [Workflow.createRunAsync()](../workflow-methods/create-run)
73
+ - [Watch Workflow](/docs/workflows/overview)