@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
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: .chunk() |
|
|
2
|
+
title: "Reference: Reference: .chunk() | RAG | Mastra Docs"
|
|
3
3
|
description: Documentation for the chunk function in Mastra, which splits documents into smaller segments using various strategies.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -59,13 +59,15 @@ The following parameters are available for all chunking strategies.
|
|
|
59
59
|
type: "number",
|
|
60
60
|
isOptional: true,
|
|
61
61
|
defaultValue: "4000",
|
|
62
|
-
description:
|
|
62
|
+
description:
|
|
63
|
+
"Maximum size of each chunk. **Note:** Some strategy configurations (markdown with headers, HTML with headers) ignore this parameter.",
|
|
63
64
|
},
|
|
64
65
|
{
|
|
65
66
|
name: "size",
|
|
66
67
|
type: "number",
|
|
67
68
|
isOptional: true,
|
|
68
|
-
description:
|
|
69
|
+
description:
|
|
70
|
+
"**Deprecated:** Use `maxSize` instead. This parameter will be removed in the next major version.",
|
|
69
71
|
},
|
|
70
72
|
{
|
|
71
73
|
name: "overlap",
|
|
@@ -78,7 +80,8 @@ The following parameters are available for all chunking strategies.
|
|
|
78
80
|
name: "lengthFunction",
|
|
79
81
|
type: "(text: string) => number",
|
|
80
82
|
isOptional: true,
|
|
81
|
-
description:
|
|
83
|
+
description:
|
|
84
|
+
"Function to calculate text length. Defaults to character count.",
|
|
82
85
|
},
|
|
83
86
|
{
|
|
84
87
|
name: "keepSeparator",
|
|
@@ -105,13 +108,12 @@ The following parameters are available for all chunking strategies.
|
|
|
105
108
|
name: "extract",
|
|
106
109
|
type: "ExtractParams",
|
|
107
110
|
isOptional: true,
|
|
108
|
-
description:
|
|
109
|
-
"Metadata extraction configuration.",
|
|
111
|
+
description: "Metadata extraction configuration.",
|
|
110
112
|
},
|
|
111
113
|
]}
|
|
112
114
|
/>
|
|
113
115
|
|
|
114
|
-
See [ExtractParams reference](/reference/rag/extract-params
|
|
116
|
+
See [ExtractParams reference](/reference/rag/extract-params) for details on the `extract` parameter.
|
|
115
117
|
|
|
116
118
|
## Strategy-Specific Options
|
|
117
119
|
|
|
@@ -189,7 +191,8 @@ The options documented below are passed directly at the top level of the configu
|
|
|
189
191
|
name: "separators",
|
|
190
192
|
type: "string[]",
|
|
191
193
|
isOptional: true,
|
|
192
|
-
description:
|
|
194
|
+
description:
|
|
195
|
+
"Array of separators to try in order of preference. The strategy will attempt to split on the first separator, then fall back to subsequent ones.",
|
|
193
196
|
},
|
|
194
197
|
{
|
|
195
198
|
name: "isSeparatorRegex",
|
|
@@ -209,7 +212,8 @@ The options documented below are passed directly at the top level of the configu
|
|
|
209
212
|
name: "separators",
|
|
210
213
|
type: "string[]",
|
|
211
214
|
isOptional: true,
|
|
212
|
-
description:
|
|
215
|
+
description:
|
|
216
|
+
"Array of separators to try in order of preference. The strategy will attempt to split on the first separator, then fall back to subsequent ones.",
|
|
213
217
|
},
|
|
214
218
|
{
|
|
215
219
|
name: "isSeparatorRegex",
|
|
@@ -222,7 +226,8 @@ The options documented below are passed directly at the top level of the configu
|
|
|
222
226
|
name: "language",
|
|
223
227
|
type: "Language",
|
|
224
228
|
isOptional: true,
|
|
225
|
-
description:
|
|
229
|
+
description:
|
|
230
|
+
"Programming or markup language for language-specific splitting behavior. See Language enum for supported values.",
|
|
226
231
|
},
|
|
227
232
|
]}
|
|
228
233
|
/>
|
|
@@ -234,41 +239,47 @@ The options documented below are passed directly at the top level of the configu
|
|
|
234
239
|
{
|
|
235
240
|
name: "maxSize",
|
|
236
241
|
type: "number",
|
|
237
|
-
description:
|
|
242
|
+
description:
|
|
243
|
+
"Maximum size of each chunk (required for sentence strategy)",
|
|
238
244
|
},
|
|
239
245
|
{
|
|
240
246
|
name: "minSize",
|
|
241
247
|
type: "number",
|
|
242
248
|
isOptional: true,
|
|
243
249
|
defaultValue: "50",
|
|
244
|
-
description:
|
|
250
|
+
description:
|
|
251
|
+
"Minimum size of each chunk. Chunks smaller than this will be merged with adjacent chunks when possible.",
|
|
245
252
|
},
|
|
246
253
|
{
|
|
247
254
|
name: "targetSize",
|
|
248
255
|
type: "number",
|
|
249
256
|
isOptional: true,
|
|
250
|
-
description:
|
|
257
|
+
description:
|
|
258
|
+
"Preferred target size for chunks. Defaults to 80% of maxSize. The strategy will try to create chunks close to this size.",
|
|
251
259
|
},
|
|
252
260
|
{
|
|
253
261
|
name: "sentenceEnders",
|
|
254
262
|
type: "string[]",
|
|
255
263
|
isOptional: true,
|
|
256
264
|
defaultValue: "['.', '!', '?']",
|
|
257
|
-
description:
|
|
265
|
+
description:
|
|
266
|
+
"Array of characters that mark sentence endings for splitting boundaries.",
|
|
258
267
|
},
|
|
259
268
|
{
|
|
260
269
|
name: "fallbackToWords",
|
|
261
270
|
type: "boolean",
|
|
262
271
|
isOptional: true,
|
|
263
272
|
defaultValue: "true",
|
|
264
|
-
description:
|
|
273
|
+
description:
|
|
274
|
+
"Whether to fall back to word-level splitting for sentences that exceed maxSize.",
|
|
265
275
|
},
|
|
266
276
|
{
|
|
267
277
|
name: "fallbackToCharacters",
|
|
268
278
|
type: "boolean",
|
|
269
279
|
isOptional: true,
|
|
270
280
|
defaultValue: "true",
|
|
271
|
-
description:
|
|
281
|
+
description:
|
|
282
|
+
"Whether to fall back to character-level splitting for words that exceed maxSize. Only applies if fallbackToWords is enabled.",
|
|
272
283
|
},
|
|
273
284
|
]}
|
|
274
285
|
/>
|
|
@@ -336,33 +347,38 @@ The options documented below are passed directly at the top level of the configu
|
|
|
336
347
|
type: "number",
|
|
337
348
|
isOptional: true,
|
|
338
349
|
defaultValue: "500",
|
|
339
|
-
description:
|
|
350
|
+
description:
|
|
351
|
+
"Maximum token count for merging related sections. Sections exceeding this limit individually are left intact, but smaller sections are merged with siblings or parents if the combined size stays under this threshold.",
|
|
340
352
|
},
|
|
341
353
|
{
|
|
342
354
|
name: "modelName",
|
|
343
355
|
type: "string",
|
|
344
356
|
isOptional: true,
|
|
345
|
-
description:
|
|
357
|
+
description:
|
|
358
|
+
"Name of the model for tokenization. If provided, the model's underlying tokenization `encodingName` will be used.",
|
|
346
359
|
},
|
|
347
360
|
{
|
|
348
361
|
name: "encodingName",
|
|
349
362
|
type: "string",
|
|
350
363
|
isOptional: true,
|
|
351
364
|
defaultValue: "cl100k_base",
|
|
352
|
-
description:
|
|
365
|
+
description:
|
|
366
|
+
"Name of the token encoding to use. Derived from `modelName` if available.",
|
|
353
367
|
},
|
|
354
368
|
{
|
|
355
369
|
name: "allowedSpecial",
|
|
356
370
|
type: "Set<string> | 'all'",
|
|
357
371
|
isOptional: true,
|
|
358
|
-
description:
|
|
372
|
+
description:
|
|
373
|
+
"Set of special tokens allowed during tokenization, or 'all' to allow all special tokens",
|
|
359
374
|
},
|
|
360
375
|
{
|
|
361
376
|
name: "disallowedSpecial",
|
|
362
377
|
type: "Set<string> | 'all'",
|
|
363
378
|
isOptional: true,
|
|
364
379
|
defaultValue: "all",
|
|
365
|
-
description:
|
|
380
|
+
description:
|
|
381
|
+
"Set of special tokens to disallow during tokenization, or 'all' to disallow all special tokens",
|
|
366
382
|
},
|
|
367
383
|
]}
|
|
368
384
|
/>
|
|
@@ -387,13 +403,15 @@ The options documented below are passed directly at the top level of the configu
|
|
|
387
403
|
name: "allowedSpecial",
|
|
388
404
|
type: "Set<string> | 'all'",
|
|
389
405
|
isOptional: true,
|
|
390
|
-
description:
|
|
406
|
+
description:
|
|
407
|
+
"Set of special tokens allowed during tokenization, or 'all' to allow all special tokens",
|
|
391
408
|
},
|
|
392
409
|
{
|
|
393
410
|
name: "disallowedSpecial",
|
|
394
411
|
type: "Set<string> | 'all'",
|
|
395
412
|
isOptional: true,
|
|
396
|
-
description:
|
|
413
|
+
description:
|
|
414
|
+
"Set of special tokens to disallow during tokenization, or 'all' to disallow all special tokens",
|
|
397
415
|
},
|
|
398
416
|
]}
|
|
399
417
|
/>
|
|
@@ -3,8 +3,8 @@ title: "Reference: DatabaseConfig | RAG | Mastra Docs"
|
|
|
3
3
|
description: API reference for database-specific configuration types used with vector query tools in Mastra RAG systems.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import
|
|
7
|
-
import
|
|
6
|
+
import Tabs from "@theme/Tabs";
|
|
7
|
+
import TabItem from "@theme/TabItem";
|
|
8
8
|
|
|
9
9
|
# DatabaseConfig
|
|
10
10
|
|
|
@@ -32,13 +32,15 @@ Configuration options specific to Pinecone vector store.
|
|
|
32
32
|
{
|
|
33
33
|
name: "namespace",
|
|
34
34
|
type: "string",
|
|
35
|
-
description:
|
|
35
|
+
description:
|
|
36
|
+
"Pinecone namespace for organizing and isolating vectors within the same index. Useful for multi-tenancy or environment separation.",
|
|
36
37
|
isOptional: true,
|
|
37
38
|
},
|
|
38
39
|
{
|
|
39
40
|
name: "sparseVector",
|
|
40
41
|
type: "{ indices: number[]; values: number[]; }",
|
|
41
|
-
description:
|
|
42
|
+
description:
|
|
43
|
+
"Sparse vector for hybrid search combining dense and sparse embeddings. Enables better search quality for keyword-based queries. The indices and values arrays must be the same length.",
|
|
42
44
|
isOptional: true,
|
|
43
45
|
properties: [
|
|
44
46
|
{
|
|
@@ -64,6 +66,7 @@ Configuration options specific to Pinecone vector store.
|
|
|
64
66
|
/>
|
|
65
67
|
|
|
66
68
|
**Use Cases:**
|
|
69
|
+
|
|
67
70
|
- Multi-tenant applications (separate namespaces per tenant)
|
|
68
71
|
- Environment isolation (dev/staging/prod namespaces)
|
|
69
72
|
- Hybrid search combining semantic and keyword matching
|
|
@@ -77,30 +80,35 @@ Configuration options specific to PostgreSQL with pgvector extension.
|
|
|
77
80
|
{
|
|
78
81
|
name: "minScore",
|
|
79
82
|
type: "number",
|
|
80
|
-
description:
|
|
83
|
+
description:
|
|
84
|
+
"Minimum similarity score threshold for results. Only vectors with similarity scores above this value will be returned.",
|
|
81
85
|
isOptional: true,
|
|
82
86
|
},
|
|
83
87
|
{
|
|
84
88
|
name: "ef",
|
|
85
89
|
type: "number",
|
|
86
|
-
description:
|
|
90
|
+
description:
|
|
91
|
+
"HNSW search parameter that controls the size of the dynamic candidate list during search. Higher values improve accuracy at the cost of speed. Typically set between topK and 200.",
|
|
87
92
|
isOptional: true,
|
|
88
93
|
},
|
|
89
94
|
{
|
|
90
95
|
name: "probes",
|
|
91
96
|
type: "number",
|
|
92
|
-
description:
|
|
97
|
+
description:
|
|
98
|
+
"IVFFlat probe parameter that specifies the number of index cells to visit during search. Higher values improve recall at the cost of speed.",
|
|
93
99
|
isOptional: true,
|
|
94
100
|
},
|
|
95
101
|
]}
|
|
96
102
|
/>
|
|
97
103
|
|
|
98
104
|
**Performance Guidelines:**
|
|
105
|
+
|
|
99
106
|
- **ef**: Start with 2-4x your topK value, increase for better accuracy
|
|
100
107
|
- **probes**: Start with 1-10, increase for better recall
|
|
101
108
|
- **minScore**: Use values between 0.5-0.9 depending on your quality requirements
|
|
102
109
|
|
|
103
110
|
**Use Cases:**
|
|
111
|
+
|
|
104
112
|
- Performance optimization for high-load scenarios
|
|
105
113
|
- Quality filtering to remove irrelevant results
|
|
106
114
|
- Fine-tuning search accuracy vs speed tradeoffs
|
|
@@ -114,19 +122,22 @@ Configuration options specific to Chroma vector store.
|
|
|
114
122
|
{
|
|
115
123
|
name: "where",
|
|
116
124
|
type: "Record<string, any>",
|
|
117
|
-
description:
|
|
125
|
+
description:
|
|
126
|
+
"Metadata filtering conditions using MongoDB-style query syntax. Filters results based on metadata fields.",
|
|
118
127
|
isOptional: true,
|
|
119
128
|
},
|
|
120
129
|
{
|
|
121
130
|
name: "whereDocument",
|
|
122
131
|
type: "Record<string, any>",
|
|
123
|
-
description:
|
|
132
|
+
description:
|
|
133
|
+
"Document content filtering conditions. Allows filtering based on the actual document text content.",
|
|
124
134
|
isOptional: true,
|
|
125
135
|
},
|
|
126
136
|
]}
|
|
127
137
|
/>
|
|
128
138
|
|
|
129
139
|
**Filter Syntax Examples:**
|
|
140
|
+
|
|
130
141
|
```typescript
|
|
131
142
|
// Simple equality
|
|
132
143
|
where: { "category": "technical" }
|
|
@@ -135,9 +146,9 @@ where: { "category": "technical" }
|
|
|
135
146
|
where: { "price": { "$gt": 100 } }
|
|
136
147
|
|
|
137
148
|
// Multiple conditions
|
|
138
|
-
where: {
|
|
149
|
+
where: {
|
|
139
150
|
"category": "electronics",
|
|
140
|
-
"inStock": true
|
|
151
|
+
"inStock": true
|
|
141
152
|
}
|
|
142
153
|
|
|
143
154
|
// Document content filtering
|
|
@@ -145,19 +156,20 @@ whereDocument: { "$contains": "API documentation" }
|
|
|
145
156
|
```
|
|
146
157
|
|
|
147
158
|
**Use Cases:**
|
|
159
|
+
|
|
148
160
|
- Advanced metadata filtering
|
|
149
161
|
- Content-based document filtering
|
|
150
162
|
- Complex query combinations
|
|
151
163
|
|
|
152
164
|
## Usage Examples
|
|
153
165
|
|
|
154
|
-
<Tabs
|
|
155
|
-
<
|
|
166
|
+
<Tabs>
|
|
167
|
+
<TabItem value="basic-usage" label="Basic Usage">
|
|
156
168
|
### Basic Database Configuration
|
|
157
169
|
|
|
158
170
|
```typescript
|
|
159
171
|
import { createVectorQueryTool } from '@mastra/rag';
|
|
160
|
-
|
|
172
|
+
|
|
161
173
|
const vectorTool = createVectorQueryTool({
|
|
162
174
|
vectorStoreName: 'pinecone',
|
|
163
175
|
indexName: 'documents',
|
|
@@ -169,18 +181,19 @@ whereDocument: { "$contains": "API documentation" }
|
|
|
169
181
|
}
|
|
170
182
|
});
|
|
171
183
|
```
|
|
172
|
-
</Tabs.Tab>
|
|
173
184
|
|
|
174
|
-
|
|
185
|
+
</TabItem>
|
|
186
|
+
|
|
187
|
+
<TabItem value="runtime-override" label="Runtime Override">
|
|
175
188
|
### Runtime Configuration Override
|
|
176
189
|
|
|
177
190
|
```typescript
|
|
178
191
|
import { RuntimeContext } from '@mastra/core/runtime-context';
|
|
179
|
-
|
|
192
|
+
|
|
180
193
|
// Initial configuration
|
|
181
194
|
const vectorTool = createVectorQueryTool({
|
|
182
195
|
vectorStoreName: 'pinecone',
|
|
183
|
-
indexName: 'documents',
|
|
196
|
+
indexName: 'documents',
|
|
184
197
|
model: embedModel,
|
|
185
198
|
databaseConfig: {
|
|
186
199
|
pinecone: {
|
|
@@ -188,7 +201,7 @@ whereDocument: { "$contains": "API documentation" }
|
|
|
188
201
|
}
|
|
189
202
|
}
|
|
190
203
|
});
|
|
191
|
-
|
|
204
|
+
|
|
192
205
|
// Override at runtime
|
|
193
206
|
const runtimeContext = new RuntimeContext();
|
|
194
207
|
runtimeContext.set('databaseConfig', {
|
|
@@ -196,16 +209,17 @@ whereDocument: { "$contains": "API documentation" }
|
|
|
196
209
|
namespace: 'production'
|
|
197
210
|
}
|
|
198
211
|
});
|
|
199
|
-
|
|
212
|
+
|
|
200
213
|
await vectorTool.execute({
|
|
201
214
|
context: { queryText: 'search query' },
|
|
202
215
|
mastra,
|
|
203
216
|
runtimeContext
|
|
204
217
|
});
|
|
205
218
|
```
|
|
206
|
-
</Tabs.Tab>
|
|
207
219
|
|
|
208
|
-
|
|
220
|
+
</TabItem>
|
|
221
|
+
|
|
222
|
+
<TabItem value="multi-database" label="Multi-Database">
|
|
209
223
|
### Multi-Database Configuration
|
|
210
224
|
|
|
211
225
|
```typescript
|
|
@@ -228,12 +242,15 @@ whereDocument: { "$contains": "API documentation" }
|
|
|
228
242
|
});
|
|
229
243
|
```
|
|
230
244
|
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
245
|
+
:::note
|
|
246
|
+
|
|
247
|
+
**Multi-Database Support**: When you configure multiple databases, only the configuration matching the actual vector store being used will be applied.
|
|
248
|
+
|
|
249
|
+
:::
|
|
250
|
+
|
|
251
|
+
</TabItem>
|
|
235
252
|
|
|
236
|
-
<
|
|
253
|
+
<TabItem value="performance-tuning" label="Performance Tuning">
|
|
237
254
|
### Performance Tuning
|
|
238
255
|
|
|
239
256
|
```typescript
|
|
@@ -250,8 +267,8 @@ whereDocument: { "$contains": "API documentation" }
|
|
|
250
267
|
}
|
|
251
268
|
}
|
|
252
269
|
});
|
|
253
|
-
|
|
254
|
-
// High speed configuration
|
|
270
|
+
|
|
271
|
+
// High speed configuration
|
|
255
272
|
const highSpeedTool = createVectorQueryTool({
|
|
256
273
|
vectorStoreName: 'postgres',
|
|
257
274
|
indexName: 'embeddings',
|
|
@@ -265,7 +282,8 @@ whereDocument: { "$contains": "API documentation" }
|
|
|
265
282
|
}
|
|
266
283
|
});
|
|
267
284
|
```
|
|
268
|
-
|
|
285
|
+
|
|
286
|
+
</TabItem>
|
|
269
287
|
</Tabs>
|
|
270
288
|
|
|
271
289
|
## Extensibility
|
|
@@ -290,15 +308,15 @@ export type DatabaseConfig = {
|
|
|
290
308
|
|
|
291
309
|
// 3. Use in vector query tool
|
|
292
310
|
const vectorTool = createVectorQueryTool({
|
|
293
|
-
vectorStoreName:
|
|
294
|
-
indexName:
|
|
311
|
+
vectorStoreName: "newdatabase",
|
|
312
|
+
indexName: "documents",
|
|
295
313
|
model: embedModel,
|
|
296
314
|
databaseConfig: {
|
|
297
315
|
newdatabase: {
|
|
298
|
-
customParam1:
|
|
299
|
-
customParam2: 42
|
|
300
|
-
}
|
|
301
|
-
}
|
|
316
|
+
customParam1: "value",
|
|
317
|
+
customParam2: 42,
|
|
318
|
+
},
|
|
319
|
+
},
|
|
302
320
|
});
|
|
303
321
|
```
|
|
304
322
|
|
|
@@ -330,5 +348,5 @@ const vectorTool = createVectorQueryTool({
|
|
|
330
348
|
## Related
|
|
331
349
|
|
|
332
350
|
- [createVectorQueryTool()](/reference/tools/vector-query-tool)
|
|
333
|
-
- [Hybrid Vector Search](/examples/rag/query/hybrid-vector-search
|
|
334
|
-
- [Metadata Filters](/reference/rag/metadata-filters)
|
|
351
|
+
- [Hybrid Vector Search](/examples/rag/query/hybrid-vector-search)
|
|
352
|
+
- [Metadata Filters](/reference/rag/metadata-filters)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Metadata Filters |
|
|
2
|
+
title: "Reference: Metadata Filters | RAG | Mastra Docs"
|
|
3
3
|
description: Documentation for metadata filtering capabilities in Mastra, which allow for precise querying of vector search results across different vector stores.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -200,19 +200,16 @@ const results = await store.query({
|
|
|
200
200
|
## Common Rules and Restrictions
|
|
201
201
|
|
|
202
202
|
1. Field names cannot:
|
|
203
|
-
|
|
204
203
|
- Contain dots (.) unless referring to nested fields
|
|
205
204
|
- Start with $ or contain null characters
|
|
206
205
|
- Be empty strings
|
|
207
206
|
|
|
208
207
|
2. Values must be:
|
|
209
|
-
|
|
210
208
|
- Valid JSON types (string, number, boolean, object, array)
|
|
211
209
|
- Not undefined
|
|
212
210
|
- Properly typed for the operator (e.g., numbers for numeric comparisons)
|
|
213
211
|
|
|
214
212
|
3. Logical operators:
|
|
215
|
-
|
|
216
213
|
- Must contain valid conditions
|
|
217
214
|
- Cannot be empty
|
|
218
215
|
- Must be properly nested
|
|
@@ -225,7 +222,6 @@ const results = await store.query({
|
|
|
225
222
|
- Invalid: `{ "field": { "$gt": { "$and": [{...}] } } }`
|
|
226
223
|
|
|
227
224
|
4. $not operator:
|
|
228
|
-
|
|
229
225
|
- Must be an object
|
|
230
226
|
- Cannot be empty
|
|
231
227
|
- Can be used at field level or top level
|
|
@@ -317,31 +313,32 @@ const results = await store.query({
|
|
|
317
313
|
- Indexing metadata fields is recommended for optimal performance
|
|
318
314
|
|
|
319
315
|
### Couchbase
|
|
316
|
+
|
|
320
317
|
- Currently does not have support for metadata filters. Filtering must be done client-side after retrieving results or by using the Couchbase SDK's Search capabilities directly for more complex queries.
|
|
321
318
|
|
|
322
319
|
### Amazon S3 Vectors
|
|
323
320
|
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
321
|
+
- Equality values must be primitives (string/number/boolean). `null`/`undefined`, arrays, objects, and Date are not allowed for equality. Range operators accept numbers or Date (Dates are normalized to epoch ms).
|
|
322
|
+
- `$in`/`$nin` require **non-empty arrays of primitives**; Date elements are allowed and normalized to epoch ms. **Array equality** is not supported.
|
|
323
|
+
- Implicit AND is canonicalized (`{a:1,b:2}` → `{$and:[{a:1},{b:2}]}`). Logical operators must contain field conditions, use non-empty arrays, and appear only at the root or within other logical operators (not inside field values).
|
|
324
|
+
- Keys listed in `nonFilterableMetadataKeys` at index creation are stored but not filterable; this setting is immutable.
|
|
325
|
+
- $exists requires a boolean value.
|
|
326
|
+
- undefined/null/empty filters are treated as no filter.
|
|
327
|
+
- Each metadata key name limited to 63 characters.
|
|
328
|
+
- Total metadata per vector: Up to 40 KB (filterable + non-filterable)
|
|
329
|
+
- Total metadata keys per vector: Up to 10
|
|
330
|
+
- Filterable metadata per vector: Up to 2 KB
|
|
331
|
+
- Non-filterable metadata keys per vector index: Up to 10
|
|
335
332
|
|
|
336
333
|
## Related
|
|
337
334
|
|
|
338
|
-
- [Astra](
|
|
339
|
-
- [Chroma](
|
|
340
|
-
- [Cloudflare Vectorize](
|
|
341
|
-
- [LibSQL](
|
|
342
|
-
- [MongoDB](
|
|
343
|
-
- [PgStore](
|
|
344
|
-
- [Pinecone](
|
|
345
|
-
- [Qdrant](
|
|
346
|
-
- [Upstash](
|
|
347
|
-
- [Amazon S3 Vectors](
|
|
335
|
+
- [Astra](/reference/vectors/astra)
|
|
336
|
+
- [Chroma](/reference/vectors/chroma)
|
|
337
|
+
- [Cloudflare Vectorize](/reference/vectors/vectorize)
|
|
338
|
+
- [LibSQL](/reference/vectors/libsql)
|
|
339
|
+
- [MongoDB](/reference/vectors/mongodb)
|
|
340
|
+
- [PgStore](/reference/vectors/pg)
|
|
341
|
+
- [Pinecone](/reference/vectors/pinecone)
|
|
342
|
+
- [Qdrant](/reference/vectors/qdrant)
|
|
343
|
+
- [Upstash](/reference/vectors/upstash)
|
|
344
|
+
- [Amazon S3 Vectors](/reference/vectors/s3vectors)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: rerank() | RAG | Mastra Docs"
|
|
3
3
|
description: Documentation for the rerank function in Mastra, which provides advanced reranking capabilities for vector search results.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: rerankWithScorer() | RAG | Mastra Docs"
|
|
3
3
|
description: Documentation for the rerank function in Mastra, which provides advanced reranking capabilities for vector search results.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -22,7 +22,7 @@ function rerankWithScorer({
|
|
|
22
22
|
import { openai } from "@ai-sdk/openai";
|
|
23
23
|
import { rerankWithScorer as rerank, CohereRelevanceScorer } from "@mastra/rag";
|
|
24
24
|
|
|
25
|
-
const scorer = new CohereRelevanceScorer(
|
|
25
|
+
const scorer = new CohereRelevanceScorer("rerank-v3.5");
|
|
26
26
|
|
|
27
27
|
const rerankedResults = await rerank({
|
|
28
28
|
results: vectorSearchResults,
|