@mastra/mcp-docs-server 0.13.39 → 1.0.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/organized/changelogs/%40internal%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 +223 -223
- 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 +214 -214
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +74 -74
- 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 +58 -58
- 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 +217 -217
- 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 +70 -70
- 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 +206 -206
- 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 +33 -33
- package/.docs/organized/changelogs/mastra.md +86 -86
- 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 +23 -15
- package/.docs/raw/agents/guardrails.mdx +33 -12
- package/.docs/raw/agents/networks.mdx +8 -4
- package/.docs/raw/agents/overview.mdx +21 -15
- package/.docs/raw/agents/using-tools.mdx +11 -8
- package/.docs/raw/auth/auth0.mdx +8 -8
- package/.docs/raw/auth/clerk.mdx +6 -6
- package/.docs/raw/auth/firebase.mdx +8 -8
- package/.docs/raw/auth/index.mdx +6 -6
- package/.docs/raw/auth/jwt.mdx +6 -6
- package/.docs/raw/auth/supabase.mdx +7 -7
- package/.docs/raw/auth/workos.mdx +8 -8
- package/.docs/raw/community/contributing-templates.mdx +3 -3
- package/.docs/raw/community/discord.mdx +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/31-enhancing-memory-configuration.md +2 -0
- 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 +5 -5
- package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +7 -5
- package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +3 -3
- package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +4 -4
- 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 +4 -4
- package/.docs/raw/deployment/serverless-platforms/index.mdx +10 -7
- package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +4 -4
- package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +4 -4
- 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 +8 -8
- package/.docs/raw/evals/running-in-ci.mdx +113 -0
- package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +22 -21
- package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +8 -8
- package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +3 -0
- package/.docs/raw/frameworks/servers/express.mdx +10 -9
- package/.docs/raw/frameworks/web-frameworks/astro.mdx +6 -6
- package/.docs/raw/frameworks/web-frameworks/next-js.mdx +3 -3
- package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +4 -4
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +2 -2
- package/.docs/raw/getting-started/installation.mdx +13 -12
- 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 +1 -1
- 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 +389 -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/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 +9 -5
- package/.docs/raw/memory/semantic-recall.mdx +12 -7
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +10 -5
- package/.docs/raw/memory/storage/memory-with-pg.mdx +9 -4
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +9 -4
- 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 +10 -18
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +7 -16
- 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 +7 -16
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +7 -16
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/otel.mdx +9 -18
- 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 +33 -28
- 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/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 +11 -11
- 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 +5 -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 +1 -1
- package/.docs/raw/reference/processors/language-detector.mdx +1 -1
- package/.docs/raw/reference/processors/moderation-processor.mdx +1 -1
- package/.docs/raw/reference/processors/pii-detector.mdx +1 -1
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +1 -1
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +1 -1
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +1 -1
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +1 -1
- 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/libsql.mdx +2 -0
- package/.docs/raw/reference/storage/mssql.mdx +5 -0
- package/.docs/raw/reference/storage/postgresql.mdx +6 -0
- package/.docs/raw/reference/storage/upstash.mdx +1 -0
- 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 +2 -2
- 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/libsql.mdx +1 -0
- package/.docs/raw/reference/vectors/pg.mdx +3 -0
- 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 +19 -18
- 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 +32 -19
- 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 +9 -8
- package/.docs/raw/voice/text-to-speech.mdx +12 -11
- 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 +2 -2
- 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 +52 -57
- 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
|
@@ -69,7 +69,7 @@ const chunks = await doc.chunk({
|
|
|
69
69
|
|
|
70
70
|
**Note:** Metadata extraction may use LLM calls, so ensure your API key is set.
|
|
71
71
|
|
|
72
|
-
We go deeper into chunking strategies in our [chunk documentation](/reference/rag/chunk).
|
|
72
|
+
We go deeper into chunking strategies in our [chunk documentation](/reference/v1/rag/chunk).
|
|
73
73
|
|
|
74
74
|
## Step 2: Embedding Generation
|
|
75
75
|
|
|
@@ -80,7 +80,7 @@ Transform chunks into embeddings using your preferred provider. Mastra supports
|
|
|
80
80
|
The simplest way is to use Mastra's model router with `provider/model` strings:
|
|
81
81
|
|
|
82
82
|
```ts showLineNumbers copy
|
|
83
|
-
import { ModelRouterEmbeddingModel } from "@mastra/core";
|
|
83
|
+
import { ModelRouterEmbeddingModel } from "@mastra/core/llm";
|
|
84
84
|
import { embedMany } from "ai";
|
|
85
85
|
|
|
86
86
|
const embeddingModel = new ModelRouterEmbeddingModel(
|
|
@@ -201,10 +201,10 @@ await vectorStore.upsert({
|
|
|
201
201
|
|
|
202
202
|
For more examples of different chunking strategies and embedding configurations, see:
|
|
203
203
|
|
|
204
|
-
- [Chunk Reference](/reference/rag/chunk)
|
|
205
|
-
- [Embeddings Reference](/reference/rag/embeddings)
|
|
204
|
+
- [Chunk Reference](/reference/v1/rag/chunk)
|
|
205
|
+
- [Embeddings Reference](/reference/v1/rag/embeddings)
|
|
206
206
|
|
|
207
207
|
For more details on vector databases and embeddings, see:
|
|
208
208
|
|
|
209
209
|
- [Vector Databases](./vector-databases)
|
|
210
|
-
- [Embedding API Reference](/reference/rag/embeddings)
|
|
210
|
+
- [Embedding API Reference](/reference/v1/rag/embeddings)
|
|
@@ -43,6 +43,7 @@ const { embeddings } = await embedMany({
|
|
|
43
43
|
|
|
44
44
|
// 4. Store in vector database
|
|
45
45
|
const pgVector = new PgVector({
|
|
46
|
+
id: 'pg-vector',
|
|
46
47
|
connectionString: process.env.POSTGRES_CONNECTION_STRING,
|
|
47
48
|
});
|
|
48
49
|
await pgVector.upsert({
|
|
@@ -70,18 +71,7 @@ The basic building block of RAG is document processing. Documents can be chunked
|
|
|
70
71
|
|
|
71
72
|
Mastra supports multiple vector stores for embedding persistence and similarity search, including pgvector, Pinecone, Qdrant, and MongoDB. See the [vector database doc](./vector-databases).
|
|
72
73
|
|
|
73
|
-
## Observability and Debugging
|
|
74
|
-
|
|
75
|
-
Mastra's RAG system includes observability features to help you optimize your retrieval pipeline:
|
|
76
|
-
|
|
77
|
-
- Track embedding generation performance and costs
|
|
78
|
-
- Monitor chunk quality and retrieval relevance
|
|
79
|
-
- Analyze query patterns and cache hit rates
|
|
80
|
-
- Export metrics to your observability platform
|
|
81
|
-
|
|
82
|
-
See the [OTEL Tracing](/docs/observability/otel-tracing) documentation for more details.
|
|
83
|
-
|
|
84
74
|
## More resources
|
|
85
75
|
|
|
86
|
-
- [Chain of Thought RAG Example]
|
|
87
|
-
- [All RAG Examples](
|
|
76
|
+
- [Chain of Thought RAG Example]/examples/v1/rag/usage/cot-rag)
|
|
77
|
+
- [All RAG Examples](/examples/v1/) (including different chunking strategies, embedding models, and vector stores)
|
|
@@ -39,6 +39,7 @@ const { embedding } = await embed({
|
|
|
39
39
|
|
|
40
40
|
// Query vector store
|
|
41
41
|
const pgVector = new PgVector({
|
|
42
|
+
id: 'pg-vector',
|
|
42
43
|
connectionString: process.env.POSTGRES_CONNECTION_STRING,
|
|
43
44
|
});
|
|
44
45
|
const results = await pgVector.query({
|
|
@@ -69,7 +70,7 @@ Results include both the text content and a similarity score:
|
|
|
69
70
|
];
|
|
70
71
|
```
|
|
71
72
|
|
|
72
|
-
For an example of how to use the basic retrieval method, see the [Retrieve Results](/examples/rag/query/retrieve-results) example.
|
|
73
|
+
For an example of how to use the basic retrieval method, see the [Retrieve Results](/examples/v1/rag/query/retrieve-results) example.
|
|
73
74
|
|
|
74
75
|
## Advanced Retrieval options
|
|
75
76
|
|
|
@@ -77,7 +78,7 @@ For an example of how to use the basic retrieval method, see the [Retrieve Resul
|
|
|
77
78
|
|
|
78
79
|
Filter results based on metadata fields to narrow down the search space. This is useful when you have documents from different sources, time periods, or with specific attributes. Mastra provides a unified MongoDB-style query syntax that works across all supported vector stores.
|
|
79
80
|
|
|
80
|
-
For detailed information about available operators and syntax, see the [Metadata Filters Reference](/reference/rag/metadata-filters).
|
|
81
|
+
For detailed information about available operators and syntax, see the [Metadata Filters Reference](/reference/v1/rag/metadata-filters).
|
|
81
82
|
|
|
82
83
|
Basic filtering examples:
|
|
83
84
|
|
|
@@ -145,7 +146,7 @@ Common use cases for metadata filtering:
|
|
|
145
146
|
- Combine multiple conditions for precise querying
|
|
146
147
|
- Filter by document attributes (e.g., language, author)
|
|
147
148
|
|
|
148
|
-
For an example of how to use metadata filtering, see the [Hybrid Vector Search](/examples/rag/query/hybrid-vector-search) example.
|
|
149
|
+
For an example of how to use metadata filtering, see the [Hybrid Vector Search](/examples/v1/rag/query/hybrid-vector-search) example.
|
|
149
150
|
|
|
150
151
|
### Vector Query Tool
|
|
151
152
|
|
|
@@ -241,13 +242,13 @@ const lanceQueryTool = createVectorQueryTool({
|
|
|
241
242
|
- Quality-gated search results
|
|
242
243
|
- Embedded, file-based vector storage with LanceDB for edge deployment scenarios
|
|
243
244
|
|
|
244
|
-
You can also override these configurations at runtime using the
|
|
245
|
+
You can also override these configurations at runtime using the request context:
|
|
245
246
|
|
|
246
247
|
```ts showLineNumbers copy
|
|
247
|
-
import {
|
|
248
|
+
import { RequestContext } from "@mastra/core/request-context";
|
|
248
249
|
|
|
249
|
-
const
|
|
250
|
-
|
|
250
|
+
const requestContext = new RequestContext();
|
|
251
|
+
requestContext.set("databaseConfig", {
|
|
251
252
|
pinecone: {
|
|
252
253
|
namespace: "runtime-namespace",
|
|
253
254
|
},
|
|
@@ -256,11 +257,11 @@ runtimeContext.set("databaseConfig", {
|
|
|
256
257
|
await pineconeQueryTool.execute({
|
|
257
258
|
context: { queryText: "search query" },
|
|
258
259
|
mastra,
|
|
259
|
-
|
|
260
|
+
requestContext,
|
|
260
261
|
});
|
|
261
262
|
```
|
|
262
263
|
|
|
263
|
-
For detailed configuration options and advanced usage, see the [Vector Query Tool Reference](/reference/tools/vector-query-tool).
|
|
264
|
+
For detailed configuration options and advanced usage, see the [Vector Query Tool Reference](/reference/v1/tools/vector-query-tool).
|
|
264
265
|
|
|
265
266
|
### Vector Store Prompts
|
|
266
267
|
|
|
@@ -275,6 +276,7 @@ import { openai } from "@ai-sdk/openai";
|
|
|
275
276
|
import { PGVECTOR_PROMPT } from "@mastra/pg";
|
|
276
277
|
|
|
277
278
|
export const ragAgent = new Agent({
|
|
279
|
+
id: "rag-agent",
|
|
278
280
|
name: "RAG Agent",
|
|
279
281
|
model: openai("gpt-4o-mini"),
|
|
280
282
|
instructions: `
|
|
@@ -294,6 +296,7 @@ import { openai } from "@ai-sdk/openai";
|
|
|
294
296
|
import { PINECONE_PROMPT } from "@mastra/pinecone";
|
|
295
297
|
|
|
296
298
|
export const ragAgent = new Agent({
|
|
299
|
+
id: "rag-agent",
|
|
297
300
|
name: "RAG Agent",
|
|
298
301
|
model: openai("gpt-4o-mini"),
|
|
299
302
|
instructions: `
|
|
@@ -313,6 +316,7 @@ import { openai } from "@ai-sdk/openai";
|
|
|
313
316
|
import { QDRANT_PROMPT } from "@mastra/qdrant";
|
|
314
317
|
|
|
315
318
|
export const ragAgent = new Agent({
|
|
319
|
+
id: "rag-agent",
|
|
316
320
|
name: "RAG Agent",
|
|
317
321
|
model: openai("gpt-4o-mini"),
|
|
318
322
|
instructions: `
|
|
@@ -332,6 +336,7 @@ import { openai } from "@ai-sdk/openai";
|
|
|
332
336
|
import { CHROMA_PROMPT } from "@mastra/chroma";
|
|
333
337
|
|
|
334
338
|
export const ragAgent = new Agent({
|
|
339
|
+
id: "rag-agent",
|
|
335
340
|
name: "RAG Agent",
|
|
336
341
|
model: openai("gpt-4o-mini"),
|
|
337
342
|
instructions: `
|
|
@@ -351,6 +356,7 @@ import { openai } from "@ai-sdk/openai";
|
|
|
351
356
|
import { ASTRA_PROMPT } from "@mastra/astra";
|
|
352
357
|
|
|
353
358
|
export const ragAgent = new Agent({
|
|
359
|
+
id: "rag-agent",
|
|
354
360
|
name: "RAG Agent",
|
|
355
361
|
model: openai("gpt-4o-mini"),
|
|
356
362
|
instructions: `
|
|
@@ -370,6 +376,7 @@ import { openai } from "@ai-sdk/openai";
|
|
|
370
376
|
import { LIBSQL_PROMPT } from "@mastra/libsql";
|
|
371
377
|
|
|
372
378
|
export const ragAgent = new Agent({
|
|
379
|
+
id: "rag-agent",
|
|
373
380
|
name: "RAG Agent",
|
|
374
381
|
model: openai("gpt-4o-mini"),
|
|
375
382
|
instructions: `
|
|
@@ -389,6 +396,7 @@ import { openai } from "@ai-sdk/openai";
|
|
|
389
396
|
import { UPSTASH_PROMPT } from "@mastra/upstash";
|
|
390
397
|
|
|
391
398
|
export const ragAgent = new Agent({
|
|
399
|
+
id: "rag-agent",
|
|
392
400
|
name: "RAG Agent",
|
|
393
401
|
model: openai("gpt-4o-mini"),
|
|
394
402
|
instructions: `
|
|
@@ -408,6 +416,7 @@ import { openai } from "@ai-sdk/openai";
|
|
|
408
416
|
import { VECTORIZE_PROMPT } from "@mastra/vectorize";
|
|
409
417
|
|
|
410
418
|
export const ragAgent = new Agent({
|
|
419
|
+
id: "rag-agent",
|
|
411
420
|
name: "RAG Agent",
|
|
412
421
|
model: openai("gpt-4o-mini"),
|
|
413
422
|
instructions: `
|
|
@@ -427,6 +436,7 @@ import { openai } from "@ai-sdk/openai";
|
|
|
427
436
|
import { MONGODB_PROMPT } from "@mastra/mongodb";
|
|
428
437
|
|
|
429
438
|
export const ragAgent = new Agent({
|
|
439
|
+
id: "rag-agent",
|
|
430
440
|
name: "RAG Agent",
|
|
431
441
|
model: openai("gpt-4o-mini"),
|
|
432
442
|
instructions: `
|
|
@@ -446,6 +456,7 @@ import { openai } from "@ai-sdk/openai";
|
|
|
446
456
|
import { OPENSEARCH_PROMPT } from "@mastra/opensearch";
|
|
447
457
|
|
|
448
458
|
export const ragAgent = new Agent({
|
|
459
|
+
id: "rag-agent",
|
|
449
460
|
name: "RAG Agent",
|
|
450
461
|
model: openai("gpt-4o-mini"),
|
|
451
462
|
instructions: `
|
|
@@ -465,6 +476,7 @@ import { openai } from "@ai-sdk/openai";
|
|
|
465
476
|
import { S3VECTORS_PROMPT } from "@mastra/s3vectors";
|
|
466
477
|
|
|
467
478
|
export const ragAgent = new Agent({
|
|
479
|
+
id: "rag-agent",
|
|
468
480
|
name: "RAG Agent",
|
|
469
481
|
model: openai("gpt-4o-mini"),
|
|
470
482
|
instructions: `
|
|
@@ -531,7 +543,7 @@ const relevanceProvider = new ZeroEntropyRelevanceScorer("zerank-1");
|
|
|
531
543
|
|
|
532
544
|
The re-ranked results combine vector similarity with semantic understanding to improve retrieval quality.
|
|
533
545
|
|
|
534
|
-
For more details about re-ranking, see the [rerank()](/reference/rag/rerankWithScorer) method.
|
|
546
|
+
For more details about re-ranking, see the [rerank()](/reference/v1/rag/rerankWithScorer) method.
|
|
535
547
|
|
|
536
548
|
For an example of how to use the re-ranking method, see the Re-ranking Results example in the examples section.
|
|
537
549
|
|
|
@@ -556,6 +568,6 @@ const graphQueryTool = createGraphQueryTool({
|
|
|
556
568
|
});
|
|
557
569
|
```
|
|
558
570
|
|
|
559
|
-
For more details about graph-based retrieval, see the [GraphRAG](/reference/rag/graph-rag) class and the [createGraphQueryTool()](/reference/tools/graph-rag-tool) function.
|
|
571
|
+
For more details about graph-based retrieval, see the [GraphRAG](/reference/v1/rag/graph-rag) class and the [createGraphQueryTool()](/reference/v1/tools/graph-rag-tool) function.
|
|
560
572
|
|
|
561
|
-
For an example of how to use the graph-based retrieval method, see the [Graph-based Retrieval](/examples/rag/usage/graph-rag) example.
|
|
573
|
+
For an example of how to use the graph-based retrieval method, see the [Graph-based Retrieval](/examples/v1/rag/usage/graph-rag) example.
|
|
@@ -45,6 +45,7 @@ For detailed setup instructions and best practices, see the [official MongoDB At
|
|
|
45
45
|
import { PgVector } from "@mastra/pg";
|
|
46
46
|
|
|
47
47
|
const store = new PgVector({
|
|
48
|
+
id: 'pg-vector',
|
|
48
49
|
connectionString: process.env.POSTGRES_CONNECTION_STRING,
|
|
49
50
|
});
|
|
50
51
|
|
|
@@ -73,6 +74,7 @@ For detailed setup instructions and best practices, see the [official pgvector r
|
|
|
73
74
|
import { PineconeVector } from "@mastra/pinecone";
|
|
74
75
|
|
|
75
76
|
const store = new PineconeVector({
|
|
77
|
+
id: 'pinecone-vector',
|
|
76
78
|
apiKey: process.env.PINECONE_API_KEY,
|
|
77
79
|
});
|
|
78
80
|
await store.createIndex({
|
|
@@ -94,6 +96,7 @@ await store.upsert({
|
|
|
94
96
|
import { QdrantVector } from "@mastra/qdrant";
|
|
95
97
|
|
|
96
98
|
const store = new QdrantVector({
|
|
99
|
+
id: 'qdrant-vector',
|
|
97
100
|
url: process.env.QDRANT_URL,
|
|
98
101
|
apiKey: process.env.QDRANT_API_KEY,
|
|
99
102
|
});
|
|
@@ -122,6 +125,7 @@ import { ChromaVector } from "@mastra/chroma";
|
|
|
122
125
|
|
|
123
126
|
// Running on Chroma Cloud
|
|
124
127
|
const store = new ChromaVector({
|
|
128
|
+
id: 'chroma-vector',
|
|
125
129
|
apiKey: process.env.CHROMA_API_KEY,
|
|
126
130
|
tenant: process.env.CHROMA_TENANT,
|
|
127
131
|
database: process.env.CHROMA_DATABASE,
|
|
@@ -172,6 +176,7 @@ await store.upsert({
|
|
|
172
176
|
import { LibSQLVector } from "@mastra/core/vector/libsql";
|
|
173
177
|
|
|
174
178
|
const store = new LibSQLVector({
|
|
179
|
+
id: 'libsql-vector',
|
|
175
180
|
connectionUrl: process.env.DATABASE_URL,
|
|
176
181
|
authToken: process.env.DATABASE_AUTH_TOKEN, // Optional: for Turso cloud databases
|
|
177
182
|
});
|
|
@@ -197,6 +202,7 @@ import { UpstashVector } from "@mastra/upstash";
|
|
|
197
202
|
|
|
198
203
|
// In upstash they refer to the store as an index
|
|
199
204
|
const store = new UpstashVector({
|
|
205
|
+
id: 'upstash-vector',
|
|
200
206
|
url: process.env.UPSTASH_URL,
|
|
201
207
|
token: process.env.UPSTASH_TOKEN,
|
|
202
208
|
});
|
|
@@ -490,7 +496,7 @@ The upsert operation:
|
|
|
490
496
|
- Creates new vectors if they don't exist
|
|
491
497
|
- Automatically handles batching for large datasets
|
|
492
498
|
|
|
493
|
-
For complete examples of upserting embeddings in different vector stores, see the [Upsert Embeddings](/examples/rag/upsert/upsert-embeddings) guide.
|
|
499
|
+
For complete examples of upserting embeddings in different vector stores, see the [Upsert Embeddings](/examples/v1/rag/upsert/upsert-embeddings) guide.
|
|
494
500
|
|
|
495
501
|
## Adding Metadata
|
|
496
502
|
|
|
@@ -17,14 +17,16 @@ import { Agent } from "@mastra/core/agent";
|
|
|
17
17
|
|
|
18
18
|
// String instructions
|
|
19
19
|
export const agent = new Agent({
|
|
20
|
-
|
|
20
|
+
id: "test-agent",
|
|
21
|
+
name: "Test Agent",
|
|
21
22
|
instructions: "You are a helpful assistant that provides concise answers.",
|
|
22
23
|
model: openai("gpt-4o"),
|
|
23
24
|
});
|
|
24
25
|
|
|
25
26
|
// System message object
|
|
26
27
|
export const agent2 = new Agent({
|
|
27
|
-
|
|
28
|
+
id: "test-agent-2",
|
|
29
|
+
name: "Test Agent 2",
|
|
28
30
|
instructions: {
|
|
29
31
|
role: "system",
|
|
30
32
|
content: "You are an expert programmer",
|
|
@@ -34,7 +36,8 @@ export const agent2 = new Agent({
|
|
|
34
36
|
|
|
35
37
|
// Array of system messages
|
|
36
38
|
export const agent3 = new Agent({
|
|
37
|
-
|
|
39
|
+
id: "test-agent-3",
|
|
40
|
+
name: "Test Agent 3",
|
|
38
41
|
instructions: [
|
|
39
42
|
{ role: "system", content: "You are a helpful assistant" },
|
|
40
43
|
{ role: "system", content: "You have expertise in TypeScript" },
|
|
@@ -52,7 +55,8 @@ import { openai } from "@ai-sdk/openai";
|
|
|
52
55
|
import { Agent } from "@mastra/core/agent";
|
|
53
56
|
|
|
54
57
|
export const agent = new Agent({
|
|
55
|
-
|
|
58
|
+
id: "core-message-agent",
|
|
59
|
+
name: "Core Message Agent",
|
|
56
60
|
instructions: {
|
|
57
61
|
role: "system",
|
|
58
62
|
content:
|
|
@@ -80,7 +84,8 @@ const preferredTone = {
|
|
|
80
84
|
};
|
|
81
85
|
|
|
82
86
|
export const agent = new Agent({
|
|
83
|
-
|
|
87
|
+
id: "multi-message-agent",
|
|
88
|
+
name: "Multi Message Agent",
|
|
84
89
|
instructions: [
|
|
85
90
|
{ role: "system", content: "You are a customer service representative." },
|
|
86
91
|
preferredTone,
|
|
@@ -122,58 +127,58 @@ export const agent = new Agent({
|
|
|
122
127
|
},
|
|
123
128
|
{
|
|
124
129
|
name: "instructions",
|
|
125
|
-
type: "SystemMessage | ({
|
|
130
|
+
type: "SystemMessage | ({ requestContext: RequestContext }) => SystemMessage | Promise<SystemMessage>",
|
|
126
131
|
isOptional: false,
|
|
127
|
-
description: `Instructions that guide the agent's behavior. Can be a string, array of strings, system message object,
|
|
128
|
-
array of system messages, or a function that returns any of these types dynamically.
|
|
132
|
+
description: `Instructions that guide the agent's behavior. Can be a string, array of strings, system message object,
|
|
133
|
+
array of system messages, or a function that returns any of these types dynamically.
|
|
129
134
|
SystemMessage types: string | string[] | CoreSystemMessage | CoreSystemMessage[] | SystemModelMessage | SystemModelMessage[]`,
|
|
130
135
|
},
|
|
131
136
|
{
|
|
132
137
|
name: "model",
|
|
133
|
-
type: "MastraLanguageModel | ({
|
|
138
|
+
type: "MastraLanguageModel | ({ requestContext: RequestContext }) => MastraLanguageModel | Promise<MastraLanguageModel>",
|
|
134
139
|
isOptional: false,
|
|
135
140
|
description:
|
|
136
141
|
"The language model used by the agent. Can be provided statically or resolved at runtime.",
|
|
137
142
|
},
|
|
138
143
|
{
|
|
139
144
|
name: "agents",
|
|
140
|
-
type: "Record<string, Agent> | ({
|
|
145
|
+
type: "Record<string, Agent> | ({ requestContext: RequestContext }) => Record<string, Agent> | Promise<Record<string, Agent>>",
|
|
141
146
|
isOptional: true,
|
|
142
147
|
description:
|
|
143
148
|
"Sub-Agents that the agent can access. Can be provided statically or resolved dynamically.",
|
|
144
149
|
},
|
|
145
150
|
{
|
|
146
151
|
name: "tools",
|
|
147
|
-
type: "ToolsInput | ({
|
|
152
|
+
type: "ToolsInput | ({ requestContext: RequestContext }) => ToolsInput | Promise<ToolsInput>",
|
|
148
153
|
isOptional: true,
|
|
149
154
|
description:
|
|
150
155
|
"Tools that the agent can access. Can be provided statically or resolved dynamically.",
|
|
151
156
|
},
|
|
152
157
|
{
|
|
153
158
|
name: "workflows",
|
|
154
|
-
type: "Record<string, Workflow> | ({
|
|
159
|
+
type: "Record<string, Workflow> | ({ requestContext: RequestContext }) => Record<string, Workflow> | Promise<Record<string, Workflow>>",
|
|
155
160
|
isOptional: true,
|
|
156
161
|
description:
|
|
157
162
|
"Workflows that the agent can execute. Can be static or dynamically resolved.",
|
|
158
163
|
},
|
|
159
164
|
{
|
|
160
|
-
name: "
|
|
161
|
-
type: "
|
|
165
|
+
name: "defaultOptions",
|
|
166
|
+
type: "AgentExecutionOptions | ({ requestContext: RequestContext }) => AgentExecutionOptions | Promise<AgentExecutionOptions>",
|
|
162
167
|
isOptional: true,
|
|
163
|
-
description:
|
|
168
|
+
description:
|
|
169
|
+
"Default options used when calling `stream()` and `generate()`.",
|
|
164
170
|
},
|
|
165
171
|
{
|
|
166
|
-
name: "
|
|
167
|
-
type: "
|
|
172
|
+
name: "defaultGenerateOptionsLegacy",
|
|
173
|
+
type: "AgentGenerateOptions | ({ requestContext: RequestContext }) => AgentGenerateOptions | Promise<AgentGenerateOptions>",
|
|
168
174
|
isOptional: true,
|
|
169
|
-
description: "Default options used when calling `
|
|
175
|
+
description: "Default options used when calling `generateLegacy()`.",
|
|
170
176
|
},
|
|
171
177
|
{
|
|
172
|
-
name: "
|
|
173
|
-
type: "
|
|
178
|
+
name: "defaultStreamOptionsLegacy",
|
|
179
|
+
type: "AgentStreamOptions | ({ requestContext: RequestContext }) => AgentStreamOptions | Promise<AgentStreamOptions>",
|
|
174
180
|
isOptional: true,
|
|
175
|
-
description:
|
|
176
|
-
"Default options used when calling `stream()` in vNext mode.",
|
|
181
|
+
description: "Default options used when calling `streamLegacy()`.",
|
|
177
182
|
},
|
|
178
183
|
{
|
|
179
184
|
name: "mastra",
|
|
@@ -184,7 +189,7 @@ export const agent = new Agent({
|
|
|
184
189
|
},
|
|
185
190
|
{
|
|
186
191
|
name: "scorers",
|
|
187
|
-
type: "MastraScorers | ({
|
|
192
|
+
type: "MastraScorers | ({ requestContext: RequestContext }) => MastraScorers | Promise<MastraScorers>",
|
|
188
193
|
isOptional: true,
|
|
189
194
|
description:
|
|
190
195
|
"Scoring configuration for runtime evaluation and telemetry. Can be static or dynamically provided.",
|
|
@@ -197,7 +202,7 @@ export const agent = new Agent({
|
|
|
197
202
|
},
|
|
198
203
|
{
|
|
199
204
|
name: "memory",
|
|
200
|
-
type: "MastraMemory | ({
|
|
205
|
+
type: "MastraMemory | ({ requestContext: RequestContext }) => MastraMemory | Promise<MastraMemory>",
|
|
201
206
|
isOptional: true,
|
|
202
207
|
description:
|
|
203
208
|
"Memory module used for storing and retrieving stateful context.",
|
|
@@ -210,14 +215,14 @@ export const agent = new Agent({
|
|
|
210
215
|
},
|
|
211
216
|
{
|
|
212
217
|
name: "inputProcessors",
|
|
213
|
-
type: "Processor[] | ({
|
|
218
|
+
type: "Processor[] | ({ requestContext: RequestContext }) => Processor[] | Promise<Processor[]>",
|
|
214
219
|
isOptional: true,
|
|
215
220
|
description:
|
|
216
221
|
"Input processors that can modify or validate messages before they are processed by the agent. Must implement the `processInput` function.",
|
|
217
222
|
},
|
|
218
223
|
{
|
|
219
224
|
name: "outputProcessors",
|
|
220
|
-
type: "Processor[] | ({
|
|
225
|
+
type: "Processor[] | ({ requestContext: RequestContext }) => Processor[] | Promise<Processor[]>",
|
|
221
226
|
isOptional: true,
|
|
222
227
|
description:
|
|
223
228
|
"Output processors that can modify or validate messages from the agent, before it is sent to the client. Must implement either (or both) of the `processOutputResult` and `processOutputStream` functions.",
|
|
@@ -239,5 +244,5 @@ export const agent = new Agent({
|
|
|
239
244
|
|
|
240
245
|
## Related
|
|
241
246
|
|
|
242
|
-
- [Agents overview](/docs/agents/overview)
|
|
243
|
-
- [Calling Agents](/examples/agents/calling-agents)
|
|
247
|
+
- [Agents overview](/docs/v1/agents/overview)
|
|
248
|
+
- [Calling Agents](/examples/v1/agents/calling-agents)
|
|
@@ -118,7 +118,7 @@ const aiSdkResult = await agent.generate("message for agent", {
|
|
|
118
118
|
name: "tracingContext",
|
|
119
119
|
type: "TracingContext",
|
|
120
120
|
isOptional: true,
|
|
121
|
-
description: "
|
|
121
|
+
description: "Tracing context for span hierarchy and metadata.",
|
|
122
122
|
},
|
|
123
123
|
{
|
|
124
124
|
name: "returnScorerData",
|
|
@@ -348,7 +348,7 @@ const aiSdkResult = await agent.generate("message for agent", {
|
|
|
348
348
|
type: "TelemetrySettings",
|
|
349
349
|
isOptional: true,
|
|
350
350
|
description:
|
|
351
|
-
"Settings for OTLP telemetry collection during generation (not
|
|
351
|
+
"Settings for OTLP telemetry collection during generation (not Tracing).",
|
|
352
352
|
properties: [
|
|
353
353
|
{
|
|
354
354
|
parameters: [
|
|
@@ -607,27 +607,27 @@ const aiSdkResult = await agent.generate("message for agent", {
|
|
|
607
607
|
description: "Unique identifier for this execution run.",
|
|
608
608
|
},
|
|
609
609
|
{
|
|
610
|
-
name: "
|
|
611
|
-
type: "
|
|
610
|
+
name: "requestContext",
|
|
611
|
+
type: "RequestContext",
|
|
612
612
|
isOptional: true,
|
|
613
613
|
description:
|
|
614
|
-
"
|
|
614
|
+
"Request Context containing dynamic configuration and state.",
|
|
615
615
|
},
|
|
616
616
|
{
|
|
617
617
|
name: "tracingContext",
|
|
618
618
|
type: "TracingContext",
|
|
619
619
|
isOptional: true,
|
|
620
620
|
description:
|
|
621
|
-
"
|
|
621
|
+
"Tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
|
|
622
622
|
properties: [
|
|
623
623
|
{
|
|
624
624
|
parameters: [
|
|
625
625
|
{
|
|
626
626
|
name: "currentSpan",
|
|
627
|
-
type: "
|
|
627
|
+
type: "Span",
|
|
628
628
|
isOptional: true,
|
|
629
629
|
description:
|
|
630
|
-
"Current
|
|
630
|
+
"Current span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.",
|
|
631
631
|
},
|
|
632
632
|
],
|
|
633
633
|
},
|
|
@@ -637,7 +637,7 @@ const aiSdkResult = await agent.generate("message for agent", {
|
|
|
637
637
|
name: "tracingOptions",
|
|
638
638
|
type: "TracingOptions",
|
|
639
639
|
isOptional: true,
|
|
640
|
-
description: "Options for
|
|
640
|
+
description: "Options for Tracing configuration.",
|
|
641
641
|
properties: [
|
|
642
642
|
{
|
|
643
643
|
parameters: [
|
|
@@ -677,7 +677,7 @@ const aiSdkResult = await agent.generate("message for agent", {
|
|
|
677
677
|
type: "string",
|
|
678
678
|
isOptional: true,
|
|
679
679
|
description:
|
|
680
|
-
"The trace ID associated with this execution when
|
|
680
|
+
"The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.",
|
|
681
681
|
},
|
|
682
682
|
]}
|
|
683
683
|
/>
|
|
@@ -7,7 +7,7 @@ description: "Documentation for the legacy `Agent.generateLegacy()` method in Ma
|
|
|
7
7
|
|
|
8
8
|
:::warning
|
|
9
9
|
|
|
10
|
-
**Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.generate()`](./generate) method instead.
|
|
10
|
+
**Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.generate()`](./generate) method instead.
|
|
11
11
|
|
|
12
12
|
:::
|
|
13
13
|
|
|
@@ -400,11 +400,11 @@ await agent.generateLegacy("message for agent");
|
|
|
400
400
|
],
|
|
401
401
|
},
|
|
402
402
|
{
|
|
403
|
-
name: "
|
|
404
|
-
type: "
|
|
403
|
+
name: "requestContext",
|
|
404
|
+
type: "RequestContext",
|
|
405
405
|
isOptional: true,
|
|
406
406
|
description:
|
|
407
|
-
"
|
|
407
|
+
"Request Context for dependency injection and contextual information.",
|
|
408
408
|
},
|
|
409
409
|
{
|
|
410
410
|
name: "maxTokens",
|
|
@@ -518,7 +518,7 @@ await agent.generateLegacy("message for agent");
|
|
|
518
518
|
|
|
519
519
|
:::info
|
|
520
520
|
|
|
521
|
-
The new `.generate()` method offers enhanced capabilities including AI SDK v5 compatibility, better structured output handling, and improved streaming support. See the [migration guide](
|
|
521
|
+
The new `.generate()` method offers enhanced capabilities including AI SDK v5 compatibility, better structured output handling, and improved streaming support. See the [migration guide](/guides/v1/migrations/vnext-to-standard-apis) for detailed migration instructions.
|
|
522
522
|
|
|
523
523
|
:::
|
|
524
524
|
|
|
@@ -604,7 +604,7 @@ await agent.generateLegacy(
|
|
|
604
604
|
|
|
605
605
|
## Related
|
|
606
606
|
|
|
607
|
-
- [Migration Guide](
|
|
607
|
+
- [Migration Guide](/guides/v1/migrations/vnext-to-standard-apis)
|
|
608
608
|
- [New .generate() method](./generate)
|
|
609
|
-
- [Generating responses](/docs/agents/overview#generating-responses)
|
|
610
|
-
- [Streaming responses](/docs/agents/overview#generating-responses)
|
|
609
|
+
- [Generating responses](/docs/v1/agents/overview#generating-responses)
|
|
610
|
+
- [Streaming responses](/docs/v1/agents/overview#generating-responses)
|
|
@@ -1,16 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Agent.
|
|
3
|
-
description: "Documentation for the `Agent.
|
|
2
|
+
title: "Reference: Agent.getDefaultGenerateOptionsLegacy() | Agents | Mastra Docs"
|
|
3
|
+
description: "Documentation for the `Agent.getDefaultGenerateOptionsLegacy()` method in Mastra agents, which retrieves the default options used for generateLegacy calls."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
# Agent.
|
|
6
|
+
# Agent.getDefaultGenerateOptionsLegacy()
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
:::warning
|
|
9
|
+
|
|
10
|
+
**Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.getDefaultOptions()`](./getDefaultOptions) method instead.
|
|
11
|
+
|
|
12
|
+
:::
|
|
13
|
+
|
|
14
|
+
Agents can be configured with default generation options for controlling model behavior, output formatting and tool and workflow calls. The `.getDefaultGenerateOptionsLegacy()` method retrieves these defaults, resolving them if they are functions. These options apply to all `generateLegacy()` calls unless overridden and are useful for inspecting an agent’s unknown defaults.
|
|
9
15
|
|
|
10
16
|
## Usage example
|
|
11
17
|
|
|
12
18
|
```typescript copy
|
|
13
|
-
await agent.
|
|
19
|
+
await agent.getDefaultGenerateOptionsLegacy();
|
|
14
20
|
```
|
|
15
21
|
|
|
16
22
|
## Parameters
|
|
@@ -19,10 +25,10 @@ await agent.getDefaultGenerateOptions();
|
|
|
19
25
|
content={[
|
|
20
26
|
{
|
|
21
27
|
name: "options",
|
|
22
|
-
type: "{
|
|
28
|
+
type: "{ requestContext?: RequestContext }",
|
|
23
29
|
isOptional: true,
|
|
24
30
|
defaultValue: "{}",
|
|
25
|
-
description: "Optional configuration object containing
|
|
31
|
+
description: "Optional configuration object containing request context.",
|
|
26
32
|
},
|
|
27
33
|
]}
|
|
28
34
|
/>
|
|
@@ -43,8 +49,8 @@ await agent.getDefaultGenerateOptions();
|
|
|
43
49
|
## Extended usage example
|
|
44
50
|
|
|
45
51
|
```typescript copy
|
|
46
|
-
await agent.
|
|
47
|
-
|
|
52
|
+
await agent.getDefaultGenerateOptionsLegacy({
|
|
53
|
+
requestContext: new RequestContext(),
|
|
48
54
|
});
|
|
49
55
|
```
|
|
50
56
|
|
|
@@ -53,17 +59,17 @@ await agent.getDefaultGenerateOptions({
|
|
|
53
59
|
<PropertiesTable
|
|
54
60
|
content={[
|
|
55
61
|
{
|
|
56
|
-
name: "
|
|
57
|
-
type: "
|
|
62
|
+
name: "requestContext",
|
|
63
|
+
type: "RequestContext",
|
|
58
64
|
isOptional: true,
|
|
59
|
-
defaultValue: "new
|
|
65
|
+
defaultValue: "new RequestContext()",
|
|
60
66
|
description:
|
|
61
|
-
"
|
|
67
|
+
"Request Context for dependency injection and contextual information.",
|
|
62
68
|
},
|
|
63
69
|
]}
|
|
64
70
|
/>
|
|
65
71
|
|
|
66
72
|
## Related
|
|
67
73
|
|
|
68
|
-
- [Agent generation](/docs/agents/overview#generating-responses)
|
|
69
|
-
- [
|
|
74
|
+
- [Agent generation](/docs/v1/agents/overview#generating-responses)
|
|
75
|
+
- [Request Context](/docs/v1/server-db/request-context)
|