@mastra/mcp-docs-server 0.13.39 → 1.0.0-beta.1
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%2Fai-sdk-v4.md +1 -0
- package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +0 -10
- package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +0 -10
- package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +36 -36
- package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +0 -10
- package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +70 -70
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +40 -40
- package/.docs/organized/changelogs/%40mastra%2Fastra.md +19 -19
- package/.docs/organized/changelogs/%40mastra%2Fauth.md +4 -14
- package/.docs/organized/changelogs/%40mastra%2Fchroma.md +18 -18
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +220 -220
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +190 -190
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +7 -0
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +210 -210
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +69 -69
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +67 -67
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +70 -70
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +67 -67
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +209 -209
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +191 -191
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +34 -34
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +5 -13
- package/.docs/organized/changelogs/%40mastra%2Flance.md +182 -182
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Floggers.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +56 -56
- package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fmcp.md +65 -65
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +228 -228
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +206 -206
- package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +19 -19
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +197 -197
- package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +216 -216
- package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Frag.md +61 -61
- package/.docs/organized/changelogs/%40mastra%2Freact.md +66 -66
- package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +9 -17
- package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +6 -30
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +203 -203
- package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +190 -190
- package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +18 -18
- package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +21 -21
- package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +56 -56
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +56 -56
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +20 -20
- package/.docs/organized/changelogs/create-mastra.md +29 -29
- package/.docs/organized/changelogs/mastra.md +93 -93
- package/.docs/organized/code-examples/a2a.md +4 -2
- package/.docs/organized/code-examples/agui.md +12 -9
- package/.docs/organized/code-examples/ai-sdk-useChat.md +12 -18
- package/.docs/organized/code-examples/ai-sdk-v5.md +4 -2
- package/.docs/organized/code-examples/bird-checker-with-express.md +5 -4
- package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +4 -3
- package/.docs/organized/code-examples/bird-checker-with-nextjs.md +4 -3
- package/.docs/organized/code-examples/client-side-tools.md +1 -0
- package/.docs/organized/code-examples/crypto-chatbot.md +1 -1
- package/.docs/organized/code-examples/experimental-auth-weather-agent.md +8 -177
- package/.docs/organized/code-examples/fireworks-r1.md +2 -2
- package/.docs/organized/code-examples/heads-up-game.md +10 -7
- package/.docs/organized/code-examples/mcp-configuration.md +5 -3
- package/.docs/organized/code-examples/mcp-registry-registry.md +3 -2
- package/.docs/organized/code-examples/memory-per-resource-example.md +4 -2
- package/.docs/organized/code-examples/memory-todo-agent.md +1 -0
- package/.docs/organized/code-examples/memory-with-context.md +2 -1
- package/.docs/organized/code-examples/memory-with-libsql.md +4 -2
- package/.docs/organized/code-examples/memory-with-mongodb.md +4 -2
- package/.docs/organized/code-examples/memory-with-pg.md +4 -2
- package/.docs/organized/code-examples/memory-with-processors.md +13 -8
- package/.docs/organized/code-examples/memory-with-upstash.md +5 -3
- package/.docs/organized/code-examples/openapi-spec-writer.md +32 -41
- package/.docs/organized/code-examples/quick-start.md +5 -32
- package/.docs/organized/code-examples/stock-price-tool.md +6 -5
- package/.docs/organized/code-examples/weather-agent.md +21 -16
- package/.docs/organized/code-examples/workflow-ai-recruiter.md +3 -2
- package/.docs/organized/code-examples/workflow-with-inline-steps.md +9 -12
- package/.docs/organized/code-examples/workflow-with-memory.md +16 -15
- package/.docs/organized/code-examples/workflow-with-separate-steps.md +2 -2
- package/.docs/organized/code-examples/workflow-with-suspend-resume.md +3 -2
- package/.docs/raw/agents/adding-voice.mdx +27 -22
- package/.docs/raw/agents/agent-memory.mdx +24 -16
- package/.docs/raw/agents/guardrails.mdx +33 -12
- package/.docs/raw/agents/networks.mdx +8 -4
- package/.docs/raw/agents/overview.mdx +23 -17
- package/.docs/raw/agents/using-tools.mdx +11 -8
- package/.docs/raw/auth/auth0.mdx +9 -9
- package/.docs/raw/auth/clerk.mdx +7 -7
- package/.docs/raw/auth/firebase.mdx +9 -9
- package/.docs/raw/auth/index.mdx +6 -6
- package/.docs/raw/auth/jwt.mdx +7 -7
- package/.docs/raw/auth/supabase.mdx +8 -8
- package/.docs/raw/auth/workos.mdx +9 -9
- package/.docs/raw/community/contributing-templates.mdx +3 -3
- package/.docs/raw/community/discord.mdx +1 -1
- package/.docs/raw/course/01-first-agent/03-verifying-installation.md +1 -1
- package/.docs/raw/course/01-first-agent/08-exporting-your-agent.md +2 -1
- package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +2 -1
- package/.docs/raw/course/02-agent-tools-mcp/02-installing-mcp.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +2 -0
- package/.docs/raw/course/03-agent-memory/03-installing-memory.md +1 -1
- package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -0
- package/.docs/raw/course/03-agent-memory/10-storage-configuration.md +2 -3
- package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +2 -0
- package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +2 -0
- package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -0
- package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +2 -0
- package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +1 -0
- package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +1 -0
- package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +1 -0
- package/.docs/raw/course/04-workflows/08-running-workflows-programmatically.md +2 -2
- package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +6 -6
- package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +8 -6
- package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +5 -5
- package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +5 -5
- package/.docs/raw/deployment/cloud-providers/index.mdx +11 -8
- package/.docs/raw/deployment/monorepo.mdx +2 -2
- package/.docs/raw/deployment/overview.mdx +2 -2
- package/.docs/raw/deployment/server-deployment.mdx +2 -10
- package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +5 -5
- package/.docs/raw/deployment/serverless-platforms/index.mdx +10 -7
- package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +5 -5
- package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +5 -5
- package/.docs/raw/deployment/web-framework.mdx +8 -8
- package/.docs/raw/{scorers → evals}/custom-scorers.mdx +6 -6
- package/.docs/raw/evals/off-the-shelf-scorers.mdx +50 -0
- package/.docs/raw/{scorers → evals}/overview.mdx +9 -9
- package/.docs/raw/evals/running-in-ci.mdx +113 -0
- package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +26 -25
- package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +1 -1
- package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +17 -17
- package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +4 -1
- package/.docs/raw/frameworks/servers/express.mdx +11 -10
- package/.docs/raw/frameworks/web-frameworks/astro.mdx +18 -18
- package/.docs/raw/frameworks/web-frameworks/next-js.mdx +7 -7
- package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +16 -16
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +7 -7
- package/.docs/raw/getting-started/installation.mdx +26 -25
- package/.docs/raw/getting-started/mcp-docs-server.mdx +1 -1
- package/.docs/raw/getting-started/project-structure.mdx +4 -4
- package/.docs/raw/getting-started/studio.mdx +8 -8
- package/.docs/raw/getting-started/templates.mdx +6 -6
- package/.docs/raw/guides/guide/ai-recruiter.mdx +264 -0
- package/.docs/raw/guides/guide/chef-michel.mdx +271 -0
- package/.docs/raw/guides/guide/notes-mcp-server.mdx +450 -0
- package/.docs/raw/guides/guide/research-assistant.mdx +380 -0
- package/.docs/raw/guides/guide/stock-agent.mdx +185 -0
- package/.docs/raw/guides/guide/web-search.mdx +291 -0
- package/.docs/raw/guides/index.mdx +43 -0
- package/.docs/raw/guides/migrations/agentnetwork.mdx +114 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/_template.mdx +50 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +265 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/cli.mdx +48 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +153 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/evals.mdx +230 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +171 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mcp.mdx +114 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +241 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +83 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +62 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +270 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +115 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +280 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +23 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/voice.mdx +39 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +178 -0
- package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +367 -0
- package/.docs/raw/guides/quickstarts/nextjs.mdx +275 -0
- package/.docs/raw/index.mdx +9 -9
- package/.docs/raw/{observability/logging.mdx → logging.mdx} +4 -4
- package/.docs/raw/mastra-cloud/dashboard.mdx +2 -2
- package/.docs/raw/mastra-cloud/observability.mdx +6 -6
- package/.docs/raw/mastra-cloud/overview.mdx +2 -2
- package/.docs/raw/mastra-cloud/setting-up.mdx +4 -4
- package/.docs/raw/memory/conversation-history.mdx +1 -0
- package/.docs/raw/memory/memory-processors.mdx +4 -3
- package/.docs/raw/memory/overview.mdx +10 -6
- package/.docs/raw/memory/semantic-recall.mdx +13 -8
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +12 -7
- package/.docs/raw/memory/storage/memory-with-pg.mdx +11 -6
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +11 -6
- package/.docs/raw/memory/threads-and-resources.mdx +11 -13
- package/.docs/raw/memory/working-memory.mdx +30 -14
- package/.docs/raw/observability/overview.mdx +13 -30
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/arize.mdx +11 -19
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +8 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/cloud.mdx +11 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/default.mdx +16 -20
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langfuse.mdx +8 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +8 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/otel.mdx +12 -21
- package/.docs/raw/observability/{ai-tracing → tracing}/overview.mdx +107 -142
- package/.docs/raw/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx +14 -13
- package/.docs/raw/rag/chunking-and-embedding.mdx +5 -5
- package/.docs/raw/rag/overview.mdx +3 -13
- package/.docs/raw/rag/retrieval.mdx +24 -12
- package/.docs/raw/rag/vector-databases.mdx +7 -1
- package/.docs/raw/reference/agents/agent.mdx +35 -30
- package/.docs/raw/reference/agents/generate.mdx +10 -10
- package/.docs/raw/reference/agents/generateLegacy.mdx +8 -8
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +21 -15
- package/.docs/raw/reference/agents/getDefaultOptions.mdx +69 -0
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +22 -16
- package/.docs/raw/reference/agents/getDescription.mdx +1 -1
- package/.docs/raw/reference/agents/getInstructions.mdx +8 -8
- package/.docs/raw/reference/agents/getLLM.mdx +9 -9
- package/.docs/raw/reference/agents/getMemory.mdx +9 -9
- package/.docs/raw/reference/agents/getModel.mdx +10 -10
- package/.docs/raw/reference/agents/getVoice.mdx +8 -8
- package/.docs/raw/reference/agents/listAgents.mdx +9 -9
- package/.docs/raw/reference/agents/listScorers.mdx +7 -7
- package/.docs/raw/reference/agents/listTools.mdx +7 -7
- package/.docs/raw/reference/agents/listWorkflows.mdx +7 -7
- package/.docs/raw/reference/agents/network.mdx +11 -10
- package/.docs/raw/reference/auth/auth0.mdx +4 -4
- package/.docs/raw/reference/auth/clerk.mdx +4 -4
- package/.docs/raw/reference/auth/firebase.mdx +6 -6
- package/.docs/raw/reference/auth/jwt.mdx +4 -4
- package/.docs/raw/reference/auth/supabase.mdx +4 -4
- package/.docs/raw/reference/auth/workos.mdx +4 -4
- package/.docs/raw/reference/cli/create-mastra.mdx +10 -10
- package/.docs/raw/reference/cli/mastra.mdx +7 -7
- package/.docs/raw/reference/client-js/agents.mdx +6 -2
- package/.docs/raw/reference/client-js/mastra-client.mdx +7 -7
- package/.docs/raw/reference/client-js/memory.mdx +24 -16
- package/.docs/raw/reference/client-js/observability.mdx +11 -11
- package/.docs/raw/reference/client-js/workflows.mdx +6 -34
- package/.docs/raw/reference/core/getAgent.mdx +1 -1
- package/.docs/raw/reference/core/getAgentById.mdx +1 -1
- package/.docs/raw/reference/core/getDeployer.mdx +2 -2
- package/.docs/raw/reference/core/getLogger.mdx +2 -2
- package/.docs/raw/reference/core/getMCPServer.mdx +31 -15
- package/.docs/raw/reference/core/getMCPServerById.mdx +81 -0
- package/.docs/raw/reference/core/getScorer.mdx +3 -3
- package/.docs/raw/reference/core/getScorerById.mdx +79 -0
- package/.docs/raw/reference/core/getServer.mdx +2 -2
- package/.docs/raw/reference/core/getStorage.mdx +2 -2
- package/.docs/raw/reference/core/getTelemetry.mdx +2 -2
- package/.docs/raw/reference/core/getVector.mdx +2 -2
- package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
- package/.docs/raw/reference/core/listAgents.mdx +1 -1
- package/.docs/raw/reference/core/listLogs.mdx +2 -2
- package/.docs/raw/reference/core/listLogsByRunId.mdx +2 -2
- package/.docs/raw/reference/core/listMCPServers.mdx +65 -0
- package/.docs/raw/reference/core/listScorers.mdx +3 -3
- package/.docs/raw/reference/core/listVectors.mdx +36 -0
- package/.docs/raw/reference/core/listWorkflows.mdx +6 -6
- package/.docs/raw/reference/core/mastra-class.mdx +3 -2
- package/.docs/raw/reference/core/setLogger.mdx +2 -2
- package/.docs/raw/reference/core/setStorage.mdx +3 -2
- package/.docs/raw/reference/core/setTelemetry.mdx +2 -2
- package/.docs/raw/reference/deployer/cloudflare.mdx +2 -2
- package/.docs/raw/reference/deployer/deployer.mdx +0 -6
- package/.docs/raw/reference/deployer/netlify.mdx +2 -2
- package/.docs/raw/reference/deployer/vercel.mdx +3 -3
- package/.docs/raw/reference/evals/answer-relevancy.mdx +164 -126
- package/.docs/raw/reference/{scorers → evals}/answer-similarity.mdx +27 -27
- package/.docs/raw/reference/evals/bias.mdx +149 -115
- package/.docs/raw/reference/evals/completeness.mdx +148 -117
- package/.docs/raw/reference/evals/content-similarity.mdx +126 -113
- package/.docs/raw/reference/evals/context-precision.mdx +290 -133
- package/.docs/raw/reference/{scorers → evals}/context-relevance.mdx +6 -6
- package/.docs/raw/reference/{scorers → evals}/create-scorer.mdx +69 -60
- package/.docs/raw/reference/evals/faithfulness.mdx +163 -121
- package/.docs/raw/reference/evals/hallucination.mdx +159 -132
- package/.docs/raw/reference/evals/keyword-coverage.mdx +169 -125
- package/.docs/raw/reference/{scorers → evals}/mastra-scorer.mdx +7 -5
- package/.docs/raw/reference/{scorers → evals}/noise-sensitivity.mdx +9 -9
- package/.docs/raw/reference/evals/prompt-alignment.mdx +604 -182
- package/.docs/raw/reference/{scorers/run-experiment.mdx → evals/run-evals.mdx} +17 -18
- package/.docs/raw/reference/evals/textual-difference.mdx +149 -117
- package/.docs/raw/reference/evals/tone-consistency.mdx +149 -125
- package/.docs/raw/reference/{scorers → evals}/tool-call-accuracy.mdx +8 -6
- package/.docs/raw/reference/evals/toxicity.mdx +152 -96
- package/.docs/raw/reference/{observability/logging → logging}/pino-logger.mdx +2 -2
- package/.docs/raw/reference/memory/createThread.mdx +5 -5
- package/.docs/raw/reference/memory/deleteMessages.mdx +7 -7
- package/.docs/raw/reference/memory/getThreadById.mdx +4 -4
- package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +110 -0
- package/.docs/raw/reference/memory/memory-class.mdx +13 -9
- package/.docs/raw/reference/memory/query.mdx +58 -57
- package/.docs/raw/reference/memory/recall.mdx +185 -0
- package/.docs/raw/reference/observability/tracing/configuration.mdx +245 -0
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/arize.mdx +13 -13
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +11 -8
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/cloud-exporter.mdx +21 -19
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/console-exporter.mdx +49 -17
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/default-exporter.mdx +42 -41
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/langfuse.mdx +10 -7
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +10 -7
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/otel.mdx +5 -5
- package/.docs/raw/reference/observability/tracing/instances.mdx +168 -0
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/interfaces.mdx +115 -89
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx +3 -3
- package/.docs/raw/reference/observability/{ai-tracing/span.mdx → tracing/spans.mdx} +59 -41
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +9 -3
- package/.docs/raw/reference/processors/language-detector.mdx +9 -3
- package/.docs/raw/reference/processors/moderation-processor.mdx +9 -3
- package/.docs/raw/reference/processors/pii-detector.mdx +9 -3
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +9 -3
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +9 -3
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +9 -3
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +9 -3
- package/.docs/raw/reference/rag/chunk.mdx +1 -8
- package/.docs/raw/reference/rag/database-config.mdx +7 -7
- package/.docs/raw/reference/rag/metadata-filters.mdx +14 -11
- 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 +3 -3
- package/.docs/raw/reference/storage/lance.mdx +1 -1
- package/.docs/raw/reference/storage/libsql.mdx +3 -1
- package/.docs/raw/reference/storage/mongodb.mdx +1 -1
- package/.docs/raw/reference/storage/mssql.mdx +6 -1
- package/.docs/raw/reference/storage/postgresql.mdx +7 -1
- package/.docs/raw/reference/storage/upstash.mdx +2 -1
- package/.docs/raw/reference/streaming/agents/stream.mdx +12 -12
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +8 -8
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +3 -3
- package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +3 -3
- package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +6 -6
- package/.docs/raw/reference/streaming/workflows/stream.mdx +10 -10
- package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +11 -11
- package/.docs/raw/reference/templates/overview.mdx +3 -3
- package/.docs/raw/reference/tools/create-tool.mdx +52 -35
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +15 -15
- package/.docs/raw/reference/tools/mcp-client.mdx +1 -1
- package/.docs/raw/reference/tools/mcp-server.mdx +119 -35
- package/.docs/raw/reference/tools/vector-query-tool.mdx +27 -26
- package/.docs/raw/reference/vectors/couchbase.mdx +8 -2
- package/.docs/raw/reference/vectors/libsql.mdx +2 -1
- package/.docs/raw/reference/vectors/mongodb.mdx +7 -1
- package/.docs/raw/reference/vectors/pg.mdx +3 -0
- package/.docs/raw/reference/vectors/s3vectors.mdx +1 -1
- package/.docs/raw/reference/vectors/upstash.mdx +1 -0
- package/.docs/raw/reference/voice/google-gemini-live.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addTools.mdx +3 -3
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -4
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +14 -14
- package/.docs/raw/reference/workflows/run-methods/start.mdx +17 -17
- package/.docs/raw/reference/workflows/run.mdx +1 -8
- package/.docs/raw/reference/workflows/step.mdx +5 -5
- 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 -13
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +5 -0
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow.mdx +1 -1
- package/.docs/raw/server-db/custom-api-routes.mdx +2 -2
- package/.docs/raw/server-db/mastra-client.mdx +23 -22
- package/.docs/raw/server-db/middleware.mdx +7 -7
- package/.docs/raw/server-db/production-server.mdx +4 -4
- package/.docs/raw/server-db/{runtime-context.mdx → request-context.mdx} +46 -45
- package/.docs/raw/server-db/storage.mdx +29 -21
- package/.docs/raw/streaming/events.mdx +3 -3
- package/.docs/raw/streaming/overview.mdx +5 -5
- package/.docs/raw/streaming/tool-streaming.mdx +18 -17
- package/.docs/raw/streaming/workflow-streaming.mdx +1 -1
- package/.docs/raw/tools-mcp/advanced-usage.mdx +5 -4
- package/.docs/raw/tools-mcp/mcp-overview.mdx +33 -20
- package/.docs/raw/tools-mcp/overview.mdx +11 -11
- package/.docs/raw/voice/overview.mdx +63 -43
- package/.docs/raw/voice/speech-to-speech.mdx +5 -3
- package/.docs/raw/voice/speech-to-text.mdx +10 -9
- package/.docs/raw/voice/text-to-speech.mdx +13 -12
- package/.docs/raw/workflows/agents-and-tools.mdx +9 -5
- package/.docs/raw/workflows/control-flow.mdx +3 -3
- package/.docs/raw/workflows/error-handling.mdx +2 -21
- package/.docs/raw/workflows/human-in-the-loop.mdx +7 -4
- package/.docs/raw/workflows/inngest-workflow.mdx +3 -3
- package/.docs/raw/workflows/input-data-mapping.mdx +107 -0
- package/.docs/raw/workflows/overview.mdx +17 -16
- package/.docs/raw/workflows/snapshots.mdx +13 -11
- package/.docs/raw/workflows/suspend-and-resume.mdx +23 -15
- package/CHANGELOG.md +55 -53
- package/README.md +11 -2
- package/dist/{chunk-TUAHUTTB.js → chunk-5NJC7NRO.js} +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/prepare-docs/copy-raw.d.ts.map +1 -1
- package/dist/prepare-docs/prepare.js +1 -1
- package/dist/prompts/migration.d.ts +6 -0
- package/dist/prompts/migration.d.ts.map +1 -0
- package/dist/stdio.js +402 -30
- package/dist/tools/migration.d.ts +40 -0
- package/dist/tools/migration.d.ts.map +1 -0
- package/package.json +8 -12
- package/.docs/organized/changelogs/%40mastra%2Fcloud.md +0 -302
- package/.docs/raw/observability/nextjs-tracing.mdx +0 -109
- package/.docs/raw/observability/otel-tracing.mdx +0 -189
- package/.docs/raw/reference/agents/getScorers.mdx +0 -69
- package/.docs/raw/reference/agents/getTools.mdx +0 -69
- package/.docs/raw/reference/agents/getWorkflows.mdx +0 -69
- package/.docs/raw/reference/client-js/workflows-legacy.mdx +0 -143
- package/.docs/raw/reference/core/getAgents.mdx +0 -35
- package/.docs/raw/reference/core/getLogs.mdx +0 -96
- package/.docs/raw/reference/core/getLogsByRunId.mdx +0 -87
- package/.docs/raw/reference/core/getMCPServers.mdx +0 -36
- package/.docs/raw/reference/core/getMemory.mdx +0 -36
- package/.docs/raw/reference/core/getScorerByName.mdx +0 -78
- package/.docs/raw/reference/core/getScorers.mdx +0 -43
- package/.docs/raw/reference/core/getVectors.mdx +0 -36
- package/.docs/raw/reference/core/getWorkflows.mdx +0 -45
- package/.docs/raw/reference/evals/context-position.mdx +0 -197
- package/.docs/raw/reference/evals/context-relevancy.mdx +0 -196
- package/.docs/raw/reference/evals/contextual-recall.mdx +0 -196
- package/.docs/raw/reference/evals/summarization.mdx +0 -212
- package/.docs/raw/reference/legacyWorkflows/after.mdx +0 -89
- package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +0 -79
- package/.docs/raw/reference/legacyWorkflows/commit.mdx +0 -33
- package/.docs/raw/reference/legacyWorkflows/createRun.mdx +0 -76
- package/.docs/raw/reference/legacyWorkflows/else.mdx +0 -68
- package/.docs/raw/reference/legacyWorkflows/events.mdx +0 -305
- package/.docs/raw/reference/legacyWorkflows/execute.mdx +0 -110
- package/.docs/raw/reference/legacyWorkflows/if.mdx +0 -108
- package/.docs/raw/reference/legacyWorkflows/resume.mdx +0 -158
- package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +0 -133
- package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +0 -207
- package/.docs/raw/reference/legacyWorkflows/start.mdx +0 -87
- package/.docs/raw/reference/legacyWorkflows/step-class.mdx +0 -100
- package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +0 -137
- package/.docs/raw/reference/legacyWorkflows/step-function.mdx +0 -93
- package/.docs/raw/reference/legacyWorkflows/step-options.mdx +0 -69
- package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +0 -196
- package/.docs/raw/reference/legacyWorkflows/suspend.mdx +0 -70
- package/.docs/raw/reference/legacyWorkflows/then.mdx +0 -72
- package/.docs/raw/reference/legacyWorkflows/until.mdx +0 -168
- package/.docs/raw/reference/legacyWorkflows/watch.mdx +0 -124
- package/.docs/raw/reference/legacyWorkflows/while.mdx +0 -168
- package/.docs/raw/reference/legacyWorkflows/workflow.mdx +0 -234
- package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +0 -79
- package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +0 -110
- package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +0 -185
- package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +0 -238
- package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +0 -117
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +0 -81
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +0 -121
- package/.docs/raw/reference/observability/otel-tracing/providers/braintrust.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +0 -20
- package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +0 -73
- package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +0 -41
- package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +0 -84
- package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +0 -48
- package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +0 -43
- package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +0 -40
- package/.docs/raw/reference/scorers/answer-relevancy.mdx +0 -227
- package/.docs/raw/reference/scorers/bias.mdx +0 -228
- package/.docs/raw/reference/scorers/completeness.mdx +0 -214
- package/.docs/raw/reference/scorers/content-similarity.mdx +0 -197
- package/.docs/raw/reference/scorers/context-precision.mdx +0 -352
- package/.docs/raw/reference/scorers/faithfulness.mdx +0 -241
- package/.docs/raw/reference/scorers/hallucination.mdx +0 -252
- package/.docs/raw/reference/scorers/keyword-coverage.mdx +0 -229
- package/.docs/raw/reference/scorers/prompt-alignment.mdx +0 -668
- package/.docs/raw/reference/scorers/textual-difference.mdx +0 -203
- package/.docs/raw/reference/scorers/tone-consistency.mdx +0 -211
- package/.docs/raw/reference/scorers/toxicity.mdx +0 -228
- package/.docs/raw/reference/workflows/run-methods/watch.mdx +0 -73
- package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +0 -24
- package/.docs/raw/scorers/evals-old-api/overview.mdx +0 -106
- package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +0 -85
- package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +0 -58
- package/.docs/raw/scorers/off-the-shelf-scorers.mdx +0 -50
- package/.docs/raw/workflows-legacy/control-flow.mdx +0 -774
- package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +0 -239
- package/.docs/raw/workflows-legacy/error-handling.mdx +0 -187
- package/.docs/raw/workflows-legacy/nested-workflows.mdx +0 -360
- package/.docs/raw/workflows-legacy/overview.mdx +0 -182
- package/.docs/raw/workflows-legacy/runtime-variables.mdx +0 -156
- package/.docs/raw/workflows-legacy/steps.mdx +0 -115
- package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +0 -406
- package/.docs/raw/workflows-legacy/variables.mdx +0 -318
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Reference: Memory.getThreadsByResourceId() | Memory | Mastra Docs"
|
|
3
|
-
description: "Documentation for the `Memory.getThreadsByResourceId()` method in Mastra, which retrieves all threads that belong to a specific resource."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Memory.getThreadsByResourceId()
|
|
7
|
-
|
|
8
|
-
The `.getThreadsByResourceId()` function retrieves all threads associated with a specific resource ID from storage. Threads can be sorted by creation or modification time in ascending or descending order.
|
|
9
|
-
|
|
10
|
-
## Usage Example
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
await memory?.getThreadsByResourceId({ resourceId: "user-123" });
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
<PropertiesTable
|
|
19
|
-
content={[
|
|
20
|
-
{
|
|
21
|
-
name: "resourceId",
|
|
22
|
-
type: "string",
|
|
23
|
-
description: "The ID of the resource whose threads are to be retrieved.",
|
|
24
|
-
isOptional: false,
|
|
25
|
-
},
|
|
26
|
-
{
|
|
27
|
-
name: "orderBy",
|
|
28
|
-
type: "ThreadOrderBy",
|
|
29
|
-
description:
|
|
30
|
-
"Field to sort threads by. Accepts 'createdAt' or 'updatedAt'. Default: 'createdAt'",
|
|
31
|
-
isOptional: true,
|
|
32
|
-
},
|
|
33
|
-
{
|
|
34
|
-
name: "sortDirection",
|
|
35
|
-
type: "ThreadSortDirection",
|
|
36
|
-
description:
|
|
37
|
-
"Sort order direction. Accepts 'ASC' or 'DESC'. Default: 'DESC'",
|
|
38
|
-
isOptional: true,
|
|
39
|
-
},
|
|
40
|
-
]}
|
|
41
|
-
/>
|
|
42
|
-
|
|
43
|
-
## Returns
|
|
44
|
-
|
|
45
|
-
<PropertiesTable
|
|
46
|
-
content={[
|
|
47
|
-
{
|
|
48
|
-
name: "StorageThreadType[]",
|
|
49
|
-
type: "Promise",
|
|
50
|
-
description:
|
|
51
|
-
"A promise that resolves to an array of threads associated with the given resource ID.",
|
|
52
|
-
},
|
|
53
|
-
]}
|
|
54
|
-
/>
|
|
55
|
-
|
|
56
|
-
## Extended usage example
|
|
57
|
-
|
|
58
|
-
```typescript title="src/test-memory.ts" showLineNumbers copy
|
|
59
|
-
import { mastra } from "./mastra";
|
|
60
|
-
|
|
61
|
-
const agent = mastra.getAgent("agent");
|
|
62
|
-
const memory = await agent.getMemory();
|
|
63
|
-
|
|
64
|
-
const thread = await memory?.getThreadsByResourceId({
|
|
65
|
-
resourceId: "user-123",
|
|
66
|
-
orderBy: "updatedAt",
|
|
67
|
-
sortDirection: "ASC",
|
|
68
|
-
});
|
|
69
|
-
|
|
70
|
-
console.log(thread);
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
### Related
|
|
74
|
-
|
|
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)
|
|
@@ -1,110 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Reference: Memory.getThreadsByResourceIdPaginated() | Memory | Mastra Docs"
|
|
3
|
-
description: "Documentation for the `Memory.getThreadsByResourceIdPaginated()` method in Mastra, which retrieves threads associated with a specific resource ID with pagination support."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Memory.getThreadsByResourceIdPaginated()
|
|
7
|
-
|
|
8
|
-
The `.getThreadsByResourceIdPaginated()` method retrieves threads associated with a specific resource ID with pagination support.
|
|
9
|
-
|
|
10
|
-
## Usage Example
|
|
11
|
-
|
|
12
|
-
```typescript copy
|
|
13
|
-
await memory.getThreadsByResourceIdPaginated({
|
|
14
|
-
resourceId: "user-123",
|
|
15
|
-
page: 0,
|
|
16
|
-
perPage: 10,
|
|
17
|
-
});
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
## Parameters
|
|
21
|
-
|
|
22
|
-
<PropertiesTable
|
|
23
|
-
content={[
|
|
24
|
-
{
|
|
25
|
-
name: "resourceId",
|
|
26
|
-
type: "string",
|
|
27
|
-
description: "The ID of the resource whose threads are to be retrieved",
|
|
28
|
-
isOptional: false,
|
|
29
|
-
},
|
|
30
|
-
{
|
|
31
|
-
name: "page",
|
|
32
|
-
type: "number",
|
|
33
|
-
description: "Page number to retrieve",
|
|
34
|
-
isOptional: false,
|
|
35
|
-
},
|
|
36
|
-
{
|
|
37
|
-
name: "perPage",
|
|
38
|
-
type: "number",
|
|
39
|
-
description: "Number of threads to return per page",
|
|
40
|
-
isOptional: false,
|
|
41
|
-
},
|
|
42
|
-
{
|
|
43
|
-
name: "orderBy",
|
|
44
|
-
type: "'createdAt' | 'updatedAt'",
|
|
45
|
-
description: "Field to sort threads by",
|
|
46
|
-
isOptional: true,
|
|
47
|
-
},
|
|
48
|
-
{
|
|
49
|
-
name: "sortDirection",
|
|
50
|
-
type: "'ASC' | 'DESC'",
|
|
51
|
-
description: "Sort order direction",
|
|
52
|
-
isOptional: true,
|
|
53
|
-
},
|
|
54
|
-
]}
|
|
55
|
-
/>
|
|
56
|
-
|
|
57
|
-
## Returns
|
|
58
|
-
|
|
59
|
-
<PropertiesTable
|
|
60
|
-
content={[
|
|
61
|
-
{
|
|
62
|
-
name: "result",
|
|
63
|
-
type: "Promise<PaginationInfo & { threads: StorageThreadType[] }>",
|
|
64
|
-
description:
|
|
65
|
-
"A promise that resolves to paginated thread results with metadata",
|
|
66
|
-
},
|
|
67
|
-
]}
|
|
68
|
-
/>
|
|
69
|
-
|
|
70
|
-
## Extended usage example
|
|
71
|
-
|
|
72
|
-
```typescript title="src/test-memory.ts" showLineNumbers copy
|
|
73
|
-
import { mastra } from "./mastra";
|
|
74
|
-
|
|
75
|
-
const agent = mastra.getAgent("agent");
|
|
76
|
-
const memory = await agent.getMemory();
|
|
77
|
-
|
|
78
|
-
let currentPage = 0;
|
|
79
|
-
let hasMorePages = true;
|
|
80
|
-
|
|
81
|
-
while (hasMorePages) {
|
|
82
|
-
const threads = await memory?.getThreadsByResourceIdPaginated({
|
|
83
|
-
resourceId: "user-123",
|
|
84
|
-
page: currentPage,
|
|
85
|
-
perPage: 25,
|
|
86
|
-
orderBy: "createdAt",
|
|
87
|
-
sortDirection: "ASC",
|
|
88
|
-
});
|
|
89
|
-
|
|
90
|
-
if (!threads) {
|
|
91
|
-
console.log("No threads");
|
|
92
|
-
break;
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
threads.threads.forEach((thread) => {
|
|
96
|
-
console.log(`Thread: ${thread.id}, Created: ${thread.createdAt}`);
|
|
97
|
-
});
|
|
98
|
-
|
|
99
|
-
hasMorePages = threads.hasMore;
|
|
100
|
-
currentPage++;
|
|
101
|
-
}
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
## Related
|
|
105
|
-
|
|
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)
|
|
@@ -1,185 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Reference: AITracing | Observability | Mastra Docs"
|
|
3
|
-
description: Core AI Tracing classes and methods
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
7
|
-
|
|
8
|
-
# AITracing
|
|
9
|
-
|
|
10
|
-
## DefaultAITracing
|
|
11
|
-
|
|
12
|
-
Default implementation of the AITracing interface.
|
|
13
|
-
|
|
14
|
-
### Constructor
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
new DefaultAITracing(config: TracingConfig)
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Creates a new DefaultAITracing instance with the specified configuration.
|
|
21
|
-
|
|
22
|
-
### Properties
|
|
23
|
-
|
|
24
|
-
Inherits all properties and methods from BaseAITracing.
|
|
25
|
-
|
|
26
|
-
## BaseAITracing
|
|
27
|
-
|
|
28
|
-
Base class for custom AI tracing implementations.
|
|
29
|
-
|
|
30
|
-
### Methods
|
|
31
|
-
|
|
32
|
-
#### getConfig
|
|
33
|
-
|
|
34
|
-
```typescript
|
|
35
|
-
getConfig(): Readonly<Required<TracingConfig>>
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
Returns the current tracing configuration.
|
|
39
|
-
|
|
40
|
-
#### getExporters
|
|
41
|
-
|
|
42
|
-
```typescript
|
|
43
|
-
getExporters(): readonly AITracingExporter[]
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
Returns all configured exporters.
|
|
47
|
-
|
|
48
|
-
#### getProcessors
|
|
49
|
-
|
|
50
|
-
```typescript
|
|
51
|
-
getProcessors(): readonly AISpanProcessor[]
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
Returns all configured processors.
|
|
55
|
-
|
|
56
|
-
#### getLogger
|
|
57
|
-
|
|
58
|
-
```typescript
|
|
59
|
-
getLogger(): IMastraLogger
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
Returns the logger instance for exporters and other components.
|
|
63
|
-
|
|
64
|
-
#### startSpan
|
|
65
|
-
|
|
66
|
-
```typescript
|
|
67
|
-
startSpan<TType extends AISpanType>(
|
|
68
|
-
options: StartSpanOptions<TType>
|
|
69
|
-
): AISpan<TType>
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
Start a new span of a specific AISpanType. Creates the root span of a trace if no parent is provided.
|
|
73
|
-
|
|
74
|
-
<PropertiesTable
|
|
75
|
-
props={[
|
|
76
|
-
{
|
|
77
|
-
name: "type",
|
|
78
|
-
type: "AISpanType",
|
|
79
|
-
description: "Type of span to create",
|
|
80
|
-
required: true,
|
|
81
|
-
},
|
|
82
|
-
{
|
|
83
|
-
name: "name",
|
|
84
|
-
type: "string",
|
|
85
|
-
description: "Name of the span",
|
|
86
|
-
required: true,
|
|
87
|
-
},
|
|
88
|
-
{
|
|
89
|
-
name: "parent",
|
|
90
|
-
type: "AnyAISpan",
|
|
91
|
-
description: "Parent span (if not root)",
|
|
92
|
-
required: false,
|
|
93
|
-
},
|
|
94
|
-
{
|
|
95
|
-
name: "attributes",
|
|
96
|
-
type: "AISpanTypeMap[TType]",
|
|
97
|
-
description: "Type-specific attributes",
|
|
98
|
-
required: false,
|
|
99
|
-
},
|
|
100
|
-
{
|
|
101
|
-
name: "metadata",
|
|
102
|
-
type: "Record<string, any>",
|
|
103
|
-
description: "User-defined metadata",
|
|
104
|
-
required: false,
|
|
105
|
-
},
|
|
106
|
-
{
|
|
107
|
-
name: "input",
|
|
108
|
-
type: "any",
|
|
109
|
-
description: "Initial input data",
|
|
110
|
-
required: false,
|
|
111
|
-
},
|
|
112
|
-
{
|
|
113
|
-
name: "customSamplerOptions",
|
|
114
|
-
type: "CustomSamplerOptions",
|
|
115
|
-
description: "Options for custom sampler",
|
|
116
|
-
required: false,
|
|
117
|
-
},
|
|
118
|
-
]}
|
|
119
|
-
/>
|
|
120
|
-
|
|
121
|
-
#### shutdown
|
|
122
|
-
|
|
123
|
-
```typescript
|
|
124
|
-
async shutdown(): Promise<void>
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
Shuts down all exporters and processors, cleaning up resources.
|
|
128
|
-
|
|
129
|
-
## Custom Implementation
|
|
130
|
-
|
|
131
|
-
To create a custom AI tracing implementation, extend BaseAITracing:
|
|
132
|
-
|
|
133
|
-
```typescript
|
|
134
|
-
class CustomAITracing extends BaseAITracing {
|
|
135
|
-
constructor(config: TracingConfig) {
|
|
136
|
-
super(config);
|
|
137
|
-
// Custom initialization
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
// Override methods as needed
|
|
141
|
-
startSpan<TType extends AISpanType>(
|
|
142
|
-
options: StartSpanOptions<TType>,
|
|
143
|
-
): AISpan<TType> {
|
|
144
|
-
// Custom span creation logic
|
|
145
|
-
return super.startSpan(options);
|
|
146
|
-
}
|
|
147
|
-
}
|
|
148
|
-
```
|
|
149
|
-
|
|
150
|
-
## NO-OP Spans
|
|
151
|
-
|
|
152
|
-
When tracing is disabled (sampling returns false), NO-OP spans are returned:
|
|
153
|
-
|
|
154
|
-
### NoOpAISpan
|
|
155
|
-
|
|
156
|
-
```typescript
|
|
157
|
-
class NoOpAISpan<TType extends AISpanType> extends BaseAISpan<TType>
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
A span that performs no operations. All methods are no-ops:
|
|
161
|
-
|
|
162
|
-
- `id` returns `'no-op'`
|
|
163
|
-
- `traceId` returns `'no-op-trace'`
|
|
164
|
-
- `isValid` returns `false`
|
|
165
|
-
- `end()`, `error()`, `update()` do nothing
|
|
166
|
-
- `createChildSpan()` returns another NO-OP span
|
|
167
|
-
|
|
168
|
-
## See Also
|
|
169
|
-
|
|
170
|
-
### Documentation
|
|
171
|
-
|
|
172
|
-
- [AI Tracing Overview](/docs/observability/ai-tracing/overview) - Concepts and usage guide
|
|
173
|
-
- [Configuration Reference](/reference/observability/ai-tracing/configuration) - Configuration options
|
|
174
|
-
- [Interfaces Reference](/reference/observability/ai-tracing/interfaces) - Type definitions
|
|
175
|
-
- [Span Reference](/reference/observability/ai-tracing/span) - Span lifecycle and methods
|
|
176
|
-
|
|
177
|
-
### Examples
|
|
178
|
-
|
|
179
|
-
- [Basic AI Tracing](/examples/observability/basic-ai-tracing) - Getting started example
|
|
180
|
-
|
|
181
|
-
### Exporters
|
|
182
|
-
|
|
183
|
-
- [DefaultExporter](/reference/observability/ai-tracing/exporters/default-exporter) - Storage persistence
|
|
184
|
-
- [CloudExporter](/reference/observability/ai-tracing/exporters/cloud-exporter) - Mastra Cloud integration
|
|
185
|
-
- [ConsoleExporter](/reference/observability/ai-tracing/exporters/console-exporter) - Debug output
|
|
@@ -1,238 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Reference: Configuration | Observability | Mastra Docs"
|
|
3
|
-
description: AI Tracing configuration types and registry functions
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
7
|
-
|
|
8
|
-
# Configuration
|
|
9
|
-
|
|
10
|
-
## ObservabilityRegistryConfig
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
interface ObservabilityRegistryConfig {
|
|
14
|
-
default?: { enabled?: boolean };
|
|
15
|
-
configs?: Record<string, TracingConfig | AITracing>;
|
|
16
|
-
configSelector?: ConfigSelector;
|
|
17
|
-
}
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
<PropertiesTable
|
|
21
|
-
props={[
|
|
22
|
-
{
|
|
23
|
-
name: "default",
|
|
24
|
-
type: "{ enabled?: boolean }",
|
|
25
|
-
description: "Enable default configuration",
|
|
26
|
-
required: false,
|
|
27
|
-
},
|
|
28
|
-
{
|
|
29
|
-
name: "configs",
|
|
30
|
-
type: "Record<string, TracingConfig | AITracing>",
|
|
31
|
-
description: "Named tracing configurations",
|
|
32
|
-
required: false,
|
|
33
|
-
},
|
|
34
|
-
{
|
|
35
|
-
name: "configSelector",
|
|
36
|
-
type: "ConfigSelector",
|
|
37
|
-
description: "Runtime configuration selector",
|
|
38
|
-
required: false,
|
|
39
|
-
},
|
|
40
|
-
]}
|
|
41
|
-
/>
|
|
42
|
-
|
|
43
|
-
## TracingConfig
|
|
44
|
-
|
|
45
|
-
```typescript
|
|
46
|
-
interface TracingConfig {
|
|
47
|
-
name: string;
|
|
48
|
-
serviceName: string;
|
|
49
|
-
sampling?: SamplingStrategy;
|
|
50
|
-
exporters?: AITracingExporter[];
|
|
51
|
-
processors?: AISpanProcessor[];
|
|
52
|
-
}
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
<PropertiesTable
|
|
56
|
-
props={[
|
|
57
|
-
{
|
|
58
|
-
name: "name",
|
|
59
|
-
type: "string",
|
|
60
|
-
description: "Configuration identifier",
|
|
61
|
-
required: true,
|
|
62
|
-
},
|
|
63
|
-
{
|
|
64
|
-
name: "serviceName",
|
|
65
|
-
type: "string",
|
|
66
|
-
description: "Service name in traces",
|
|
67
|
-
required: true,
|
|
68
|
-
},
|
|
69
|
-
{
|
|
70
|
-
name: "sampling",
|
|
71
|
-
type: "SamplingStrategy",
|
|
72
|
-
description: "Sampling configuration",
|
|
73
|
-
required: false,
|
|
74
|
-
},
|
|
75
|
-
{
|
|
76
|
-
name: "exporters",
|
|
77
|
-
type: "AITracingExporter[]",
|
|
78
|
-
description: "Trace data exporters",
|
|
79
|
-
required: false,
|
|
80
|
-
},
|
|
81
|
-
{
|
|
82
|
-
name: "processors",
|
|
83
|
-
type: "AISpanProcessor[]",
|
|
84
|
-
description: "Span processors",
|
|
85
|
-
required: false,
|
|
86
|
-
},
|
|
87
|
-
]}
|
|
88
|
-
/>
|
|
89
|
-
|
|
90
|
-
## SamplingStrategy
|
|
91
|
-
|
|
92
|
-
```typescript
|
|
93
|
-
type SamplingStrategy =
|
|
94
|
-
| { type: "always" }
|
|
95
|
-
| { type: "never" }
|
|
96
|
-
| { type: "ratio"; probability: number }
|
|
97
|
-
| { type: "custom"; sampler: (options?: TracingOptions) => boolean };
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
## ConfigSelector
|
|
101
|
-
|
|
102
|
-
```typescript
|
|
103
|
-
type ConfigSelector = (
|
|
104
|
-
options: ConfigSelectorOptions,
|
|
105
|
-
availableConfigs: Map<string, AITracing>,
|
|
106
|
-
) => string | undefined;
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
## ConfigSelectorOptions
|
|
110
|
-
|
|
111
|
-
```typescript
|
|
112
|
-
interface ConfigSelectorOptions {
|
|
113
|
-
metadata?: Record<string, any>;
|
|
114
|
-
runtimeContext?: Map<string, any>;
|
|
115
|
-
}
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
# Registry Functions
|
|
119
|
-
|
|
120
|
-
## setupAITracing
|
|
121
|
-
|
|
122
|
-
```typescript
|
|
123
|
-
function setupAITracing(config: ObservabilityRegistryConfig): void;
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
Initializes AI tracing from configuration. Called automatically by Mastra constructor.
|
|
127
|
-
|
|
128
|
-
## registerAITracing
|
|
129
|
-
|
|
130
|
-
```typescript
|
|
131
|
-
function registerAITracing(
|
|
132
|
-
name: string,
|
|
133
|
-
instance: AITracing,
|
|
134
|
-
isDefault?: boolean,
|
|
135
|
-
): void;
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
Registers a tracing config in the global registry.
|
|
139
|
-
|
|
140
|
-
## getAITracing
|
|
141
|
-
|
|
142
|
-
```typescript
|
|
143
|
-
function getAITracing(name: string): AITracing | undefined;
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
Retrieves a tracing config by name.
|
|
147
|
-
|
|
148
|
-
## getDefaultAITracing
|
|
149
|
-
|
|
150
|
-
```typescript
|
|
151
|
-
function getDefaultAITracing(): AITracing | undefined;
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
Returns the default tracing config.
|
|
155
|
-
|
|
156
|
-
## getSelectedAITracing
|
|
157
|
-
|
|
158
|
-
```typescript
|
|
159
|
-
function getSelectedAITracing(
|
|
160
|
-
options: ConfigSelectorOptions,
|
|
161
|
-
): AITracing | undefined;
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
Returns the tracing config selected by the config selector or default.
|
|
165
|
-
|
|
166
|
-
## setSelector
|
|
167
|
-
|
|
168
|
-
```typescript
|
|
169
|
-
function setSelector(selector: ConfigSelector): void;
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
Sets the global config selector function.
|
|
173
|
-
|
|
174
|
-
## unregisterAITracing
|
|
175
|
-
|
|
176
|
-
```typescript
|
|
177
|
-
function unregisterAITracing(name: string): boolean;
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
Removes a tracing config from the registry.
|
|
181
|
-
|
|
182
|
-
## shutdownAITracingRegistry
|
|
183
|
-
|
|
184
|
-
```typescript
|
|
185
|
-
async function shutdownAITracingRegistry(): Promise<void>;
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
Shuts down all tracing configs and clears the registry.
|
|
189
|
-
|
|
190
|
-
## clearAITracingRegistry
|
|
191
|
-
|
|
192
|
-
```typescript
|
|
193
|
-
function clearAITracingRegistry(): void;
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
Clears all configs without shutdown.
|
|
197
|
-
|
|
198
|
-
## getAllAITracing
|
|
199
|
-
|
|
200
|
-
```typescript
|
|
201
|
-
function getAllAITracing(): ReadonlyMap<string, AITracing>;
|
|
202
|
-
```
|
|
203
|
-
|
|
204
|
-
Returns all registered tracing configs.
|
|
205
|
-
|
|
206
|
-
## hasAITracing
|
|
207
|
-
|
|
208
|
-
```typescript
|
|
209
|
-
function hasAITracing(name: string): boolean;
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
Checks if a tracing instance exists and is enabled.
|
|
213
|
-
|
|
214
|
-
## See Also
|
|
215
|
-
|
|
216
|
-
### Documentation
|
|
217
|
-
|
|
218
|
-
- [AI Tracing Overview](/docs/observability/ai-tracing/overview) - Concepts and usage guide
|
|
219
|
-
- [Sampling Strategies](/docs/observability/ai-tracing/overview#sampling-strategies) - Sampling configuration details
|
|
220
|
-
- [Multi-Config Setup](/docs/observability/ai-tracing/overview#multi-config-setup) - Using multiple configurations
|
|
221
|
-
|
|
222
|
-
### Reference
|
|
223
|
-
|
|
224
|
-
- [AITracing Classes](/reference/observability/ai-tracing/) - Core tracing classes
|
|
225
|
-
- [Interfaces](/reference/observability/ai-tracing/interfaces) - Type definitions
|
|
226
|
-
- [Span Reference](/reference/observability/ai-tracing/span) - Span lifecycle
|
|
227
|
-
|
|
228
|
-
### Examples
|
|
229
|
-
|
|
230
|
-
- [Basic AI Tracing](/examples/observability/basic-ai-tracing) - Getting started
|
|
231
|
-
|
|
232
|
-
### Exporters
|
|
233
|
-
|
|
234
|
-
- [DefaultExporter](/reference/observability/ai-tracing/exporters/default-exporter) - Storage configuration
|
|
235
|
-
- [CloudExporter](/reference/observability/ai-tracing/exporters/cloud-exporter) - Cloud setup
|
|
236
|
-
- [Braintrust](/reference/observability/ai-tracing/exporters/braintrust) - Braintrust integration
|
|
237
|
-
- [Langfuse](/reference/observability/ai-tracing/exporters/langfuse) - Langfuse integration
|
|
238
|
-
- [LangSmith](/reference/observability/ai-tracing/exporters/langsmith) - LangSmith integration
|