@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.
- package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +2 -0
- package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +2 -0
- package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +8 -8
- package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +2 -0
- package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fastra.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fauth.md +6 -0
- package/.docs/organized/changelogs/%40mastra%2Fchroma.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +38 -38
- package/.docs/organized/changelogs/%40mastra%2Fcloud.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +88 -88
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +28 -28
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +27 -27
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +27 -27
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +27 -27
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +59 -59
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +6 -0
- package/.docs/organized/changelogs/%40mastra%2Flance.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Floggers.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +25 -25
- package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fmcp.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +48 -48
- package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Frag.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Freact.md +24 -24
- package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +9 -0
- package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +6 -0
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +40 -40
- package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +11 -1
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +10 -10
- package/.docs/organized/changelogs/create-mastra.md +11 -11
- package/.docs/organized/changelogs/mastra.md +34 -34
- package/.docs/raw/agents/adding-voice.mdx +20 -9
- package/.docs/raw/agents/agent-memory.mdx +55 -39
- package/.docs/raw/agents/guardrails.mdx +68 -61
- package/.docs/raw/agents/networks.mdx +50 -46
- package/.docs/raw/agents/overview.mdx +126 -89
- package/.docs/raw/agents/using-tools.mdx +14 -15
- package/.docs/raw/auth/auth0.mdx +28 -27
- package/.docs/raw/auth/clerk.mdx +22 -20
- package/.docs/raw/auth/firebase.mdx +42 -39
- package/.docs/raw/auth/index.mdx +1 -1
- package/.docs/raw/auth/jwt.mdx +18 -16
- package/.docs/raw/auth/supabase.mdx +20 -18
- package/.docs/raw/auth/workos.mdx +32 -26
- package/.docs/raw/community/contributing-templates.mdx +7 -7
- package/.docs/raw/community/discord.mdx +2 -2
- package/.docs/raw/community/licensing.mdx +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/04-initializing-mcp-tools.md +2 -2
- package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -1
- package/.docs/raw/course/03-agent-memory/26-updating-mastra-export-comprehensive.md +0 -32
- package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +41 -22
- package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +48 -29
- package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +52 -24
- package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +86 -55
- package/.docs/raw/deployment/cloud-providers/index.mdx +16 -13
- package/.docs/raw/deployment/monorepo.mdx +32 -42
- package/.docs/raw/deployment/overview.mdx +15 -15
- package/.docs/raw/deployment/server-deployment.mdx +18 -23
- package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +16 -17
- package/.docs/raw/deployment/serverless-platforms/index.mdx +15 -12
- package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +14 -23
- package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +16 -23
- package/.docs/raw/deployment/web-framework.mdx +14 -14
- package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +130 -121
- package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +54 -43
- package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +51 -36
- package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +161 -120
- package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +60 -49
- package/.docs/raw/frameworks/servers/express.mdx +46 -45
- package/.docs/raw/frameworks/web-frameworks/astro.mdx +245 -162
- package/.docs/raw/frameworks/web-frameworks/next-js.mdx +112 -69
- package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +171 -130
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +94 -81
- package/.docs/raw/getting-started/installation.mdx +165 -134
- package/.docs/raw/getting-started/mcp-docs-server.mdx +36 -39
- package/.docs/raw/getting-started/project-structure.mdx +34 -42
- package/.docs/raw/getting-started/studio.mdx +42 -50
- package/.docs/raw/getting-started/templates.mdx +18 -15
- package/.docs/raw/index.mdx +9 -9
- package/.docs/raw/mastra-cloud/dashboard.mdx +12 -12
- package/.docs/raw/mastra-cloud/observability.mdx +9 -10
- package/.docs/raw/mastra-cloud/overview.mdx +17 -23
- package/.docs/raw/mastra-cloud/setting-up.mdx +33 -20
- package/.docs/raw/memory/conversation-history.mdx +2 -2
- package/.docs/raw/memory/overview.mdx +22 -24
- package/.docs/raw/memory/semantic-recall.mdx +16 -17
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +27 -28
- package/.docs/raw/memory/storage/memory-with-pg.mdx +26 -26
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +26 -27
- package/.docs/raw/memory/threads-and-resources.mdx +24 -21
- package/.docs/raw/memory/working-memory.mdx +27 -38
- package/.docs/raw/observability/ai-tracing/exporters/arize.mdx +30 -29
- package/.docs/raw/observability/ai-tracing/exporters/braintrust.mdx +8 -9
- package/.docs/raw/observability/ai-tracing/exporters/cloud.mdx +17 -16
- package/.docs/raw/observability/ai-tracing/exporters/default.mdx +37 -38
- package/.docs/raw/observability/ai-tracing/exporters/langfuse.mdx +18 -17
- package/.docs/raw/observability/ai-tracing/exporters/langsmith.mdx +14 -14
- package/.docs/raw/observability/ai-tracing/exporters/otel.mdx +56 -46
- package/.docs/raw/observability/ai-tracing/overview.mdx +151 -128
- package/.docs/raw/observability/ai-tracing/processors/sensitive-data-filter.mdx +57 -36
- package/.docs/raw/observability/logging.mdx +14 -17
- package/.docs/raw/observability/nextjs-tracing.mdx +5 -5
- package/.docs/raw/observability/otel-tracing.mdx +17 -18
- package/.docs/raw/observability/overview.mdx +15 -11
- package/.docs/raw/rag/chunking-and-embedding.mdx +10 -8
- package/.docs/raw/rag/overview.mdx +5 -5
- package/.docs/raw/rag/retrieval.mdx +125 -107
- package/.docs/raw/rag/vector-databases.mdx +232 -223
- package/.docs/raw/reference/agents/agent.mdx +56 -43
- package/.docs/raw/reference/agents/generate.mdx +367 -261
- package/.docs/raw/reference/agents/generateLegacy.mdx +260 -178
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +7 -5
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +7 -5
- package/.docs/raw/reference/agents/getDescription.mdx +3 -2
- package/.docs/raw/reference/agents/getInstructions.mdx +7 -5
- package/.docs/raw/reference/agents/getLLM.mdx +11 -7
- package/.docs/raw/reference/agents/getMemory.mdx +7 -5
- package/.docs/raw/reference/agents/getModel.mdx +7 -5
- package/.docs/raw/reference/agents/getScorers.mdx +7 -5
- package/.docs/raw/reference/agents/getTools.mdx +7 -5
- package/.docs/raw/reference/agents/getVoice.mdx +7 -5
- package/.docs/raw/reference/agents/getWorkflows.mdx +7 -5
- package/.docs/raw/reference/agents/listAgents.mdx +6 -4
- package/.docs/raw/reference/agents/listScorers.mdx +69 -0
- package/.docs/raw/reference/agents/listTools.mdx +69 -0
- package/.docs/raw/reference/agents/listWorkflows.mdx +69 -0
- package/.docs/raw/reference/agents/network.mdx +171 -116
- package/.docs/raw/reference/auth/auth0.mdx +18 -14
- package/.docs/raw/reference/auth/clerk.mdx +15 -12
- package/.docs/raw/reference/auth/firebase.mdx +23 -16
- package/.docs/raw/reference/auth/jwt.mdx +7 -6
- package/.docs/raw/reference/auth/supabase.mdx +13 -10
- package/.docs/raw/reference/auth/workos.mdx +17 -13
- package/.docs/raw/reference/cli/create-mastra.mdx +61 -44
- package/.docs/raw/reference/cli/mastra.mdx +11 -11
- package/.docs/raw/reference/client-js/agents.mdx +41 -44
- package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
- package/.docs/raw/reference/client-js/logs.mdx +2 -2
- package/.docs/raw/reference/client-js/mastra-client.mdx +28 -20
- package/.docs/raw/reference/client-js/memory.mdx +7 -3
- package/.docs/raw/reference/client-js/observability.mdx +10 -9
- package/.docs/raw/reference/client-js/telemetry.mdx +1 -1
- package/.docs/raw/reference/client-js/tools.mdx +2 -2
- package/.docs/raw/reference/client-js/vectors.mdx +1 -1
- package/.docs/raw/reference/client-js/workflows-legacy.mdx +1 -1
- package/.docs/raw/reference/client-js/workflows.mdx +8 -8
- package/.docs/raw/reference/core/getAgent.mdx +6 -5
- package/.docs/raw/reference/core/getAgentById.mdx +5 -4
- package/.docs/raw/reference/core/getAgents.mdx +3 -3
- package/.docs/raw/reference/core/getDeployer.mdx +4 -3
- package/.docs/raw/reference/core/getLogger.mdx +4 -3
- package/.docs/raw/reference/core/getLogs.mdx +10 -6
- package/.docs/raw/reference/core/getLogsByRunId.mdx +8 -5
- package/.docs/raw/reference/core/getMCPServer.mdx +8 -5
- package/.docs/raw/reference/core/getMCPServers.mdx +4 -3
- package/.docs/raw/reference/core/getMemory.mdx +4 -3
- package/.docs/raw/reference/core/getScorer.mdx +15 -12
- package/.docs/raw/reference/core/getScorerByName.mdx +13 -10
- package/.docs/raw/reference/core/getScorers.mdx +3 -2
- package/.docs/raw/reference/core/getServer.mdx +4 -3
- package/.docs/raw/reference/core/getStorage.mdx +4 -3
- package/.docs/raw/reference/core/getTelemetry.mdx +4 -3
- package/.docs/raw/reference/core/getVector.mdx +6 -4
- package/.docs/raw/reference/core/getVectors.mdx +4 -3
- package/.docs/raw/reference/core/getWorkflow.mdx +7 -4
- package/.docs/raw/reference/core/getWorkflows.mdx +5 -3
- package/.docs/raw/reference/core/listAgents.mdx +35 -0
- package/.docs/raw/reference/core/listLogs.mdx +96 -0
- package/.docs/raw/reference/core/listLogsByRunId.mdx +87 -0
- package/.docs/raw/reference/core/listScorers.mdx +43 -0
- package/.docs/raw/reference/core/listWorkflows.mdx +45 -0
- package/.docs/raw/reference/core/mastra-class.mdx +16 -16
- package/.docs/raw/reference/core/setLogger.mdx +6 -4
- package/.docs/raw/reference/core/setStorage.mdx +4 -4
- package/.docs/raw/reference/core/setTelemetry.mdx +4 -3
- package/.docs/raw/reference/deployer/cloudflare.mdx +11 -7
- package/.docs/raw/reference/deployer/deployer.mdx +2 -1
- package/.docs/raw/reference/deployer/netlify.mdx +4 -4
- package/.docs/raw/reference/deployer/vercel.mdx +6 -6
- package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -5
- package/.docs/raw/reference/evals/bias.mdx +4 -5
- package/.docs/raw/reference/evals/completeness.mdx +4 -5
- package/.docs/raw/reference/evals/content-similarity.mdx +4 -5
- package/.docs/raw/reference/evals/context-position.mdx +4 -5
- package/.docs/raw/reference/evals/context-precision.mdx +4 -5
- package/.docs/raw/reference/evals/context-relevancy.mdx +4 -5
- package/.docs/raw/reference/evals/contextual-recall.mdx +4 -5
- package/.docs/raw/reference/evals/faithfulness.mdx +4 -5
- package/.docs/raw/reference/evals/hallucination.mdx +4 -6
- package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -5
- package/.docs/raw/reference/evals/prompt-alignment.mdx +4 -6
- package/.docs/raw/reference/evals/summarization.mdx +4 -6
- package/.docs/raw/reference/evals/textual-difference.mdx +4 -5
- package/.docs/raw/reference/evals/tone-consistency.mdx +4 -7
- package/.docs/raw/reference/evals/toxicity.mdx +4 -5
- package/.docs/raw/reference/index.mdx +3 -3
- package/.docs/raw/reference/legacyWorkflows/after.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/commit.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/createRun.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/else.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/events.mdx +7 -7
- package/.docs/raw/reference/legacyWorkflows/execute.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/if.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/resume.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/start.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/step-class.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/step-function.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/step-options.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/suspend.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/then.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/until.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/watch.mdx +3 -3
- package/.docs/raw/reference/legacyWorkflows/while.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/workflow.mdx +7 -7
- package/.docs/raw/reference/memory/createThread.mdx +10 -10
- package/.docs/raw/reference/memory/deleteMessages.mdx +7 -5
- package/.docs/raw/reference/memory/getThreadById.mdx +6 -5
- package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +11 -10
- package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +10 -9
- package/.docs/raw/reference/memory/{Memory.mdx → memory-class.mdx} +55 -47
- package/.docs/raw/reference/memory/query.mdx +39 -25
- package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +9 -6
- package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +26 -22
- package/.docs/raw/reference/observability/ai-tracing/exporters/arize.mdx +16 -12
- package/.docs/raw/reference/observability/ai-tracing/exporters/braintrust.mdx +14 -14
- package/.docs/raw/reference/observability/ai-tracing/exporters/cloud-exporter.mdx +16 -11
- package/.docs/raw/reference/observability/ai-tracing/exporters/console-exporter.mdx +10 -6
- package/.docs/raw/reference/observability/ai-tracing/exporters/default-exporter.mdx +23 -15
- package/.docs/raw/reference/observability/ai-tracing/exporters/langfuse.mdx +6 -6
- package/.docs/raw/reference/observability/ai-tracing/exporters/langsmith.mdx +13 -13
- package/.docs/raw/reference/observability/ai-tracing/exporters/otel.mdx +44 -36
- package/.docs/raw/reference/observability/ai-tracing/interfaces.mdx +116 -107
- package/.docs/raw/reference/observability/ai-tracing/processors/sensitive-data-filter.mdx +37 -32
- package/.docs/raw/reference/observability/ai-tracing/span.mdx +29 -26
- package/.docs/raw/reference/observability/logging/pino-logger.mdx +13 -15
- package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +2 -2
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +3 -3
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +2 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +12 -14
- package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +4 -4
- package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +4 -4
- package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +2 -2
- package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +1 -1
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +3 -4
- package/.docs/raw/reference/processors/language-detector.mdx +6 -8
- package/.docs/raw/reference/processors/moderation-processor.mdx +36 -11
- package/.docs/raw/reference/processors/pii-detector.mdx +34 -9
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +6 -8
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +14 -10
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +3 -5
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +3 -4
- package/.docs/raw/reference/rag/chunk.mdx +41 -23
- package/.docs/raw/reference/rag/database-config.mdx +56 -38
- package/.docs/raw/reference/rag/embeddings.mdx +1 -1
- package/.docs/raw/reference/rag/extract-params.mdx +1 -1
- package/.docs/raw/reference/rag/graph-rag.mdx +1 -1
- package/.docs/raw/reference/rag/metadata-filters.mdx +23 -26
- package/.docs/raw/reference/rag/rerank.mdx +1 -1
- package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -2
- package/.docs/raw/reference/scorers/answer-relevancy.mdx +35 -17
- package/.docs/raw/reference/scorers/answer-similarity.mdx +84 -68
- package/.docs/raw/reference/scorers/bias.mdx +22 -19
- package/.docs/raw/reference/scorers/completeness.mdx +21 -16
- package/.docs/raw/reference/scorers/content-similarity.mdx +12 -10
- package/.docs/raw/reference/scorers/context-precision.mdx +73 -64
- package/.docs/raw/reference/scorers/context-relevance.mdx +142 -126
- package/.docs/raw/reference/scorers/create-scorer.mdx +93 -61
- package/.docs/raw/reference/scorers/faithfulness.mdx +21 -13
- package/.docs/raw/reference/scorers/hallucination.mdx +17 -12
- package/.docs/raw/reference/scorers/keyword-coverage.mdx +32 -27
- package/.docs/raw/reference/scorers/mastra-scorer.mdx +39 -33
- package/.docs/raw/reference/scorers/noise-sensitivity.mdx +203 -152
- package/.docs/raw/reference/scorers/prompt-alignment.mdx +186 -132
- package/.docs/raw/reference/scorers/run-experiment.mdx +41 -32
- package/.docs/raw/reference/scorers/textual-difference.mdx +25 -26
- package/.docs/raw/reference/scorers/tone-consistency.mdx +29 -26
- package/.docs/raw/reference/scorers/tool-call-accuracy.mdx +180 -176
- package/.docs/raw/reference/scorers/toxicity.mdx +35 -31
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
- package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
- package/.docs/raw/reference/storage/dynamodb.mdx +1 -1
- package/.docs/raw/reference/storage/lance.mdx +1 -1
- package/.docs/raw/reference/storage/libsql.mdx +2 -2
- package/.docs/raw/reference/storage/mongodb.mdx +4 -5
- package/.docs/raw/reference/storage/mssql.mdx +8 -7
- package/.docs/raw/reference/storage/postgresql.mdx +35 -33
- package/.docs/raw/reference/storage/upstash.mdx +6 -5
- package/.docs/raw/reference/streaming/ChunkType.mdx +788 -314
- package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +265 -109
- package/.docs/raw/reference/streaming/agents/stream.mdx +375 -266
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +233 -162
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +4 -4
- package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +5 -5
- package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +25 -21
- package/.docs/raw/reference/streaming/workflows/stream.mdx +36 -27
- package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +37 -28
- package/.docs/raw/reference/templates/overview.mdx +16 -39
- package/.docs/raw/reference/tools/client.mdx +1 -1
- package/.docs/raw/reference/tools/create-tool.mdx +45 -35
- package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -2
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +12 -12
- package/.docs/raw/reference/tools/mcp-client.mdx +78 -72
- package/.docs/raw/reference/tools/mcp-server.mdx +91 -78
- package/.docs/raw/reference/tools/vector-query-tool.mdx +48 -38
- package/.docs/raw/reference/vectors/astra.mdx +1 -1
- package/.docs/raw/reference/vectors/chroma.mdx +25 -19
- package/.docs/raw/reference/vectors/couchbase.mdx +4 -4
- package/.docs/raw/reference/vectors/lance.mdx +5 -6
- package/.docs/raw/reference/vectors/libsql.mdx +1 -1
- package/.docs/raw/reference/vectors/mongodb.mdx +1 -1
- package/.docs/raw/reference/vectors/opensearch.mdx +1 -1
- package/.docs/raw/reference/vectors/pg.mdx +8 -4
- package/.docs/raw/reference/vectors/pinecone.mdx +1 -1
- package/.docs/raw/reference/vectors/qdrant.mdx +1 -1
- package/.docs/raw/reference/vectors/s3vectors.mdx +35 -27
- package/.docs/raw/reference/vectors/turbopuffer.mdx +1 -1
- package/.docs/raw/reference/vectors/upstash.mdx +33 -25
- package/.docs/raw/reference/vectors/vectorize.mdx +1 -1
- package/.docs/raw/reference/voice/azure.mdx +1 -1
- package/.docs/raw/reference/voice/cloudflare.mdx +1 -1
- package/.docs/raw/reference/voice/composite-voice.mdx +1 -1
- package/.docs/raw/reference/voice/deepgram.mdx +1 -1
- package/.docs/raw/reference/voice/elevenlabs.mdx +1 -1
- package/.docs/raw/reference/voice/google-gemini-live.mdx +7 -5
- package/.docs/raw/reference/voice/google.mdx +1 -1
- package/.docs/raw/reference/voice/mastra-voice.mdx +1 -1
- package/.docs/raw/reference/voice/murf.mdx +1 -1
- package/.docs/raw/reference/voice/openai-realtime.mdx +1 -1
- package/.docs/raw/reference/voice/openai.mdx +1 -1
- package/.docs/raw/reference/voice/playai.mdx +1 -1
- package/.docs/raw/reference/voice/sarvam.mdx +1 -1
- package/.docs/raw/reference/voice/speechify.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addInstructions.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addTools.mdx +1 -1
- package/.docs/raw/reference/voice/voice.answer.mdx +1 -1
- package/.docs/raw/reference/voice/voice.close.mdx +1 -1
- package/.docs/raw/reference/voice/voice.connect.mdx +1 -1
- package/.docs/raw/reference/voice/voice.events.mdx +1 -1
- package/.docs/raw/reference/voice/voice.getSpeakers.mdx +23 -30
- package/.docs/raw/reference/voice/voice.listen.mdx +1 -1
- package/.docs/raw/reference/voice/voice.off.mdx +1 -1
- package/.docs/raw/reference/voice/voice.on.mdx +1 -1
- package/.docs/raw/reference/voice/voice.send.mdx +1 -1
- package/.docs/raw/reference/voice/voice.speak.mdx +1 -1
- package/.docs/raw/reference/voice/voice.updateConfig.mdx +1 -1
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -3
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +49 -34
- package/.docs/raw/reference/workflows/run-methods/start.mdx +43 -31
- package/.docs/raw/reference/workflows/run-methods/watch.mdx +7 -8
- package/.docs/raw/reference/workflows/run.mdx +7 -10
- package/.docs/raw/reference/workflows/step.mdx +16 -13
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +7 -7
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +74 -3
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +5 -5
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +3 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +3 -2
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +3 -3
- package/.docs/raw/reference/workflows/workflow.mdx +12 -23
- package/.docs/raw/scorers/custom-scorers.mdx +58 -48
- package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +6 -8
- package/.docs/raw/scorers/evals-old-api/overview.mdx +8 -8
- package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +9 -9
- package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +5 -5
- package/.docs/raw/scorers/off-the-shelf-scorers.mdx +3 -1
- package/.docs/raw/scorers/overview.mdx +23 -22
- package/.docs/raw/server-db/custom-api-routes.mdx +8 -8
- package/.docs/raw/server-db/mastra-client.mdx +56 -54
- package/.docs/raw/server-db/middleware.mdx +15 -11
- package/.docs/raw/server-db/production-server.mdx +5 -7
- package/.docs/raw/server-db/runtime-context.mdx +41 -38
- package/.docs/raw/server-db/storage.mdx +82 -87
- package/.docs/raw/streaming/events.mdx +24 -16
- package/.docs/raw/streaming/overview.mdx +17 -18
- package/.docs/raw/streaming/tool-streaming.mdx +9 -10
- package/.docs/raw/streaming/workflow-streaming.mdx +14 -12
- package/.docs/raw/tools-mcp/advanced-usage.mdx +2 -2
- package/.docs/raw/tools-mcp/mcp-overview.mdx +92 -102
- package/.docs/raw/tools-mcp/overview.mdx +10 -15
- package/.docs/raw/voice/overview.mdx +273 -250
- package/.docs/raw/voice/speech-to-speech.mdx +14 -12
- package/.docs/raw/voice/speech-to-text.mdx +2 -2
- package/.docs/raw/voice/text-to-speech.mdx +2 -2
- package/.docs/raw/workflows/agents-and-tools.mdx +27 -30
- package/.docs/raw/workflows/control-flow.mdx +213 -170
- package/.docs/raw/workflows/error-handling.mdx +15 -17
- package/.docs/raw/workflows/human-in-the-loop.mdx +39 -39
- package/.docs/raw/workflows/inngest-workflow.mdx +35 -31
- package/.docs/raw/workflows/overview.mdx +108 -56
- package/.docs/raw/workflows/snapshots.mdx +54 -36
- package/.docs/raw/workflows/suspend-and-resume.mdx +52 -65
- package/.docs/raw/workflows-legacy/control-flow.mdx +15 -17
- package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +3 -1
- package/.docs/raw/workflows-legacy/error-handling.mdx +8 -6
- package/.docs/raw/workflows-legacy/nested-workflows.mdx +6 -0
- package/.docs/raw/workflows-legacy/overview.mdx +28 -26
- package/.docs/raw/workflows-legacy/runtime-variables.mdx +4 -2
- package/.docs/raw/workflows-legacy/steps.mdx +5 -3
- package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +10 -8
- package/.docs/raw/workflows-legacy/variables.mdx +10 -8
- package/CHANGELOG.md +24 -0
- package/package.json +5 -5
- package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -148
- package/.docs/raw/workflows/input-data-mapping.mdx +0 -107
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: MastraVoice | Voice
|
|
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: OpenAI Realtime Voice | Voice
|
|
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: voice.addInstructions() | Voice
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
|
@@ -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
|
|
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
|
-
|
|
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
|
-
</
|
|
73
|
+
</TabItem>
|
|
81
74
|
|
|
82
|
-
<
|
|
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
|
-
</
|
|
86
|
+
</TabItem>
|
|
94
87
|
|
|
95
|
-
<
|
|
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
|
-
</
|
|
103
|
+
</TabItem>
|
|
111
104
|
|
|
112
|
-
<
|
|
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
|
-
</
|
|
125
|
+
</TabItem>
|
|
133
126
|
|
|
134
|
-
<
|
|
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
|
-
</
|
|
143
|
+
</TabItem>
|
|
151
144
|
|
|
152
|
-
<
|
|
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
|
-
</
|
|
165
|
+
</TabItem>
|
|
173
166
|
|
|
174
|
-
<
|
|
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
|
-
</
|
|
193
|
+
</TabItem>
|
|
201
194
|
|
|
202
|
-
<
|
|
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
|
-
</
|
|
233
|
+
</TabItem>
|
|
241
234
|
|
|
242
|
-
<
|
|
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
|
-
</
|
|
255
|
+
</TabItem>
|
|
263
256
|
|
|
264
|
-
|
|
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
|
-
</
|
|
282
|
+
</TabItem>
|
|
290
283
|
</Tabs>
|
|
291
284
|
|
|
292
285
|
## Notes
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: voice.send() | Voice
|
|
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.updateConfig() | Voice
|
|
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:
|
|
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](
|
|
58
|
-
- [Workflow.createRunAsync()](../create-run
|
|
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:
|
|
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:
|
|
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
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
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
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
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
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
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:
|
|
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:
|
|
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](
|
|
135
|
-
- [Workflow.createRunAsync()](../create-run
|
|
136
|
-
- [Suspend and resume](
|
|
137
|
-
- [Human in the loop example](
|
|
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:
|
|
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
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
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
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
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
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
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:
|
|
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:
|
|
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](
|
|
134
|
-
- [Workflow.createRunAsync()](../create-run
|
|
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:
|
|
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:
|
|
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
|
-
|
|
71
|
-
|
|
72
|
-
- [
|
|
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)
|