@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
|
@@ -12,15 +12,14 @@ Think of `Mastra` as a top-level registry:
|
|
|
12
12
|
- Registering **integrations** makes them accessible to **agents**, **workflows**, and **tools** alike.
|
|
13
13
|
- **tools** aren’t registered on `Mastra` directly but are associated with agents and discovered automatically.
|
|
14
14
|
|
|
15
|
-
|
|
16
15
|
## Usage example
|
|
17
16
|
|
|
18
|
-
```typescript
|
|
19
|
-
import { Mastra } from
|
|
20
|
-
import { PinoLogger } from
|
|
21
|
-
import { LibSQLStore } from
|
|
22
|
-
import { weatherWorkflow } from
|
|
23
|
-
import { weatherAgent } from
|
|
17
|
+
```typescript title="src/mastra/index.ts"
|
|
18
|
+
import { Mastra } from "@mastra/core/mastra";
|
|
19
|
+
import { PinoLogger } from "@mastra/loggers";
|
|
20
|
+
import { LibSQLStore } from "@mastra/libsql";
|
|
21
|
+
import { weatherWorkflow } from "./workflows/weather-workflow";
|
|
22
|
+
import { weatherAgent } from "./agents/weather-agent";
|
|
24
23
|
|
|
25
24
|
export const mastra = new Mastra({
|
|
26
25
|
workflows: { weatherWorkflow },
|
|
@@ -29,8 +28,8 @@ export const mastra = new Mastra({
|
|
|
29
28
|
url: ":memory:",
|
|
30
29
|
}),
|
|
31
30
|
logger: new PinoLogger({
|
|
32
|
-
name:
|
|
33
|
-
level:
|
|
31
|
+
name: "Mastra",
|
|
32
|
+
level: "info",
|
|
34
33
|
}),
|
|
35
34
|
});
|
|
36
35
|
```
|
|
@@ -77,7 +76,8 @@ export const mastra = new Mastra({
|
|
|
77
76
|
{
|
|
78
77
|
name: "idGenerator",
|
|
79
78
|
type: "() => string",
|
|
80
|
-
description:
|
|
79
|
+
description:
|
|
80
|
+
"Custom ID generator function. Used by agents, workflows, memory, and other components to generate unique identifiers.",
|
|
81
81
|
isOptional: true,
|
|
82
82
|
},
|
|
83
83
|
{
|
|
@@ -125,19 +125,19 @@ export const mastra = new Mastra({
|
|
|
125
125
|
{
|
|
126
126
|
name: "bundler",
|
|
127
127
|
type: "BundlerConfig",
|
|
128
|
-
description:
|
|
128
|
+
description:
|
|
129
|
+
"Configuration for the asset bundler with options for externals, sourcemap, and transpilePackages.",
|
|
129
130
|
isOptional: true,
|
|
130
|
-
defaultValue:
|
|
131
|
+
defaultValue:
|
|
132
|
+
"{ externals: [], sourcemap: false, transpilePackages: [] }",
|
|
131
133
|
},
|
|
132
134
|
{
|
|
133
135
|
name: "scorers",
|
|
134
136
|
type: "Record<string, MastraScorer>",
|
|
135
|
-
|
|
137
|
+
description:
|
|
138
|
+
"Scorers to register for scoring traces and overriding default scorers used during agent generation or workflow execution. Structured as a key-value pair, with keys being the scorer name and values being the scorer instance.",
|
|
136
139
|
isOptional: true,
|
|
137
140
|
defaultValue: "{}",
|
|
138
141
|
},
|
|
139
142
|
]}
|
|
140
143
|
/>
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
@@ -20,7 +20,8 @@ mastra.setLogger({ logger: new PinoLogger({ name: "testLogger" }) });
|
|
|
20
20
|
{
|
|
21
21
|
name: "options",
|
|
22
22
|
type: "{ logger: TLogger }",
|
|
23
|
-
description:
|
|
23
|
+
description:
|
|
24
|
+
"An object containing the logger instance to set for all components.",
|
|
24
25
|
},
|
|
25
26
|
]}
|
|
26
27
|
/>
|
|
@@ -32,7 +33,8 @@ mastra.setLogger({ logger: new PinoLogger({ name: "testLogger" }) });
|
|
|
32
33
|
{
|
|
33
34
|
name: "logger",
|
|
34
35
|
type: "TLogger",
|
|
35
|
-
description:
|
|
36
|
+
description:
|
|
37
|
+
"The logger instance to set for all components (agents, workflows, etc.).",
|
|
36
38
|
},
|
|
37
39
|
]}
|
|
38
40
|
/>
|
|
@@ -43,5 +45,5 @@ This method does not return a value.
|
|
|
43
45
|
|
|
44
46
|
## Related
|
|
45
47
|
|
|
46
|
-
- [Logging overview](
|
|
47
|
-
- [Logger reference](
|
|
48
|
+
- [Logging overview](/docs/observability/logging)
|
|
49
|
+
- [Logger reference](/reference/observability/logging/pino-logger)
|
|
@@ -12,8 +12,8 @@ The `.setStorage()` method is used to set the storage instance for the Mastra in
|
|
|
12
12
|
```typescript copy
|
|
13
13
|
mastra.setStorage(
|
|
14
14
|
new LibSQLStore({
|
|
15
|
-
url: ":memory:"
|
|
16
|
-
})
|
|
15
|
+
url: ":memory:",
|
|
16
|
+
}),
|
|
17
17
|
);
|
|
18
18
|
```
|
|
19
19
|
|
|
@@ -35,5 +35,5 @@ This method does not return a value.
|
|
|
35
35
|
|
|
36
36
|
## Related
|
|
37
37
|
|
|
38
|
-
- [Storage overview](
|
|
39
|
-
- [Storage reference](
|
|
38
|
+
- [Storage overview](/docs/server-db/storage)
|
|
39
|
+
- [Storage reference](/reference/storage/libsql)
|
|
@@ -20,7 +20,8 @@ mastra.setTelemetry({ export: { type: "console" } });
|
|
|
20
20
|
{
|
|
21
21
|
name: "telemetry",
|
|
22
22
|
type: "OtelConfig",
|
|
23
|
-
description:
|
|
23
|
+
description:
|
|
24
|
+
"The telemetry configuration object to set for all components.",
|
|
24
25
|
},
|
|
25
26
|
]}
|
|
26
27
|
/>
|
|
@@ -31,5 +32,5 @@ This method does not return a value.
|
|
|
31
32
|
|
|
32
33
|
## Related
|
|
33
34
|
|
|
34
|
-
- [Logging](
|
|
35
|
-
- [PinoLogger](
|
|
35
|
+
- [Logging](/docs/observability/logging)
|
|
36
|
+
- [PinoLogger](/reference/observability/logging/pino-logger)
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
2
|
+
title: "Reference: CloudflareDeployer | Deployer | Mastra Docs"
|
|
3
3
|
description: "Documentation for the CloudflareDeployer class, which deploys Mastra applications to Cloudflare Workers."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# CloudflareDeployer
|
|
7
7
|
|
|
8
|
-
The `CloudflareDeployer` class handles deployment of standalone Mastra applications to Cloudflare Workers. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/
|
|
8
|
+
The `CloudflareDeployer` class handles deployment of standalone Mastra applications to Cloudflare Workers. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/) class with Cloudflare specific functionality.
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript title="src/mastra/index.ts" showLineNumbers copy
|
|
13
13
|
import { Mastra } from "@mastra/core/mastra";
|
|
14
14
|
import { CloudflareDeployer } from "@mastra/deployer-cloudflare";
|
|
15
15
|
|
|
@@ -60,7 +60,8 @@ export const mastra = new Mastra({
|
|
|
60
60
|
{
|
|
61
61
|
name: "routes",
|
|
62
62
|
type: "CFRoute[]",
|
|
63
|
-
description:
|
|
63
|
+
description:
|
|
64
|
+
"Array of route configurations for your worker. Each route requires: pattern (string), zone_name (string), custom_domain (boolean, optional).",
|
|
64
65
|
isOptional: true,
|
|
65
66
|
},
|
|
66
67
|
{
|
|
@@ -72,19 +73,22 @@ export const mastra = new Mastra({
|
|
|
72
73
|
{
|
|
73
74
|
name: "env",
|
|
74
75
|
type: "Record<string, any>",
|
|
75
|
-
description:
|
|
76
|
+
description:
|
|
77
|
+
"Environment variables to be included in the worker configuration.",
|
|
76
78
|
isOptional: true,
|
|
77
79
|
},
|
|
78
80
|
{
|
|
79
81
|
name: "d1Databases",
|
|
80
82
|
type: "D1DatabaseBinding[]",
|
|
81
|
-
description:
|
|
83
|
+
description:
|
|
84
|
+
"Array of D1 database bindings. Each binding requires: binding (string), database_name (string), database_id (string), preview_database_id (string, optional).",
|
|
82
85
|
isOptional: true,
|
|
83
86
|
},
|
|
84
87
|
{
|
|
85
88
|
name: "kvNamespaces",
|
|
86
89
|
type: "KVNamespaceBinding[]",
|
|
87
|
-
description:
|
|
90
|
+
description:
|
|
91
|
+
"Array of KV namespace bindings. Each binding requires: binding (string), id (string).",
|
|
88
92
|
isOptional: true,
|
|
89
93
|
},
|
|
90
94
|
]}
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
2
|
+
title: "Reference: NetlifyDeployer | Deployer | Mastra Docs"
|
|
3
3
|
description: "Documentation for the NetlifyDeployer class, which deploys Mastra applications to Netlify Functions."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# NetlifyDeployer
|
|
7
7
|
|
|
8
|
-
The `NetlifyDeployer` class handles deployment of standalone Mastra applications to Netlify. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/
|
|
8
|
+
The `NetlifyDeployer` class handles deployment of standalone Mastra applications to Netlify. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/) class with Netlify specific functionality.
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript title="src/mastra/index.ts" showLineNumbers copy
|
|
13
13
|
import { Mastra } from "@mastra/core/mastra";
|
|
14
14
|
import { NetlifyDeployer } from "@mastra/deployer-netlify";
|
|
15
15
|
|
|
16
16
|
export const mastra = new Mastra({
|
|
17
17
|
// ...
|
|
18
|
-
deployer: new NetlifyDeployer()
|
|
18
|
+
deployer: new NetlifyDeployer(),
|
|
19
19
|
});
|
|
20
20
|
```
|
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
2
|
+
title: "Reference: VercelDeployer | Deployer | Mastra Docs"
|
|
3
3
|
description: "Documentation for the VercelDeployer class, which deploys Mastra applications to Vercel."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# VercelDeployer
|
|
7
7
|
|
|
8
|
-
The `VercelDeployer` class handles deployment of standalone Mastra applications to Vercel. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/
|
|
8
|
+
The `VercelDeployer` class handles deployment of standalone Mastra applications to Vercel. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/) class with Vercel specific functionality.
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript title="src/mastra/index.ts" showLineNumbers copy
|
|
13
13
|
import { Mastra } from "@mastra/core/mastra";
|
|
14
14
|
import { VercelDeployer } from "@mastra/deployer-vercel";
|
|
15
15
|
|
|
16
16
|
export const mastra = new Mastra({
|
|
17
17
|
// ...
|
|
18
|
-
deployer: new VercelDeployer()
|
|
18
|
+
deployer: new VercelDeployer(),
|
|
19
19
|
});
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -31,7 +31,7 @@ These options are merged into `.vercel/output/functions/index.func/.vc-config.js
|
|
|
31
31
|
|
|
32
32
|
### Example with overrides
|
|
33
33
|
|
|
34
|
-
```typescript
|
|
34
|
+
```typescript title="src/mastra/index.ts" showLineNumbers copy
|
|
35
35
|
import { Mastra } from "@mastra/core/mastra";
|
|
36
36
|
import { VercelDeployer } from "@mastra/deployer-vercel";
|
|
37
37
|
|
|
@@ -43,4 +43,4 @@ export const mastra = new Mastra({
|
|
|
43
43
|
regions: ["sfo1", "iad1"],
|
|
44
44
|
}),
|
|
45
45
|
});
|
|
46
|
-
```
|
|
46
|
+
```
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: AnswerRelevancyMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Answer Relevancy Metric in Mastra, which evaluates how well LLM outputs address the input query.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# AnswerRelevancyMetric
|
|
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 `AnswerRelevancyMetric` class evaluates how well an LLM's output answers or addresses the input query. It uses a judge-based system to determine relevancy and provides detailed scoring and reasoning.
|
|
13
13
|
|
|
@@ -130,7 +130,6 @@ The metric evaluates relevancy through query-answer alignment, considering compl
|
|
|
130
130
|
### Scoring Process
|
|
131
131
|
|
|
132
132
|
1. Statement Analysis:
|
|
133
|
-
|
|
134
133
|
- Breaks output into meaningful statements while preserving context
|
|
135
134
|
- Evaluates each statement against query requirements
|
|
136
135
|
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: BiasMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Bias Metric in Mastra, which evaluates LLM outputs for various forms of bias, including gender, political, racial/ethnic, or geographical bias.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# BiasMetric
|
|
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 `BiasMetric` class evaluates whether an LLM's output contains various forms of bias, including gender, political, racial/ethnic, or geographical bias. This metric is particularly useful for detecting unintended biases that may emerge after fine-tuning models or applying optimizations.
|
|
13
13
|
|
|
@@ -137,7 +137,6 @@ The metric evaluates bias through opinion analysis based on:
|
|
|
137
137
|
### Scoring Process
|
|
138
138
|
|
|
139
139
|
1. Extracts opinions from text:
|
|
140
|
-
|
|
141
140
|
- Identifies subjective statements
|
|
142
141
|
- Excludes factual claims
|
|
143
142
|
- Includes cited opinions
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: CompletenessMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Completeness Metric in Mastra, which evaluates how thoroughly LLM outputs cover key elements present in the input.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# CompletenessMetric
|
|
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 `CompletenessMetric` class evaluates how thoroughly an LLM's output covers the key elements present in the input. It analyzes nouns, verbs, topics, and terms to determine coverage and provides a detailed completeness score.
|
|
13
13
|
|
|
@@ -130,7 +130,6 @@ The metric evaluates completeness through linguistic element coverage analysis.
|
|
|
130
130
|
### Scoring Process
|
|
131
131
|
|
|
132
132
|
1. Extracts key elements:
|
|
133
|
-
|
|
134
133
|
- Nouns and named entities
|
|
135
134
|
- Action verbs
|
|
136
135
|
- Topic-specific terms
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: ContentSimilarityMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Content Similarity Metric in Mastra, which measures textual similarity between strings and provides a matching score.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# ContentSimilarityMetric
|
|
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 `ContentSimilarityMetric` class measures the textual similarity between two strings, providing a score that indicates how closely they match. It supports configurable options for case sensitivity and whitespace handling.
|
|
13
13
|
|
|
@@ -118,7 +118,6 @@ The metric evaluates textual similarity through character-level matching and con
|
|
|
118
118
|
### Scoring Process
|
|
119
119
|
|
|
120
120
|
1. Normalizes text:
|
|
121
|
-
|
|
122
121
|
- Case normalization (if ignoreCase: true)
|
|
123
122
|
- Whitespace normalization (if ignoreWhitespace: true)
|
|
124
123
|
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: ContextPositionMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Context Position Metric in Mastra, which evaluates the ordering of context nodes based on their relevance to the query and output.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# ContextPositionMetric
|
|
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 `ContextPositionMetric` class evaluates how well context nodes are ordered based on their relevance to the query and output. It uses position-weighted scoring to emphasize the importance of having the most relevant context pieces appear earlier in the sequence.
|
|
13
13
|
|
|
@@ -132,7 +132,6 @@ The metric evaluates context positioning through binary relevance assessment and
|
|
|
132
132
|
### Scoring Process
|
|
133
133
|
|
|
134
134
|
1. Evaluates context relevance:
|
|
135
|
-
|
|
136
135
|
- Assigns binary verdict (yes/no) to each piece
|
|
137
136
|
- Records position in sequence
|
|
138
137
|
- Documents relevance reasoning
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: ContextPrecisionMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Context Precision Metric in Mastra, which evaluates the relevance and precision of retrieved context nodes for generating expected outputs.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# ContextPrecisionMetric
|
|
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 `ContextPrecisionMetric` class evaluates how relevant and precise the retrieved context nodes are for generating the expected output. It uses a judge-based system to analyze each context piece's contribution and provides weighted scoring based on position.
|
|
13
13
|
|
|
@@ -132,7 +132,6 @@ The metric evaluates context precision through binary relevance assessment and M
|
|
|
132
132
|
### Scoring Process
|
|
133
133
|
|
|
134
134
|
1. Assigns binary relevance scores:
|
|
135
|
-
|
|
136
135
|
- Relevant context: 1
|
|
137
136
|
- Irrelevant context: 0
|
|
138
137
|
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: ContextRelevancyMetric | Evals | Mastra Docs"
|
|
3
3
|
description: Documentation for the Context Relevancy Metric, which evaluates the relevance of retrieved context in RAG pipelines.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ScorerCallout } from '@/components/scorer-callout'
|
|
7
|
-
|
|
8
6
|
# ContextRelevancyMetric
|
|
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 `ContextRelevancyMetric` class evaluates the quality of your RAG (Retrieval-Augmented Generation) pipeline's retriever by measuring how relevant the retrieved context is to the input query. It uses an LLM-based evaluation system that first extracts statements from the context and then assesses their relevance to the input.
|
|
13
13
|
|
|
@@ -134,7 +134,6 @@ The metric evaluates how well retrieved context matches the query through binary
|
|
|
134
134
|
### Scoring Process
|
|
135
135
|
|
|
136
136
|
1. Extracts statements from context:
|
|
137
|
-
|
|
138
137
|
- Breaks down context into meaningful units
|
|
139
138
|
- Preserves semantic relationships
|
|
140
139
|
|
|
@@ -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`
|