@mastra/mcp-docs-server 0.13.37 → 0.13.38
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +2 -0
- package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +2 -0
- package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +8 -8
- package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +2 -0
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +23 -23
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +69 -69
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +25 -25
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +15 -15
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +27 -27
- package/.docs/organized/changelogs/%40mastra%2Freact.md +15 -15
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +23 -23
- package/.docs/organized/changelogs/create-mastra.md +5 -5
- package/.docs/organized/changelogs/mastra.md +17 -17
- package/.docs/raw/agents/adding-voice.mdx +20 -9
- package/.docs/raw/agents/agent-memory.mdx +55 -39
- package/.docs/raw/agents/guardrails.mdx +68 -61
- package/.docs/raw/agents/networks.mdx +50 -46
- package/.docs/raw/agents/overview.mdx +125 -88
- package/.docs/raw/agents/using-tools.mdx +14 -15
- package/.docs/raw/auth/auth0.mdx +28 -27
- package/.docs/raw/auth/clerk.mdx +22 -20
- package/.docs/raw/auth/firebase.mdx +42 -39
- package/.docs/raw/auth/index.mdx +1 -1
- package/.docs/raw/auth/jwt.mdx +18 -16
- package/.docs/raw/auth/supabase.mdx +20 -18
- package/.docs/raw/auth/workos.mdx +32 -26
- package/.docs/raw/community/contributing-templates.mdx +7 -7
- package/.docs/raw/community/discord.mdx +2 -2
- package/.docs/raw/community/licensing.mdx +1 -1
- package/.docs/raw/course/03-agent-memory/26-updating-mastra-export-comprehensive.md +0 -32
- package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +41 -22
- package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +48 -29
- package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +52 -24
- package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +86 -55
- package/.docs/raw/deployment/cloud-providers/index.mdx +16 -13
- package/.docs/raw/deployment/monorepo.mdx +32 -42
- package/.docs/raw/deployment/overview.mdx +15 -15
- package/.docs/raw/deployment/server-deployment.mdx +18 -23
- package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +16 -17
- package/.docs/raw/deployment/serverless-platforms/index.mdx +15 -12
- package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +14 -23
- package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +16 -23
- package/.docs/raw/deployment/web-framework.mdx +14 -14
- package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +138 -145
- package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +54 -43
- package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +51 -36
- package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +161 -120
- package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +59 -48
- package/.docs/raw/frameworks/servers/express.mdx +45 -44
- package/.docs/raw/frameworks/web-frameworks/astro.mdx +245 -162
- package/.docs/raw/frameworks/web-frameworks/next-js.mdx +112 -69
- package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +189 -164
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +94 -81
- package/.docs/raw/getting-started/installation.mdx +164 -133
- package/.docs/raw/getting-started/mcp-docs-server.mdx +36 -39
- package/.docs/raw/getting-started/project-structure.mdx +34 -42
- package/.docs/raw/getting-started/studio.mdx +40 -58
- package/.docs/raw/getting-started/templates.mdx +22 -27
- package/.docs/raw/index.mdx +9 -9
- package/.docs/raw/mastra-cloud/dashboard.mdx +10 -10
- package/.docs/raw/mastra-cloud/observability.mdx +7 -8
- package/.docs/raw/mastra-cloud/overview.mdx +16 -22
- package/.docs/raw/mastra-cloud/setting-up.mdx +33 -20
- package/.docs/raw/memory/conversation-history.mdx +2 -2
- package/.docs/raw/memory/overview.mdx +21 -23
- package/.docs/raw/memory/semantic-recall.mdx +14 -13
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +27 -28
- package/.docs/raw/memory/storage/memory-with-pg.mdx +26 -26
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +26 -27
- package/.docs/raw/memory/threads-and-resources.mdx +23 -20
- package/.docs/raw/memory/working-memory.mdx +27 -38
- package/.docs/raw/observability/ai-tracing/exporters/arize.mdx +30 -29
- package/.docs/raw/observability/ai-tracing/exporters/braintrust.mdx +8 -9
- package/.docs/raw/observability/ai-tracing/exporters/cloud.mdx +17 -16
- package/.docs/raw/observability/ai-tracing/exporters/default.mdx +31 -32
- package/.docs/raw/observability/ai-tracing/exporters/langfuse.mdx +18 -17
- package/.docs/raw/observability/ai-tracing/exporters/langsmith.mdx +14 -14
- package/.docs/raw/observability/ai-tracing/exporters/otel.mdx +56 -46
- package/.docs/raw/observability/ai-tracing/overview.mdx +145 -122
- package/.docs/raw/observability/ai-tracing/processors/sensitive-data-filter.mdx +57 -36
- package/.docs/raw/observability/logging.mdx +14 -17
- package/.docs/raw/observability/nextjs-tracing.mdx +5 -5
- package/.docs/raw/observability/otel-tracing.mdx +17 -18
- package/.docs/raw/observability/overview.mdx +14 -10
- package/.docs/raw/rag/chunking-and-embedding.mdx +10 -8
- package/.docs/raw/rag/overview.mdx +5 -5
- package/.docs/raw/rag/retrieval.mdx +125 -107
- package/.docs/raw/rag/vector-databases.mdx +232 -223
- package/.docs/raw/reference/agents/agent.mdx +54 -41
- package/.docs/raw/reference/agents/generate.mdx +367 -261
- package/.docs/raw/reference/agents/generateLegacy.mdx +260 -178
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +7 -5
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +7 -5
- package/.docs/raw/reference/agents/getDescription.mdx +3 -2
- package/.docs/raw/reference/agents/getInstructions.mdx +7 -5
- package/.docs/raw/reference/agents/getLLM.mdx +11 -7
- package/.docs/raw/reference/agents/getMemory.mdx +7 -5
- package/.docs/raw/reference/agents/getModel.mdx +7 -5
- package/.docs/raw/reference/agents/getScorers.mdx +7 -5
- package/.docs/raw/reference/agents/getTools.mdx +7 -5
- package/.docs/raw/reference/agents/getVoice.mdx +7 -5
- package/.docs/raw/reference/agents/getWorkflows.mdx +7 -5
- package/.docs/raw/reference/agents/listAgents.mdx +6 -4
- package/.docs/raw/reference/agents/network.mdx +171 -116
- package/.docs/raw/reference/auth/auth0.mdx +18 -14
- package/.docs/raw/reference/auth/clerk.mdx +15 -12
- package/.docs/raw/reference/auth/firebase.mdx +23 -16
- package/.docs/raw/reference/auth/jwt.mdx +7 -6
- package/.docs/raw/reference/auth/supabase.mdx +13 -10
- package/.docs/raw/reference/auth/workos.mdx +17 -13
- package/.docs/raw/reference/cli/create-mastra.mdx +61 -44
- package/.docs/raw/reference/cli/mastra.mdx +11 -11
- package/.docs/raw/reference/client-js/agents.mdx +40 -43
- package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
- package/.docs/raw/reference/client-js/logs.mdx +1 -1
- package/.docs/raw/reference/client-js/mastra-client.mdx +21 -13
- package/.docs/raw/reference/client-js/memory.mdx +6 -2
- package/.docs/raw/reference/client-js/observability.mdx +10 -9
- package/.docs/raw/reference/client-js/telemetry.mdx +1 -1
- package/.docs/raw/reference/client-js/tools.mdx +1 -1
- package/.docs/raw/reference/client-js/vectors.mdx +1 -1
- package/.docs/raw/reference/client-js/workflows-legacy.mdx +1 -1
- package/.docs/raw/reference/client-js/workflows.mdx +7 -7
- package/.docs/raw/reference/core/getAgent.mdx +6 -5
- package/.docs/raw/reference/core/getAgentById.mdx +5 -4
- package/.docs/raw/reference/core/getAgents.mdx +3 -3
- package/.docs/raw/reference/core/getDeployer.mdx +4 -3
- package/.docs/raw/reference/core/getLogger.mdx +4 -3
- package/.docs/raw/reference/core/getLogs.mdx +10 -6
- package/.docs/raw/reference/core/getLogsByRunId.mdx +8 -5
- package/.docs/raw/reference/core/getMCPServer.mdx +8 -5
- package/.docs/raw/reference/core/getMCPServers.mdx +4 -3
- package/.docs/raw/reference/core/getMemory.mdx +4 -3
- package/.docs/raw/reference/core/getScorer.mdx +15 -12
- package/.docs/raw/reference/core/getScorerByName.mdx +12 -9
- package/.docs/raw/reference/core/getScorers.mdx +3 -2
- package/.docs/raw/reference/core/getServer.mdx +4 -3
- package/.docs/raw/reference/core/getStorage.mdx +4 -3
- package/.docs/raw/reference/core/getTelemetry.mdx +4 -3
- package/.docs/raw/reference/core/getVector.mdx +6 -4
- package/.docs/raw/reference/core/getVectors.mdx +4 -3
- package/.docs/raw/reference/core/getWorkflow.mdx +7 -4
- package/.docs/raw/reference/core/getWorkflows.mdx +5 -3
- package/.docs/raw/reference/core/mastra-class.mdx +16 -16
- package/.docs/raw/reference/core/setLogger.mdx +6 -4
- package/.docs/raw/reference/core/setStorage.mdx +4 -4
- package/.docs/raw/reference/core/setTelemetry.mdx +4 -3
- package/.docs/raw/reference/deployer/cloudflare.mdx +11 -7
- package/.docs/raw/reference/deployer/deployer.mdx +2 -1
- package/.docs/raw/reference/deployer/netlify.mdx +4 -4
- package/.docs/raw/reference/deployer/vercel.mdx +6 -6
- package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -5
- package/.docs/raw/reference/evals/bias.mdx +4 -5
- package/.docs/raw/reference/evals/completeness.mdx +4 -5
- package/.docs/raw/reference/evals/content-similarity.mdx +4 -5
- package/.docs/raw/reference/evals/context-position.mdx +4 -5
- package/.docs/raw/reference/evals/context-precision.mdx +4 -5
- package/.docs/raw/reference/evals/context-relevancy.mdx +4 -5
- package/.docs/raw/reference/evals/contextual-recall.mdx +4 -5
- package/.docs/raw/reference/evals/faithfulness.mdx +4 -5
- package/.docs/raw/reference/evals/hallucination.mdx +4 -6
- package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -5
- package/.docs/raw/reference/evals/prompt-alignment.mdx +4 -6
- package/.docs/raw/reference/evals/summarization.mdx +4 -6
- package/.docs/raw/reference/evals/textual-difference.mdx +4 -5
- package/.docs/raw/reference/evals/tone-consistency.mdx +4 -7
- package/.docs/raw/reference/evals/toxicity.mdx +4 -5
- package/.docs/raw/reference/index.mdx +3 -3
- package/.docs/raw/reference/legacyWorkflows/after.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/commit.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/createRun.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/else.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/events.mdx +7 -7
- package/.docs/raw/reference/legacyWorkflows/execute.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/if.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/resume.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/start.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/step-class.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/step-function.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/step-options.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/suspend.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/then.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/until.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/watch.mdx +3 -3
- package/.docs/raw/reference/legacyWorkflows/while.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/workflow.mdx +7 -7
- package/.docs/raw/reference/memory/createThread.mdx +10 -10
- package/.docs/raw/reference/memory/deleteMessages.mdx +7 -5
- package/.docs/raw/reference/memory/getThreadById.mdx +6 -5
- package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +11 -10
- package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +10 -9
- package/.docs/raw/reference/memory/{Memory.mdx → memory-class.mdx} +53 -46
- package/.docs/raw/reference/memory/query.mdx +39 -25
- package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +9 -5
- package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +26 -22
- package/.docs/raw/reference/observability/ai-tracing/exporters/arize.mdx +16 -12
- package/.docs/raw/reference/observability/ai-tracing/exporters/braintrust.mdx +14 -14
- package/.docs/raw/reference/observability/ai-tracing/exporters/cloud-exporter.mdx +16 -11
- package/.docs/raw/reference/observability/ai-tracing/exporters/console-exporter.mdx +10 -6
- package/.docs/raw/reference/observability/ai-tracing/exporters/default-exporter.mdx +23 -15
- package/.docs/raw/reference/observability/ai-tracing/exporters/langfuse.mdx +6 -6
- package/.docs/raw/reference/observability/ai-tracing/exporters/langsmith.mdx +13 -13
- package/.docs/raw/reference/observability/ai-tracing/exporters/otel.mdx +44 -36
- package/.docs/raw/reference/observability/ai-tracing/interfaces.mdx +115 -106
- package/.docs/raw/reference/observability/ai-tracing/processors/sensitive-data-filter.mdx +37 -32
- package/.docs/raw/reference/observability/ai-tracing/span.mdx +29 -26
- package/.docs/raw/reference/observability/logging/pino-logger.mdx +13 -15
- package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +2 -2
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +3 -3
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +2 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +12 -14
- package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +3 -3
- package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +4 -4
- package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +2 -2
- package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +1 -1
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +13 -10
- package/.docs/raw/reference/processors/language-detector.mdx +27 -17
- package/.docs/raw/reference/processors/moderation-processor.mdx +26 -17
- package/.docs/raw/reference/processors/pii-detector.mdx +28 -18
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +25 -17
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +26 -17
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +22 -15
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +13 -12
- package/.docs/raw/reference/rag/chunk.mdx +41 -23
- package/.docs/raw/reference/rag/database-config.mdx +56 -38
- package/.docs/raw/reference/rag/document.mdx +1 -1
- package/.docs/raw/reference/rag/embeddings.mdx +1 -1
- package/.docs/raw/reference/rag/extract-params.mdx +1 -1
- package/.docs/raw/reference/rag/graph-rag.mdx +1 -1
- package/.docs/raw/reference/rag/metadata-filters.mdx +23 -26
- package/.docs/raw/reference/rag/rerank.mdx +1 -1
- package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -2
- package/.docs/raw/reference/scorers/answer-relevancy.mdx +35 -17
- package/.docs/raw/reference/scorers/answer-similarity.mdx +84 -68
- package/.docs/raw/reference/scorers/bias.mdx +22 -19
- package/.docs/raw/reference/scorers/completeness.mdx +21 -16
- package/.docs/raw/reference/scorers/content-similarity.mdx +12 -10
- package/.docs/raw/reference/scorers/context-precision.mdx +73 -64
- package/.docs/raw/reference/scorers/context-relevance.mdx +142 -126
- package/.docs/raw/reference/scorers/create-scorer.mdx +93 -61
- package/.docs/raw/reference/scorers/faithfulness.mdx +21 -13
- package/.docs/raw/reference/scorers/hallucination.mdx +17 -12
- package/.docs/raw/reference/scorers/keyword-coverage.mdx +32 -27
- package/.docs/raw/reference/scorers/mastra-scorer.mdx +39 -33
- package/.docs/raw/reference/scorers/noise-sensitivity.mdx +203 -152
- package/.docs/raw/reference/scorers/prompt-alignment.mdx +186 -132
- package/.docs/raw/reference/scorers/run-experiment.mdx +40 -31
- package/.docs/raw/reference/scorers/textual-difference.mdx +25 -26
- package/.docs/raw/reference/scorers/tone-consistency.mdx +29 -26
- package/.docs/raw/reference/scorers/tool-call-accuracy.mdx +180 -176
- package/.docs/raw/reference/scorers/toxicity.mdx +35 -31
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
- package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
- package/.docs/raw/reference/storage/dynamodb.mdx +1 -1
- package/.docs/raw/reference/storage/lance.mdx +1 -1
- package/.docs/raw/reference/storage/libsql.mdx +2 -2
- package/.docs/raw/reference/storage/mongodb.mdx +4 -5
- package/.docs/raw/reference/storage/mssql.mdx +5 -4
- package/.docs/raw/reference/storage/postgresql.mdx +35 -33
- package/.docs/raw/reference/storage/upstash.mdx +6 -5
- package/.docs/raw/reference/streaming/ChunkType.mdx +788 -314
- package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +265 -109
- package/.docs/raw/reference/streaming/agents/stream.mdx +375 -266
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +233 -162
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +4 -4
- package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +5 -5
- package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +24 -20
- package/.docs/raw/reference/streaming/workflows/stream.mdx +35 -26
- package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +36 -27
- package/.docs/raw/reference/templates/overview.mdx +16 -39
- package/.docs/raw/reference/tools/client.mdx +1 -1
- package/.docs/raw/reference/tools/create-tool.mdx +45 -35
- package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -2
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +12 -12
- package/.docs/raw/reference/tools/mcp-client.mdx +70 -64
- package/.docs/raw/reference/tools/mcp-server.mdx +91 -78
- package/.docs/raw/reference/tools/vector-query-tool.mdx +48 -38
- package/.docs/raw/reference/vectors/astra.mdx +1 -1
- package/.docs/raw/reference/vectors/chroma.mdx +25 -19
- package/.docs/raw/reference/vectors/couchbase.mdx +4 -4
- package/.docs/raw/reference/vectors/lance.mdx +5 -6
- package/.docs/raw/reference/vectors/libsql.mdx +1 -1
- package/.docs/raw/reference/vectors/mongodb.mdx +1 -1
- package/.docs/raw/reference/vectors/opensearch.mdx +1 -1
- package/.docs/raw/reference/vectors/pg.mdx +8 -4
- package/.docs/raw/reference/vectors/pinecone.mdx +1 -1
- package/.docs/raw/reference/vectors/qdrant.mdx +1 -1
- package/.docs/raw/reference/vectors/s3vectors.mdx +35 -27
- package/.docs/raw/reference/vectors/turbopuffer.mdx +1 -1
- package/.docs/raw/reference/vectors/upstash.mdx +33 -25
- package/.docs/raw/reference/vectors/vectorize.mdx +1 -1
- package/.docs/raw/reference/voice/azure.mdx +1 -1
- package/.docs/raw/reference/voice/cloudflare.mdx +1 -1
- package/.docs/raw/reference/voice/composite-voice.mdx +1 -1
- package/.docs/raw/reference/voice/deepgram.mdx +1 -1
- package/.docs/raw/reference/voice/elevenlabs.mdx +1 -1
- package/.docs/raw/reference/voice/google-gemini-live.mdx +6 -4
- package/.docs/raw/reference/voice/google.mdx +1 -1
- package/.docs/raw/reference/voice/mastra-voice.mdx +1 -1
- package/.docs/raw/reference/voice/murf.mdx +1 -1
- package/.docs/raw/reference/voice/openai-realtime.mdx +1 -1
- package/.docs/raw/reference/voice/openai.mdx +1 -1
- package/.docs/raw/reference/voice/playai.mdx +1 -1
- package/.docs/raw/reference/voice/sarvam.mdx +1 -1
- package/.docs/raw/reference/voice/speechify.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addInstructions.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addTools.mdx +1 -1
- package/.docs/raw/reference/voice/voice.answer.mdx +1 -1
- package/.docs/raw/reference/voice/voice.close.mdx +1 -1
- package/.docs/raw/reference/voice/voice.connect.mdx +1 -1
- package/.docs/raw/reference/voice/voice.events.mdx +1 -1
- package/.docs/raw/reference/voice/voice.getSpeakers.mdx +23 -30
- package/.docs/raw/reference/voice/voice.listen.mdx +1 -1
- package/.docs/raw/reference/voice/voice.off.mdx +1 -1
- package/.docs/raw/reference/voice/voice.on.mdx +1 -1
- package/.docs/raw/reference/voice/voice.send.mdx +1 -1
- package/.docs/raw/reference/voice/voice.speak.mdx +1 -1
- package/.docs/raw/reference/voice/voice.updateConfig.mdx +1 -1
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -3
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +49 -34
- package/.docs/raw/reference/workflows/run-methods/start.mdx +43 -31
- package/.docs/raw/reference/workflows/run-methods/watch.mdx +7 -8
- package/.docs/raw/reference/workflows/run.mdx +7 -10
- package/.docs/raw/reference/workflows/step.mdx +15 -12
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +7 -7
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +3 -2
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +5 -5
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +3 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +3 -2
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +3 -3
- package/.docs/raw/reference/workflows/workflow.mdx +13 -10
- package/.docs/raw/scorers/custom-scorers.mdx +58 -48
- package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +6 -8
- package/.docs/raw/scorers/evals-old-api/overview.mdx +8 -8
- package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +9 -9
- package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +5 -5
- package/.docs/raw/scorers/off-the-shelf-scorers.mdx +3 -1
- package/.docs/raw/scorers/overview.mdx +20 -19
- package/.docs/raw/server-db/custom-api-routes.mdx +8 -8
- package/.docs/raw/server-db/mastra-client.mdx +56 -54
- package/.docs/raw/server-db/middleware.mdx +11 -7
- package/.docs/raw/server-db/production-server.mdx +5 -7
- package/.docs/raw/server-db/runtime-context.mdx +41 -38
- package/.docs/raw/server-db/storage.mdx +82 -87
- package/.docs/raw/streaming/events.mdx +24 -16
- package/.docs/raw/streaming/overview.mdx +17 -18
- package/.docs/raw/streaming/tool-streaming.mdx +9 -10
- package/.docs/raw/streaming/workflow-streaming.mdx +14 -12
- package/.docs/raw/tools-mcp/advanced-usage.mdx +2 -2
- package/.docs/raw/tools-mcp/mcp-overview.mdx +92 -102
- package/.docs/raw/tools-mcp/overview.mdx +9 -14
- package/.docs/raw/voice/overview.mdx +273 -250
- package/.docs/raw/voice/speech-to-speech.mdx +14 -12
- package/.docs/raw/voice/speech-to-text.mdx +2 -2
- package/.docs/raw/voice/text-to-speech.mdx +2 -2
- package/.docs/raw/workflows/agents-and-tools.mdx +29 -28
- package/.docs/raw/workflows/control-flow.mdx +24 -24
- package/.docs/raw/workflows/error-handling.mdx +15 -17
- package/.docs/raw/workflows/human-in-the-loop.mdx +39 -39
- package/.docs/raw/workflows/inngest-workflow.mdx +33 -29
- package/.docs/raw/workflows/input-data-mapping.mdx +9 -9
- package/.docs/raw/workflows/overview.mdx +60 -60
- package/.docs/raw/workflows/snapshots.mdx +54 -36
- package/.docs/raw/workflows/suspend-and-resume.mdx +52 -57
- package/.docs/raw/workflows-legacy/control-flow.mdx +15 -17
- package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +3 -1
- package/.docs/raw/workflows-legacy/error-handling.mdx +8 -6
- package/.docs/raw/workflows-legacy/nested-workflows.mdx +6 -0
- package/.docs/raw/workflows-legacy/overview.mdx +28 -26
- package/.docs/raw/workflows-legacy/runtime-variables.mdx +4 -2
- package/.docs/raw/workflows-legacy/steps.mdx +5 -3
- package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +10 -8
- package/.docs/raw/workflows-legacy/variables.mdx +10 -8
- package/CHANGELOG.md +14 -0
- package/package.json +5 -5
- package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -148
|
@@ -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,10 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "AITracing |
|
|
2
|
+
title: "Reference: AITracing | Observability | Mastra Docs"
|
|
3
3
|
description: Core AI Tracing classes and methods
|
|
4
4
|
asIndexPage: true
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
import
|
|
7
|
+
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
8
8
|
|
|
9
9
|
# AITracing
|
|
10
10
|
|
|
@@ -137,10 +137,10 @@ class CustomAITracing extends BaseAITracing {
|
|
|
137
137
|
super(config);
|
|
138
138
|
// Custom initialization
|
|
139
139
|
}
|
|
140
|
-
|
|
140
|
+
|
|
141
141
|
// Override methods as needed
|
|
142
142
|
startSpan<TType extends AISpanType>(
|
|
143
|
-
options: StartSpanOptions<TType
|
|
143
|
+
options: StartSpanOptions<TType>,
|
|
144
144
|
): AISpan<TType> {
|
|
145
145
|
// Custom span creation logic
|
|
146
146
|
return super.startSpan(options);
|
|
@@ -159,6 +159,7 @@ class NoOpAISpan<TType extends AISpanType> extends BaseAISpan<TType>
|
|
|
159
159
|
```
|
|
160
160
|
|
|
161
161
|
A span that performs no operations. All methods are no-ops:
|
|
162
|
+
|
|
162
163
|
- `id` returns `'no-op'`
|
|
163
164
|
- `traceId` returns `'no-op-trace'`
|
|
164
165
|
- `isValid` returns `false`
|
|
@@ -168,15 +169,18 @@ A span that performs no operations. All methods are no-ops:
|
|
|
168
169
|
## See Also
|
|
169
170
|
|
|
170
171
|
### Documentation
|
|
172
|
+
|
|
171
173
|
- [AI Tracing Overview](/docs/observability/ai-tracing/overview) - Concepts and usage guide
|
|
172
174
|
- [Configuration Reference](/reference/observability/ai-tracing/configuration) - Configuration options
|
|
173
175
|
- [Interfaces Reference](/reference/observability/ai-tracing/interfaces) - Type definitions
|
|
174
176
|
- [Span Reference](/reference/observability/ai-tracing/span) - Span lifecycle and methods
|
|
175
177
|
|
|
176
178
|
### Examples
|
|
179
|
+
|
|
177
180
|
- [Basic AI Tracing](/examples/observability/basic-ai-tracing) - Getting started example
|
|
178
181
|
|
|
179
182
|
### Exporters
|
|
183
|
+
|
|
180
184
|
- [DefaultExporter](/reference/observability/ai-tracing/exporters/default-exporter) - Storage persistence
|
|
181
185
|
- [CloudExporter](/reference/observability/ai-tracing/exporters/cloud-exporter) - Mastra Cloud integration
|
|
182
|
-
- [ConsoleExporter](/reference/observability/ai-tracing/exporters/console-exporter) - Debug output
|
|
186
|
+
- [ConsoleExporter](/reference/observability/ai-tracing/exporters/console-exporter) - Debug output
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Configuration |
|
|
2
|
+
title: "Reference: Configuration | Observability | Mastra Docs"
|
|
3
3
|
description: AI Tracing configuration types and registry functions
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import
|
|
6
|
+
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
7
7
|
|
|
8
8
|
# Configuration
|
|
9
9
|
|
|
@@ -91,10 +91,10 @@ interface TracingConfig {
|
|
|
91
91
|
|
|
92
92
|
```typescript
|
|
93
93
|
type SamplingStrategy =
|
|
94
|
-
| { type:
|
|
95
|
-
| { type:
|
|
96
|
-
| { type:
|
|
97
|
-
| { type:
|
|
94
|
+
| { type: "always" }
|
|
95
|
+
| { type: "never" }
|
|
96
|
+
| { type: "ratio"; probability: number }
|
|
97
|
+
| { type: "custom"; sampler: (options?: TracingOptions) => boolean };
|
|
98
98
|
```
|
|
99
99
|
|
|
100
100
|
## ConfigSelector
|
|
@@ -102,7 +102,7 @@ type SamplingStrategy =
|
|
|
102
102
|
```typescript
|
|
103
103
|
type ConfigSelector = (
|
|
104
104
|
options: ConfigSelectorOptions,
|
|
105
|
-
availableConfigs: Map<string, AITracing
|
|
105
|
+
availableConfigs: Map<string, AITracing>,
|
|
106
106
|
) => string | undefined;
|
|
107
107
|
```
|
|
108
108
|
|
|
@@ -120,7 +120,7 @@ interface ConfigSelectorOptions {
|
|
|
120
120
|
## setupAITracing
|
|
121
121
|
|
|
122
122
|
```typescript
|
|
123
|
-
function setupAITracing(config: ObservabilityRegistryConfig): void
|
|
123
|
+
function setupAITracing(config: ObservabilityRegistryConfig): void;
|
|
124
124
|
```
|
|
125
125
|
|
|
126
126
|
Initializes AI tracing from configuration. Called automatically by Mastra constructor.
|
|
@@ -131,8 +131,8 @@ Initializes AI tracing from configuration. Called automatically by Mastra constr
|
|
|
131
131
|
function registerAITracing(
|
|
132
132
|
name: string,
|
|
133
133
|
instance: AITracing,
|
|
134
|
-
isDefault?: boolean
|
|
135
|
-
): void
|
|
134
|
+
isDefault?: boolean,
|
|
135
|
+
): void;
|
|
136
136
|
```
|
|
137
137
|
|
|
138
138
|
Registers a tracing config in the global registry.
|
|
@@ -140,7 +140,7 @@ Registers a tracing config in the global registry.
|
|
|
140
140
|
## getAITracing
|
|
141
141
|
|
|
142
142
|
```typescript
|
|
143
|
-
function getAITracing(name: string): AITracing | undefined
|
|
143
|
+
function getAITracing(name: string): AITracing | undefined;
|
|
144
144
|
```
|
|
145
145
|
|
|
146
146
|
Retrieves a tracing config by name.
|
|
@@ -148,7 +148,7 @@ Retrieves a tracing config by name.
|
|
|
148
148
|
## getDefaultAITracing
|
|
149
149
|
|
|
150
150
|
```typescript
|
|
151
|
-
function getDefaultAITracing(): AITracing | undefined
|
|
151
|
+
function getDefaultAITracing(): AITracing | undefined;
|
|
152
152
|
```
|
|
153
153
|
|
|
154
154
|
Returns the default tracing config.
|
|
@@ -157,8 +157,8 @@ Returns the default tracing config.
|
|
|
157
157
|
|
|
158
158
|
```typescript
|
|
159
159
|
function getSelectedAITracing(
|
|
160
|
-
options: ConfigSelectorOptions
|
|
161
|
-
): AITracing | undefined
|
|
160
|
+
options: ConfigSelectorOptions,
|
|
161
|
+
): AITracing | undefined;
|
|
162
162
|
```
|
|
163
163
|
|
|
164
164
|
Returns the tracing config selected by the config selector or default.
|
|
@@ -166,7 +166,7 @@ Returns the tracing config selected by the config selector or default.
|
|
|
166
166
|
## setSelector
|
|
167
167
|
|
|
168
168
|
```typescript
|
|
169
|
-
function setSelector(selector: ConfigSelector): void
|
|
169
|
+
function setSelector(selector: ConfigSelector): void;
|
|
170
170
|
```
|
|
171
171
|
|
|
172
172
|
Sets the global config selector function.
|
|
@@ -174,7 +174,7 @@ Sets the global config selector function.
|
|
|
174
174
|
## unregisterAITracing
|
|
175
175
|
|
|
176
176
|
```typescript
|
|
177
|
-
function unregisterAITracing(name: string): boolean
|
|
177
|
+
function unregisterAITracing(name: string): boolean;
|
|
178
178
|
```
|
|
179
179
|
|
|
180
180
|
Removes a tracing config from the registry.
|
|
@@ -182,7 +182,7 @@ Removes a tracing config from the registry.
|
|
|
182
182
|
## shutdownAITracingRegistry
|
|
183
183
|
|
|
184
184
|
```typescript
|
|
185
|
-
async function shutdownAITracingRegistry(): Promise<void
|
|
185
|
+
async function shutdownAITracingRegistry(): Promise<void>;
|
|
186
186
|
```
|
|
187
187
|
|
|
188
188
|
Shuts down all tracing configs and clears the registry.
|
|
@@ -190,7 +190,7 @@ Shuts down all tracing configs and clears the registry.
|
|
|
190
190
|
## clearAITracingRegistry
|
|
191
191
|
|
|
192
192
|
```typescript
|
|
193
|
-
function clearAITracingRegistry(): void
|
|
193
|
+
function clearAITracingRegistry(): void;
|
|
194
194
|
```
|
|
195
195
|
|
|
196
196
|
Clears all configs without shutdown.
|
|
@@ -198,7 +198,7 @@ Clears all configs without shutdown.
|
|
|
198
198
|
## getAllAITracing
|
|
199
199
|
|
|
200
200
|
```typescript
|
|
201
|
-
function getAllAITracing(): ReadonlyMap<string, AITracing
|
|
201
|
+
function getAllAITracing(): ReadonlyMap<string, AITracing>;
|
|
202
202
|
```
|
|
203
203
|
|
|
204
204
|
Returns all registered tracing configs.
|
|
@@ -206,7 +206,7 @@ Returns all registered tracing configs.
|
|
|
206
206
|
## hasAITracing
|
|
207
207
|
|
|
208
208
|
```typescript
|
|
209
|
-
function hasAITracing(name: string): boolean
|
|
209
|
+
function hasAITracing(name: string): boolean;
|
|
210
210
|
```
|
|
211
211
|
|
|
212
212
|
Checks if a tracing instance exists and is enabled.
|
|
@@ -214,21 +214,25 @@ Checks if a tracing instance exists and is enabled.
|
|
|
214
214
|
## See Also
|
|
215
215
|
|
|
216
216
|
### Documentation
|
|
217
|
+
|
|
217
218
|
- [AI Tracing Overview](/docs/observability/ai-tracing/overview) - Concepts and usage guide
|
|
218
219
|
- [Sampling Strategies](/docs/observability/ai-tracing/overview#sampling-strategies) - Sampling configuration details
|
|
219
220
|
- [Multi-Config Setup](/docs/observability/ai-tracing/overview#multi-config-setup) - Using multiple configurations
|
|
220
221
|
|
|
221
222
|
### Reference
|
|
222
|
-
|
|
223
|
+
|
|
224
|
+
- [AITracing Classes](/reference/observability/ai-tracing/) - Core tracing classes
|
|
223
225
|
- [Interfaces](/reference/observability/ai-tracing/interfaces) - Type definitions
|
|
224
226
|
- [Span Reference](/reference/observability/ai-tracing/span) - Span lifecycle
|
|
225
227
|
|
|
226
228
|
### Examples
|
|
229
|
+
|
|
227
230
|
- [Basic AI Tracing](/examples/observability/basic-ai-tracing) - Getting started
|
|
228
231
|
|
|
229
232
|
### Exporters
|
|
233
|
+
|
|
230
234
|
- [DefaultExporter](/reference/observability/ai-tracing/exporters/default-exporter) - Storage configuration
|
|
231
235
|
- [CloudExporter](/reference/observability/ai-tracing/exporters/cloud-exporter) - Cloud setup
|
|
232
236
|
- [Braintrust](/reference/observability/ai-tracing/exporters/braintrust) - Braintrust integration
|
|
233
237
|
- [Langfuse](/reference/observability/ai-tracing/exporters/langfuse) - Langfuse integration
|
|
234
|
-
- [LangSmith](/reference/observability/ai-tracing/exporters/langsmith) - LangSmith integration
|
|
238
|
+
- [LangSmith](/reference/observability/ai-tracing/exporters/langsmith) - LangSmith integration
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "ArizeExporter |
|
|
2
|
+
title: "Reference: ArizeExporter | Observability | Mastra Docs"
|
|
3
3
|
description: Arize exporter for AI tracing using OpenInference
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import
|
|
6
|
+
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
7
7
|
|
|
8
8
|
# ArizeExporter
|
|
9
9
|
|
|
@@ -33,7 +33,7 @@ interface ArizeExporterConfig {
|
|
|
33
33
|
// Inherited from OtelExporterConfig
|
|
34
34
|
timeout?: number;
|
|
35
35
|
batchSize?: number;
|
|
36
|
-
logLevel?:
|
|
36
|
+
logLevel?: "debug" | "info" | "warn" | "error";
|
|
37
37
|
resourceAttributes?: Record<string, any>;
|
|
38
38
|
}
|
|
39
39
|
```
|
|
@@ -43,19 +43,22 @@ interface ArizeExporterConfig {
|
|
|
43
43
|
{
|
|
44
44
|
name: "endpoint",
|
|
45
45
|
type: "string",
|
|
46
|
-
description:
|
|
46
|
+
description:
|
|
47
|
+
"Collector endpoint for trace exports (e.g., 'http://localhost:6006/v1/traces' for Phoenix). Required for Phoenix. Optional for Arize AX (defaults to https://otlp.arize.com/v1/traces).",
|
|
47
48
|
required: false,
|
|
48
49
|
},
|
|
49
50
|
{
|
|
50
51
|
name: "apiKey",
|
|
51
52
|
type: "string",
|
|
52
|
-
description:
|
|
53
|
+
description:
|
|
54
|
+
"API key for authentication. Required for Phoenix Cloud and Arize AX. Optional for self-hosted Phoenix.",
|
|
53
55
|
required: false,
|
|
54
56
|
},
|
|
55
57
|
{
|
|
56
58
|
name: "spaceId",
|
|
57
59
|
type: "string",
|
|
58
|
-
description:
|
|
60
|
+
description:
|
|
61
|
+
"Arize AX space identifier. Required when sending traces to Arize AX.",
|
|
59
62
|
required: false,
|
|
60
63
|
},
|
|
61
64
|
{
|
|
@@ -73,7 +76,8 @@ interface ArizeExporterConfig {
|
|
|
73
76
|
{
|
|
74
77
|
name: "timeout",
|
|
75
78
|
type: "number",
|
|
76
|
-
description:
|
|
79
|
+
description:
|
|
80
|
+
"Timeout in milliseconds before exporting spans (default: 30000)",
|
|
77
81
|
required: false,
|
|
78
82
|
},
|
|
79
83
|
{
|
|
@@ -128,24 +132,24 @@ Flushes pending data and shuts down the client.
|
|
|
128
132
|
### Phoenix Configuration
|
|
129
133
|
|
|
130
134
|
```typescript
|
|
131
|
-
import { ArizeExporter } from
|
|
135
|
+
import { ArizeExporter } from "@mastra/arize";
|
|
132
136
|
|
|
133
137
|
const exporter = new ArizeExporter({
|
|
134
|
-
endpoint:
|
|
138
|
+
endpoint: "http://localhost:6006/v1/traces",
|
|
135
139
|
apiKey: process.env.PHOENIX_API_KEY, // Optional for local Phoenix
|
|
136
|
-
projectName:
|
|
140
|
+
projectName: "my-ai-project",
|
|
137
141
|
});
|
|
138
142
|
```
|
|
139
143
|
|
|
140
144
|
### Arize AX Configuration
|
|
141
145
|
|
|
142
146
|
```typescript
|
|
143
|
-
import { ArizeExporter } from
|
|
147
|
+
import { ArizeExporter } from "@mastra/arize";
|
|
144
148
|
|
|
145
149
|
const exporter = new ArizeExporter({
|
|
146
150
|
spaceId: process.env.ARIZE_SPACE_ID!,
|
|
147
151
|
apiKey: process.env.ARIZE_API_KEY!,
|
|
148
|
-
projectName:
|
|
152
|
+
projectName: "my-ai-project",
|
|
149
153
|
});
|
|
150
154
|
```
|
|
151
155
|
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "BraintrustExporter |
|
|
2
|
+
title: "Reference: BraintrustExporter | Observability | Mastra Docs"
|
|
3
3
|
description: Braintrust exporter for AI tracing
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import
|
|
6
|
+
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
7
7
|
|
|
8
8
|
# BraintrustExporter
|
|
9
9
|
|
|
@@ -22,7 +22,7 @@ interface BraintrustExporterConfig {
|
|
|
22
22
|
apiKey?: string;
|
|
23
23
|
endpoint?: string;
|
|
24
24
|
projectName?: string;
|
|
25
|
-
logLevel?:
|
|
25
|
+
logLevel?: "debug" | "info" | "warn" | "error";
|
|
26
26
|
tuningParameters?: Record<string, any>;
|
|
27
27
|
}
|
|
28
28
|
```
|
|
@@ -91,22 +91,22 @@ Flushes pending data and shuts down the client.
|
|
|
91
91
|
## Usage
|
|
92
92
|
|
|
93
93
|
```typescript
|
|
94
|
-
import { BraintrustExporter } from
|
|
94
|
+
import { BraintrustExporter } from "@mastra/braintrust";
|
|
95
95
|
|
|
96
96
|
const exporter = new BraintrustExporter({
|
|
97
97
|
apiKey: process.env.BRAINTRUST_API_KEY,
|
|
98
|
-
projectName:
|
|
98
|
+
projectName: "my-ai-project",
|
|
99
99
|
});
|
|
100
100
|
```
|
|
101
101
|
|
|
102
102
|
## Span Type Mapping
|
|
103
103
|
|
|
104
|
-
| AI Span Type
|
|
105
|
-
|
|
106
|
-
| `MODEL_GENERATION`
|
|
107
|
-
| `MODEL_CHUNK`
|
|
108
|
-
| `TOOL_CALL`
|
|
109
|
-
| `MCP_TOOL_CALL`
|
|
110
|
-
| `WORKFLOW_CONDITIONAL_EVAL` | `function`
|
|
111
|
-
| `WORKFLOW_WAIT_EVENT`
|
|
112
|
-
| All others
|
|
104
|
+
| AI Span Type | Braintrust Type |
|
|
105
|
+
| --------------------------- | --------------- |
|
|
106
|
+
| `MODEL_GENERATION` | `llm` |
|
|
107
|
+
| `MODEL_CHUNK` | `llm` |
|
|
108
|
+
| `TOOL_CALL` | `tool` |
|
|
109
|
+
| `MCP_TOOL_CALL` | `tool` |
|
|
110
|
+
| `WORKFLOW_CONDITIONAL_EVAL` | `function` |
|
|
111
|
+
| `WORKFLOW_WAIT_EVENT` | `function` |
|
|
112
|
+
| All others | `task` |
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "CloudExporter |
|
|
2
|
+
title: "Reference: CloudExporter | Observability | Mastra Docs"
|
|
3
3
|
description: API reference for the CloudExporter
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import
|
|
6
|
+
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
7
7
|
|
|
8
8
|
# CloudExporter
|
|
9
9
|
|
|
@@ -32,19 +32,19 @@ new CloudExporter(config?: CloudExporterConfig)
|
|
|
32
32
|
interface CloudExporterConfig {
|
|
33
33
|
/** Maximum number of spans per batch. Default: 1000 */
|
|
34
34
|
maxBatchSize?: number;
|
|
35
|
-
|
|
35
|
+
|
|
36
36
|
/** Maximum wait time before flushing in milliseconds. Default: 5000 */
|
|
37
37
|
maxBatchWaitMs?: number;
|
|
38
|
-
|
|
38
|
+
|
|
39
39
|
/** Maximum retry attempts. Default: 3 */
|
|
40
40
|
maxRetries?: number;
|
|
41
|
-
|
|
41
|
+
|
|
42
42
|
/** Cloud access token (from env or config) */
|
|
43
43
|
accessToken?: string;
|
|
44
|
-
|
|
44
|
+
|
|
45
45
|
/** Cloud AI tracing endpoint */
|
|
46
46
|
endpoint?: string;
|
|
47
|
-
|
|
47
|
+
|
|
48
48
|
/** Optional logger */
|
|
49
49
|
logger?: IMastraLogger;
|
|
50
50
|
}
|
|
@@ -97,12 +97,14 @@ Flushes remaining events and performs cleanup.
|
|
|
97
97
|
### Authentication
|
|
98
98
|
|
|
99
99
|
If no access token is provided via config or environment variable, the exporter:
|
|
100
|
+
|
|
100
101
|
- Logs a warning with sign-up information
|
|
101
102
|
- Operates as a no-op (discards all events)
|
|
102
103
|
|
|
103
104
|
### Batching
|
|
104
105
|
|
|
105
106
|
The exporter batches spans for efficient network usage:
|
|
107
|
+
|
|
106
108
|
- Flushes when batch size reaches `maxBatchSize`
|
|
107
109
|
- Flushes when `maxBatchWaitMs` elapsed since first span in batch
|
|
108
110
|
- Flushes on `shutdown()`
|
|
@@ -146,31 +148,34 @@ interface MastraCloudSpanRecord {
|
|
|
146
148
|
## Usage
|
|
147
149
|
|
|
148
150
|
```typescript
|
|
149
|
-
import { CloudExporter } from
|
|
151
|
+
import { CloudExporter } from "@mastra/core/ai-tracing";
|
|
150
152
|
|
|
151
153
|
// Uses environment variable for token
|
|
152
154
|
const exporter = new CloudExporter();
|
|
153
155
|
|
|
154
156
|
// Explicit configuration
|
|
155
157
|
const customExporter = new CloudExporter({
|
|
156
|
-
accessToken:
|
|
158
|
+
accessToken: "your-token",
|
|
157
159
|
maxBatchSize: 500,
|
|
158
|
-
maxBatchWaitMs: 2000
|
|
160
|
+
maxBatchWaitMs: 2000,
|
|
159
161
|
});
|
|
160
162
|
```
|
|
161
163
|
|
|
162
164
|
## See Also
|
|
163
165
|
|
|
164
166
|
### Documentation
|
|
167
|
+
|
|
165
168
|
- [AI Tracing Overview](/docs/observability/ai-tracing/overview) - Complete guide
|
|
166
169
|
- [Exporters](/docs/observability/ai-tracing/overview#exporters) - Exporter concepts
|
|
167
170
|
|
|
168
171
|
### Other Exporters
|
|
172
|
+
|
|
169
173
|
- [DefaultExporter](/reference/observability/ai-tracing/exporters/default-exporter) - Storage persistence
|
|
170
174
|
- [ConsoleExporter](/reference/observability/ai-tracing/exporters/console-exporter) - Debug output
|
|
171
175
|
- [Langfuse](/reference/observability/ai-tracing/exporters/langfuse) - Langfuse integration
|
|
172
176
|
- [Braintrust](/reference/observability/ai-tracing/exporters/braintrust) - Braintrust integration
|
|
173
177
|
|
|
174
178
|
### Reference
|
|
179
|
+
|
|
175
180
|
- [Configuration](/reference/observability/ai-tracing/configuration) - Configuration options
|
|
176
|
-
- [Interfaces](/reference/observability/ai-tracing/interfaces) - Type definitions
|
|
181
|
+
- [Interfaces](/reference/observability/ai-tracing/interfaces) - Type definitions
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "ConsoleExporter |
|
|
2
|
+
title: "Reference: ConsoleExporter | Observability | Mastra Docs"
|
|
3
3
|
description: API reference for the ConsoleExporter
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import
|
|
6
|
+
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
7
7
|
|
|
8
8
|
# ConsoleExporter
|
|
9
9
|
|
|
@@ -20,7 +20,8 @@ new ConsoleExporter(logger?: IMastraLogger)
|
|
|
20
20
|
{
|
|
21
21
|
name: "logger",
|
|
22
22
|
type: "IMastraLogger",
|
|
23
|
-
description:
|
|
23
|
+
description:
|
|
24
|
+
"Logger instance to use. Falls back to ConsoleLogger with INFO level if not provided",
|
|
24
25
|
required: false,
|
|
25
26
|
},
|
|
26
27
|
]}
|
|
@@ -112,8 +113,8 @@ The exporter outputs different formats based on event type:
|
|
|
112
113
|
## Usage
|
|
113
114
|
|
|
114
115
|
```typescript
|
|
115
|
-
import { ConsoleExporter } from
|
|
116
|
-
import { ConsoleLogger, LogLevel } from
|
|
116
|
+
import { ConsoleExporter } from "@mastra/core/ai-tracing";
|
|
117
|
+
import { ConsoleLogger, LogLevel } from "@mastra/core/logger";
|
|
117
118
|
|
|
118
119
|
// Use default logger (INFO level)
|
|
119
120
|
const exporter = new ConsoleExporter();
|
|
@@ -134,15 +135,18 @@ const exporterWithLogger = new ConsoleExporter(customLogger);
|
|
|
134
135
|
## See Also
|
|
135
136
|
|
|
136
137
|
### Documentation
|
|
138
|
+
|
|
137
139
|
- [AI Tracing Overview](/docs/observability/ai-tracing/overview) - Complete guide
|
|
138
140
|
- [Exporters](/docs/observability/ai-tracing/overview#exporters) - Exporter concepts
|
|
139
141
|
|
|
140
142
|
### Other Exporters
|
|
143
|
+
|
|
141
144
|
- [DefaultExporter](/reference/observability/ai-tracing/exporters/default-exporter) - Storage persistence
|
|
142
145
|
- [CloudExporter](/reference/observability/ai-tracing/exporters/cloud-exporter) - Mastra Cloud
|
|
143
146
|
- [Langfuse](/reference/observability/ai-tracing/exporters/langfuse) - Langfuse integration
|
|
144
147
|
- [Braintrust](/reference/observability/ai-tracing/exporters/braintrust) - Braintrust integration
|
|
145
148
|
|
|
146
149
|
### Reference
|
|
150
|
+
|
|
147
151
|
- [Configuration](/reference/observability/ai-tracing/configuration) - Configuration options
|
|
148
|
-
- [Interfaces](/reference/observability/ai-tracing/interfaces) - Type definitions
|
|
152
|
+
- [Interfaces](/reference/observability/ai-tracing/interfaces) - Type definitions
|