@mastra/mcp-docs-server 0.13.37 → 0.13.39-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +2 -0
- package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +2 -0
- package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +8 -8
- package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +2 -0
- package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fastra.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fauth.md +6 -0
- package/.docs/organized/changelogs/%40mastra%2Fchroma.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +38 -38
- package/.docs/organized/changelogs/%40mastra%2Fcloud.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +88 -88
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +28 -28
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +27 -27
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +27 -27
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +27 -27
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +59 -59
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +6 -0
- package/.docs/organized/changelogs/%40mastra%2Flance.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Floggers.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +25 -25
- package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fmcp.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +48 -48
- package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Frag.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Freact.md +24 -24
- package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +9 -0
- package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +6 -0
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +40 -40
- package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +11 -1
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +10 -10
- package/.docs/organized/changelogs/create-mastra.md +11 -11
- package/.docs/organized/changelogs/mastra.md +34 -34
- package/.docs/raw/agents/adding-voice.mdx +20 -9
- package/.docs/raw/agents/agent-memory.mdx +55 -39
- package/.docs/raw/agents/guardrails.mdx +68 -61
- package/.docs/raw/agents/networks.mdx +50 -46
- package/.docs/raw/agents/overview.mdx +126 -89
- package/.docs/raw/agents/using-tools.mdx +14 -15
- package/.docs/raw/auth/auth0.mdx +28 -27
- package/.docs/raw/auth/clerk.mdx +22 -20
- package/.docs/raw/auth/firebase.mdx +42 -39
- package/.docs/raw/auth/index.mdx +1 -1
- package/.docs/raw/auth/jwt.mdx +18 -16
- package/.docs/raw/auth/supabase.mdx +20 -18
- package/.docs/raw/auth/workos.mdx +32 -26
- package/.docs/raw/community/contributing-templates.mdx +7 -7
- package/.docs/raw/community/discord.mdx +2 -2
- package/.docs/raw/community/licensing.mdx +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/04-initializing-mcp-tools.md +2 -2
- package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -1
- package/.docs/raw/course/03-agent-memory/26-updating-mastra-export-comprehensive.md +0 -32
- package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +41 -22
- package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +48 -29
- package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +52 -24
- package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +86 -55
- package/.docs/raw/deployment/cloud-providers/index.mdx +16 -13
- package/.docs/raw/deployment/monorepo.mdx +32 -42
- package/.docs/raw/deployment/overview.mdx +15 -15
- package/.docs/raw/deployment/server-deployment.mdx +18 -23
- package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +16 -17
- package/.docs/raw/deployment/serverless-platforms/index.mdx +15 -12
- package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +14 -23
- package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +16 -23
- package/.docs/raw/deployment/web-framework.mdx +14 -14
- package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +130 -121
- package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +54 -43
- package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +51 -36
- package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +161 -120
- package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +60 -49
- package/.docs/raw/frameworks/servers/express.mdx +46 -45
- package/.docs/raw/frameworks/web-frameworks/astro.mdx +245 -162
- package/.docs/raw/frameworks/web-frameworks/next-js.mdx +112 -69
- package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +171 -130
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +94 -81
- package/.docs/raw/getting-started/installation.mdx +165 -134
- package/.docs/raw/getting-started/mcp-docs-server.mdx +36 -39
- package/.docs/raw/getting-started/project-structure.mdx +34 -42
- package/.docs/raw/getting-started/studio.mdx +42 -50
- package/.docs/raw/getting-started/templates.mdx +18 -15
- package/.docs/raw/index.mdx +9 -9
- package/.docs/raw/mastra-cloud/dashboard.mdx +12 -12
- package/.docs/raw/mastra-cloud/observability.mdx +9 -10
- package/.docs/raw/mastra-cloud/overview.mdx +17 -23
- package/.docs/raw/mastra-cloud/setting-up.mdx +33 -20
- package/.docs/raw/memory/conversation-history.mdx +2 -2
- package/.docs/raw/memory/overview.mdx +22 -24
- package/.docs/raw/memory/semantic-recall.mdx +16 -17
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +27 -28
- package/.docs/raw/memory/storage/memory-with-pg.mdx +26 -26
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +26 -27
- package/.docs/raw/memory/threads-and-resources.mdx +24 -21
- package/.docs/raw/memory/working-memory.mdx +27 -38
- package/.docs/raw/observability/ai-tracing/exporters/arize.mdx +30 -29
- package/.docs/raw/observability/ai-tracing/exporters/braintrust.mdx +8 -9
- package/.docs/raw/observability/ai-tracing/exporters/cloud.mdx +17 -16
- package/.docs/raw/observability/ai-tracing/exporters/default.mdx +37 -38
- package/.docs/raw/observability/ai-tracing/exporters/langfuse.mdx +18 -17
- package/.docs/raw/observability/ai-tracing/exporters/langsmith.mdx +14 -14
- package/.docs/raw/observability/ai-tracing/exporters/otel.mdx +56 -46
- package/.docs/raw/observability/ai-tracing/overview.mdx +151 -128
- package/.docs/raw/observability/ai-tracing/processors/sensitive-data-filter.mdx +57 -36
- package/.docs/raw/observability/logging.mdx +14 -17
- package/.docs/raw/observability/nextjs-tracing.mdx +5 -5
- package/.docs/raw/observability/otel-tracing.mdx +17 -18
- package/.docs/raw/observability/overview.mdx +15 -11
- package/.docs/raw/rag/chunking-and-embedding.mdx +10 -8
- package/.docs/raw/rag/overview.mdx +5 -5
- package/.docs/raw/rag/retrieval.mdx +125 -107
- package/.docs/raw/rag/vector-databases.mdx +232 -223
- package/.docs/raw/reference/agents/agent.mdx +56 -43
- package/.docs/raw/reference/agents/generate.mdx +367 -261
- package/.docs/raw/reference/agents/generateLegacy.mdx +260 -178
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +7 -5
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +7 -5
- package/.docs/raw/reference/agents/getDescription.mdx +3 -2
- package/.docs/raw/reference/agents/getInstructions.mdx +7 -5
- package/.docs/raw/reference/agents/getLLM.mdx +11 -7
- package/.docs/raw/reference/agents/getMemory.mdx +7 -5
- package/.docs/raw/reference/agents/getModel.mdx +7 -5
- package/.docs/raw/reference/agents/getScorers.mdx +7 -5
- package/.docs/raw/reference/agents/getTools.mdx +7 -5
- package/.docs/raw/reference/agents/getVoice.mdx +7 -5
- package/.docs/raw/reference/agents/getWorkflows.mdx +7 -5
- package/.docs/raw/reference/agents/listAgents.mdx +6 -4
- package/.docs/raw/reference/agents/listScorers.mdx +69 -0
- package/.docs/raw/reference/agents/listTools.mdx +69 -0
- package/.docs/raw/reference/agents/listWorkflows.mdx +69 -0
- package/.docs/raw/reference/agents/network.mdx +171 -116
- package/.docs/raw/reference/auth/auth0.mdx +18 -14
- package/.docs/raw/reference/auth/clerk.mdx +15 -12
- package/.docs/raw/reference/auth/firebase.mdx +23 -16
- package/.docs/raw/reference/auth/jwt.mdx +7 -6
- package/.docs/raw/reference/auth/supabase.mdx +13 -10
- package/.docs/raw/reference/auth/workos.mdx +17 -13
- package/.docs/raw/reference/cli/create-mastra.mdx +61 -44
- package/.docs/raw/reference/cli/mastra.mdx +11 -11
- package/.docs/raw/reference/client-js/agents.mdx +41 -44
- package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
- package/.docs/raw/reference/client-js/logs.mdx +2 -2
- package/.docs/raw/reference/client-js/mastra-client.mdx +28 -20
- package/.docs/raw/reference/client-js/memory.mdx +7 -3
- package/.docs/raw/reference/client-js/observability.mdx +10 -9
- package/.docs/raw/reference/client-js/telemetry.mdx +1 -1
- package/.docs/raw/reference/client-js/tools.mdx +2 -2
- package/.docs/raw/reference/client-js/vectors.mdx +1 -1
- package/.docs/raw/reference/client-js/workflows-legacy.mdx +1 -1
- package/.docs/raw/reference/client-js/workflows.mdx +8 -8
- package/.docs/raw/reference/core/getAgent.mdx +6 -5
- package/.docs/raw/reference/core/getAgentById.mdx +5 -4
- package/.docs/raw/reference/core/getAgents.mdx +3 -3
- package/.docs/raw/reference/core/getDeployer.mdx +4 -3
- package/.docs/raw/reference/core/getLogger.mdx +4 -3
- package/.docs/raw/reference/core/getLogs.mdx +10 -6
- package/.docs/raw/reference/core/getLogsByRunId.mdx +8 -5
- package/.docs/raw/reference/core/getMCPServer.mdx +8 -5
- package/.docs/raw/reference/core/getMCPServers.mdx +4 -3
- package/.docs/raw/reference/core/getMemory.mdx +4 -3
- package/.docs/raw/reference/core/getScorer.mdx +15 -12
- package/.docs/raw/reference/core/getScorerByName.mdx +13 -10
- package/.docs/raw/reference/core/getScorers.mdx +3 -2
- package/.docs/raw/reference/core/getServer.mdx +4 -3
- package/.docs/raw/reference/core/getStorage.mdx +4 -3
- package/.docs/raw/reference/core/getTelemetry.mdx +4 -3
- package/.docs/raw/reference/core/getVector.mdx +6 -4
- package/.docs/raw/reference/core/getVectors.mdx +4 -3
- package/.docs/raw/reference/core/getWorkflow.mdx +7 -4
- package/.docs/raw/reference/core/getWorkflows.mdx +5 -3
- package/.docs/raw/reference/core/listAgents.mdx +35 -0
- package/.docs/raw/reference/core/listLogs.mdx +96 -0
- package/.docs/raw/reference/core/listLogsByRunId.mdx +87 -0
- package/.docs/raw/reference/core/listScorers.mdx +43 -0
- package/.docs/raw/reference/core/listWorkflows.mdx +45 -0
- package/.docs/raw/reference/core/mastra-class.mdx +16 -16
- package/.docs/raw/reference/core/setLogger.mdx +6 -4
- package/.docs/raw/reference/core/setStorage.mdx +4 -4
- package/.docs/raw/reference/core/setTelemetry.mdx +4 -3
- package/.docs/raw/reference/deployer/cloudflare.mdx +11 -7
- package/.docs/raw/reference/deployer/deployer.mdx +2 -1
- package/.docs/raw/reference/deployer/netlify.mdx +4 -4
- package/.docs/raw/reference/deployer/vercel.mdx +6 -6
- package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -5
- package/.docs/raw/reference/evals/bias.mdx +4 -5
- package/.docs/raw/reference/evals/completeness.mdx +4 -5
- package/.docs/raw/reference/evals/content-similarity.mdx +4 -5
- package/.docs/raw/reference/evals/context-position.mdx +4 -5
- package/.docs/raw/reference/evals/context-precision.mdx +4 -5
- package/.docs/raw/reference/evals/context-relevancy.mdx +4 -5
- package/.docs/raw/reference/evals/contextual-recall.mdx +4 -5
- package/.docs/raw/reference/evals/faithfulness.mdx +4 -5
- package/.docs/raw/reference/evals/hallucination.mdx +4 -6
- package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -5
- package/.docs/raw/reference/evals/prompt-alignment.mdx +4 -6
- package/.docs/raw/reference/evals/summarization.mdx +4 -6
- package/.docs/raw/reference/evals/textual-difference.mdx +4 -5
- package/.docs/raw/reference/evals/tone-consistency.mdx +4 -7
- package/.docs/raw/reference/evals/toxicity.mdx +4 -5
- package/.docs/raw/reference/index.mdx +3 -3
- package/.docs/raw/reference/legacyWorkflows/after.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/commit.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/createRun.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/else.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/events.mdx +7 -7
- package/.docs/raw/reference/legacyWorkflows/execute.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/if.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/resume.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/start.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/step-class.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/step-function.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/step-options.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/suspend.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/then.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/until.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/watch.mdx +3 -3
- package/.docs/raw/reference/legacyWorkflows/while.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/workflow.mdx +7 -7
- package/.docs/raw/reference/memory/createThread.mdx +10 -10
- package/.docs/raw/reference/memory/deleteMessages.mdx +7 -5
- package/.docs/raw/reference/memory/getThreadById.mdx +6 -5
- package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +11 -10
- package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +10 -9
- package/.docs/raw/reference/memory/{Memory.mdx → memory-class.mdx} +55 -47
- package/.docs/raw/reference/memory/query.mdx +39 -25
- package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +9 -6
- package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +26 -22
- package/.docs/raw/reference/observability/ai-tracing/exporters/arize.mdx +16 -12
- package/.docs/raw/reference/observability/ai-tracing/exporters/braintrust.mdx +14 -14
- package/.docs/raw/reference/observability/ai-tracing/exporters/cloud-exporter.mdx +16 -11
- package/.docs/raw/reference/observability/ai-tracing/exporters/console-exporter.mdx +10 -6
- package/.docs/raw/reference/observability/ai-tracing/exporters/default-exporter.mdx +23 -15
- package/.docs/raw/reference/observability/ai-tracing/exporters/langfuse.mdx +6 -6
- package/.docs/raw/reference/observability/ai-tracing/exporters/langsmith.mdx +13 -13
- package/.docs/raw/reference/observability/ai-tracing/exporters/otel.mdx +44 -36
- package/.docs/raw/reference/observability/ai-tracing/interfaces.mdx +116 -107
- package/.docs/raw/reference/observability/ai-tracing/processors/sensitive-data-filter.mdx +37 -32
- package/.docs/raw/reference/observability/ai-tracing/span.mdx +29 -26
- package/.docs/raw/reference/observability/logging/pino-logger.mdx +13 -15
- package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +2 -2
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +3 -3
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +2 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +12 -14
- package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +4 -4
- package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +4 -4
- package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +2 -2
- package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +1 -1
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +3 -4
- package/.docs/raw/reference/processors/language-detector.mdx +6 -8
- package/.docs/raw/reference/processors/moderation-processor.mdx +36 -11
- package/.docs/raw/reference/processors/pii-detector.mdx +34 -9
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +6 -8
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +14 -10
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +3 -5
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +3 -4
- package/.docs/raw/reference/rag/chunk.mdx +41 -23
- package/.docs/raw/reference/rag/database-config.mdx +56 -38
- package/.docs/raw/reference/rag/embeddings.mdx +1 -1
- package/.docs/raw/reference/rag/extract-params.mdx +1 -1
- package/.docs/raw/reference/rag/graph-rag.mdx +1 -1
- package/.docs/raw/reference/rag/metadata-filters.mdx +23 -26
- package/.docs/raw/reference/rag/rerank.mdx +1 -1
- package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -2
- package/.docs/raw/reference/scorers/answer-relevancy.mdx +35 -17
- package/.docs/raw/reference/scorers/answer-similarity.mdx +84 -68
- package/.docs/raw/reference/scorers/bias.mdx +22 -19
- package/.docs/raw/reference/scorers/completeness.mdx +21 -16
- package/.docs/raw/reference/scorers/content-similarity.mdx +12 -10
- package/.docs/raw/reference/scorers/context-precision.mdx +73 -64
- package/.docs/raw/reference/scorers/context-relevance.mdx +142 -126
- package/.docs/raw/reference/scorers/create-scorer.mdx +93 -61
- package/.docs/raw/reference/scorers/faithfulness.mdx +21 -13
- package/.docs/raw/reference/scorers/hallucination.mdx +17 -12
- package/.docs/raw/reference/scorers/keyword-coverage.mdx +32 -27
- package/.docs/raw/reference/scorers/mastra-scorer.mdx +39 -33
- package/.docs/raw/reference/scorers/noise-sensitivity.mdx +203 -152
- package/.docs/raw/reference/scorers/prompt-alignment.mdx +186 -132
- package/.docs/raw/reference/scorers/run-experiment.mdx +41 -32
- package/.docs/raw/reference/scorers/textual-difference.mdx +25 -26
- package/.docs/raw/reference/scorers/tone-consistency.mdx +29 -26
- package/.docs/raw/reference/scorers/tool-call-accuracy.mdx +180 -176
- package/.docs/raw/reference/scorers/toxicity.mdx +35 -31
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
- package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
- package/.docs/raw/reference/storage/dynamodb.mdx +1 -1
- package/.docs/raw/reference/storage/lance.mdx +1 -1
- package/.docs/raw/reference/storage/libsql.mdx +2 -2
- package/.docs/raw/reference/storage/mongodb.mdx +4 -5
- package/.docs/raw/reference/storage/mssql.mdx +8 -7
- package/.docs/raw/reference/storage/postgresql.mdx +35 -33
- package/.docs/raw/reference/storage/upstash.mdx +6 -5
- package/.docs/raw/reference/streaming/ChunkType.mdx +788 -314
- package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +265 -109
- package/.docs/raw/reference/streaming/agents/stream.mdx +375 -266
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +233 -162
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +4 -4
- package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +5 -5
- package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +25 -21
- package/.docs/raw/reference/streaming/workflows/stream.mdx +36 -27
- package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +37 -28
- package/.docs/raw/reference/templates/overview.mdx +16 -39
- package/.docs/raw/reference/tools/client.mdx +1 -1
- package/.docs/raw/reference/tools/create-tool.mdx +45 -35
- package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -2
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +12 -12
- package/.docs/raw/reference/tools/mcp-client.mdx +78 -72
- package/.docs/raw/reference/tools/mcp-server.mdx +91 -78
- package/.docs/raw/reference/tools/vector-query-tool.mdx +48 -38
- package/.docs/raw/reference/vectors/astra.mdx +1 -1
- package/.docs/raw/reference/vectors/chroma.mdx +25 -19
- package/.docs/raw/reference/vectors/couchbase.mdx +4 -4
- package/.docs/raw/reference/vectors/lance.mdx +5 -6
- package/.docs/raw/reference/vectors/libsql.mdx +1 -1
- package/.docs/raw/reference/vectors/mongodb.mdx +1 -1
- package/.docs/raw/reference/vectors/opensearch.mdx +1 -1
- package/.docs/raw/reference/vectors/pg.mdx +8 -4
- package/.docs/raw/reference/vectors/pinecone.mdx +1 -1
- package/.docs/raw/reference/vectors/qdrant.mdx +1 -1
- package/.docs/raw/reference/vectors/s3vectors.mdx +35 -27
- package/.docs/raw/reference/vectors/turbopuffer.mdx +1 -1
- package/.docs/raw/reference/vectors/upstash.mdx +33 -25
- package/.docs/raw/reference/vectors/vectorize.mdx +1 -1
- package/.docs/raw/reference/voice/azure.mdx +1 -1
- package/.docs/raw/reference/voice/cloudflare.mdx +1 -1
- package/.docs/raw/reference/voice/composite-voice.mdx +1 -1
- package/.docs/raw/reference/voice/deepgram.mdx +1 -1
- package/.docs/raw/reference/voice/elevenlabs.mdx +1 -1
- package/.docs/raw/reference/voice/google-gemini-live.mdx +7 -5
- package/.docs/raw/reference/voice/google.mdx +1 -1
- package/.docs/raw/reference/voice/mastra-voice.mdx +1 -1
- package/.docs/raw/reference/voice/murf.mdx +1 -1
- package/.docs/raw/reference/voice/openai-realtime.mdx +1 -1
- package/.docs/raw/reference/voice/openai.mdx +1 -1
- package/.docs/raw/reference/voice/playai.mdx +1 -1
- package/.docs/raw/reference/voice/sarvam.mdx +1 -1
- package/.docs/raw/reference/voice/speechify.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addInstructions.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addTools.mdx +1 -1
- package/.docs/raw/reference/voice/voice.answer.mdx +1 -1
- package/.docs/raw/reference/voice/voice.close.mdx +1 -1
- package/.docs/raw/reference/voice/voice.connect.mdx +1 -1
- package/.docs/raw/reference/voice/voice.events.mdx +1 -1
- package/.docs/raw/reference/voice/voice.getSpeakers.mdx +23 -30
- package/.docs/raw/reference/voice/voice.listen.mdx +1 -1
- package/.docs/raw/reference/voice/voice.off.mdx +1 -1
- package/.docs/raw/reference/voice/voice.on.mdx +1 -1
- package/.docs/raw/reference/voice/voice.send.mdx +1 -1
- package/.docs/raw/reference/voice/voice.speak.mdx +1 -1
- package/.docs/raw/reference/voice/voice.updateConfig.mdx +1 -1
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -3
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +49 -34
- package/.docs/raw/reference/workflows/run-methods/start.mdx +43 -31
- package/.docs/raw/reference/workflows/run-methods/watch.mdx +7 -8
- package/.docs/raw/reference/workflows/run.mdx +7 -10
- package/.docs/raw/reference/workflows/step.mdx +16 -13
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +7 -7
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +74 -3
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +5 -5
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +3 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +3 -2
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +3 -3
- package/.docs/raw/reference/workflows/workflow.mdx +12 -23
- package/.docs/raw/scorers/custom-scorers.mdx +58 -48
- package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +6 -8
- package/.docs/raw/scorers/evals-old-api/overview.mdx +8 -8
- package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +9 -9
- package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +5 -5
- package/.docs/raw/scorers/off-the-shelf-scorers.mdx +3 -1
- package/.docs/raw/scorers/overview.mdx +23 -22
- package/.docs/raw/server-db/custom-api-routes.mdx +8 -8
- package/.docs/raw/server-db/mastra-client.mdx +56 -54
- package/.docs/raw/server-db/middleware.mdx +15 -11
- package/.docs/raw/server-db/production-server.mdx +5 -7
- package/.docs/raw/server-db/runtime-context.mdx +41 -38
- package/.docs/raw/server-db/storage.mdx +82 -87
- package/.docs/raw/streaming/events.mdx +24 -16
- package/.docs/raw/streaming/overview.mdx +17 -18
- package/.docs/raw/streaming/tool-streaming.mdx +9 -10
- package/.docs/raw/streaming/workflow-streaming.mdx +14 -12
- package/.docs/raw/tools-mcp/advanced-usage.mdx +2 -2
- package/.docs/raw/tools-mcp/mcp-overview.mdx +92 -102
- package/.docs/raw/tools-mcp/overview.mdx +10 -15
- package/.docs/raw/voice/overview.mdx +273 -250
- package/.docs/raw/voice/speech-to-speech.mdx +14 -12
- package/.docs/raw/voice/speech-to-text.mdx +2 -2
- package/.docs/raw/voice/text-to-speech.mdx +2 -2
- package/.docs/raw/workflows/agents-and-tools.mdx +27 -30
- package/.docs/raw/workflows/control-flow.mdx +213 -170
- package/.docs/raw/workflows/error-handling.mdx +15 -17
- package/.docs/raw/workflows/human-in-the-loop.mdx +39 -39
- package/.docs/raw/workflows/inngest-workflow.mdx +35 -31
- package/.docs/raw/workflows/overview.mdx +108 -56
- package/.docs/raw/workflows/snapshots.mdx +54 -36
- package/.docs/raw/workflows/suspend-and-resume.mdx +52 -65
- package/.docs/raw/workflows-legacy/control-flow.mdx +15 -17
- package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +3 -1
- package/.docs/raw/workflows-legacy/error-handling.mdx +8 -6
- package/.docs/raw/workflows-legacy/nested-workflows.mdx +6 -0
- package/.docs/raw/workflows-legacy/overview.mdx +28 -26
- package/.docs/raw/workflows-legacy/runtime-variables.mdx +4 -2
- package/.docs/raw/workflows-legacy/steps.mdx +5 -3
- package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +10 -8
- package/.docs/raw/workflows-legacy/variables.mdx +10 -8
- package/CHANGELOG.md +24 -0
- package/package.json +5 -5
- package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -148
- package/.docs/raw/workflows/input-data-mapping.mdx +0 -107
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Chroma Vector Store |
|
|
2
|
+
title: "Reference: Chroma Vector Store | Vectors | Mastra Docs"
|
|
3
3
|
description: Documentation for the ChromaVector class in Mastra, which provides vector search using ChromaDB.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { Callout } from "nextra/components";
|
|
7
|
-
|
|
8
6
|
# Chroma Vector Store
|
|
9
7
|
|
|
10
8
|
The ChromaVector class provides vector search using [Chroma](https://docs.trychroma.com/docs/overview/getting-started), an open-source embedding database.
|
|
11
9
|
It offers efficient vector search with metadata filtering and hybrid search capabilities.
|
|
12
10
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
11
|
+
:::info
|
|
12
|
+
|
|
13
|
+
<b>Chroma Cloud</b>
|
|
14
|
+
|
|
16
15
|
Chroma Cloud powers serverless vector and full-text search. It's extremely fast, cost-effective, scalable and painless. Create a DB and try it out in under 30 seconds with $5 of free credits.
|
|
17
16
|
|
|
18
17
|
[Get started with Chroma Cloud](https://trychroma.com/signup)
|
|
19
|
-
|
|
20
|
-
|
|
18
|
+
|
|
19
|
+
:::
|
|
21
20
|
|
|
22
21
|
## Constructor Options
|
|
23
22
|
|
|
@@ -27,7 +26,8 @@ It offers efficient vector search with metadata filtering and hybrid search capa
|
|
|
27
26
|
name: "host",
|
|
28
27
|
type: "string",
|
|
29
28
|
isOptional: true,
|
|
30
|
-
description:
|
|
29
|
+
description:
|
|
30
|
+
"The host address of the Chroma server. Defaults to 'localhost'",
|
|
31
31
|
},
|
|
32
32
|
{
|
|
33
33
|
name: "port",
|
|
@@ -39,7 +39,8 @@ It offers efficient vector search with metadata filtering and hybrid search capa
|
|
|
39
39
|
name: "ssl",
|
|
40
40
|
type: "boolean",
|
|
41
41
|
isOptional: true,
|
|
42
|
-
description:
|
|
42
|
+
description:
|
|
43
|
+
"Whether to use SSL/HTTPS for connections. Defaults to false",
|
|
43
44
|
},
|
|
44
45
|
{
|
|
45
46
|
name: "apiKey",
|
|
@@ -51,13 +52,15 @@ It offers efficient vector search with metadata filtering and hybrid search capa
|
|
|
51
52
|
name: "tenant",
|
|
52
53
|
type: "string",
|
|
53
54
|
isOptional: true,
|
|
54
|
-
description:
|
|
55
|
+
description:
|
|
56
|
+
"The tenant name in the Chroma server to connect to. Defaults to 'default_tenant' for single-node Chroma. Auto-resolved for Chroma Cloud users based on the provided API key",
|
|
55
57
|
},
|
|
56
58
|
{
|
|
57
59
|
name: "database",
|
|
58
60
|
type: "string",
|
|
59
61
|
isOptional: true,
|
|
60
|
-
description:
|
|
62
|
+
description:
|
|
63
|
+
"The database name to connect to. Defaults to 'default_database' for single-node Chroma. Auto-resolved for Chroma Cloud users based on the provided API key",
|
|
61
64
|
},
|
|
62
65
|
{
|
|
63
66
|
name: "headers",
|
|
@@ -70,7 +73,7 @@ It offers efficient vector search with metadata filtering and hybrid search capa
|
|
|
70
73
|
type: "RequestInit",
|
|
71
74
|
isOptional: true,
|
|
72
75
|
description: "Additional fetch options for HTTP requests",
|
|
73
|
-
}
|
|
76
|
+
},
|
|
74
77
|
]}
|
|
75
78
|
/>
|
|
76
79
|
|
|
@@ -81,9 +84,10 @@ If you are a Chroma Cloud user, simply provide the `ChromaVector` constructor yo
|
|
|
81
84
|
When you install the `@mastra/chroma` package, you get access to the [Chroma CLI](https://docs.trychroma.com/docs/cli/db), which can set these as environment variables for you: `chroma db connect [DB-NAME] --env-file`.
|
|
82
85
|
|
|
83
86
|
Otherwise, you have several options for setting up your single-node Chroma server:
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
+
|
|
88
|
+
- Run one locally using the Chroma CLI: `chroma run`. You can find more configuration options on the [Chroma docs](https://docs.trychroma.com/docs/cli/run).
|
|
89
|
+
- Run on [Docker](https://docs.trychroma.com/guides/deploy/docker) using the official Chroma image.
|
|
90
|
+
- Deploy your own Chroma server on your provider of choice. Chroma offers example templates for [AWS](https://docs.trychroma.com/guides/deploy/aws), [Azure](https://docs.trychroma.com/guides/deploy/azure), and [GCP](https://docs.trychroma.com/guides/deploy/gcp).
|
|
87
91
|
|
|
88
92
|
## Methods
|
|
89
93
|
|
|
@@ -128,7 +132,7 @@ Note: Forking is only supported on Chroma Cloud, or if you deploy your own OSS *
|
|
|
128
132
|
name: "newIndexName",
|
|
129
133
|
type: "string",
|
|
130
134
|
description: "The name of the forked index",
|
|
131
|
-
}
|
|
135
|
+
},
|
|
132
136
|
]}
|
|
133
137
|
/>
|
|
134
138
|
|
|
@@ -251,7 +255,8 @@ You can also provide the shape of your metadata to a `get` call for type inferen
|
|
|
251
255
|
name: "ids",
|
|
252
256
|
type: "string[]",
|
|
253
257
|
isOptional: true,
|
|
254
|
-
description:
|
|
258
|
+
description:
|
|
259
|
+
"A list of record IDs to return. If not provided, all records are returned.",
|
|
255
260
|
},
|
|
256
261
|
{
|
|
257
262
|
name: "filter",
|
|
@@ -284,7 +289,8 @@ You can also provide the shape of your metadata to a `get` call for type inferen
|
|
|
284
289
|
type: "number",
|
|
285
290
|
isOptional: true,
|
|
286
291
|
defaultValue: 0,
|
|
287
|
-
description:
|
|
292
|
+
description:
|
|
293
|
+
"Offset for returning records. Use with `limit` to paginate results.",
|
|
288
294
|
},
|
|
289
295
|
]}
|
|
290
296
|
/>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Couchbase Vector Store |
|
|
2
|
+
title: "Reference: Couchbase Vector Store | Vectors | Mastra Docs"
|
|
3
3
|
description: Documentation for the CouchbaseVector class in Mastra, which provides vector search using Couchbase Vector Search.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -21,7 +21,7 @@ npm install @mastra/couchbase
|
|
|
21
21
|
## Usage Example
|
|
22
22
|
|
|
23
23
|
```typescript copy showLineNumbers
|
|
24
|
-
import { CouchbaseVector } from
|
|
24
|
+
import { CouchbaseVector } from "@mastra/couchbase";
|
|
25
25
|
|
|
26
26
|
const store = new CouchbaseVector({
|
|
27
27
|
connectionString: process.env.COUCHBASE_CONNECTION_STRING,
|
|
@@ -317,7 +317,7 @@ try {
|
|
|
317
317
|
// Handle specific error cases
|
|
318
318
|
if (error.message.includes("Invalid index name")) {
|
|
319
319
|
console.error(
|
|
320
|
-
"Index name must start with a letter or underscore and contain only valid characters."
|
|
320
|
+
"Index name must start with a letter or underscore and contain only valid characters.",
|
|
321
321
|
);
|
|
322
322
|
} else if (error.message.includes("Index not found")) {
|
|
323
323
|
console.error("The specified index does not exist");
|
|
@@ -342,4 +342,4 @@ try {
|
|
|
342
342
|
|
|
343
343
|
## Related
|
|
344
344
|
|
|
345
|
-
- [Metadata Filters](../rag/metadata-filters)
|
|
345
|
+
- [Metadata Filters](../rag/metadata-filters)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Lance Vector Store |
|
|
2
|
+
title: "Reference: Lance Vector Store | Vectors | Mastra Docs"
|
|
3
3
|
description: "Documentation for the LanceVectorStore class in Mastra, which provides vector search using LanceDB, an embedded vector database based on the Lance columnar format."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -21,8 +21,7 @@ The LanceVectorStore uses a factory pattern for creation. You should use the sta
|
|
|
21
21
|
{
|
|
22
22
|
name: "options",
|
|
23
23
|
type: "ConnectionOptions",
|
|
24
|
-
description:
|
|
25
|
-
"Additional connection options for LanceDB",
|
|
24
|
+
description: "Additional connection options for LanceDB",
|
|
26
25
|
isOptional: true,
|
|
27
26
|
},
|
|
28
27
|
]}
|
|
@@ -42,8 +41,8 @@ const vectorStore = await LanceVectorStore.create("/path/to/db");
|
|
|
42
41
|
const cloudStore = await LanceVectorStore.create("db://host:port");
|
|
43
42
|
|
|
44
43
|
// Connect to a cloud database with options
|
|
45
|
-
const s3Store = await LanceVectorStore.create("s3://bucket/db", {
|
|
46
|
-
storageOptions: { timeout:
|
|
44
|
+
const s3Store = await LanceVectorStore.create("s3://bucket/db", {
|
|
45
|
+
storageOptions: { timeout: "60s" },
|
|
47
46
|
});
|
|
48
47
|
```
|
|
49
48
|
|
|
@@ -448,4 +447,4 @@ try {
|
|
|
448
447
|
|
|
449
448
|
## Related
|
|
450
449
|
|
|
451
|
-
- [Metadata Filters](../rag/metadata-filters)
|
|
450
|
+
- [Metadata Filters](../rag/metadata-filters)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
2
|
+
title: "Reference: LibSQLVector Store | Vectors | Mastra Docs"
|
|
3
3
|
description: Documentation for the LibSQLVector class in Mastra, which provides vector search using LibSQL with vector extensions.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: MongoDB Vector Store |
|
|
2
|
+
title: "Reference: MongoDB Vector Store | Vectors | Mastra Docs"
|
|
3
3
|
description: Documentation for the MongoDBVector class in Mastra, which provides vector search using MongoDB Atlas and Atlas Vector Search.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: OpenSearch Vector Store |
|
|
2
|
+
title: "Reference: OpenSearch Vector Store | Vectors | Mastra Docs"
|
|
3
3
|
description: Documentation for the OpenSearchVector class in Mastra, which provides vector search using OpenSearch.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: PG Vector Store |
|
|
2
|
+
title: "Reference: PG Vector Store | Vectors | Mastra Docs"
|
|
3
3
|
description: Documentation for the PgVector class in Mastra, which provides vector search using PostgreSQL with pgvector extension.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -584,16 +584,18 @@ try {
|
|
|
584
584
|
### Performance Optimization
|
|
585
585
|
|
|
586
586
|
#### IVFFlat Tuning
|
|
587
|
+
|
|
587
588
|
- **lists parameter**: Set to `sqrt(n) * 2` where n is the number of vectors
|
|
588
589
|
- More lists = better accuracy but slower build time
|
|
589
590
|
- Fewer lists = faster build but potentially lower accuracy
|
|
590
591
|
|
|
591
592
|
#### HNSW Tuning
|
|
592
|
-
|
|
593
|
+
|
|
594
|
+
- **m parameter**:
|
|
593
595
|
- 8-16: Moderate accuracy, lower memory
|
|
594
596
|
- 16-32: High accuracy, moderate memory
|
|
595
597
|
- 32-64: Very high accuracy, high memory
|
|
596
|
-
- **efConstruction**:
|
|
598
|
+
- **efConstruction**:
|
|
597
599
|
- 32-64: Fast build, good quality
|
|
598
600
|
- 64-128: Slower build, better quality
|
|
599
601
|
- 128-256: Slowest build, best quality
|
|
@@ -601,6 +603,7 @@ try {
|
|
|
601
603
|
### Index Recreation Behavior
|
|
602
604
|
|
|
603
605
|
The system automatically detects configuration changes and only rebuilds indexes when necessary:
|
|
606
|
+
|
|
604
607
|
- Same configuration: Index is kept (no recreation)
|
|
605
608
|
- Changed configuration: Index is dropped and rebuilt
|
|
606
609
|
- This prevents the performance issues from unnecessary index recreations
|
|
@@ -617,10 +620,11 @@ The system automatically detects configuration changes and only rebuilds indexes
|
|
|
617
620
|
The `PgVector` class exposes its underlying PostgreSQL connection pool as a public field:
|
|
618
621
|
|
|
619
622
|
```typescript
|
|
620
|
-
pgVector.pool // instance of pg.Pool
|
|
623
|
+
pgVector.pool; // instance of pg.Pool
|
|
621
624
|
```
|
|
622
625
|
|
|
623
626
|
This enables advanced usage such as running direct SQL queries, managing transactions, or monitoring pool state. When using the pool directly:
|
|
627
|
+
|
|
624
628
|
- You are responsible for releasing clients (`client.release()`) after use.
|
|
625
629
|
- The pool remains accessible after calling `disconnect()`, but new queries will fail.
|
|
626
630
|
- Direct access bypasses any validation or transaction logic provided by PgVector methods.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Pinecone Vector Store |
|
|
2
|
+
title: "Reference: Pinecone Vector Store | Vectors | Mastra Docs"
|
|
3
3
|
description: Documentation for the PineconeVector class in Mastra, which provides an interface to Pinecone's vector database.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Qdrant Vector Store |
|
|
2
|
+
title: "Reference: Qdrant Vector Store | Vectors | Mastra Docs"
|
|
3
3
|
description: Documentation for integrating Qdrant with Mastra, a vector similarity search engine for managing vectors and payloads.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Amazon S3 Vectors Store |
|
|
2
|
+
title: "Reference: Amazon S3 Vectors Store | Vectors | Mastra Docs"
|
|
3
3
|
description: Documentation for the S3Vectors class in Mastra, which provides vector search using Amazon S3 Vectors (Preview).
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -47,7 +47,12 @@ const ids = await store.upsert({
|
|
|
47
47
|
[0.3, 0.4 /* … */],
|
|
48
48
|
],
|
|
49
49
|
metadata: [
|
|
50
|
-
{
|
|
50
|
+
{
|
|
51
|
+
text: "doc1",
|
|
52
|
+
genre: "documentary",
|
|
53
|
+
year: 2023,
|
|
54
|
+
createdAt: new Date("2024-01-01"),
|
|
55
|
+
},
|
|
51
56
|
{ text: "doc2", genre: "comedy", year: 2021 },
|
|
52
57
|
],
|
|
53
58
|
});
|
|
@@ -84,7 +89,8 @@ await store.disconnect();
|
|
|
84
89
|
name: "nonFilterableMetadataKeys",
|
|
85
90
|
type: "string[]",
|
|
86
91
|
isOptional: true,
|
|
87
|
-
description:
|
|
92
|
+
description:
|
|
93
|
+
"Metadata keys that should NOT be filterable (applied to the index at creation time). Use this for large text fields like `content`.",
|
|
88
94
|
},
|
|
89
95
|
]}
|
|
90
96
|
/>
|
|
@@ -100,7 +106,8 @@ Creates a new vector index in the configured vector bucket. If the index already
|
|
|
100
106
|
{
|
|
101
107
|
name: "indexName",
|
|
102
108
|
type: "string",
|
|
103
|
-
description:
|
|
109
|
+
description:
|
|
110
|
+
"Logical index name. Normalized internally: underscores are replaced with hyphens and the name is lowercased.",
|
|
104
111
|
},
|
|
105
112
|
{
|
|
106
113
|
name: "dimension",
|
|
@@ -112,7 +119,8 @@ Creates a new vector index in the configured vector bucket. If the index already
|
|
|
112
119
|
type: "'cosine' | 'euclidean'",
|
|
113
120
|
isOptional: true,
|
|
114
121
|
defaultValue: "cosine",
|
|
115
|
-
description:
|
|
122
|
+
description:
|
|
123
|
+
"Distance metric for similarity search. `dotproduct` is not supported by S3 Vectors.",
|
|
116
124
|
},
|
|
117
125
|
]}
|
|
118
126
|
/>
|
|
@@ -175,7 +183,8 @@ Searches for nearest neighbors with optional metadata filtering.
|
|
|
175
183
|
name: "filter",
|
|
176
184
|
type: "S3VectorsFilter",
|
|
177
185
|
isOptional: true,
|
|
178
|
-
description:
|
|
186
|
+
description:
|
|
187
|
+
"JSON-based metadata filter supporting `$and`, `$or`, `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`, `$in`, `$nin`, `$exists`.",
|
|
179
188
|
},
|
|
180
189
|
{
|
|
181
190
|
name: "includeVector",
|
|
@@ -187,7 +196,6 @@ Searches for nearest neighbors with optional metadata filtering.
|
|
|
187
196
|
]}
|
|
188
197
|
/>
|
|
189
198
|
|
|
190
|
-
|
|
191
199
|
> **Scoring:** Results include `score = 1/(1 + distance)` so that higher is better while preserving the underlying distance ranking.
|
|
192
200
|
|
|
193
201
|
### describeIndex()
|
|
@@ -310,20 +318,20 @@ interface QueryResult {
|
|
|
310
318
|
|
|
311
319
|
S3 Vectors supports a strict subset of operators and value types. The Mastra filter translator:
|
|
312
320
|
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
321
|
+
- **Canonicalizes implicit AND**: `{a:1,b:2}` → `{ $and: [{a:1},{b:2}] }`.
|
|
322
|
+
- **Normalizes Date values** to epoch ms for numeric comparisons and array elements.
|
|
323
|
+
- **Disallows Date** in equality positions (`field: value` or `$eq/$ne`); equality values must be **string | number | boolean**.
|
|
324
|
+
- **Rejects** null/undefined for equality; **array equality** is not supported (use `$in`/`$nin`).
|
|
325
|
+
- Only **`$and` / `$or`** are allowed as top-level logical operators.
|
|
326
|
+
- Logical operators must contain **field conditions** (not direct operators).
|
|
319
327
|
|
|
320
328
|
**Supported operators:**
|
|
321
329
|
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
330
|
+
- **Logical:** `$and`, `$or` (non-empty arrays)
|
|
331
|
+
- **Basic:** `$eq`, `$ne` (string | number | boolean)
|
|
332
|
+
- **Numeric:** `$gt`, `$gte`, `$lt`, `$lte` (number or `Date` → epoch ms)
|
|
333
|
+
- **Array:** `$in`, `$nin` (non-empty arrays of string | number | boolean; `Date` → epoch ms)
|
|
334
|
+
- **Element:** `$exists` (boolean)
|
|
327
335
|
|
|
328
336
|
**Unsupported / disallowed (rejected):** `$not`, `$nor`, `$regex`, `$all`, `$elemMatch`, `$size`, `$text`, etc.
|
|
329
337
|
|
|
@@ -369,18 +377,18 @@ try {
|
|
|
369
377
|
|
|
370
378
|
Typical environment variables when wiring your app:
|
|
371
379
|
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
380
|
+
- `S3_VECTORS_BUCKET_NAME`: Your S3 **vector bucket** name (used to populate `vectorBucketName`).
|
|
381
|
+
- `AWS_REGION`: AWS region for the S3 Vectors bucket.
|
|
382
|
+
- **AWS credentials**: via the standard AWS SDK provider chain (`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_PROFILE`, etc.).
|
|
375
383
|
|
|
376
384
|
## Best Practices
|
|
377
385
|
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
386
|
+
- Choose the metric (`cosine` or `euclidean`) to match your embedding model; `dotproduct` is not supported.
|
|
387
|
+
- Keep **filterable** metadata small and structured (string/number/boolean). Store large text (e.g., `content`) as **non-filterable**.
|
|
388
|
+
- Use **dotted paths** for nested metadata and explicit `$and`/`$or` for complex logic.
|
|
389
|
+
- Avoid calling `describeIndex()` on hot paths—`count` is computed with paginated `ListVectors` (**O(n)**).
|
|
390
|
+
- Use `includeVector: true` only when you need raw vectors.
|
|
383
391
|
|
|
384
392
|
## Related
|
|
385
393
|
|
|
386
|
-
|
|
394
|
+
- [Metadata Filters](../rag/metadata-filters)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Turbopuffer Vector Store |
|
|
2
|
+
title: "Reference: Turbopuffer Vector Store | Vectors | Mastra Docs"
|
|
3
3
|
description: Documentation for integrating Turbopuffer with Mastra, a high-performance vector database for efficient similarity search.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Upstash Vector Store |
|
|
2
|
+
title: "Reference: Upstash Vector Store | Vectors | Mastra Docs"
|
|
3
3
|
description: Documentation for the UpstashVector class in Mastra, which provides vector search using Upstash Vector.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -70,7 +70,8 @@ Note: This method is a no-op for Upstash as indexes are created automatically.
|
|
|
70
70
|
name: "sparseVectors",
|
|
71
71
|
type: "{ indices: number[], values: number[] }[]",
|
|
72
72
|
isOptional: true,
|
|
73
|
-
description:
|
|
73
|
+
description:
|
|
74
|
+
"Array of sparse vectors for hybrid search. Each sparse vector must have matching indices and values arrays.",
|
|
74
75
|
},
|
|
75
76
|
{
|
|
76
77
|
name: "metadata",
|
|
@@ -105,7 +106,8 @@ Note: This method is a no-op for Upstash as indexes are created automatically.
|
|
|
105
106
|
name: "sparseVector",
|
|
106
107
|
type: "{ indices: number[], values: number[] }",
|
|
107
108
|
isOptional: true,
|
|
108
|
-
description:
|
|
109
|
+
description:
|
|
110
|
+
"Optional sparse vector for hybrid search. Must have matching indices and values arrays.",
|
|
109
111
|
},
|
|
110
112
|
{
|
|
111
113
|
name: "topK",
|
|
@@ -131,13 +133,15 @@ Note: This method is a no-op for Upstash as indexes are created automatically.
|
|
|
131
133
|
name: "fusionAlgorithm",
|
|
132
134
|
type: "FusionAlgorithm",
|
|
133
135
|
isOptional: true,
|
|
134
|
-
description:
|
|
136
|
+
description:
|
|
137
|
+
"Algorithm used to combine dense and sparse search results in hybrid search (e.g., RRF - Reciprocal Rank Fusion)",
|
|
135
138
|
},
|
|
136
139
|
{
|
|
137
140
|
name: "queryMode",
|
|
138
141
|
type: "QueryMode",
|
|
139
142
|
isOptional: true,
|
|
140
|
-
description:
|
|
143
|
+
description:
|
|
144
|
+
"Search mode: 'DENSE' for dense-only, 'SPARSE' for sparse-only, or 'HYBRID' for combined search",
|
|
141
145
|
},
|
|
142
146
|
]}
|
|
143
147
|
/>
|
|
@@ -197,7 +201,8 @@ interface IndexStats {
|
|
|
197
201
|
{
|
|
198
202
|
name: "update",
|
|
199
203
|
type: "object",
|
|
200
|
-
description:
|
|
204
|
+
description:
|
|
205
|
+
"Update object containing vector, sparse vector, and/or metadata",
|
|
201
206
|
},
|
|
202
207
|
]}
|
|
203
208
|
/>
|
|
@@ -234,65 +239,68 @@ Upstash Vector supports hybrid search that combines semantic search (dense vecto
|
|
|
234
239
|
### Basic Hybrid Usage
|
|
235
240
|
|
|
236
241
|
```typescript copy
|
|
237
|
-
import { UpstashVector } from
|
|
242
|
+
import { UpstashVector } from "@mastra/upstash";
|
|
238
243
|
|
|
239
244
|
const vectorStore = new UpstashVector({
|
|
240
245
|
url: process.env.UPSTASH_VECTOR_URL,
|
|
241
|
-
token: process.env.UPSTASH_VECTOR_TOKEN
|
|
246
|
+
token: process.env.UPSTASH_VECTOR_TOKEN,
|
|
242
247
|
});
|
|
243
248
|
|
|
244
249
|
// Upsert vectors with both dense and sparse components
|
|
245
|
-
const denseVectors = [
|
|
250
|
+
const denseVectors = [
|
|
251
|
+
[0.1, 0.2, 0.3],
|
|
252
|
+
[0.4, 0.5, 0.6],
|
|
253
|
+
];
|
|
246
254
|
const sparseVectors = [
|
|
247
255
|
{ indices: [1, 5, 10], values: [0.8, 0.6, 0.4] },
|
|
248
|
-
{ indices: [2, 6, 11], values: [0.7, 0.5, 0.3] }
|
|
256
|
+
{ indices: [2, 6, 11], values: [0.7, 0.5, 0.3] },
|
|
249
257
|
];
|
|
250
258
|
|
|
251
259
|
await vectorStore.upsert({
|
|
252
|
-
indexName:
|
|
260
|
+
indexName: "hybrid-index",
|
|
253
261
|
vectors: denseVectors,
|
|
254
262
|
sparseVectors: sparseVectors,
|
|
255
|
-
metadata: [{ title:
|
|
263
|
+
metadata: [{ title: "Document 1" }, { title: "Document 2" }],
|
|
256
264
|
});
|
|
257
265
|
|
|
258
266
|
// Query with hybrid search
|
|
259
267
|
const results = await vectorStore.query({
|
|
260
|
-
indexName:
|
|
268
|
+
indexName: "hybrid-index",
|
|
261
269
|
queryVector: [0.1, 0.2, 0.3],
|
|
262
270
|
sparseVector: { indices: [1, 5], values: [0.9, 0.7] },
|
|
263
|
-
topK: 10
|
|
271
|
+
topK: 10,
|
|
264
272
|
});
|
|
265
273
|
```
|
|
266
274
|
|
|
267
275
|
### Advanced Hybrid Search Options
|
|
268
276
|
|
|
269
277
|
```typescript copy
|
|
270
|
-
import { FusionAlgorithm, QueryMode } from
|
|
278
|
+
import { FusionAlgorithm, QueryMode } from "@upstash/vector";
|
|
271
279
|
|
|
272
280
|
// Query with specific fusion algorithm
|
|
273
281
|
const fusionResults = await vectorStore.query({
|
|
274
|
-
indexName:
|
|
282
|
+
indexName: "hybrid-index",
|
|
275
283
|
queryVector: [0.1, 0.2, 0.3],
|
|
276
284
|
sparseVector: { indices: [1, 5], values: [0.9, 0.7] },
|
|
277
285
|
fusionAlgorithm: FusionAlgorithm.RRF,
|
|
278
|
-
topK: 10
|
|
286
|
+
topK: 10,
|
|
279
287
|
});
|
|
280
288
|
|
|
281
289
|
// Dense-only search
|
|
282
290
|
const denseResults = await vectorStore.query({
|
|
283
|
-
indexName:
|
|
291
|
+
indexName: "hybrid-index",
|
|
284
292
|
queryVector: [0.1, 0.2, 0.3],
|
|
285
293
|
queryMode: QueryMode.DENSE,
|
|
286
|
-
topK: 10
|
|
294
|
+
topK: 10,
|
|
287
295
|
});
|
|
288
296
|
|
|
289
297
|
// Sparse-only search
|
|
290
298
|
const sparseResults = await vectorStore.query({
|
|
291
|
-
indexName:
|
|
299
|
+
indexName: "hybrid-index",
|
|
292
300
|
queryVector: [0.1, 0.2, 0.3], // Still required for index structure
|
|
293
301
|
sparseVector: { indices: [1, 5], values: [0.9, 0.7] },
|
|
294
302
|
queryMode: QueryMode.SPARSE,
|
|
295
|
-
topK: 10
|
|
303
|
+
topK: 10,
|
|
296
304
|
});
|
|
297
305
|
```
|
|
298
306
|
|
|
@@ -301,13 +309,13 @@ const sparseResults = await vectorStore.query({
|
|
|
301
309
|
```typescript copy
|
|
302
310
|
// Update both dense and sparse components
|
|
303
311
|
await vectorStore.updateVector({
|
|
304
|
-
indexName:
|
|
305
|
-
id:
|
|
312
|
+
indexName: "hybrid-index",
|
|
313
|
+
id: "vector-id",
|
|
306
314
|
update: {
|
|
307
315
|
vector: [0.2, 0.3, 0.4],
|
|
308
316
|
sparseVector: { indices: [2, 7, 12], values: [0.9, 0.8, 0.6] },
|
|
309
|
-
metadata: { title:
|
|
310
|
-
}
|
|
317
|
+
metadata: { title: "Updated Document" },
|
|
318
|
+
},
|
|
311
319
|
});
|
|
312
320
|
```
|
|
313
321
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Cloudflare Vector Store |
|
|
2
|
+
title: "Reference: Cloudflare Vector Store | Vectors | Mastra Docs"
|
|
3
3
|
description: Documentation for the CloudflareVector class in Mastra, which provides vector search using Cloudflare Vectorize.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Azure
|
|
2
|
+
title: "Reference: Azure | Voice | Mastra Docs"
|
|
3
3
|
description: "Documentation for the AzureVoice class, providing text-to-speech and speech-to-text capabilities using Azure Cognitive Services."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: CompositeVoice | Voice
|
|
2
|
+
title: "Reference: CompositeVoice | Voice | Mastra Docs"
|
|
3
3
|
description: "Documentation for the CompositeVoice class, which enables combining multiple voice providers for flexible text-to-speech and speech-to-text operations."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Deepgram
|
|
2
|
+
title: "Reference: Deepgram | Voice | Mastra Docs"
|
|
3
3
|
description: "Documentation for the Deepgram voice implementation, providing text-to-speech and speech-to-text capabilities with multiple voice models and languages."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: ElevenLabs
|
|
2
|
+
title: "Reference: ElevenLabs | Voice | Mastra Docs"
|
|
3
3
|
description: "Documentation for the ElevenLabs voice implementation, offering high-quality text-to-speech capabilities with multiple voice models and natural-sounding synthesis."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference: Google Gemini Live Voice | Voice
|
|
2
|
+
title: "Reference: Google Gemini Live Voice | Voice | Mastra Docs"
|
|
3
3
|
description: "Documentation for the GeminiLiveVoice class, providing real-time multimodal voice interactions using Google's Gemini Live API with support for both Gemini API and Vertex AI."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -161,7 +161,8 @@ voice.close();
|
|
|
161
161
|
{
|
|
162
162
|
name: "sessionConfig",
|
|
163
163
|
type: "GeminiSessionConfig",
|
|
164
|
-
description:
|
|
164
|
+
description:
|
|
165
|
+
"Session configuration including interrupt and context settings.",
|
|
165
166
|
isOptional: true,
|
|
166
167
|
},
|
|
167
168
|
{
|
|
@@ -219,7 +220,7 @@ Establishes a connection to the Gemini Live API. Must be called before using spe
|
|
|
219
220
|
{
|
|
220
221
|
name: "runtimeContext",
|
|
221
222
|
type: "object",
|
|
222
|
-
description: "Optional
|
|
223
|
+
description: "Optional request context for the connection.",
|
|
223
224
|
isOptional: true,
|
|
224
225
|
},
|
|
225
226
|
{
|
|
@@ -506,7 +507,8 @@ The GeminiLiveVoice class emits the following events:
|
|
|
506
507
|
description:
|
|
507
508
|
"Interrupt events. Callback receives { type: 'user' | 'model', timestamp: number }.",
|
|
508
509
|
},
|
|
509
|
-
|
|
510
|
+
|
|
511
|
+
]}
|
|
510
512
|
/>
|
|
511
513
|
|
|
512
514
|
## Available Models
|
|
@@ -598,7 +600,7 @@ const voice = new GeminiLiveVoice({
|
|
|
598
600
|
Enable the model to call functions during conversations:
|
|
599
601
|
|
|
600
602
|
```typescript
|
|
601
|
-
import { z } from
|
|
603
|
+
import { z } from "zod";
|
|
602
604
|
|
|
603
605
|
voice.addTools({
|
|
604
606
|
weather: {
|