@mastra/mcp-docs-server 0.13.37 → 0.13.38
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%2Fclient-js.md +23 -23
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +69 -69
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +25 -25
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +15 -15
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +27 -27
- package/.docs/organized/changelogs/%40mastra%2Freact.md +15 -15
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +23 -23
- package/.docs/organized/changelogs/create-mastra.md +5 -5
- package/.docs/organized/changelogs/mastra.md +17 -17
- 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 +125 -88
- 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/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 +138 -145
- 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 +59 -48
- package/.docs/raw/frameworks/servers/express.mdx +45 -44
- 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 +189 -164
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +94 -81
- package/.docs/raw/getting-started/installation.mdx +164 -133
- 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 +40 -58
- package/.docs/raw/getting-started/templates.mdx +22 -27
- package/.docs/raw/index.mdx +9 -9
- package/.docs/raw/mastra-cloud/dashboard.mdx +10 -10
- package/.docs/raw/mastra-cloud/observability.mdx +7 -8
- package/.docs/raw/mastra-cloud/overview.mdx +16 -22
- 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 +21 -23
- package/.docs/raw/memory/semantic-recall.mdx +14 -13
- 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 +23 -20
- 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 +31 -32
- 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 +145 -122
- 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 +14 -10
- 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 +54 -41
- 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/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 +40 -43
- package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
- package/.docs/raw/reference/client-js/logs.mdx +1 -1
- package/.docs/raw/reference/client-js/mastra-client.mdx +21 -13
- package/.docs/raw/reference/client-js/memory.mdx +6 -2
- 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 +1 -1
- 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 +7 -7
- 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 +12 -9
- 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/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} +53 -46
- package/.docs/raw/reference/memory/query.mdx +39 -25
- package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +9 -5
- 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 +115 -106
- 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 +3 -3
- 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 +13 -10
- package/.docs/raw/reference/processors/language-detector.mdx +27 -17
- package/.docs/raw/reference/processors/moderation-processor.mdx +26 -17
- package/.docs/raw/reference/processors/pii-detector.mdx +28 -18
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +25 -17
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +26 -17
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +22 -15
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +13 -12
- package/.docs/raw/reference/rag/chunk.mdx +41 -23
- package/.docs/raw/reference/rag/database-config.mdx +56 -38
- package/.docs/raw/reference/rag/document.mdx +1 -1
- 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 +40 -31
- 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 +5 -4
- 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 +24 -20
- package/.docs/raw/reference/streaming/workflows/stream.mdx +35 -26
- package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +36 -27
- 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 +70 -64
- 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 +6 -4
- 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 +15 -12
- 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 +3 -2
- 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 +13 -10
- 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 +20 -19
- 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 +11 -7
- 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 +9 -14
- 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 +29 -28
- package/.docs/raw/workflows/control-flow.mdx +24 -24
- 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 +33 -29
- package/.docs/raw/workflows/input-data-mapping.mdx +9 -9
- package/.docs/raw/workflows/overview.mdx +60 -60
- package/.docs/raw/workflows/snapshots.mdx +54 -36
- package/.docs/raw/workflows/suspend-and-resume.mdx +52 -57
- 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 +14 -0
- package/package.json +5 -5
- package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -148
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: ContextualRecallMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Contextual Recall Metric, which evaluates the completeness of LLM responses in incorporating relevant context.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# ContextualRecallMetric
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
:::info Scorers
|
|
9
|
+
This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
|
|
10
|
+
:::
|
|
11
11
|
|
|
12
12
|
The `ContextualRecallMetric` class evaluates how effectively an LLM's response incorporates all relevant information from the provided context. It measures whether important information from the reference documents was successfully included in the response, focusing on completeness rather than precision.
|
|
13
13
|
|
|
@@ -133,7 +133,6 @@ The metric evaluates recall through comparison of response content against relev
|
|
|
133
133
|
### Scoring Process
|
|
134
134
|
|
|
135
135
|
1. Evaluates information recall:
|
|
136
|
-
|
|
137
136
|
- Identifies relevant items in context
|
|
138
137
|
- Tracks correctly recalled information
|
|
139
138
|
- Measures completeness of recall
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: FaithfulnessMetric Reference | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Faithfulness Metric in Mastra, which evaluates the factual accuracy of LLM outputs compared to the provided context.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# FaithfulnessMetric Reference
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
:::info Scorers
|
|
9
|
+
This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
|
|
10
|
+
:::
|
|
11
11
|
|
|
12
12
|
The `FaithfulnessMetric` in Mastra evaluates how factually accurate an LLM's output is compared to the provided context. It extracts claims from the output and verifies them against the context, making it essential to measure RAG pipeline responses' reliability.
|
|
13
13
|
|
|
@@ -134,7 +134,6 @@ The metric evaluates faithfulness through claim verification against provided co
|
|
|
134
134
|
### Scoring Process
|
|
135
135
|
|
|
136
136
|
1. Analyzes claims and context:
|
|
137
|
-
|
|
138
137
|
- Extracts all claims (factual and speculative)
|
|
139
138
|
- Verifies each claim against context
|
|
140
139
|
- Assigns one of three verdicts:
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: HallucinationMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Hallucination Metric in Mastra, which evaluates the factual correctness of LLM outputs by identifying contradictions with provided context.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# HallucinationMetric
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
:::info Scorers
|
|
9
|
+
This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
|
|
10
|
+
:::
|
|
11
11
|
|
|
12
12
|
The `HallucinationMetric` evaluates whether an LLM generates factually correct information by comparing its output against the provided context. This metric measures hallucination by identifying direct contradictions between the context and the output.
|
|
13
13
|
|
|
@@ -140,13 +140,11 @@ The metric evaluates hallucination through contradiction detection and unsupport
|
|
|
140
140
|
### Scoring Process
|
|
141
141
|
|
|
142
142
|
1. Analyzes factual content:
|
|
143
|
-
|
|
144
143
|
- Extracts statements from context
|
|
145
144
|
- Identifies numerical values and dates
|
|
146
145
|
- Maps statement relationships
|
|
147
146
|
|
|
148
147
|
2. Analyzes output for hallucinations:
|
|
149
|
-
|
|
150
148
|
- Compares against context statements
|
|
151
149
|
- Marks direct conflicts as hallucinations
|
|
152
150
|
- Identifies unsupported claims as hallucinations
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: KeywordCoverageMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Keyword Coverage Metric in Mastra, which evaluates how well LLM outputs cover important keywords from the input.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# KeywordCoverageMetric
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
:::info Scorers
|
|
9
|
+
This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
|
|
10
|
+
:::
|
|
11
11
|
|
|
12
12
|
The `KeywordCoverageMetric` class evaluates how well an LLM's output covers the important keywords from the input. It analyzes keyword presence and matches while ignoring common words and stop words.
|
|
13
13
|
|
|
@@ -98,7 +98,6 @@ The metric evaluates keyword coverage by matching keywords with the following fe
|
|
|
98
98
|
### Scoring Process
|
|
99
99
|
|
|
100
100
|
1. Processes keywords from input and output:
|
|
101
|
-
|
|
102
101
|
- Filters out common words and stop words
|
|
103
102
|
- Normalizes case and word forms
|
|
104
103
|
- Handles special terms and compounds
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: PromptAlignmentMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Prompt Alignment Metric in Mastra, which evaluates how well LLM outputs adhere to given prompt instructions.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# PromptAlignmentMetric
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
:::info Scorers
|
|
9
|
+
This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
|
|
10
|
+
:::
|
|
11
11
|
|
|
12
12
|
The `PromptAlignmentMetric` class evaluates how strictly an LLM's output follows a set of given prompt instructions. It uses a judge-based system to verify each instruction is followed exactly and provides detailed reasoning for any deviations.
|
|
13
13
|
|
|
@@ -150,13 +150,11 @@ Each instruction receives one of three verdicts:
|
|
|
150
150
|
### Scoring Process
|
|
151
151
|
|
|
152
152
|
1. Evaluates instruction applicability:
|
|
153
|
-
|
|
154
153
|
- Determines if each instruction applies to the context
|
|
155
154
|
- Marks irrelevant instructions as "n/a"
|
|
156
155
|
- Considers domain-specific requirements
|
|
157
156
|
|
|
158
157
|
2. Assesses compliance for applicable instructions:
|
|
159
|
-
|
|
160
158
|
- Evaluates each applicable instruction independently
|
|
161
159
|
- Requires complete compliance for "yes" verdict
|
|
162
160
|
- Documents specific reasons for all verdicts
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: SummarizationMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Summarization Metric in Mastra, which evaluates the quality of LLM-generated summaries for content and factual accuracy.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# SummarizationMetric
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
:::info Scorers
|
|
9
|
+
This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
|
|
10
|
+
:::
|
|
11
11
|
|
|
12
12
|
The `SummarizationMetric` evaluates how well an LLM's summary captures the original text's content while maintaining factual accuracy. It combines two aspects: alignment (factual correctness) and coverage (inclusion of key information), using the minimum scores to ensure both qualities are necessary for a good summary.
|
|
13
13
|
|
|
@@ -139,7 +139,6 @@ console.log(result.info); // Object containing detailed metrics about the summar
|
|
|
139
139
|
The metric evaluates summaries through two essential components:
|
|
140
140
|
|
|
141
141
|
1. **Alignment Score**: Measures factual correctness
|
|
142
|
-
|
|
143
142
|
- Extracts claims from the summary
|
|
144
143
|
- Verifies each claim against the original text
|
|
145
144
|
- Assigns "yes", "no", or "unsure" verdicts
|
|
@@ -152,7 +151,6 @@ The metric evaluates summaries through two essential components:
|
|
|
152
151
|
### Scoring Process
|
|
153
152
|
|
|
154
153
|
1. Calculates alignment score:
|
|
155
|
-
|
|
156
154
|
- Extracts claims from summary
|
|
157
155
|
- Verifies against source text
|
|
158
156
|
- Computes: `supported_claims / total_claims`
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: TextualDifferenceMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Textual Difference Metric in Mastra, which measures textual differences between strings using sequence matching.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# TextualDifferenceMetric
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
:::info Scorers
|
|
9
|
+
This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
|
|
10
|
+
:::
|
|
11
11
|
|
|
12
12
|
The `TextualDifferenceMetric` class uses sequence matching to measure the textual differences between two strings. It provides detailed information about changes, including the number of operations needed to transform one text into another.
|
|
13
13
|
|
|
@@ -119,7 +119,6 @@ The metric calculates several measures:
|
|
|
119
119
|
### Scoring Process
|
|
120
120
|
|
|
121
121
|
1. Analyzes textual differences:
|
|
122
|
-
|
|
123
122
|
- Performs sequence matching between input and output
|
|
124
123
|
- Counts the number of change operations required
|
|
125
124
|
- Measures length differences
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: ToneConsistencyMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Tone Consistency Metric in Mastra, which evaluates emotional tone and sentiment consistency in text.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# ToneConsistencyMetric
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
:::info Scorers
|
|
9
|
+
This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
|
|
10
|
+
:::
|
|
11
11
|
|
|
12
12
|
The `ToneConsistencyMetric` class evaluates the text's emotional tone and sentiment consistency. It can operate in two modes: comparing tone between input/output pairs or analyzing tone stability within a single text.
|
|
13
13
|
|
|
@@ -117,20 +117,17 @@ The metric evaluates sentiment consistency through tone pattern analysis and mod
|
|
|
117
117
|
### Scoring Process
|
|
118
118
|
|
|
119
119
|
1. Analyzes tone patterns:
|
|
120
|
-
|
|
121
120
|
- Extracts sentiment features
|
|
122
121
|
- Computes sentiment scores
|
|
123
122
|
- Measures tone variations
|
|
124
123
|
|
|
125
124
|
2. Calculates mode-specific score:
|
|
126
125
|
**Tone Consistency** (input and output):
|
|
127
|
-
|
|
128
126
|
- Compares sentiment between texts
|
|
129
127
|
- Calculates sentiment difference
|
|
130
128
|
- Score = 1 - (sentiment_difference / max_difference)
|
|
131
129
|
|
|
132
130
|
**Tone Stability** (single input):
|
|
133
|
-
|
|
134
131
|
- Analyzes sentiment across sentences
|
|
135
132
|
- Calculates sentiment variance
|
|
136
133
|
- Score = 1 - (sentiment_variance / max_variance)
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: ToxicityMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Toxicity Metric in Mastra, which evaluates LLM outputs for racist, biased, or toxic elements.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# ToxicityMetric
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
:::info Scorers
|
|
9
|
+
This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
|
|
10
|
+
:::
|
|
11
11
|
|
|
12
12
|
The `ToxicityMetric` class evaluates whether an LLM's output contains racist, biased, or toxic elements. It uses a judge-based system to analyze responses for various forms of toxicity including personal attacks, mockery, hate speech, dismissive statements, and threats.
|
|
13
13
|
|
|
@@ -128,7 +128,6 @@ The metric evaluates toxicity through multiple aspects:
|
|
|
128
128
|
### Scoring Process
|
|
129
129
|
|
|
130
130
|
1. Analyzes toxic elements:
|
|
131
|
-
|
|
132
131
|
- Identifies personal attacks and mockery
|
|
133
132
|
- Detects hate speech and threats
|
|
134
133
|
- Evaluates dismissive statements
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
3
|
-
description: "Mastra
|
|
2
|
+
title: "Reference: Overview"
|
|
3
|
+
description: "Reference documentation on Mastra's APIs and tools"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ReferenceCards } from "
|
|
6
|
+
import { ReferenceCards } from "@site/src/components/ReferenceCards";
|
|
7
7
|
|
|
8
8
|
# Reference
|
|
9
9
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: .after() |
|
|
2
|
+
title: "Reference: .after() | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: Documentation for the `after()` method in workflows (legacy), enabling branching and merging paths.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -83,7 +83,7 @@ workflow
|
|
|
83
83
|
|
|
84
84
|
## Related
|
|
85
85
|
|
|
86
|
-
- [Branching Paths example](
|
|
87
|
-
- [Workflow Class Reference](./workflow
|
|
88
|
-
- [Step Reference](./step-class
|
|
89
|
-
- [Control Flow Guide](
|
|
86
|
+
- [Branching Paths example](/examples/workflows_legacy/branching-paths)
|
|
87
|
+
- [Workflow Class Reference](./workflow)
|
|
88
|
+
- [Step Reference](./step-class)
|
|
89
|
+
- [Control Flow Guide](/docs/workflows-legacy/control-flow)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
2
|
+
title: "Reference: afterEvent() | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: "Reference for the afterEvent method in Mastra workflows that creates event-based suspension points."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -73,7 +73,7 @@ workflow
|
|
|
73
73
|
|
|
74
74
|
## Related
|
|
75
75
|
|
|
76
|
-
- [Event-Driven Workflows](./events
|
|
77
|
-
- [resumeWithEvent()](./resumeWithEvent
|
|
78
|
-
- [Suspend and Resume](
|
|
79
|
-
- [Workflow Class](./workflow
|
|
76
|
+
- [Event-Driven Workflows](./events)
|
|
77
|
+
- [resumeWithEvent()](./resumeWithEvent)
|
|
78
|
+
- [Suspend and Resume](/docs/workflows-legacy/suspend-and-resume)
|
|
79
|
+
- [Workflow Class](./workflow)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Workflow.commit() |
|
|
2
|
+
title: "Reference: Workflow.commit() | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: Documentation for the `.commit()` method in workflows, which re-initializes the workflow machine with the current step configuration.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -27,7 +27,7 @@ workflow.step(stepA).then(stepB).commit();
|
|
|
27
27
|
|
|
28
28
|
## Related
|
|
29
29
|
|
|
30
|
-
- [Branching Paths example](
|
|
31
|
-
- [Workflow Class Reference](./workflow
|
|
32
|
-
- [Step Reference](./step-class
|
|
33
|
-
- [Control Flow Guide](
|
|
30
|
+
- [Branching Paths example](/examples/workflows_legacy/branching-paths)
|
|
31
|
+
- [Workflow Class Reference](./workflow)
|
|
32
|
+
- [Step Reference](./step-class)
|
|
33
|
+
- [Control Flow Guide](/docs/workflows-legacy/control-flow)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Workflow.createRun() |
|
|
2
|
+
title: "Reference: Workflow.createRun() | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: "Documentation for the `.createRun()` method in workflows (legacy), which initializes a new workflow run instance."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -71,6 +71,6 @@ try {
|
|
|
71
71
|
|
|
72
72
|
## Related
|
|
73
73
|
|
|
74
|
-
- [Workflow Class Reference](./workflow
|
|
75
|
-
- [Step Class Reference](./step-class
|
|
76
|
-
- See the [Creating a Workflow](
|
|
74
|
+
- [Workflow Class Reference](./workflow)
|
|
75
|
+
- [Step Class Reference](./step-class)
|
|
76
|
+
- See the [Creating a Workflow](/examples/workflows_legacy/creating-a-workflow) example for complete usage
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Workflow.else() |
|
|
2
|
+
title: "Reference: Workflow.else() | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: "Documentation for the `.else()` method in Mastra workflows, which creates an alternative branch when an if condition is false."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -62,7 +62,7 @@ try {
|
|
|
62
62
|
|
|
63
63
|
## Related
|
|
64
64
|
|
|
65
|
-
- [if Reference](./if
|
|
66
|
-
- [then Reference](./then
|
|
67
|
-
- [Control Flow Guide](
|
|
68
|
-
- [Step Condition Reference](./step-condition
|
|
65
|
+
- [if Reference](./if)
|
|
66
|
+
- [then Reference](./then)
|
|
67
|
+
- [Control Flow Guide](/docs/workflows-legacy/control-flow)
|
|
68
|
+
- [Step Condition Reference](./step-condition)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Event-Driven Workflows
|
|
2
|
+
title: "Reference: Event-Driven Workflows | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: "Learn how to create event-driven workflows using afterEvent and resumeWithEvent methods in Mastra."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -297,9 +297,9 @@ runWorkflow().catch(console.error);
|
|
|
297
297
|
|
|
298
298
|
## Related
|
|
299
299
|
|
|
300
|
-
- [Suspend and Resume in Workflows](
|
|
301
|
-
- [Workflow Class Reference](./workflow
|
|
302
|
-
- [Resume Method Reference](./resume
|
|
303
|
-
- [Watch Method Reference](./watch
|
|
304
|
-
- [After Event Reference](./afterEvent
|
|
305
|
-
- [Resume With Event Reference](./resumeWithEvent
|
|
300
|
+
- [Suspend and Resume in Workflows](/docs/workflows-legacy/suspend-and-resume)
|
|
301
|
+
- [Workflow Class Reference](./workflow)
|
|
302
|
+
- [Resume Method Reference](./resume)
|
|
303
|
+
- [Watch Method Reference](./watch)
|
|
304
|
+
- [After Event Reference](./afterEvent)
|
|
305
|
+
- [Resume With Event Reference](./resumeWithEvent)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Workflow.execute() | Workflows
|
|
2
|
+
title: "Reference: Workflow.execute() | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: "Documentation for the `.execute()` method in Mastra workflows, which runs workflow steps and returns results."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -105,6 +105,6 @@ if (status === "COMPLETED") {
|
|
|
105
105
|
|
|
106
106
|
### Related
|
|
107
107
|
|
|
108
|
-
- [Workflow.createRun()](./createRun
|
|
109
|
-
- [Workflow.commit()](./commit
|
|
110
|
-
- [Workflow.start()](./start
|
|
108
|
+
- [Workflow.createRun()](./createRun)
|
|
109
|
+
- [Workflow.commit()](./commit)
|
|
110
|
+
- [Workflow.start()](./start)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Workflow.if() |
|
|
2
|
+
title: "Reference: Workflow.if() | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: "Documentation for the `.if()` method in Mastra workflows, which creates conditional branches based on specified conditions."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -102,7 +102,7 @@ try {
|
|
|
102
102
|
|
|
103
103
|
## Related
|
|
104
104
|
|
|
105
|
-
- [else Reference](./else
|
|
106
|
-
- [then Reference](./then
|
|
107
|
-
- [Control Flow Guide](
|
|
108
|
-
- [Step Condition Reference](./step-condition
|
|
105
|
+
- [else Reference](./else)
|
|
106
|
+
- [then Reference](./then)
|
|
107
|
+
- [Control Flow Guide](/docs/workflows-legacy/control-flow)
|
|
108
|
+
- [Step Condition Reference](./step-condition)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: run.resume() |
|
|
2
|
+
title: "Reference: run.resume() | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: Documentation for the `.resume()` method in workflows, which continues execution of a suspended workflow step.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -152,7 +152,7 @@ try {
|
|
|
152
152
|
|
|
153
153
|
## Related
|
|
154
154
|
|
|
155
|
-
- [Suspend and Resume](
|
|
156
|
-
- [`suspend` Reference](./suspend
|
|
157
|
-
- [`watch` Reference](./watch
|
|
158
|
-
- [Workflow Class Reference](./workflow
|
|
155
|
+
- [Suspend and Resume](/docs/workflows-legacy/suspend-and-resume)
|
|
156
|
+
- [`suspend` Reference](./suspend)
|
|
157
|
+
- [`watch` Reference](./watch)
|
|
158
|
+
- [Workflow Class Reference](./workflow)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
2
|
+
title: "Reference: resumeWithEvent() | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: "Reference for the resumeWithEvent method that resumes suspended workflows using event data."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -126,8 +126,8 @@ await start({ triggerData: { requestId: "auto-123" } });
|
|
|
126
126
|
|
|
127
127
|
## Related
|
|
128
128
|
|
|
129
|
-
- [Event-Driven Workflows](./events
|
|
130
|
-
- [afterEvent()](./afterEvent
|
|
131
|
-
- [Suspend and Resume](
|
|
132
|
-
- [resume()](./resume
|
|
133
|
-
- [watch()](./watch
|
|
129
|
+
- [Event-Driven Workflows](./events)
|
|
130
|
+
- [afterEvent()](./afterEvent)
|
|
131
|
+
- [Suspend and Resume](/docs/workflows-legacy/suspend-and-resume)
|
|
132
|
+
- [resume()](./resume)
|
|
133
|
+
- [watch()](./watch)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Snapshots |
|
|
2
|
+
title: "Reference: Snapshots | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: "Technical reference on snapshots in Mastra - the serialized workflow state that enables suspend and resume functionality"
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -76,7 +76,7 @@ Mastra persists snapshots to the configured storage system. By default, snapshot
|
|
|
76
76
|
The snapshots are stored in the `workflow_snapshots` table and identified uniquely by the `run_id` for the associated run when using libsql.
|
|
77
77
|
Utilizing a persistence layer allows for the snapshots to be persisted across workflow runs, allowing for advanced human-in-the-loop functionality.
|
|
78
78
|
|
|
79
|
-
Read more about [libsql storage](../storage/libsql
|
|
79
|
+
Read more about [libsql storage](../storage/libsql) and [upstash storage](../storage/upstash) here.
|
|
80
80
|
|
|
81
81
|
### Saving Snapshots
|
|
82
82
|
|
|
@@ -201,7 +201,7 @@ run.watch(async ({ activePaths }) => {
|
|
|
201
201
|
|
|
202
202
|
## Related
|
|
203
203
|
|
|
204
|
-
- [Suspend Function Reference](./suspend
|
|
205
|
-
- [Resume Function Reference](./resume
|
|
206
|
-
- [Watch Function Reference](./watch
|
|
207
|
-
- [Suspend and Resume Guide](
|
|
204
|
+
- [Suspend Function Reference](./suspend)
|
|
205
|
+
- [Resume Function Reference](./resume)
|
|
206
|
+
- [Watch Function Reference](./watch)
|
|
207
|
+
- [Suspend and Resume Guide](/docs/workflows-legacy/suspend-and-resume)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: start() |
|
|
2
|
+
title: "Reference: start() | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: "Documentation for the `start()` method in workflows, which begins execution of a workflow run."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -76,11 +76,11 @@ try {
|
|
|
76
76
|
|
|
77
77
|
## Related
|
|
78
78
|
|
|
79
|
-
- [Example: Creating a Workflow](
|
|
80
|
-
- [Example: Suspend and Resume](
|
|
81
|
-
- [createRun Reference](./createRun
|
|
82
|
-
- [Workflow Class Reference](./workflow
|
|
83
|
-
- [Step Class Reference](./step-class
|
|
79
|
+
- [Example: Creating a Workflow](/examples/workflows_legacy/creating-a-workflow)
|
|
80
|
+
- [Example: Suspend and Resume](/examples/workflows_legacy/suspend-and-resume)
|
|
81
|
+
- [createRun Reference](./createRun)
|
|
82
|
+
- [Workflow Class Reference](./workflow)
|
|
83
|
+
- [Step Class Reference](./step-class)
|
|
84
84
|
|
|
85
85
|
```
|
|
86
86
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Step |
|
|
2
|
+
title: "Reference: Step | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: Documentation for the Step class, which defines individual units of work within a workflow.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -95,6 +95,6 @@ const processOrder = new LegacyStep({
|
|
|
95
95
|
|
|
96
96
|
## Related
|
|
97
97
|
|
|
98
|
-
- [Workflow Reference](./workflow
|
|
99
|
-
- [Step Configuration Guide](
|
|
100
|
-
- [Control Flow Guide](
|
|
98
|
+
- [Workflow Reference](./workflow)
|
|
99
|
+
- [Step Configuration Guide](/docs/workflows-legacy/steps)
|
|
100
|
+
- [Control Flow Guide](/docs/workflows-legacy/control-flow)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: StepCondition |
|
|
2
|
+
title: "Reference: StepCondition | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: Documentation for the step condition class in workflows, which determines whether a step should execute based on the output of previous steps or trigger data.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -132,6 +132,6 @@ This query syntax allows for readable conditional logic for determining whether
|
|
|
132
132
|
|
|
133
133
|
## Related
|
|
134
134
|
|
|
135
|
-
- [Step Options Reference](./step-options
|
|
136
|
-
- [Step Function Reference](./step-function
|
|
137
|
-
- [Control Flow Guide](
|
|
135
|
+
- [Step Options Reference](./step-options)
|
|
136
|
+
- [Step Function Reference](./step-function)
|
|
137
|
+
- [Control Flow Guide](/docs/workflows-legacy/control-flow)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Workflow.step() | Workflows
|
|
2
|
+
title: "Reference: Workflow.step() | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: Documentation for the `.step()` method in workflows, which adds a new step to the workflow.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -87,7 +87,7 @@ workflow.step({
|
|
|
87
87
|
|
|
88
88
|
## Related
|
|
89
89
|
|
|
90
|
-
- [Basic Usage with Step Instance](
|
|
91
|
-
- [Step Class Reference](./step-class
|
|
92
|
-
- [Workflow Class Reference](./workflow
|
|
93
|
-
- [Control Flow Guide](
|
|
90
|
+
- [Basic Usage with Step Instance](/docs/workflows-legacy/steps)
|
|
91
|
+
- [Step Class Reference](./step-class)
|
|
92
|
+
- [Workflow Class Reference](./workflow)
|
|
93
|
+
- [Control Flow Guide](/docs/workflows-legacy/control-flow)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: StepOptions |
|
|
2
|
+
title: "Reference: StepOptions | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: Documentation for the step options in workflows, which control variable mapping, execution conditions, and other runtime behavior.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -62,8 +62,8 @@ workflow.step(processOrder, {
|
|
|
62
62
|
|
|
63
63
|
## Related
|
|
64
64
|
|
|
65
|
-
- [Path Comparison](
|
|
66
|
-
- [Step Function Reference](./step-function
|
|
67
|
-
- [Step Class Reference](./step-class
|
|
68
|
-
- [Workflow Class Reference](./workflow
|
|
69
|
-
- [Control Flow Guide](
|
|
65
|
+
- [Path Comparison](/docs/workflows-legacy/control-flow)
|
|
66
|
+
- [Step Function Reference](./step-function)
|
|
67
|
+
- [Step Class Reference](./step-class)
|
|
68
|
+
- [Workflow Class Reference](./workflow)
|
|
69
|
+
- [Control Flow Guide](/docs/workflows-legacy/control-flow)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Step Retries |
|
|
2
|
+
title: "Reference: Step Retries | Legacy Workflows | Mastra Docs"
|
|
3
3
|
description: "Automatically retry failed steps in Mastra workflows with configurable retry policies."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -191,6 +191,6 @@ You can monitor retry attempts in your logs. Mastra logs retry-related events at
|
|
|
191
191
|
|
|
192
192
|
## Related
|
|
193
193
|
|
|
194
|
-
- [Step Class Reference](./step-class
|
|
195
|
-
- [Workflow Configuration](./workflow
|
|
196
|
-
- [Error Handling in Workflows](
|
|
194
|
+
- [Step Class Reference](./step-class)
|
|
195
|
+
- [Workflow Configuration](./workflow)
|
|
196
|
+
- [Error Handling in Workflows](/docs/workflows-legacy/error-handling)
|