@mastra/mcp-docs-server 1.0.0-beta.13 → 1.0.0-beta.15
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/%40mastra%2Fagent-builder.md +27 -27
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +78 -78
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +195 -195
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +173 -173
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +195 -195
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +195 -195
- package/.docs/organized/changelogs/%40mastra%2Fconvex.md +248 -0
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +338 -338
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +33 -33
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +41 -41
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +195 -195
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +6 -0
- package/.docs/organized/changelogs/%40mastra%2Flance.md +195 -195
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +195 -195
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +139 -139
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +219 -219
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +219 -219
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +235 -235
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +102 -102
- package/.docs/organized/changelogs/%40mastra%2Frag.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Freact.md +77 -70
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +218 -218
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +195 -195
- package/.docs/organized/changelogs/create-mastra.md +13 -13
- package/.docs/organized/changelogs/mastra.md +56 -56
- package/.docs/organized/code-examples/agent-v6.md +210 -0
- package/.docs/organized/code-examples/ai-elements.md +1 -1
- package/.docs/organized/code-examples/client-side-tools.md +1 -1
- package/.docs/raw/agents/adding-voice.mdx +10 -6
- package/.docs/raw/agents/agent-approval.mdx +5 -6
- package/.docs/raw/agents/agent-memory.mdx +22 -30
- package/.docs/raw/agents/guardrails.mdx +60 -50
- package/.docs/raw/agents/networks.mdx +8 -12
- package/.docs/raw/agents/overview.mdx +39 -23
- package/.docs/raw/agents/processors.mdx +20 -19
- package/.docs/raw/agents/structured-output.mdx +11 -7
- package/.docs/raw/agents/using-tools.mdx +4 -5
- package/.docs/raw/deployment/mastra-server.mdx +3 -3
- package/.docs/raw/deployment/overview.mdx +7 -1
- package/.docs/raw/deployment/web-framework.mdx +4 -6
- package/.docs/raw/deployment/workflow-runners.mdx +14 -0
- package/.docs/raw/evals/custom-scorers.mdx +9 -6
- package/.docs/raw/evals/overview.mdx +3 -6
- package/.docs/raw/evals/running-in-ci.mdx +2 -2
- package/.docs/raw/getting-started/manual-install.mdx +20 -20
- package/.docs/raw/getting-started/mcp-docs-server.mdx +2 -2
- package/.docs/raw/getting-started/studio.mdx +1 -1
- package/.docs/raw/guides/agent-frameworks/ai-sdk.mdx +4 -4
- package/.docs/raw/guides/build-your-ui/ai-sdk-ui.mdx +30 -30
- package/.docs/raw/guides/build-your-ui/assistant-ui.mdx +8 -8
- package/.docs/raw/guides/build-your-ui/copilotkit.mdx +11 -11
- package/.docs/raw/guides/deployment/amazon-ec2.mdx +9 -9
- package/.docs/raw/guides/deployment/aws-lambda.mdx +11 -11
- package/.docs/raw/guides/deployment/azure-app-services.mdx +2 -2
- package/.docs/raw/guides/deployment/cloudflare-deployer.mdx +5 -6
- package/.docs/raw/guides/deployment/digital-ocean.mdx +10 -10
- package/.docs/raw/guides/deployment/index.mdx +1 -1
- package/.docs/raw/guides/deployment/inngest.mdx +444 -0
- package/.docs/raw/guides/deployment/netlify-deployer.mdx +4 -4
- package/.docs/raw/guides/deployment/vercel-deployer.mdx +5 -6
- package/.docs/raw/guides/getting-started/astro.mdx +292 -451
- package/.docs/raw/guides/getting-started/express.mdx +7 -7
- package/.docs/raw/guides/getting-started/hono.mdx +18 -18
- package/.docs/raw/guides/getting-started/next-js.mdx +19 -20
- package/.docs/raw/guides/getting-started/quickstart.mdx +4 -4
- package/.docs/raw/guides/getting-started/sveltekit.mdx +238 -409
- package/.docs/raw/guides/getting-started/vite-react.mdx +21 -21
- package/.docs/raw/guides/guide/ai-recruiter.mdx +10 -10
- package/.docs/raw/guides/guide/chef-michel.mdx +9 -11
- package/.docs/raw/guides/guide/notes-mcp-server.mdx +15 -15
- package/.docs/raw/guides/guide/research-assistant.mdx +13 -13
- package/.docs/raw/guides/guide/stock-agent.mdx +5 -5
- package/.docs/raw/guides/guide/web-search.mdx +8 -8
- package/.docs/raw/guides/guide/whatsapp-chat-bot.mdx +7 -7
- package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +2 -2
- package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +1 -1
- package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +11 -3
- package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +11 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +41 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +0 -2
- package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +21 -23
- package/.docs/raw/index.mdx +2 -2
- package/.docs/raw/mastra-cloud/deployment.mdx +39 -0
- package/.docs/raw/mastra-cloud/observability.mdx +9 -15
- package/.docs/raw/mastra-cloud/overview.mdx +14 -44
- package/.docs/raw/mastra-cloud/setup.mdx +64 -0
- package/.docs/raw/mastra-cloud/studio.mdx +35 -0
- package/.docs/raw/mcp/overview.mdx +31 -13
- package/.docs/raw/mcp/publishing-mcp-server.mdx +2 -2
- package/.docs/raw/memory/memory-processors.mdx +9 -9
- package/.docs/raw/memory/message-history.mdx +69 -0
- package/.docs/raw/memory/overview.mdx +34 -76
- package/.docs/raw/memory/semantic-recall.mdx +58 -49
- package/.docs/raw/memory/storage.mdx +188 -0
- package/.docs/raw/memory/working-memory.mdx +7 -7
- package/.docs/raw/observability/logging.mdx +9 -10
- package/.docs/raw/observability/overview.mdx +0 -1
- package/.docs/raw/observability/tracing/bridges/otel.mdx +2 -2
- package/.docs/raw/observability/tracing/exporters/default.mdx +3 -3
- package/.docs/raw/observability/tracing/exporters/langfuse.mdx +1 -2
- package/.docs/raw/observability/tracing/overview.mdx +23 -25
- package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +3 -3
- package/.docs/raw/rag/chunking-and-embedding.mdx +6 -6
- package/.docs/raw/rag/graph-rag.mdx +7 -7
- package/.docs/raw/rag/overview.mdx +1 -1
- package/.docs/raw/rag/retrieval.mdx +21 -22
- package/.docs/raw/rag/vector-databases.mdx +22 -22
- package/.docs/raw/reference/agents/agent.mdx +3 -3
- package/.docs/raw/reference/agents/generate.mdx +1 -1
- package/.docs/raw/reference/agents/generateLegacy.mdx +2 -2
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +2 -2
- package/.docs/raw/reference/agents/getDefaultOptions.mdx +2 -2
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +2 -2
- package/.docs/raw/reference/agents/getDescription.mdx +1 -1
- package/.docs/raw/reference/agents/getInstructions.mdx +2 -2
- package/.docs/raw/reference/agents/getLLM.mdx +2 -2
- package/.docs/raw/reference/agents/getMemory.mdx +2 -2
- package/.docs/raw/reference/agents/getModel.mdx +2 -2
- package/.docs/raw/reference/agents/getTools.mdx +2 -2
- package/.docs/raw/reference/agents/getVoice.mdx +2 -2
- package/.docs/raw/reference/agents/listAgents.mdx +2 -2
- package/.docs/raw/reference/agents/listScorers.mdx +2 -2
- package/.docs/raw/reference/agents/listTools.mdx +2 -2
- package/.docs/raw/reference/agents/listWorkflows.mdx +2 -2
- package/.docs/raw/reference/agents/network.mdx +1 -1
- package/.docs/raw/reference/ai-sdk/chat-route.mdx +2 -2
- package/.docs/raw/reference/ai-sdk/handle-chat-stream.mdx +1 -1
- package/.docs/raw/reference/ai-sdk/handle-network-stream.mdx +1 -1
- package/.docs/raw/reference/ai-sdk/handle-workflow-stream.mdx +1 -1
- package/.docs/raw/reference/ai-sdk/network-route.mdx +2 -2
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-stream.mdx +6 -6
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-v4-messages.mdx +3 -3
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-v5-messages.mdx +3 -3
- package/.docs/raw/reference/ai-sdk/with-mastra.mdx +1 -1
- package/.docs/raw/reference/ai-sdk/workflow-route.mdx +2 -2
- package/.docs/raw/reference/auth/auth0.mdx +1 -2
- package/.docs/raw/reference/auth/clerk.mdx +1 -2
- package/.docs/raw/reference/auth/firebase.mdx +2 -4
- package/.docs/raw/reference/auth/jwt.mdx +1 -2
- package/.docs/raw/reference/auth/supabase.mdx +1 -2
- package/.docs/raw/reference/auth/workos.mdx +1 -2
- package/.docs/raw/reference/cli/create-mastra.mdx +10 -10
- package/.docs/raw/reference/cli/mastra.mdx +9 -9
- package/.docs/raw/reference/client-js/agents.mdx +1 -2
- package/.docs/raw/reference/client-js/mastra-client.mdx +1 -1
- package/.docs/raw/reference/core/getAgent.mdx +1 -1
- package/.docs/raw/reference/core/getAgentById.mdx +1 -1
- package/.docs/raw/reference/core/getDeployer.mdx +1 -1
- package/.docs/raw/reference/core/getLogger.mdx +1 -1
- package/.docs/raw/reference/core/getMCPServer.mdx +1 -1
- package/.docs/raw/reference/core/getMCPServerById.mdx +1 -1
- package/.docs/raw/reference/core/getMemory.mdx +2 -2
- package/.docs/raw/reference/core/getServer.mdx +1 -1
- package/.docs/raw/reference/core/getStorage.mdx +2 -2
- package/.docs/raw/reference/core/getStoredAgentById.mdx +3 -3
- package/.docs/raw/reference/core/getTelemetry.mdx +1 -1
- package/.docs/raw/reference/core/getVector.mdx +1 -1
- package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
- package/.docs/raw/reference/core/listAgents.mdx +1 -1
- package/.docs/raw/reference/core/listLogs.mdx +1 -1
- package/.docs/raw/reference/core/listLogsByRunId.mdx +1 -1
- package/.docs/raw/reference/core/listMCPServers.mdx +1 -1
- package/.docs/raw/reference/core/listMemory.mdx +2 -2
- package/.docs/raw/reference/core/listStoredAgents.mdx +4 -4
- package/.docs/raw/reference/core/listVectors.mdx +1 -1
- package/.docs/raw/reference/core/listWorkflows.mdx +1 -1
- package/.docs/raw/reference/core/setLogger.mdx +1 -1
- package/.docs/raw/reference/core/setStorage.mdx +2 -2
- package/.docs/raw/reference/core/setTelemetry.mdx +1 -1
- package/.docs/raw/reference/deployer/cloudflare.mdx +1 -2
- package/.docs/raw/reference/deployer/deployer.mdx +0 -1
- package/.docs/raw/reference/deployer/netlify.mdx +1 -1
- package/.docs/raw/reference/deployer/vercel.mdx +2 -4
- package/.docs/raw/reference/evals/answer-relevancy.mdx +1 -1
- package/.docs/raw/reference/evals/answer-similarity.mdx +1 -1
- package/.docs/raw/reference/evals/bias.mdx +1 -1
- package/.docs/raw/reference/evals/completeness.mdx +1 -1
- package/.docs/raw/reference/evals/content-similarity.mdx +1 -1
- package/.docs/raw/reference/evals/context-precision.mdx +1 -1
- package/.docs/raw/reference/evals/faithfulness.mdx +1 -1
- package/.docs/raw/reference/evals/hallucination.mdx +1 -1
- package/.docs/raw/reference/evals/keyword-coverage.mdx +1 -1
- package/.docs/raw/reference/evals/prompt-alignment.mdx +7 -7
- package/.docs/raw/reference/evals/textual-difference.mdx +1 -1
- package/.docs/raw/reference/evals/tone-consistency.mdx +1 -1
- package/.docs/raw/reference/evals/tool-call-accuracy.mdx +10 -10
- package/.docs/raw/reference/evals/toxicity.mdx +1 -1
- package/.docs/raw/reference/logging/pino-logger.mdx +7 -8
- package/.docs/raw/reference/memory/createThread.mdx +2 -2
- package/.docs/raw/reference/memory/deleteMessages.mdx +2 -2
- package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +2 -2
- package/.docs/raw/reference/memory/memory-class.mdx +3 -3
- package/.docs/raw/reference/memory/query.mdx +2 -2
- package/.docs/raw/reference/memory/recall.mdx +2 -2
- package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +1 -1
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +2 -2
- package/.docs/raw/reference/processors/language-detector.mdx +2 -2
- package/.docs/raw/reference/processors/message-history-processor.mdx +2 -2
- package/.docs/raw/reference/processors/moderation-processor.mdx +3 -3
- package/.docs/raw/reference/processors/pii-detector.mdx +3 -3
- package/.docs/raw/reference/processors/processor-interface.mdx +13 -13
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +2 -2
- package/.docs/raw/reference/processors/semantic-recall-processor.mdx +2 -2
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +2 -2
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +40 -19
- package/.docs/raw/reference/processors/tool-call-filter.mdx +3 -3
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +2 -2
- package/.docs/raw/reference/processors/working-memory-processor.mdx +3 -3
- package/.docs/raw/reference/rag/chunk.mdx +1 -1
- package/.docs/raw/reference/rag/extract-params.mdx +2 -2
- package/.docs/raw/reference/rag/metadata-filters.mdx +7 -7
- package/.docs/raw/reference/server/create-route.mdx +13 -13
- package/.docs/raw/reference/server/express-adapter.mdx +6 -7
- package/.docs/raw/reference/server/hono-adapter.mdx +6 -7
- package/.docs/raw/reference/server/mastra-server.mdx +20 -20
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +7 -5
- package/.docs/raw/reference/storage/cloudflare.mdx +2 -2
- package/.docs/raw/reference/storage/convex.mdx +6 -6
- package/.docs/raw/reference/storage/dynamodb.mdx +4 -4
- package/.docs/raw/reference/storage/lance.mdx +6 -5
- package/.docs/raw/reference/storage/libsql.mdx +72 -54
- package/.docs/raw/reference/storage/mongodb.mdx +84 -9
- package/.docs/raw/reference/storage/mssql.mdx +8 -6
- package/.docs/raw/{memory → reference}/storage/overview.mdx +12 -110
- package/.docs/raw/reference/storage/postgresql.mdx +82 -9
- package/.docs/raw/reference/storage/upstash.mdx +74 -2
- package/.docs/raw/reference/streaming/agents/stream.mdx +5 -5
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +2 -2
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +1 -1
- package/.docs/raw/reference/streaming/workflows/resumeStream.mdx +1 -1
- package/.docs/raw/reference/streaming/workflows/stream.mdx +2 -2
- package/.docs/raw/reference/streaming/workflows/timeTravelStream.mdx +4 -4
- package/.docs/raw/reference/templates/overview.mdx +1 -2
- package/.docs/raw/reference/tools/create-tool.mdx +1 -4
- package/.docs/raw/reference/tools/vector-query-tool.mdx +1 -1
- package/.docs/raw/reference/vectors/astra.mdx +3 -3
- package/.docs/raw/reference/vectors/chroma.mdx +3 -3
- package/.docs/raw/reference/vectors/convex.mdx +12 -12
- package/.docs/raw/reference/vectors/couchbase.mdx +5 -5
- package/.docs/raw/reference/vectors/duckdb.mdx +10 -10
- package/.docs/raw/reference/vectors/elasticsearch.mdx +4 -4
- package/.docs/raw/reference/vectors/lance.mdx +4 -4
- package/.docs/raw/reference/vectors/libsql.mdx +61 -11
- package/.docs/raw/reference/vectors/mongodb.mdx +58 -5
- package/.docs/raw/reference/vectors/pg.mdx +53 -6
- package/.docs/raw/reference/vectors/pinecone.mdx +3 -3
- package/.docs/raw/reference/vectors/qdrant.mdx +3 -3
- package/.docs/raw/reference/vectors/s3vectors.mdx +6 -6
- package/.docs/raw/reference/vectors/turbopuffer.mdx +4 -4
- package/.docs/raw/reference/vectors/upstash.mdx +55 -6
- package/.docs/raw/reference/vectors/vectorize.mdx +3 -3
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +2 -2
- package/.docs/raw/reference/workflows/run-methods/restart.mdx +1 -3
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +2 -2
- package/.docs/raw/reference/workflows/run-methods/start.mdx +2 -2
- package/.docs/raw/reference/workflows/run-methods/startAsync.mdx +2 -2
- package/.docs/raw/reference/workflows/run-methods/timeTravel.mdx +5 -5
- package/.docs/raw/reference/workflows/run.mdx +1 -1
- package/.docs/raw/reference/workflows/step.mdx +3 -3
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +3 -3
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +6 -6
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +7 -7
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow.mdx +3 -3
- package/.docs/raw/server/auth/auth0.mdx +20 -14
- package/.docs/raw/server/auth/clerk.mdx +16 -9
- package/.docs/raw/server/auth/firebase.mdx +21 -15
- package/.docs/raw/server/auth/jwt.mdx +14 -7
- package/.docs/raw/server/auth/supabase.mdx +16 -9
- package/.docs/raw/server/auth/workos.mdx +19 -13
- package/.docs/raw/server/custom-adapters.mdx +10 -10
- package/.docs/raw/server/custom-api-routes.mdx +2 -4
- package/.docs/raw/server/mastra-client.mdx +24 -13
- package/.docs/raw/server/mastra-server.mdx +3 -3
- package/.docs/raw/server/middleware.mdx +7 -7
- package/.docs/raw/server/request-context.mdx +31 -30
- package/.docs/raw/server/server-adapters.mdx +6 -6
- package/.docs/raw/streaming/events.mdx +14 -7
- package/.docs/raw/streaming/overview.mdx +21 -10
- package/.docs/raw/streaming/tool-streaming.mdx +6 -6
- package/.docs/raw/streaming/workflow-streaming.mdx +6 -8
- package/.docs/raw/tools-mcp/advanced-usage.mdx +2 -2
- package/.docs/raw/tools-mcp/mcp-overview.mdx +31 -12
- package/.docs/raw/tools-mcp/overview.mdx +9 -10
- package/.docs/raw/voice/overview.mdx +2 -2
- package/.docs/raw/workflows/agents-and-tools.mdx +28 -19
- package/.docs/raw/workflows/control-flow.mdx +27 -40
- package/.docs/raw/workflows/error-handling.mdx +15 -22
- package/.docs/raw/workflows/human-in-the-loop.mdx +6 -7
- package/.docs/raw/workflows/input-data-mapping.mdx +7 -7
- package/.docs/raw/workflows/overview.mdx +34 -23
- package/.docs/raw/workflows/snapshots.mdx +16 -45
- package/.docs/raw/workflows/suspend-and-resume.mdx +7 -7
- package/.docs/raw/workflows/time-travel.mdx +16 -16
- package/.docs/raw/workflows/workflow-state.mdx +5 -8
- package/CHANGELOG.md +16 -0
- package/dist/logger.d.ts +3 -0
- package/dist/logger.d.ts.map +1 -1
- package/dist/stdio.js +53 -0
- package/package.json +3 -3
- package/.docs/raw/mastra-cloud/dashboard.mdx +0 -96
- package/.docs/raw/mastra-cloud/setting-up.mdx +0 -102
- package/.docs/raw/memory/conversation-history.mdx +0 -24
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +0 -140
- package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -150
- package/.docs/raw/memory/storage/memory-with-pg.mdx +0 -138
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +0 -146
- package/.docs/raw/memory/threads-and-resources.mdx +0 -95
- package/.docs/raw/workflows/inngest-workflow.mdx +0 -363
|
@@ -15,7 +15,7 @@ After generating embeddings, you need to store them in a database that supports
|
|
|
15
15
|
<Tabs>
|
|
16
16
|
<TabItem value="mongodb" label="MongoDB">
|
|
17
17
|
|
|
18
|
-
```ts title="vector-store.ts"
|
|
18
|
+
```ts title="vector-store.ts"
|
|
19
19
|
import { MongoDBVector } from "@mastra/mongodb";
|
|
20
20
|
|
|
21
21
|
const store = new MongoDBVector({
|
|
@@ -41,7 +41,7 @@ For detailed setup instructions and best practices, see the [official MongoDB At
|
|
|
41
41
|
|
|
42
42
|
<TabItem value="pg-vector" label="PgVector">
|
|
43
43
|
|
|
44
|
-
```ts title="vector-store.ts"
|
|
44
|
+
```ts title="vector-store.ts"
|
|
45
45
|
import { PgVector } from "@mastra/pg";
|
|
46
46
|
|
|
47
47
|
const store = new PgVector({
|
|
@@ -70,7 +70,7 @@ For detailed setup instructions and best practices, see the [official pgvector r
|
|
|
70
70
|
|
|
71
71
|
<TabItem value="pinecone" label="Pinecone">
|
|
72
72
|
|
|
73
|
-
```ts title="vector-store.ts"
|
|
73
|
+
```ts title="vector-store.ts"
|
|
74
74
|
import { PineconeVector } from "@mastra/pinecone";
|
|
75
75
|
|
|
76
76
|
const store = new PineconeVector({
|
|
@@ -92,7 +92,7 @@ await store.upsert({
|
|
|
92
92
|
|
|
93
93
|
<TabItem value="qdrant" label="Qdrant">
|
|
94
94
|
|
|
95
|
-
```ts title="vector-store.ts"
|
|
95
|
+
```ts title="vector-store.ts"
|
|
96
96
|
import { QdrantVector } from "@mastra/qdrant";
|
|
97
97
|
|
|
98
98
|
const store = new QdrantVector({
|
|
@@ -117,7 +117,7 @@ await store.upsert({
|
|
|
117
117
|
|
|
118
118
|
<TabItem value="chroma" label="Chroma">
|
|
119
119
|
|
|
120
|
-
```ts title="vector-store.ts"
|
|
120
|
+
```ts title="vector-store.ts"
|
|
121
121
|
import { ChromaVector } from "@mastra/chroma";
|
|
122
122
|
|
|
123
123
|
// Running Chroma locally
|
|
@@ -147,7 +147,7 @@ await store.upsert({
|
|
|
147
147
|
|
|
148
148
|
<TabItem value="astra" label="Astra">
|
|
149
149
|
|
|
150
|
-
```ts title="vector-store.ts"
|
|
150
|
+
```ts title="vector-store.ts"
|
|
151
151
|
import { AstraVector } from "@mastra/astra";
|
|
152
152
|
|
|
153
153
|
const store = new AstraVector({
|
|
@@ -170,9 +170,9 @@ await store.upsert({
|
|
|
170
170
|
|
|
171
171
|
</TabItem>
|
|
172
172
|
|
|
173
|
-
<TabItem value="libsql" label="
|
|
173
|
+
<TabItem value="libsql" label="libSQL">
|
|
174
174
|
|
|
175
|
-
```ts title="vector-store.ts"
|
|
175
|
+
```ts title="vector-store.ts"
|
|
176
176
|
import { LibSQLVector } from "@mastra/core/vector/libsql";
|
|
177
177
|
|
|
178
178
|
const store = new LibSQLVector({
|
|
@@ -197,7 +197,7 @@ await store.upsert({
|
|
|
197
197
|
|
|
198
198
|
<TabItem value="upstash" label="Upstash">
|
|
199
199
|
|
|
200
|
-
```ts title="vector-store.ts"
|
|
200
|
+
```ts title="vector-store.ts"
|
|
201
201
|
import { UpstashVector } from "@mastra/upstash";
|
|
202
202
|
|
|
203
203
|
// In upstash they refer to the store as an index
|
|
@@ -220,7 +220,7 @@ await store.upsert({
|
|
|
220
220
|
|
|
221
221
|
<TabItem value="cloudflare" label="Cloudflare">
|
|
222
222
|
|
|
223
|
-
```ts title="vector-store.ts"
|
|
223
|
+
```ts title="vector-store.ts"
|
|
224
224
|
import { CloudflareVector } from "@mastra/vectorize";
|
|
225
225
|
|
|
226
226
|
const store = new CloudflareVector({
|
|
@@ -242,7 +242,7 @@ await store.upsert({
|
|
|
242
242
|
|
|
243
243
|
<TabItem value="opensearch" label="OpenSearch">
|
|
244
244
|
|
|
245
|
-
```ts title="vector-store.ts"
|
|
245
|
+
```ts title="vector-store.ts"
|
|
246
246
|
import { OpenSearchVector } from "@mastra/opensearch";
|
|
247
247
|
|
|
248
248
|
const store = new OpenSearchVector({ url: process.env.OPENSEARCH_URL });
|
|
@@ -263,7 +263,7 @@ await store.upsert({
|
|
|
263
263
|
|
|
264
264
|
<TabItem value="elasticsearch" label="ElasticSearch">
|
|
265
265
|
|
|
266
|
-
```ts title="vector-store.ts"
|
|
266
|
+
```ts title="vector-store.ts"
|
|
267
267
|
import { ElasticSearchVector } from "@mastra/elasticsearch";
|
|
268
268
|
|
|
269
269
|
const store = new ElasticSearchVector({ url: process.env.ELASTICSEARCH_URL });
|
|
@@ -283,7 +283,7 @@ await store.upsert({
|
|
|
283
283
|
</TabItem>
|
|
284
284
|
<TabItem value="couchbase" label="Couchbase">
|
|
285
285
|
|
|
286
|
-
```ts title="vector-store.ts"
|
|
286
|
+
```ts title="vector-store.ts"
|
|
287
287
|
import { CouchbaseVector } from "@mastra/couchbase";
|
|
288
288
|
|
|
289
289
|
const store = new CouchbaseVector({
|
|
@@ -308,7 +308,7 @@ await store.upsert({
|
|
|
308
308
|
</TabItem>
|
|
309
309
|
<TabItem value="lancedb" label="Lance">
|
|
310
310
|
|
|
311
|
-
```ts title="vector-store.ts"
|
|
311
|
+
```ts title="vector-store.ts"
|
|
312
312
|
import { LanceVectorStore } from "@mastra/lance";
|
|
313
313
|
|
|
314
314
|
const store = await LanceVectorStore.create("/path/to/db");
|
|
@@ -334,7 +334,7 @@ For detailed setup instructions and best practices, see the [official LanceDB do
|
|
|
334
334
|
</TabItem>
|
|
335
335
|
<TabItem value="s3vectors" label="S3 Vectors">
|
|
336
336
|
|
|
337
|
-
```ts title="vector-store.ts"
|
|
337
|
+
```ts title="vector-store.ts"
|
|
338
338
|
import { S3Vectors } from "@mastra/s3vectors";
|
|
339
339
|
|
|
340
340
|
const store = new S3Vectors({
|
|
@@ -368,7 +368,7 @@ Once initialized, all vector stores share the same interface for creating indexe
|
|
|
368
368
|
|
|
369
369
|
Before storing embeddings, you need to create an index with the appropriate dimension size for your embedding model:
|
|
370
370
|
|
|
371
|
-
```ts title="store-embeddings.ts"
|
|
371
|
+
```ts title="store-embeddings.ts"
|
|
372
372
|
// Create an index with dimension 1536 (for text-embedding-3-small)
|
|
373
373
|
await store.createIndex({
|
|
374
374
|
indexName: "myCollection",
|
|
@@ -445,7 +445,7 @@ Each vector database enforces specific naming conventions for indexes and collec
|
|
|
445
445
|
- Example: `my_collection_123` is valid
|
|
446
446
|
- Example: `my-collection` is not valid (contains hyphen)
|
|
447
447
|
</TabItem>
|
|
448
|
-
<TabItem value="libsql" label="
|
|
448
|
+
<TabItem value="libsql" label="libSQL">
|
|
449
449
|
Index names must:
|
|
450
450
|
- Start with a letter or underscore
|
|
451
451
|
- Contain only letters, numbers, and underscores
|
|
@@ -514,7 +514,7 @@ Each vector database enforces specific naming conventions for indexes and collec
|
|
|
514
514
|
|
|
515
515
|
After creating an index, you can store embeddings along with their basic metadata:
|
|
516
516
|
|
|
517
|
-
```ts title="store-embeddings.ts"
|
|
517
|
+
```ts title="store-embeddings.ts"
|
|
518
518
|
// Store embeddings with their corresponding metadata
|
|
519
519
|
await store.upsert({
|
|
520
520
|
indexName: "myCollection", // index name
|
|
@@ -541,7 +541,7 @@ Vector stores support rich metadata (any JSON-serializable fields) for filtering
|
|
|
541
541
|
Metadata is crucial for vector storage - without it, you'd only have numerical embeddings with no way to return the original text or filter results. Always store at least the source text as metadata.
|
|
542
542
|
:::
|
|
543
543
|
|
|
544
|
-
```ts
|
|
544
|
+
```ts
|
|
545
545
|
// Store embeddings with rich metadata for better organization and filtering
|
|
546
546
|
await store.upsert({
|
|
547
547
|
indexName: "myCollection",
|
|
@@ -581,7 +581,7 @@ When building RAG applications, you often need to clean up stale vectors when do
|
|
|
581
581
|
|
|
582
582
|
The most common use case is deleting all vectors for a specific document when a user deletes it:
|
|
583
583
|
|
|
584
|
-
```ts title="delete-vectors.ts"
|
|
584
|
+
```ts title="delete-vectors.ts"
|
|
585
585
|
// Delete all vectors for a specific document
|
|
586
586
|
await store.deleteVectors({
|
|
587
587
|
indexName: "myCollection",
|
|
@@ -598,7 +598,7 @@ This is particularly useful when:
|
|
|
598
598
|
|
|
599
599
|
You can also use complex filters to delete vectors matching multiple conditions:
|
|
600
600
|
|
|
601
|
-
```ts title="delete-vectors-advanced.ts"
|
|
601
|
+
```ts title="delete-vectors-advanced.ts"
|
|
602
602
|
// Delete all vectors for multiple documents
|
|
603
603
|
await store.deleteVectors({
|
|
604
604
|
indexName: "myCollection",
|
|
@@ -623,7 +623,7 @@ await store.deleteVectors({
|
|
|
623
623
|
|
|
624
624
|
If you have specific vector IDs to delete, you can pass them directly:
|
|
625
625
|
|
|
626
|
-
```ts title="delete-by-ids.ts"
|
|
626
|
+
```ts title="delete-by-ids.ts"
|
|
627
627
|
// Delete specific vectors by their IDs
|
|
628
628
|
await store.deleteVectors({
|
|
629
629
|
indexName: "myCollection",
|
|
@@ -11,7 +11,7 @@ The `Agent` class is the foundation for creating AI agents in Mastra. It provide
|
|
|
11
11
|
|
|
12
12
|
### Basic string instructions
|
|
13
13
|
|
|
14
|
-
```typescript title="src/mastra/agents/string-agent.ts"
|
|
14
|
+
```typescript title="src/mastra/agents/string-agent.ts"
|
|
15
15
|
import { Agent } from "@mastra/core/agent";
|
|
16
16
|
|
|
17
17
|
// String instructions
|
|
@@ -49,7 +49,7 @@ export const agent3 = new Agent({
|
|
|
49
49
|
|
|
50
50
|
Use CoreSystemMessage format to access additional properties like `providerOptions` for provider-specific configurations:
|
|
51
51
|
|
|
52
|
-
```typescript title="src/mastra/agents/core-message-agent.ts"
|
|
52
|
+
```typescript title="src/mastra/agents/core-message-agent.ts"
|
|
53
53
|
import { Agent } from "@mastra/core/agent";
|
|
54
54
|
|
|
55
55
|
export const agent = new Agent({
|
|
@@ -71,7 +71,7 @@ export const agent = new Agent({
|
|
|
71
71
|
|
|
72
72
|
### Multiple CoreSystemMessages
|
|
73
73
|
|
|
74
|
-
```typescript title="src/mastra/agents/multi-message-agent.ts"
|
|
74
|
+
```typescript title="src/mastra/agents/multi-message-agent.ts"
|
|
75
75
|
import { Agent } from "@mastra/core/agent";
|
|
76
76
|
|
|
77
77
|
// This could be customizable based on the user
|
|
@@ -15,7 +15,7 @@ The `.generateLegacy()` method is the legacy version of the agent generation API
|
|
|
15
15
|
|
|
16
16
|
## Usage example
|
|
17
17
|
|
|
18
|
-
```typescript
|
|
18
|
+
```typescript
|
|
19
19
|
await agent.generateLegacy("message for agent");
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -546,7 +546,7 @@ const result = await agent.generate("message", {
|
|
|
546
546
|
|
|
547
547
|
## Extended usage example
|
|
548
548
|
|
|
549
|
-
```typescript
|
|
549
|
+
```typescript
|
|
550
550
|
import { z } from "zod";
|
|
551
551
|
import {
|
|
552
552
|
ModerationProcessor,
|
|
@@ -15,7 +15,7 @@ Agents can be configured with default generation options for controlling model b
|
|
|
15
15
|
|
|
16
16
|
## Usage example
|
|
17
17
|
|
|
18
|
-
```typescript
|
|
18
|
+
```typescript
|
|
19
19
|
await agent.getDefaultGenerateOptionsLegacy();
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -48,7 +48,7 @@ await agent.getDefaultGenerateOptionsLegacy();
|
|
|
48
48
|
|
|
49
49
|
## Extended usage example
|
|
50
50
|
|
|
51
|
-
```typescript
|
|
51
|
+
```typescript
|
|
52
52
|
await agent.getDefaultGenerateOptionsLegacy({
|
|
53
53
|
requestContext: new RequestContext(),
|
|
54
54
|
});
|
|
@@ -9,7 +9,7 @@ Agents can be configured with default options for memory usage, output format, a
|
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript
|
|
13
13
|
await agent.getDefaultOptions();
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -42,7 +42,7 @@ await agent.getDefaultOptions();
|
|
|
42
42
|
|
|
43
43
|
## Extended usage example
|
|
44
44
|
|
|
45
|
-
```typescript
|
|
45
|
+
```typescript
|
|
46
46
|
await agent.getDefaultOptions({
|
|
47
47
|
requestContext: new RequestContext(),
|
|
48
48
|
});
|
|
@@ -15,7 +15,7 @@ Agents can be configured with default streaming options for memory usage, output
|
|
|
15
15
|
|
|
16
16
|
## Usage example
|
|
17
17
|
|
|
18
|
-
```typescript
|
|
18
|
+
```typescript
|
|
19
19
|
await agent.getDefaultStreamOptionsLegacy();
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -48,7 +48,7 @@ await agent.getDefaultStreamOptionsLegacy();
|
|
|
48
48
|
|
|
49
49
|
## Extended usage example
|
|
50
50
|
|
|
51
|
-
```typescript
|
|
51
|
+
```typescript
|
|
52
52
|
await agent.getDefaultStreamOptionsLegacy({
|
|
53
53
|
requestContext: new RequestContext(),
|
|
54
54
|
});
|
|
@@ -9,7 +9,7 @@ The `.getInstructions()` method retrieves the instructions configured for an age
|
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript
|
|
13
13
|
await agent.getInstructions();
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -42,7 +42,7 @@ await agent.getInstructions();
|
|
|
42
42
|
|
|
43
43
|
## Extended usage example
|
|
44
44
|
|
|
45
|
-
```typescript
|
|
45
|
+
```typescript
|
|
46
46
|
await agent.getInstructions({
|
|
47
47
|
requestContext: new RequestContext(),
|
|
48
48
|
});
|
|
@@ -9,7 +9,7 @@ The `.getLLM()` method retrieves the language model instance configured for an a
|
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript
|
|
13
13
|
await agent.getLLM();
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -43,7 +43,7 @@ await agent.getLLM();
|
|
|
43
43
|
|
|
44
44
|
## Extended usage example
|
|
45
45
|
|
|
46
|
-
```typescript
|
|
46
|
+
```typescript
|
|
47
47
|
await agent.getLLM({
|
|
48
48
|
requestContext: new RequestContext(),
|
|
49
49
|
model: "openai/gpt-5.1",
|
|
@@ -9,7 +9,7 @@ The `.getMemory()` method retrieves the memory system associated with an agent.
|
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript
|
|
13
13
|
await agent.getMemory();
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -42,7 +42,7 @@ await agent.getMemory();
|
|
|
42
42
|
|
|
43
43
|
## Extended usage example
|
|
44
44
|
|
|
45
|
-
```typescript
|
|
45
|
+
```typescript
|
|
46
46
|
await agent.getMemory({
|
|
47
47
|
requestContext: new RequestContext(),
|
|
48
48
|
});
|
|
@@ -9,7 +9,7 @@ The `.getModel()` method retrieves the language model configured for an agent, r
|
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript
|
|
13
13
|
await agent.getModel();
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -42,7 +42,7 @@ await agent.getModel();
|
|
|
42
42
|
|
|
43
43
|
## Extended usage example
|
|
44
44
|
|
|
45
|
-
```typescript
|
|
45
|
+
```typescript
|
|
46
46
|
await agent.getModel({
|
|
47
47
|
requestContext: new RequestContext(),
|
|
48
48
|
});
|
|
@@ -9,7 +9,7 @@ The `.getTools()` method retrieves the tools configured for an agent, resolving
|
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript
|
|
13
13
|
await agent.getTools();
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -42,7 +42,7 @@ await agent.getTools();
|
|
|
42
42
|
|
|
43
43
|
## Extended usage example
|
|
44
44
|
|
|
45
|
-
```typescript
|
|
45
|
+
```typescript
|
|
46
46
|
await agent.getTools({
|
|
47
47
|
requestContext: new RequestContext(),
|
|
48
48
|
});
|
|
@@ -9,7 +9,7 @@ The `.getVoice()` method retrieves the voice provider configured for an agent, r
|
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript
|
|
13
13
|
await agent.getVoice();
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -42,7 +42,7 @@ await agent.getVoice();
|
|
|
42
42
|
|
|
43
43
|
## Extended usage example
|
|
44
44
|
|
|
45
|
-
```typescript
|
|
45
|
+
```typescript
|
|
46
46
|
await agent.getVoice({
|
|
47
47
|
requestContext: new RequestContext(),
|
|
48
48
|
});
|
|
@@ -9,7 +9,7 @@ The `.listAgents()` method retrieves the sub-agents configured for an agent, res
|
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript
|
|
13
13
|
await agent.listAgents();
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -42,7 +42,7 @@ await agent.listAgents();
|
|
|
42
42
|
|
|
43
43
|
## Extended usage example
|
|
44
44
|
|
|
45
|
-
```typescript
|
|
45
|
+
```typescript
|
|
46
46
|
import { RequestContext } from "@mastra/core/request-context";
|
|
47
47
|
|
|
48
48
|
await agent.listAgents({
|
|
@@ -9,7 +9,7 @@ The `.listScorers()` method retrieves the scoring configuration configured for a
|
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript
|
|
13
13
|
await agent.listScorers();
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -42,7 +42,7 @@ await agent.listScorers();
|
|
|
42
42
|
|
|
43
43
|
## Extended usage example
|
|
44
44
|
|
|
45
|
-
```typescript
|
|
45
|
+
```typescript
|
|
46
46
|
await agent.listScorers({
|
|
47
47
|
requestContext: new RequestContext(),
|
|
48
48
|
});
|
|
@@ -9,7 +9,7 @@ The `.listTools()` method retrieves the tools configured for an agent, resolving
|
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript
|
|
13
13
|
await agent.listTools();
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -42,7 +42,7 @@ await agent.listTools();
|
|
|
42
42
|
|
|
43
43
|
## Extended usage example
|
|
44
44
|
|
|
45
|
-
```typescript
|
|
45
|
+
```typescript
|
|
46
46
|
await agent.listTools({
|
|
47
47
|
requestContext: new RequestContext(),
|
|
48
48
|
});
|
|
@@ -9,7 +9,7 @@ The `.listWorkflows()` method retrieves the workflows configured for an agent, r
|
|
|
9
9
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
|
-
```typescript
|
|
12
|
+
```typescript
|
|
13
13
|
await agent.listWorkflows();
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -42,7 +42,7 @@ await agent.listWorkflows();
|
|
|
42
42
|
|
|
43
43
|
## Extended usage example
|
|
44
44
|
|
|
45
|
-
```typescript
|
|
45
|
+
```typescript
|
|
46
46
|
await agent.listWorkflows({
|
|
47
47
|
requestContext: new RequestContext(),
|
|
48
48
|
});
|
|
@@ -15,7 +15,7 @@ The `.network()` method enables multi-agent collaboration and routing. This meth
|
|
|
15
15
|
|
|
16
16
|
## Usage example
|
|
17
17
|
|
|
18
|
-
```typescript
|
|
18
|
+
```typescript
|
|
19
19
|
import { Agent } from "@mastra/core/agent";
|
|
20
20
|
import { agent1, agent2 } from "./agents";
|
|
21
21
|
import { workflow1 } from "./workflows";
|
|
@@ -15,7 +15,7 @@ Use [`handleChatStream()`](/reference/v1/ai-sdk/handle-chat-stream) if you need
|
|
|
15
15
|
|
|
16
16
|
This example shows how to set up a chat route at the `/chat` endpoint that uses an agent with the ID `weatherAgent`.
|
|
17
17
|
|
|
18
|
-
```typescript title="src/mastra/index.ts"
|
|
18
|
+
```typescript title="src/mastra/index.ts"
|
|
19
19
|
import { Mastra } from "@mastra/core";
|
|
20
20
|
import { chatRoute } from "@mastra/ai-sdk";
|
|
21
21
|
|
|
@@ -33,7 +33,7 @@ export const mastra = new Mastra({
|
|
|
33
33
|
|
|
34
34
|
You can also use dynamic agent routing based on an `agentId`. The URL `/chat/weatherAgent` will resolve to the agent with the ID `weatherAgent`.
|
|
35
35
|
|
|
36
|
-
```typescript title="src/mastra/index.ts"
|
|
36
|
+
```typescript title="src/mastra/index.ts"
|
|
37
37
|
import { Mastra } from "@mastra/core";
|
|
38
38
|
import { chatRoute } from "@mastra/ai-sdk";
|
|
39
39
|
|
|
@@ -17,7 +17,7 @@ Use [`chatRoute()`](/reference/v1/ai-sdk/chat-route) if you want to create a cha
|
|
|
17
17
|
|
|
18
18
|
Next.js App Router example:
|
|
19
19
|
|
|
20
|
-
```typescript title="app/api/chat/route.ts"
|
|
20
|
+
```typescript title="app/api/chat/route.ts"
|
|
21
21
|
import { handleChatStream } from '@mastra/ai-sdk';
|
|
22
22
|
import { createUIMessageStreamResponse } from 'ai';
|
|
23
23
|
import { mastra } from '@/src/mastra';
|
|
@@ -16,7 +16,7 @@ Use [`networkRoute()`](/reference/v1/ai-sdk/network-route) if you want to create
|
|
|
16
16
|
|
|
17
17
|
Next.js App Router example:
|
|
18
18
|
|
|
19
|
-
```typescript title="app/api/network/route.ts"
|
|
19
|
+
```typescript title="app/api/network/route.ts"
|
|
20
20
|
import { handleNetworkStream } from '@mastra/ai-sdk';
|
|
21
21
|
import { createUIMessageStreamResponse } from 'ai';
|
|
22
22
|
import { mastra } from '@/src/mastra';
|
|
@@ -25,7 +25,7 @@ See [Workflow Streaming](/docs/v1/streaming/workflow-streaming#streaming-agent-t
|
|
|
25
25
|
|
|
26
26
|
Next.js App Router example:
|
|
27
27
|
|
|
28
|
-
```typescript title="app/api/workflow/route.ts"
|
|
28
|
+
```typescript title="app/api/workflow/route.ts"
|
|
29
29
|
import { handleWorkflowStream } from '@mastra/ai-sdk';
|
|
30
30
|
import { createUIMessageStreamResponse } from 'ai';
|
|
31
31
|
import { mastra } from '@/src/mastra';
|
|
@@ -15,7 +15,7 @@ Use [`handleNetworkStream()`](/reference/v1/ai-sdk/handle-network-stream) if you
|
|
|
15
15
|
|
|
16
16
|
This example shows how to set up a network route at the `/network` endpoint that uses an agent with the ID `weatherAgent`.
|
|
17
17
|
|
|
18
|
-
```typescript title="src/mastra/index.ts"
|
|
18
|
+
```typescript title="src/mastra/index.ts"
|
|
19
19
|
import { Mastra } from "@mastra/core";
|
|
20
20
|
import { networkRoute } from "@mastra/ai-sdk";
|
|
21
21
|
|
|
@@ -33,7 +33,7 @@ export const mastra = new Mastra({
|
|
|
33
33
|
|
|
34
34
|
You can also use dynamic agent routing based on an `agentId`. The URL `/network/weatherAgent` will resolve to the agent with the ID `weatherAgent`.
|
|
35
35
|
|
|
36
|
-
```typescript title="src/mastra/index.ts"
|
|
36
|
+
```typescript title="src/mastra/index.ts"
|
|
37
37
|
import { Mastra } from "@mastra/core";
|
|
38
38
|
import { networkRoute } from "@mastra/ai-sdk";
|
|
39
39
|
|
|
@@ -15,7 +15,7 @@ This is useful when building custom streaming endpoints outside Mastra's provide
|
|
|
15
15
|
|
|
16
16
|
Next.js App Router example:
|
|
17
17
|
|
|
18
|
-
```typescript title="app/api/chat/route.ts"
|
|
18
|
+
```typescript title="app/api/chat/route.ts"
|
|
19
19
|
import { mastra } from "../../mastra";
|
|
20
20
|
import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
|
|
21
21
|
import { toAISdkStream } from "@mastra/ai-sdk";
|
|
@@ -124,7 +124,7 @@ The second parameter is an options object:
|
|
|
124
124
|
|
|
125
125
|
### Converting a workflow stream
|
|
126
126
|
|
|
127
|
-
```typescript title="app/api/workflow/route.ts"
|
|
127
|
+
```typescript title="app/api/workflow/route.ts" {13}
|
|
128
128
|
import { mastra } from "../../mastra";
|
|
129
129
|
import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
|
|
130
130
|
import { toAISdkStream } from "@mastra/ai-sdk";
|
|
@@ -151,7 +151,7 @@ export async function POST(req: Request) {
|
|
|
151
151
|
|
|
152
152
|
### Converting a network stream
|
|
153
153
|
|
|
154
|
-
```typescript title="app/api/network/route.ts"
|
|
154
|
+
```typescript title="app/api/network/route.ts" {12}
|
|
155
155
|
import { mastra } from "../../mastra";
|
|
156
156
|
import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
|
|
157
157
|
import { toAISdkStream } from "@mastra/ai-sdk";
|
|
@@ -177,7 +177,7 @@ export async function POST(req: Request) {
|
|
|
177
177
|
|
|
178
178
|
### Converting an agent stream with reasoning enabled
|
|
179
179
|
|
|
180
|
-
```typescript title="app/api/reasoning/route.ts"
|
|
180
|
+
```typescript title="app/api/reasoning/route.ts" {8-12,17-20}
|
|
181
181
|
import { mastra } from "../../mastra";
|
|
182
182
|
import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
|
|
183
183
|
import { toAISdkStream } from "@mastra/ai-sdk";
|
|
@@ -211,7 +211,7 @@ export async function POST(req: Request) {
|
|
|
211
211
|
|
|
212
212
|
### Using messageMetadata
|
|
213
213
|
|
|
214
|
-
```typescript title="app/api/chat-with-metadata/route.ts"
|
|
214
|
+
```typescript title="app/api/chat-with-metadata/route.ts" {13-19}
|
|
215
215
|
import { mastra } from "../../mastra";
|
|
216
216
|
import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
|
|
217
217
|
import { toAISdkStream } from "@mastra/ai-sdk";
|
|
@@ -246,7 +246,7 @@ export async function POST(req: Request) {
|
|
|
246
246
|
|
|
247
247
|
If you're using the Mastra client SDK (`@mastra/client-js`) on the client side and want to convert streams to AI SDK format:
|
|
248
248
|
|
|
249
|
-
```typescript title="client-stream-to-ai-sdk.ts"
|
|
249
|
+
```typescript title="client-stream-to-ai-sdk.ts" {14-23,25-35}
|
|
250
250
|
import { MastraClient } from "@mastra/client-js";
|
|
251
251
|
import { createUIMessageStream } from "ai";
|
|
252
252
|
import { toAISdkStream } from "@mastra/ai-sdk";
|
|
@@ -11,7 +11,7 @@ Converts messages from various input formats to AI SDK V4 UI message format. Thi
|
|
|
11
11
|
|
|
12
12
|
## Usage example
|
|
13
13
|
|
|
14
|
-
```typescript title="app/chat/page.tsx"
|
|
14
|
+
```typescript title="app/chat/page.tsx"
|
|
15
15
|
import { toAISdkV4Messages } from "@mastra/ai-sdk";
|
|
16
16
|
import { useChat } from "ai/react"; // AI SDK V4
|
|
17
17
|
|
|
@@ -107,7 +107,7 @@ Returns an array of AI SDK V4 `UIMessage` objects with the following structure:
|
|
|
107
107
|
|
|
108
108
|
### Converting simple text messages
|
|
109
109
|
|
|
110
|
-
```typescript
|
|
110
|
+
```typescript
|
|
111
111
|
import { toAISdkV4Messages } from "@mastra/ai-sdk";
|
|
112
112
|
|
|
113
113
|
const messages = toAISdkV4Messages(["Hello", "How can I help you today?"]);
|
|
@@ -116,7 +116,7 @@ const messages = toAISdkV4Messages(["Hello", "How can I help you today?"]);
|
|
|
116
116
|
|
|
117
117
|
### Loading messages with Mastra client
|
|
118
118
|
|
|
119
|
-
```typescript
|
|
119
|
+
```typescript
|
|
120
120
|
import { MastraClient } from "@mastra/client-js";
|
|
121
121
|
import { toAISdkV4Messages } from "@mastra/ai-sdk";
|
|
122
122
|
|