@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
|
@@ -40,7 +40,7 @@ await memory?.deleteMessages(["671ae63f-3a91-4082-a907-fe7de78e10ec"]);
|
|
|
40
40
|
|
|
41
41
|
## Extended usage example
|
|
42
42
|
|
|
43
|
-
```typescript
|
|
43
|
+
```typescript title="src/test-memory.ts" showLineNumbers copy
|
|
44
44
|
import { mastra } from "./mastra";
|
|
45
45
|
import { UIMessageWithMetadata } from "@mastra/core/agent";
|
|
46
46
|
|
|
@@ -49,12 +49,14 @@ const memory = await agent.getMemory();
|
|
|
49
49
|
|
|
50
50
|
const { uiMessages } = await memory!.query({ threadId: "thread-123" });
|
|
51
51
|
|
|
52
|
-
const messageIds = uiMessages.map(
|
|
52
|
+
const messageIds = uiMessages.map(
|
|
53
|
+
(message: UIMessageWithMetadata) => message.id,
|
|
54
|
+
);
|
|
53
55
|
await memory?.deleteMessages([...messageIds]);
|
|
54
56
|
```
|
|
55
57
|
|
|
56
58
|
## Related
|
|
57
59
|
|
|
58
|
-
- [Memory Class Reference](/reference/memory/
|
|
59
|
-
- [query](/reference/memory/query
|
|
60
|
-
- [Getting Started with Memory](/docs/memory/overview
|
|
60
|
+
- [Memory Class Reference](/reference/memory/memory-class)
|
|
61
|
+
- [query](/reference/memory/query)
|
|
62
|
+
- [Getting Started with Memory](/docs/memory/overview)
|
|
@@ -33,14 +33,15 @@ await memory?.getThreadById({ threadId: "thread-123" });
|
|
|
33
33
|
{
|
|
34
34
|
name: "thread",
|
|
35
35
|
type: "Promise<StorageThreadType | null>",
|
|
36
|
-
description:
|
|
36
|
+
description:
|
|
37
|
+
"A promise that resolves to the thread associated with the given ID, or null if not found.",
|
|
37
38
|
},
|
|
38
39
|
]}
|
|
39
40
|
/>
|
|
40
41
|
|
|
41
42
|
### Related
|
|
42
43
|
|
|
43
|
-
- [Memory Class Reference](/reference/memory/
|
|
44
|
-
- [Getting Started with Memory](/docs/memory/overview
|
|
45
|
-
- [createThread](/reference/memory/createThread
|
|
46
|
-
- [getThreadsByResourceId](/reference/memory/getThreadsByResourceId
|
|
44
|
+
- [Memory Class Reference](/reference/memory/memory-class)
|
|
45
|
+
- [Getting Started with Memory](/docs/memory/overview) (Covers threads concept)
|
|
46
|
+
- [createThread](/reference/memory/createThread)
|
|
47
|
+
- [getThreadsByResourceId](/reference/memory/getThreadsByResourceId)
|
|
@@ -26,19 +26,20 @@ await memory?.getThreadsByResourceId({ resourceId: "user-123" });
|
|
|
26
26
|
{
|
|
27
27
|
name: "orderBy",
|
|
28
28
|
type: "ThreadOrderBy",
|
|
29
|
-
description:
|
|
29
|
+
description:
|
|
30
|
+
"Field to sort threads by. Accepts 'createdAt' or 'updatedAt'. Default: 'createdAt'",
|
|
30
31
|
isOptional: true,
|
|
31
32
|
},
|
|
32
33
|
{
|
|
33
34
|
name: "sortDirection",
|
|
34
35
|
type: "ThreadSortDirection",
|
|
35
|
-
description:
|
|
36
|
+
description:
|
|
37
|
+
"Sort order direction. Accepts 'ASC' or 'DESC'. Default: 'DESC'",
|
|
36
38
|
isOptional: true,
|
|
37
39
|
},
|
|
38
40
|
]}
|
|
39
41
|
/>
|
|
40
42
|
|
|
41
|
-
|
|
42
43
|
## Returns
|
|
43
44
|
|
|
44
45
|
<PropertiesTable
|
|
@@ -54,7 +55,7 @@ await memory?.getThreadsByResourceId({ resourceId: "user-123" });
|
|
|
54
55
|
|
|
55
56
|
## Extended usage example
|
|
56
57
|
|
|
57
|
-
```typescript
|
|
58
|
+
```typescript title="src/test-memory.ts" showLineNumbers copy
|
|
58
59
|
import { mastra } from "./mastra";
|
|
59
60
|
|
|
60
61
|
const agent = mastra.getAgent("agent");
|
|
@@ -63,7 +64,7 @@ const memory = await agent.getMemory();
|
|
|
63
64
|
const thread = await memory?.getThreadsByResourceId({
|
|
64
65
|
resourceId: "user-123",
|
|
65
66
|
orderBy: "updatedAt",
|
|
66
|
-
sortDirection: "ASC"
|
|
67
|
+
sortDirection: "ASC",
|
|
67
68
|
});
|
|
68
69
|
|
|
69
70
|
console.log(thread);
|
|
@@ -71,8 +72,8 @@ console.log(thread);
|
|
|
71
72
|
|
|
72
73
|
### Related
|
|
73
74
|
|
|
74
|
-
- [Memory Class Reference](/reference/memory/
|
|
75
|
-
- [getThreadsByResourceIdPaginated](/reference/memory/getThreadsByResourceIdPaginated
|
|
76
|
-
- [Getting Started with Memory](/docs/memory/overview
|
|
77
|
-
- [createThread](/reference/memory/createThread
|
|
78
|
-
- [getThreadById](/reference/memory/getThreadById
|
|
75
|
+
- [Memory Class Reference](/reference/memory/memory-class)
|
|
76
|
+
- [getThreadsByResourceIdPaginated](/reference/memory/getThreadsByResourceIdPaginated) - Paginated version
|
|
77
|
+
- [Getting Started with Memory](/docs/memory/overview) (Covers threads/resources concept)
|
|
78
|
+
- [createThread](/reference/memory/createThread)
|
|
79
|
+
- [getThreadById](/reference/memory/getThreadById)
|
|
@@ -13,7 +13,7 @@ The `.getThreadsByResourceIdPaginated()` method retrieves threads associated wit
|
|
|
13
13
|
await memory.getThreadsByResourceIdPaginated({
|
|
14
14
|
resourceId: "user-123",
|
|
15
15
|
page: 0,
|
|
16
|
-
perPage: 10
|
|
16
|
+
perPage: 10,
|
|
17
17
|
});
|
|
18
18
|
```
|
|
19
19
|
|
|
@@ -61,14 +61,15 @@ await memory.getThreadsByResourceIdPaginated({
|
|
|
61
61
|
{
|
|
62
62
|
name: "result",
|
|
63
63
|
type: "Promise<PaginationInfo & { threads: StorageThreadType[] }>",
|
|
64
|
-
description:
|
|
64
|
+
description:
|
|
65
|
+
"A promise that resolves to paginated thread results with metadata",
|
|
65
66
|
},
|
|
66
67
|
]}
|
|
67
68
|
/>
|
|
68
69
|
|
|
69
70
|
## Extended usage example
|
|
70
71
|
|
|
71
|
-
```typescript
|
|
72
|
+
```typescript title="src/test-memory.ts" showLineNumbers copy
|
|
72
73
|
import { mastra } from "./mastra";
|
|
73
74
|
|
|
74
75
|
const agent = mastra.getAgent("agent");
|
|
@@ -83,7 +84,7 @@ while (hasMorePages) {
|
|
|
83
84
|
page: currentPage,
|
|
84
85
|
perPage: 25,
|
|
85
86
|
orderBy: "createdAt",
|
|
86
|
-
sortDirection: "ASC"
|
|
87
|
+
sortDirection: "ASC",
|
|
87
88
|
});
|
|
88
89
|
|
|
89
90
|
if (!threads) {
|
|
@@ -102,8 +103,8 @@ while (hasMorePages) {
|
|
|
102
103
|
|
|
103
104
|
## Related
|
|
104
105
|
|
|
105
|
-
- [Memory Class Reference](/reference/memory/
|
|
106
|
-
- [getThreadsByResourceId](/reference/memory/getThreadsByResourceId
|
|
107
|
-
- [Getting Started with Memory](/docs/memory/overview
|
|
108
|
-
- [createThread](/reference/memory/createThread
|
|
109
|
-
- [getThreadById](/reference/memory/getThreadById
|
|
106
|
+
- [Memory Class Reference](/reference/memory/memory-class)
|
|
107
|
+
- [getThreadsByResourceId](/reference/memory/getThreadsByResourceId) - Non-paginated version
|
|
108
|
+
- [Getting Started with Memory](/docs/memory/overview) (Covers threads/resources concept)
|
|
109
|
+
- [createThread](/reference/memory/createThread)
|
|
110
|
+
- [getThreadById](/reference/memory/getThreadById)
|
|
@@ -9,7 +9,7 @@ The `Memory` class provides a robust system for managing conversation history an
|
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript title="src/mastra/agents/test-agent.ts" showLineNumbers copy
|
|
13
13
|
import { Memory } from "@mastra/memory";
|
|
14
14
|
import { Agent } from "@mastra/core/agent";
|
|
15
15
|
import { openai } from "@ai-sdk/openai";
|
|
@@ -21,14 +21,14 @@ export const agent = new Agent({
|
|
|
21
21
|
memory: new Memory({
|
|
22
22
|
options: {
|
|
23
23
|
workingMemory: {
|
|
24
|
-
enabled: true
|
|
25
|
-
}
|
|
26
|
-
}
|
|
27
|
-
})
|
|
24
|
+
enabled: true,
|
|
25
|
+
},
|
|
26
|
+
},
|
|
27
|
+
}),
|
|
28
28
|
});
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
> To enable `workingMemory` on an agent, you’ll need a storage provider configured on your main Mastra instance. See [Mastra class](../core/mastra-class
|
|
31
|
+
> To enable `workingMemory` on an agent, you’ll need a storage provider configured on your main Mastra instance. See [Mastra class](../core/mastra-class) for more information.
|
|
32
32
|
|
|
33
33
|
## Constructor parameters
|
|
34
34
|
|
|
@@ -37,19 +37,22 @@ export const agent = new Agent({
|
|
|
37
37
|
{
|
|
38
38
|
name: "storage",
|
|
39
39
|
type: "MastraStorage",
|
|
40
|
-
description:
|
|
40
|
+
description:
|
|
41
|
+
'Storage implementation for persisting memory data. Defaults to `new DefaultStorage({ config: { url: "file:memory.db" } })` if not provided.',
|
|
41
42
|
isOptional: true,
|
|
42
43
|
},
|
|
43
44
|
{
|
|
44
45
|
name: "vector",
|
|
45
46
|
type: "MastraVector | false",
|
|
46
|
-
description:
|
|
47
|
+
description:
|
|
48
|
+
"Vector store for semantic search capabilities. Set to `false` to disable vector operations.",
|
|
47
49
|
isOptional: true,
|
|
48
50
|
},
|
|
49
51
|
{
|
|
50
52
|
name: "embedder",
|
|
51
53
|
type: "EmbeddingModel<string> | EmbeddingModelV2<string>",
|
|
52
|
-
description:
|
|
54
|
+
description:
|
|
55
|
+
"Embedder instance for vector embeddings. Required when semantic recall is enabled.",
|
|
53
56
|
isOptional: true,
|
|
54
57
|
},
|
|
55
58
|
{
|
|
@@ -61,7 +64,8 @@ export const agent = new Agent({
|
|
|
61
64
|
{
|
|
62
65
|
name: "processors",
|
|
63
66
|
type: "MemoryProcessor[]",
|
|
64
|
-
description:
|
|
67
|
+
description:
|
|
68
|
+
"Array of memory processors that can filter or transform messages before they're sent to the LLM.",
|
|
65
69
|
isOptional: true,
|
|
66
70
|
},
|
|
67
71
|
]}
|
|
@@ -74,28 +78,33 @@ export const agent = new Agent({
|
|
|
74
78
|
{
|
|
75
79
|
name: "lastMessages",
|
|
76
80
|
type: "number | false",
|
|
77
|
-
description:
|
|
81
|
+
description:
|
|
82
|
+
"Number of most recent messages to retrieve. Set to false to disable.",
|
|
78
83
|
isOptional: true,
|
|
79
84
|
defaultValue: "10",
|
|
80
85
|
},
|
|
81
86
|
{
|
|
82
87
|
name: "semanticRecall",
|
|
83
88
|
type: "boolean | { topK: number; messageRange: number | { before: number; after: number }; scope?: 'thread' | 'resource' }",
|
|
84
|
-
description:
|
|
89
|
+
description:
|
|
90
|
+
"Enable semantic search in message history. Can be a boolean or an object with configuration options. When enabled, requires both vector store and embedder to be configured. Default topK is 4, default messageRange is {before: 1, after: 1}.",
|
|
85
91
|
isOptional: true,
|
|
86
92
|
defaultValue: "false",
|
|
87
93
|
},
|
|
88
94
|
{
|
|
89
95
|
name: "workingMemory",
|
|
90
96
|
type: "WorkingMemory",
|
|
91
|
-
description:
|
|
97
|
+
description:
|
|
98
|
+
"Configuration for working memory feature. Can be `{ enabled: boolean; template?: string; schema?: ZodObject<any> | JSONSchema7; scope?: 'thread' | 'resource' }` or `{ enabled: boolean }` to disable.",
|
|
92
99
|
isOptional: true,
|
|
93
|
-
defaultValue:
|
|
100
|
+
defaultValue:
|
|
101
|
+
"{ enabled: false, template: '# User Information\\n- **First Name**:\\n- **Last Name**:\\n...' }",
|
|
94
102
|
},
|
|
95
103
|
{
|
|
96
104
|
name: "threads",
|
|
97
105
|
type: "{ generateTitle?: boolean | { model: DynamicArgument<MastraLanguageModel>; instructions?: DynamicArgument<string> } }",
|
|
98
|
-
description:
|
|
106
|
+
description:
|
|
107
|
+
"Settings related to memory thread creation. `generateTitle` controls automatic thread title generation from the user's first message. Can be a boolean or an object with custom model and instructions.",
|
|
99
108
|
isOptional: true,
|
|
100
109
|
defaultValue: "{ generateTitle: false }",
|
|
101
110
|
},
|
|
@@ -114,10 +123,9 @@ export const agent = new Agent({
|
|
|
114
123
|
]}
|
|
115
124
|
/>
|
|
116
125
|
|
|
117
|
-
|
|
118
126
|
## Extended usage example
|
|
119
127
|
|
|
120
|
-
```typescript
|
|
128
|
+
```typescript title="src/mastra/agents/test-agent.ts" showLineNumbers copy
|
|
121
129
|
import { Memory } from "@mastra/memory";
|
|
122
130
|
import { Agent } from "@mastra/core/agent";
|
|
123
131
|
import { openai } from "@ai-sdk/openai";
|
|
@@ -129,32 +137,32 @@ export const agent = new Agent({
|
|
|
129
137
|
model: openai("gpt-4o"),
|
|
130
138
|
memory: new Memory({
|
|
131
139
|
storage: new LibSQLStore({
|
|
132
|
-
url: "file:./working-memory.db"
|
|
140
|
+
url: "file:./working-memory.db",
|
|
133
141
|
}),
|
|
134
142
|
vector: new LibSQLVector({
|
|
135
|
-
connectionUrl: "file:./vector-memory.db"
|
|
143
|
+
connectionUrl: "file:./vector-memory.db",
|
|
136
144
|
}),
|
|
137
145
|
options: {
|
|
138
146
|
lastMessages: 10,
|
|
139
147
|
semanticRecall: {
|
|
140
148
|
topK: 3,
|
|
141
149
|
messageRange: 2,
|
|
142
|
-
scope:
|
|
150
|
+
scope: "resource",
|
|
143
151
|
},
|
|
144
152
|
workingMemory: {
|
|
145
|
-
enabled: true
|
|
153
|
+
enabled: true,
|
|
146
154
|
},
|
|
147
155
|
threads: {
|
|
148
|
-
generateTitle: true
|
|
149
|
-
}
|
|
150
|
-
}
|
|
151
|
-
})
|
|
156
|
+
generateTitle: true,
|
|
157
|
+
},
|
|
158
|
+
},
|
|
159
|
+
}),
|
|
152
160
|
});
|
|
153
161
|
```
|
|
154
162
|
|
|
155
163
|
## PostgreSQL with index configuration
|
|
156
164
|
|
|
157
|
-
```typescript
|
|
165
|
+
```typescript title="src/mastra/agents/pg-agent.ts" showLineNumbers copy
|
|
158
166
|
import { Memory } from "@mastra/memory";
|
|
159
167
|
import { Agent } from "@mastra/core/agent";
|
|
160
168
|
import { openai } from "@ai-sdk/openai";
|
|
@@ -166,10 +174,10 @@ export const agent = new Agent({
|
|
|
166
174
|
model: openai("gpt-4o"),
|
|
167
175
|
memory: new Memory({
|
|
168
176
|
storage: new PgStore({
|
|
169
|
-
connectionString: process.env.DATABASE_URL
|
|
177
|
+
connectionString: process.env.DATABASE_URL,
|
|
170
178
|
}),
|
|
171
179
|
vector: new PgVector({
|
|
172
|
-
connectionString: process.env.DATABASE_URL
|
|
180
|
+
connectionString: process.env.DATABASE_URL,
|
|
173
181
|
}),
|
|
174
182
|
embedder: openai.embedding("text-embedding-3-small"),
|
|
175
183
|
options: {
|
|
@@ -177,30 +185,30 @@ export const agent = new Agent({
|
|
|
177
185
|
semanticRecall: {
|
|
178
186
|
topK: 5,
|
|
179
187
|
messageRange: 3,
|
|
180
|
-
scope:
|
|
188
|
+
scope: "resource",
|
|
181
189
|
indexConfig: {
|
|
182
|
-
type:
|
|
183
|
-
metric:
|
|
184
|
-
m: 16,
|
|
185
|
-
efConstruction: 64
|
|
186
|
-
}
|
|
190
|
+
type: "hnsw", // Use HNSW for better performance
|
|
191
|
+
metric: "dotproduct", // Optimal for OpenAI embeddings
|
|
192
|
+
m: 16, // Number of bi-directional links
|
|
193
|
+
efConstruction: 64, // Construction-time candidate list size
|
|
194
|
+
},
|
|
187
195
|
},
|
|
188
196
|
workingMemory: {
|
|
189
|
-
enabled: true
|
|
190
|
-
}
|
|
191
|
-
}
|
|
192
|
-
})
|
|
197
|
+
enabled: true,
|
|
198
|
+
},
|
|
199
|
+
},
|
|
200
|
+
}),
|
|
193
201
|
});
|
|
194
202
|
```
|
|
195
203
|
|
|
196
204
|
### Related
|
|
197
205
|
|
|
198
|
-
- [Getting Started with Memory](/docs/memory/overview
|
|
199
|
-
- [Semantic Recall](/docs/memory/semantic-recall
|
|
200
|
-
- [Working Memory](/docs/memory/working-memory
|
|
201
|
-
- [Memory Processors](/docs/memory/memory-processors
|
|
202
|
-
- [createThread](/reference/memory/createThread
|
|
203
|
-
- [query](/reference/memory/query
|
|
204
|
-
- [getThreadById](/reference/memory/getThreadById
|
|
205
|
-
- [getThreadsByResourceId](/reference/memory/getThreadsByResourceId
|
|
206
|
-
- [deleteMessages](/reference/memory/deleteMessages
|
|
206
|
+
- [Getting Started with Memory](/docs/memory/overview)
|
|
207
|
+
- [Semantic Recall](/docs/memory/semantic-recall)
|
|
208
|
+
- [Working Memory](/docs/memory/working-memory)
|
|
209
|
+
- [Memory Processors](/docs/memory/memory-processors)
|
|
210
|
+
- [createThread](/reference/memory/createThread)
|
|
211
|
+
- [query](/reference/memory/query)
|
|
212
|
+
- [getThreadById](/reference/memory/getThreadById)
|
|
213
|
+
- [getThreadsByResourceId](/reference/memory/getThreadsByResourceId)
|
|
214
|
+
- [deleteMessages](/reference/memory/deleteMessages)
|
|
@@ -20,13 +20,15 @@ await memory?.query({ threadId: "user-123" });
|
|
|
20
20
|
{
|
|
21
21
|
name: "threadId",
|
|
22
22
|
type: "string",
|
|
23
|
-
description:
|
|
23
|
+
description:
|
|
24
|
+
"The unique identifier of the thread to retrieve messages from",
|
|
24
25
|
isOptional: false,
|
|
25
26
|
},
|
|
26
27
|
{
|
|
27
28
|
name: "resourceId",
|
|
28
29
|
type: "string",
|
|
29
|
-
description:
|
|
30
|
+
description:
|
|
31
|
+
"Optional ID of the resource that owns the thread. If provided, validates thread ownership",
|
|
30
32
|
isOptional: true,
|
|
31
33
|
},
|
|
32
34
|
{
|
|
@@ -38,13 +40,15 @@ await memory?.query({ threadId: "user-123" });
|
|
|
38
40
|
{
|
|
39
41
|
name: "threadConfig",
|
|
40
42
|
type: "MemoryConfig",
|
|
41
|
-
description:
|
|
43
|
+
description:
|
|
44
|
+
"Configuration options for message retrieval and semantic search",
|
|
42
45
|
isOptional: true,
|
|
43
46
|
},
|
|
44
47
|
{
|
|
45
48
|
name: "format",
|
|
46
49
|
type: "'v1' | 'v2'",
|
|
47
|
-
description:
|
|
50
|
+
description:
|
|
51
|
+
"Message format to return. Defaults to 'v2' for current format, 'v1' for backwards compatibility",
|
|
48
52
|
isOptional: true,
|
|
49
53
|
},
|
|
50
54
|
]}
|
|
@@ -57,25 +61,29 @@ await memory?.query({ threadId: "user-123" });
|
|
|
57
61
|
{
|
|
58
62
|
name: "vectorSearchString",
|
|
59
63
|
type: "string",
|
|
60
|
-
description:
|
|
64
|
+
description:
|
|
65
|
+
"Search string for finding semantically similar messages. Requires semantic recall to be enabled in threadConfig.",
|
|
61
66
|
isOptional: true,
|
|
62
67
|
},
|
|
63
68
|
{
|
|
64
69
|
name: "last",
|
|
65
70
|
type: "number | false",
|
|
66
|
-
description:
|
|
71
|
+
description:
|
|
72
|
+
"Number of most recent messages to retrieve. Set to false to disable limit. Note: threadConfig.lastMessages (default: 10) will override this if smaller.",
|
|
67
73
|
isOptional: true,
|
|
68
74
|
},
|
|
69
75
|
{
|
|
70
76
|
name: "include",
|
|
71
77
|
type: "{ id: string; threadId?: string; withPreviousMessages?: number; withNextMessages?: number }[]",
|
|
72
|
-
description:
|
|
78
|
+
description:
|
|
79
|
+
"Array of specific message IDs to include with optional context messages. Each item has an `id` (required), optional `threadId` (defaults to main threadId), `withPreviousMessages` (number of messages before, defaults to 2 for vector search, 0 otherwise), and `withNextMessages` (number of messages after, defaults to 2 for vector search, 0 otherwise).",
|
|
73
80
|
isOptional: true,
|
|
74
81
|
},
|
|
75
82
|
{
|
|
76
83
|
name: "pagination",
|
|
77
84
|
type: "{ dateRange?: { start?: Date; end?: Date }; page?: number; perPage?: number }",
|
|
78
|
-
description:
|
|
85
|
+
description:
|
|
86
|
+
"Pagination options for retrieving messages in batches. Includes `dateRange` (filter by date range), `page` (0-based page number), and `perPage` (messages per page).",
|
|
79
87
|
isOptional: true,
|
|
80
88
|
},
|
|
81
89
|
]}
|
|
@@ -88,28 +96,33 @@ await memory?.query({ threadId: "user-123" });
|
|
|
88
96
|
{
|
|
89
97
|
name: "lastMessages",
|
|
90
98
|
type: "number | false",
|
|
91
|
-
description:
|
|
99
|
+
description:
|
|
100
|
+
"Number of most recent messages to retrieve. Set to false to disable.",
|
|
92
101
|
isOptional: true,
|
|
93
102
|
defaultValue: "10",
|
|
94
103
|
},
|
|
95
104
|
{
|
|
96
105
|
name: "semanticRecall",
|
|
97
106
|
type: "boolean | { topK: number; messageRange: number | { before: number; after: number }; scope?: 'thread' | 'resource' }",
|
|
98
|
-
description:
|
|
107
|
+
description:
|
|
108
|
+
"Enable semantic search in message history. Can be a boolean or an object with configuration options. When enabled, requires both vector store and embedder to be configured.",
|
|
99
109
|
isOptional: true,
|
|
100
110
|
defaultValue: "false",
|
|
101
111
|
},
|
|
102
112
|
{
|
|
103
113
|
name: "workingMemory",
|
|
104
114
|
type: "WorkingMemory",
|
|
105
|
-
description:
|
|
115
|
+
description:
|
|
116
|
+
"Configuration for working memory feature. Can be `{ enabled: boolean; template?: string; schema?: ZodObject<any> | JSONSchema7; scope?: 'thread' | 'resource' }` or `{ enabled: boolean }` to disable.",
|
|
106
117
|
isOptional: true,
|
|
107
|
-
defaultValue:
|
|
118
|
+
defaultValue:
|
|
119
|
+
"{ enabled: false, template: '# User Information\\n- **First Name**:\\n- **Last Name**:\\n...' }",
|
|
108
120
|
},
|
|
109
121
|
{
|
|
110
122
|
name: "threads",
|
|
111
123
|
type: "{ generateTitle?: boolean | { model: DynamicArgument<MastraLanguageModel>; instructions?: DynamicArgument<string> } }",
|
|
112
|
-
description:
|
|
124
|
+
description:
|
|
125
|
+
"Settings related to memory thread creation. `generateTitle` controls automatic thread title generation from the user's first message. Can be a boolean or an object with custom model and instructions.",
|
|
113
126
|
isOptional: true,
|
|
114
127
|
defaultValue: "{ generateTitle: false }",
|
|
115
128
|
},
|
|
@@ -128,14 +141,15 @@ await memory?.query({ threadId: "user-123" });
|
|
|
128
141
|
{
|
|
129
142
|
name: "uiMessages",
|
|
130
143
|
type: "UIMessageWithMetadata[]",
|
|
131
|
-
description:
|
|
144
|
+
description:
|
|
145
|
+
"Array of messages formatted for UI display, including proper threading of tool calls and results",
|
|
132
146
|
},
|
|
133
147
|
]}
|
|
134
148
|
/>
|
|
135
149
|
|
|
136
150
|
## Extended usage example
|
|
137
151
|
|
|
138
|
-
```typescript
|
|
152
|
+
```typescript title="src/test-memory.ts" showLineNumbers copy
|
|
139
153
|
import { mastra } from "./mastra";
|
|
140
154
|
|
|
141
155
|
const agent = mastra.getAgent("agent");
|
|
@@ -148,18 +162,18 @@ const { messages, uiMessages } = await memory!.query({
|
|
|
148
162
|
vectorSearchString: "What messages are there?",
|
|
149
163
|
include: [
|
|
150
164
|
{
|
|
151
|
-
id: "msg-123"
|
|
165
|
+
id: "msg-123",
|
|
152
166
|
},
|
|
153
167
|
{
|
|
154
168
|
id: "msg-456",
|
|
155
169
|
withPreviousMessages: 3,
|
|
156
|
-
withNextMessages: 1
|
|
157
|
-
}
|
|
158
|
-
]
|
|
170
|
+
withNextMessages: 1,
|
|
171
|
+
},
|
|
172
|
+
],
|
|
159
173
|
},
|
|
160
174
|
threadConfig: {
|
|
161
|
-
semanticRecall: true
|
|
162
|
-
}
|
|
175
|
+
semanticRecall: true,
|
|
176
|
+
},
|
|
163
177
|
});
|
|
164
178
|
|
|
165
179
|
console.log(messages);
|
|
@@ -168,7 +182,7 @@ console.log(uiMessages);
|
|
|
168
182
|
|
|
169
183
|
### Related
|
|
170
184
|
|
|
171
|
-
- [Memory Class Reference](/reference/memory/
|
|
172
|
-
- [Getting Started with Memory](/docs/memory/overview
|
|
173
|
-
- [Semantic Recall](/docs/memory/semantic-recall
|
|
174
|
-
- [createThread](/reference/memory/createThread
|
|
185
|
+
- [Memory Class Reference](/reference/memory/memory-class)
|
|
186
|
+
- [Getting Started with Memory](/docs/memory/overview)
|
|
187
|
+
- [Semantic Recall](/docs/memory/semantic-recall)
|
|
188
|
+
- [createThread](/reference/memory/createThread)
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "AITracing |
|
|
2
|
+
title: "Reference: AITracing | Observability | Mastra Docs"
|
|
3
3
|
description: Core AI Tracing classes and methods
|
|
4
|
-
asIndexPage: true
|
|
5
4
|
---
|
|
6
5
|
|
|
7
|
-
import
|
|
6
|
+
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
8
7
|
|
|
9
8
|
# AITracing
|
|
10
9
|
|
|
@@ -137,10 +136,10 @@ class CustomAITracing extends BaseAITracing {
|
|
|
137
136
|
super(config);
|
|
138
137
|
// Custom initialization
|
|
139
138
|
}
|
|
140
|
-
|
|
139
|
+
|
|
141
140
|
// Override methods as needed
|
|
142
141
|
startSpan<TType extends AISpanType>(
|
|
143
|
-
options: StartSpanOptions<TType
|
|
142
|
+
options: StartSpanOptions<TType>,
|
|
144
143
|
): AISpan<TType> {
|
|
145
144
|
// Custom span creation logic
|
|
146
145
|
return super.startSpan(options);
|
|
@@ -159,6 +158,7 @@ class NoOpAISpan<TType extends AISpanType> extends BaseAISpan<TType>
|
|
|
159
158
|
```
|
|
160
159
|
|
|
161
160
|
A span that performs no operations. All methods are no-ops:
|
|
161
|
+
|
|
162
162
|
- `id` returns `'no-op'`
|
|
163
163
|
- `traceId` returns `'no-op-trace'`
|
|
164
164
|
- `isValid` returns `false`
|
|
@@ -168,15 +168,18 @@ A span that performs no operations. All methods are no-ops:
|
|
|
168
168
|
## See Also
|
|
169
169
|
|
|
170
170
|
### Documentation
|
|
171
|
+
|
|
171
172
|
- [AI Tracing Overview](/docs/observability/ai-tracing/overview) - Concepts and usage guide
|
|
172
173
|
- [Configuration Reference](/reference/observability/ai-tracing/configuration) - Configuration options
|
|
173
174
|
- [Interfaces Reference](/reference/observability/ai-tracing/interfaces) - Type definitions
|
|
174
175
|
- [Span Reference](/reference/observability/ai-tracing/span) - Span lifecycle and methods
|
|
175
176
|
|
|
176
177
|
### Examples
|
|
178
|
+
|
|
177
179
|
- [Basic AI Tracing](/examples/observability/basic-ai-tracing) - Getting started example
|
|
178
180
|
|
|
179
181
|
### Exporters
|
|
182
|
+
|
|
180
183
|
- [DefaultExporter](/reference/observability/ai-tracing/exporters/default-exporter) - Storage persistence
|
|
181
184
|
- [CloudExporter](/reference/observability/ai-tracing/exporters/cloud-exporter) - Mastra Cloud integration
|
|
182
|
-
- [ConsoleExporter](/reference/observability/ai-tracing/exporters/console-exporter) - Debug output
|
|
185
|
+
- [ConsoleExporter](/reference/observability/ai-tracing/exporters/console-exporter) - Debug output
|