@mastra/mcp-docs-server 1.1.4 → 1.1.5-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/CHANGELOG.md +7 -0
- package/package.json +3 -3
- package/.docs/docs/agents/adding-voice.md +0 -353
- package/.docs/docs/agents/agent-approval.md +0 -377
- package/.docs/docs/agents/agent-memory.md +0 -212
- package/.docs/docs/agents/guardrails.md +0 -382
- package/.docs/docs/agents/network-approval.md +0 -275
- package/.docs/docs/agents/networks.md +0 -290
- package/.docs/docs/agents/overview.md +0 -309
- package/.docs/docs/agents/processors.md +0 -632
- package/.docs/docs/agents/structured-output.md +0 -271
- package/.docs/docs/agents/using-tools.md +0 -214
- package/.docs/docs/build-with-ai/mcp-docs-server.md +0 -241
- package/.docs/docs/build-with-ai/skills.md +0 -35
- package/.docs/docs/community/contributing-templates.md +0 -3
- package/.docs/docs/community/discord.md +0 -9
- package/.docs/docs/community/licensing.md +0 -66
- package/.docs/docs/deployment/cloud-providers.md +0 -15
- package/.docs/docs/deployment/mastra-server.md +0 -122
- package/.docs/docs/deployment/monorepo.md +0 -142
- package/.docs/docs/deployment/overview.md +0 -62
- package/.docs/docs/deployment/studio.md +0 -234
- package/.docs/docs/deployment/web-framework.md +0 -52
- package/.docs/docs/deployment/workflow-runners.md +0 -9
- package/.docs/docs/evals/built-in-scorers.md +0 -47
- package/.docs/docs/evals/custom-scorers.md +0 -519
- package/.docs/docs/evals/overview.md +0 -146
- package/.docs/docs/evals/running-in-ci.md +0 -106
- package/.docs/docs/getting-started/build-with-ai.md +0 -68
- package/.docs/docs/getting-started/manual-install.md +0 -226
- package/.docs/docs/getting-started/project-structure.md +0 -60
- package/.docs/docs/getting-started/start.md +0 -28
- package/.docs/docs/getting-started/studio.md +0 -101
- package/.docs/docs/index.md +0 -43
- package/.docs/docs/mastra-cloud/deployment.md +0 -77
- package/.docs/docs/mastra-cloud/observability.md +0 -38
- package/.docs/docs/mastra-cloud/overview.md +0 -23
- package/.docs/docs/mastra-cloud/setup.md +0 -42
- package/.docs/docs/mastra-cloud/studio.md +0 -24
- package/.docs/docs/mcp/overview.md +0 -370
- package/.docs/docs/mcp/publishing-mcp-server.md +0 -95
- package/.docs/docs/memory/memory-processors.md +0 -316
- package/.docs/docs/memory/message-history.md +0 -260
- package/.docs/docs/memory/observational-memory.md +0 -246
- package/.docs/docs/memory/overview.md +0 -45
- package/.docs/docs/memory/semantic-recall.md +0 -272
- package/.docs/docs/memory/storage.md +0 -261
- package/.docs/docs/memory/working-memory.md +0 -400
- package/.docs/docs/observability/datasets/overview.md +0 -188
- package/.docs/docs/observability/datasets/running-experiments.md +0 -266
- package/.docs/docs/observability/logging.md +0 -99
- package/.docs/docs/observability/overview.md +0 -70
- package/.docs/docs/observability/tracing/bridges/otel.md +0 -209
- package/.docs/docs/observability/tracing/exporters/arize.md +0 -274
- package/.docs/docs/observability/tracing/exporters/braintrust.md +0 -111
- package/.docs/docs/observability/tracing/exporters/cloud.md +0 -129
- package/.docs/docs/observability/tracing/exporters/datadog.md +0 -187
- package/.docs/docs/observability/tracing/exporters/default.md +0 -211
- package/.docs/docs/observability/tracing/exporters/laminar.md +0 -100
- package/.docs/docs/observability/tracing/exporters/langfuse.md +0 -217
- package/.docs/docs/observability/tracing/exporters/langsmith.md +0 -202
- package/.docs/docs/observability/tracing/exporters/otel.md +0 -479
- package/.docs/docs/observability/tracing/exporters/posthog.md +0 -148
- package/.docs/docs/observability/tracing/exporters/sentry.md +0 -208
- package/.docs/docs/observability/tracing/overview.md +0 -1114
- package/.docs/docs/observability/tracing/processors/sensitive-data-filter.md +0 -303
- package/.docs/docs/rag/chunking-and-embedding.md +0 -183
- package/.docs/docs/rag/graph-rag.md +0 -215
- package/.docs/docs/rag/overview.md +0 -72
- package/.docs/docs/rag/retrieval.md +0 -521
- package/.docs/docs/rag/vector-databases.md +0 -648
- package/.docs/docs/server/auth/auth0.md +0 -222
- package/.docs/docs/server/auth/better-auth.md +0 -203
- package/.docs/docs/server/auth/clerk.md +0 -132
- package/.docs/docs/server/auth/composite-auth.md +0 -234
- package/.docs/docs/server/auth/custom-auth-provider.md +0 -513
- package/.docs/docs/server/auth/firebase.md +0 -272
- package/.docs/docs/server/auth/jwt.md +0 -110
- package/.docs/docs/server/auth/simple-auth.md +0 -178
- package/.docs/docs/server/auth/supabase.md +0 -117
- package/.docs/docs/server/auth/workos.md +0 -190
- package/.docs/docs/server/auth.md +0 -38
- package/.docs/docs/server/custom-adapters.md +0 -374
- package/.docs/docs/server/custom-api-routes.md +0 -267
- package/.docs/docs/server/mastra-client.md +0 -243
- package/.docs/docs/server/mastra-server.md +0 -71
- package/.docs/docs/server/middleware.md +0 -228
- package/.docs/docs/server/request-context.md +0 -478
- package/.docs/docs/server/server-adapters.md +0 -547
- package/.docs/docs/streaming/events.md +0 -247
- package/.docs/docs/streaming/overview.md +0 -181
- package/.docs/docs/streaming/tool-streaming.md +0 -178
- package/.docs/docs/streaming/workflow-streaming.md +0 -109
- package/.docs/docs/voice/overview.md +0 -979
- package/.docs/docs/voice/speech-to-speech.md +0 -103
- package/.docs/docs/voice/speech-to-text.md +0 -80
- package/.docs/docs/voice/text-to-speech.md +0 -84
- package/.docs/docs/workflows/agents-and-tools.md +0 -170
- package/.docs/docs/workflows/control-flow.md +0 -823
- package/.docs/docs/workflows/error-handling.md +0 -360
- package/.docs/docs/workflows/human-in-the-loop.md +0 -213
- package/.docs/docs/workflows/overview.md +0 -372
- package/.docs/docs/workflows/snapshots.md +0 -238
- package/.docs/docs/workflows/suspend-and-resume.md +0 -205
- package/.docs/docs/workflows/time-travel.md +0 -309
- package/.docs/docs/workflows/workflow-state.md +0 -181
- package/.docs/docs/workspace/filesystem.md +0 -162
- package/.docs/docs/workspace/overview.md +0 -239
- package/.docs/docs/workspace/sandbox.md +0 -63
- package/.docs/docs/workspace/search.md +0 -219
- package/.docs/docs/workspace/skills.md +0 -126
- package/.docs/guides/agent-frameworks/ai-sdk.md +0 -140
- package/.docs/guides/build-your-ui/ai-sdk-ui.md +0 -1463
- package/.docs/guides/build-your-ui/assistant-ui.md +0 -156
- package/.docs/guides/build-your-ui/copilotkit.md +0 -292
- package/.docs/guides/deployment/amazon-ec2.md +0 -130
- package/.docs/guides/deployment/aws-lambda.md +0 -248
- package/.docs/guides/deployment/azure-app-services.md +0 -114
- package/.docs/guides/deployment/cloudflare.md +0 -99
- package/.docs/guides/deployment/digital-ocean.md +0 -168
- package/.docs/guides/deployment/inngest.md +0 -685
- package/.docs/guides/deployment/netlify.md +0 -77
- package/.docs/guides/deployment/vercel.md +0 -101
- package/.docs/guides/getting-started/astro.md +0 -408
- package/.docs/guides/getting-started/electron.md +0 -504
- package/.docs/guides/getting-started/express.md +0 -251
- package/.docs/guides/getting-started/hono.md +0 -191
- package/.docs/guides/getting-started/next-js.md +0 -355
- package/.docs/guides/getting-started/nuxt.md +0 -476
- package/.docs/guides/getting-started/quickstart.md +0 -67
- package/.docs/guides/getting-started/sveltekit.md +0 -300
- package/.docs/guides/getting-started/vite-react.md +0 -439
- package/.docs/guides/guide/ai-recruiter.md +0 -227
- package/.docs/guides/guide/chef-michel.md +0 -215
- package/.docs/guides/guide/code-review-bot.md +0 -221
- package/.docs/guides/guide/dev-assistant.md +0 -304
- package/.docs/guides/guide/docs-manager.md +0 -238
- package/.docs/guides/guide/github-actions-pr-description.md +0 -236
- package/.docs/guides/guide/notes-mcp-server.md +0 -425
- package/.docs/guides/guide/research-assistant.md +0 -349
- package/.docs/guides/guide/stock-agent.md +0 -134
- package/.docs/guides/guide/web-search.md +0 -326
- package/.docs/guides/guide/whatsapp-chat-bot.md +0 -416
- package/.docs/guides/index.md +0 -3
- package/.docs/guides/migrations/agentnetwork.md +0 -101
- package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +0 -112
- package/.docs/guides/migrations/upgrade-to-v1/agent.md +0 -404
- package/.docs/guides/migrations/upgrade-to-v1/cli.md +0 -57
- package/.docs/guides/migrations/upgrade-to-v1/client.md +0 -337
- package/.docs/guides/migrations/upgrade-to-v1/deployment.md +0 -37
- package/.docs/guides/migrations/upgrade-to-v1/evals.md +0 -239
- package/.docs/guides/migrations/upgrade-to-v1/mastra.md +0 -143
- package/.docs/guides/migrations/upgrade-to-v1/mcp.md +0 -97
- package/.docs/guides/migrations/upgrade-to-v1/memory.md +0 -285
- package/.docs/guides/migrations/upgrade-to-v1/overview.md +0 -119
- package/.docs/guides/migrations/upgrade-to-v1/processors.md +0 -68
- package/.docs/guides/migrations/upgrade-to-v1/rag.md +0 -42
- package/.docs/guides/migrations/upgrade-to-v1/storage.md +0 -553
- package/.docs/guides/migrations/upgrade-to-v1/tools.md +0 -180
- package/.docs/guides/migrations/upgrade-to-v1/tracing.md +0 -417
- package/.docs/guides/migrations/upgrade-to-v1/vectors.md +0 -87
- package/.docs/guides/migrations/upgrade-to-v1/voice.md +0 -30
- package/.docs/guides/migrations/upgrade-to-v1/workflows.md +0 -341
- package/.docs/guides/migrations/vnext-to-standard-apis.md +0 -364
- package/.docs/models/embeddings.md +0 -161
- package/.docs/models/gateways/azure-openai.md +0 -128
- package/.docs/models/gateways/custom-gateways.md +0 -545
- package/.docs/models/gateways/netlify.md +0 -88
- package/.docs/models/gateways/openrouter.md +0 -219
- package/.docs/models/gateways/vercel.md +0 -225
- package/.docs/models/gateways.md +0 -14
- package/.docs/models/index.md +0 -286
- package/.docs/models/providers/302ai.md +0 -134
- package/.docs/models/providers/abacus.md +0 -125
- package/.docs/models/providers/agentrouter.md +0 -90
- package/.docs/models/providers/aihubmix.md +0 -107
- package/.docs/models/providers/alibaba-cn.md +0 -135
- package/.docs/models/providers/alibaba.md +0 -111
- package/.docs/models/providers/amazon-bedrock.md +0 -33
- package/.docs/models/providers/anthropic.md +0 -153
- package/.docs/models/providers/azure.md +0 -33
- package/.docs/models/providers/bailing.md +0 -72
- package/.docs/models/providers/baseten.md +0 -77
- package/.docs/models/providers/berget.md +0 -78
- package/.docs/models/providers/cerebras.md +0 -101
- package/.docs/models/providers/chutes.md +0 -136
- package/.docs/models/providers/cloudflare-ai-gateway.md +0 -33
- package/.docs/models/providers/cloudflare-workers-ai.md +0 -109
- package/.docs/models/providers/cohere.md +0 -33
- package/.docs/models/providers/cortecs.md +0 -91
- package/.docs/models/providers/deepinfra.md +0 -112
- package/.docs/models/providers/deepseek.md +0 -88
- package/.docs/models/providers/fastrouter.md +0 -84
- package/.docs/models/providers/fireworks-ai.md +0 -89
- package/.docs/models/providers/firmware.md +0 -85
- package/.docs/models/providers/friendli.md +0 -78
- package/.docs/models/providers/github-models.md +0 -125
- package/.docs/models/providers/google-vertex.md +0 -33
- package/.docs/models/providers/google.md +0 -159
- package/.docs/models/providers/groq.md +0 -107
- package/.docs/models/providers/helicone.md +0 -161
- package/.docs/models/providers/huggingface.md +0 -90
- package/.docs/models/providers/iflowcn.md +0 -84
- package/.docs/models/providers/inception.md +0 -72
- package/.docs/models/providers/inference.md +0 -79
- package/.docs/models/providers/io-intelligence.md +0 -87
- package/.docs/models/providers/io-net.md +0 -87
- package/.docs/models/providers/jiekou.md +0 -131
- package/.docs/models/providers/kilo.md +0 -333
- package/.docs/models/providers/kimi-for-coding.md +0 -100
- package/.docs/models/providers/kuae-cloud-coding-plan.md +0 -71
- package/.docs/models/providers/llama.md +0 -77
- package/.docs/models/providers/lmstudio.md +0 -73
- package/.docs/models/providers/lucidquery.md +0 -72
- package/.docs/models/providers/minimax-cn-coding-plan.md +0 -102
- package/.docs/models/providers/minimax-cn.md +0 -102
- package/.docs/models/providers/minimax-coding-plan.md +0 -102
- package/.docs/models/providers/minimax.md +0 -104
- package/.docs/models/providers/mistral.md +0 -124
- package/.docs/models/providers/moark.md +0 -72
- package/.docs/models/providers/modelscope.md +0 -77
- package/.docs/models/providers/moonshotai-cn.md +0 -76
- package/.docs/models/providers/moonshotai.md +0 -76
- package/.docs/models/providers/morph.md +0 -73
- package/.docs/models/providers/nano-gpt.md +0 -103
- package/.docs/models/providers/nebius.md +0 -116
- package/.docs/models/providers/nova.md +0 -72
- package/.docs/models/providers/novita-ai.md +0 -154
- package/.docs/models/providers/nvidia.md +0 -141
- package/.docs/models/providers/ollama-cloud.md +0 -103
- package/.docs/models/providers/ollama.md +0 -33
- package/.docs/models/providers/openai.md +0 -193
- package/.docs/models/providers/opencode.md +0 -100
- package/.docs/models/providers/ovhcloud.md +0 -83
- package/.docs/models/providers/perplexity.md +0 -100
- package/.docs/models/providers/poe.md +0 -183
- package/.docs/models/providers/privatemode-ai.md +0 -75
- package/.docs/models/providers/requesty.md +0 -90
- package/.docs/models/providers/scaleway.md +0 -84
- package/.docs/models/providers/siliconflow-cn.md +0 -138
- package/.docs/models/providers/siliconflow.md +0 -140
- package/.docs/models/providers/stackit.md +0 -78
- package/.docs/models/providers/stepfun.md +0 -73
- package/.docs/models/providers/submodel.md +0 -79
- package/.docs/models/providers/synthetic.md +0 -96
- package/.docs/models/providers/togetherai.md +0 -115
- package/.docs/models/providers/upstage.md +0 -73
- package/.docs/models/providers/venice.md +0 -95
- package/.docs/models/providers/vivgrid.md +0 -106
- package/.docs/models/providers/vultr.md +0 -75
- package/.docs/models/providers/wandb.md +0 -80
- package/.docs/models/providers/xai.md +0 -141
- package/.docs/models/providers/xiaomi.md +0 -71
- package/.docs/models/providers/zai-coding-plan.md +0 -80
- package/.docs/models/providers/zai.md +0 -79
- package/.docs/models/providers/zenmux.md +0 -161
- package/.docs/models/providers/zhipuai-coding-plan.md +0 -79
- package/.docs/models/providers/zhipuai.md +0 -79
- package/.docs/models/providers.md +0 -81
- package/.docs/reference/agents/agent.md +0 -142
- package/.docs/reference/agents/generate.md +0 -174
- package/.docs/reference/agents/generateLegacy.md +0 -176
- package/.docs/reference/agents/getDefaultGenerateOptions.md +0 -36
- package/.docs/reference/agents/getDefaultOptions.md +0 -34
- package/.docs/reference/agents/getDefaultStreamOptions.md +0 -36
- package/.docs/reference/agents/getDescription.md +0 -21
- package/.docs/reference/agents/getInstructions.md +0 -34
- package/.docs/reference/agents/getLLM.md +0 -37
- package/.docs/reference/agents/getMemory.md +0 -34
- package/.docs/reference/agents/getModel.md +0 -34
- package/.docs/reference/agents/getTools.md +0 -29
- package/.docs/reference/agents/getVoice.md +0 -34
- package/.docs/reference/agents/listAgents.md +0 -35
- package/.docs/reference/agents/listScorers.md +0 -34
- package/.docs/reference/agents/listTools.md +0 -34
- package/.docs/reference/agents/listWorkflows.md +0 -34
- package/.docs/reference/agents/network.md +0 -134
- package/.docs/reference/ai-sdk/chat-route.md +0 -82
- package/.docs/reference/ai-sdk/handle-chat-stream.md +0 -53
- package/.docs/reference/ai-sdk/handle-network-stream.md +0 -37
- package/.docs/reference/ai-sdk/handle-workflow-stream.md +0 -55
- package/.docs/reference/ai-sdk/network-route.md +0 -74
- package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +0 -232
- package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +0 -79
- package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +0 -73
- package/.docs/reference/ai-sdk/with-mastra.md +0 -59
- package/.docs/reference/ai-sdk/workflow-route.md +0 -79
- package/.docs/reference/auth/auth0.md +0 -73
- package/.docs/reference/auth/better-auth.md +0 -71
- package/.docs/reference/auth/clerk.md +0 -36
- package/.docs/reference/auth/firebase.md +0 -80
- package/.docs/reference/auth/jwt.md +0 -26
- package/.docs/reference/auth/supabase.md +0 -33
- package/.docs/reference/auth/workos.md +0 -84
- package/.docs/reference/cli/create-mastra.md +0 -137
- package/.docs/reference/cli/mastra.md +0 -336
- package/.docs/reference/client-js/agents.md +0 -438
- package/.docs/reference/client-js/error-handling.md +0 -16
- package/.docs/reference/client-js/logs.md +0 -24
- package/.docs/reference/client-js/mastra-client.md +0 -63
- package/.docs/reference/client-js/memory.md +0 -225
- package/.docs/reference/client-js/observability.md +0 -72
- package/.docs/reference/client-js/telemetry.md +0 -20
- package/.docs/reference/client-js/tools.md +0 -44
- package/.docs/reference/client-js/vectors.md +0 -79
- package/.docs/reference/client-js/workflows.md +0 -199
- package/.docs/reference/configuration.md +0 -749
- package/.docs/reference/core/addGateway.md +0 -42
- package/.docs/reference/core/getAgent.md +0 -21
- package/.docs/reference/core/getAgentById.md +0 -21
- package/.docs/reference/core/getDeployer.md +0 -22
- package/.docs/reference/core/getGateway.md +0 -38
- package/.docs/reference/core/getGatewayById.md +0 -41
- package/.docs/reference/core/getLogger.md +0 -22
- package/.docs/reference/core/getMCPServer.md +0 -45
- package/.docs/reference/core/getMCPServerById.md +0 -53
- package/.docs/reference/core/getMemory.md +0 -50
- package/.docs/reference/core/getScorer.md +0 -54
- package/.docs/reference/core/getScorerById.md +0 -54
- package/.docs/reference/core/getServer.md +0 -22
- package/.docs/reference/core/getStorage.md +0 -22
- package/.docs/reference/core/getStoredAgentById.md +0 -89
- package/.docs/reference/core/getTelemetry.md +0 -22
- package/.docs/reference/core/getVector.md +0 -22
- package/.docs/reference/core/getWorkflow.md +0 -40
- package/.docs/reference/core/listAgents.md +0 -21
- package/.docs/reference/core/listGateways.md +0 -40
- package/.docs/reference/core/listLogs.md +0 -38
- package/.docs/reference/core/listLogsByRunId.md +0 -36
- package/.docs/reference/core/listMCPServers.md +0 -51
- package/.docs/reference/core/listMemory.md +0 -56
- package/.docs/reference/core/listScorers.md +0 -29
- package/.docs/reference/core/listStoredAgents.md +0 -93
- package/.docs/reference/core/listVectors.md +0 -22
- package/.docs/reference/core/listWorkflows.md +0 -21
- package/.docs/reference/core/mastra-class.md +0 -66
- package/.docs/reference/core/mastra-model-gateway.md +0 -153
- package/.docs/reference/core/setLogger.md +0 -26
- package/.docs/reference/core/setStorage.md +0 -27
- package/.docs/reference/datasets/addItem.md +0 -35
- package/.docs/reference/datasets/addItems.md +0 -33
- package/.docs/reference/datasets/compareExperiments.md +0 -48
- package/.docs/reference/datasets/create.md +0 -49
- package/.docs/reference/datasets/dataset.md +0 -78
- package/.docs/reference/datasets/datasets-manager.md +0 -84
- package/.docs/reference/datasets/delete.md +0 -23
- package/.docs/reference/datasets/deleteExperiment.md +0 -25
- package/.docs/reference/datasets/deleteItem.md +0 -25
- package/.docs/reference/datasets/deleteItems.md +0 -27
- package/.docs/reference/datasets/get.md +0 -29
- package/.docs/reference/datasets/getDetails.md +0 -45
- package/.docs/reference/datasets/getExperiment.md +0 -28
- package/.docs/reference/datasets/getItem.md +0 -31
- package/.docs/reference/datasets/getItemHistory.md +0 -29
- package/.docs/reference/datasets/list.md +0 -29
- package/.docs/reference/datasets/listExperimentResults.md +0 -37
- package/.docs/reference/datasets/listExperiments.md +0 -31
- package/.docs/reference/datasets/listItems.md +0 -44
- package/.docs/reference/datasets/listVersions.md +0 -31
- package/.docs/reference/datasets/startExperiment.md +0 -60
- package/.docs/reference/datasets/startExperimentAsync.md +0 -41
- package/.docs/reference/datasets/update.md +0 -46
- package/.docs/reference/datasets/updateItem.md +0 -36
- package/.docs/reference/deployer/cloudflare.md +0 -79
- package/.docs/reference/deployer/netlify.md +0 -82
- package/.docs/reference/deployer/vercel.md +0 -91
- package/.docs/reference/deployer.md +0 -100
- package/.docs/reference/evals/answer-relevancy.md +0 -105
- package/.docs/reference/evals/answer-similarity.md +0 -99
- package/.docs/reference/evals/bias.md +0 -120
- package/.docs/reference/evals/completeness.md +0 -137
- package/.docs/reference/evals/content-similarity.md +0 -101
- package/.docs/reference/evals/context-precision.md +0 -196
- package/.docs/reference/evals/context-relevance.md +0 -536
- package/.docs/reference/evals/create-scorer.md +0 -270
- package/.docs/reference/evals/faithfulness.md +0 -114
- package/.docs/reference/evals/hallucination.md +0 -220
- package/.docs/reference/evals/keyword-coverage.md +0 -128
- package/.docs/reference/evals/mastra-scorer.md +0 -123
- package/.docs/reference/evals/noise-sensitivity.md +0 -685
- package/.docs/reference/evals/prompt-alignment.md +0 -619
- package/.docs/reference/evals/run-evals.md +0 -138
- package/.docs/reference/evals/scorer-utils.md +0 -330
- package/.docs/reference/evals/textual-difference.md +0 -113
- package/.docs/reference/evals/tone-consistency.md +0 -119
- package/.docs/reference/evals/tool-call-accuracy.md +0 -533
- package/.docs/reference/evals/toxicity.md +0 -123
- package/.docs/reference/harness/harness-class.md +0 -645
- package/.docs/reference/index.md +0 -276
- package/.docs/reference/logging/pino-logger.md +0 -117
- package/.docs/reference/memory/clone-utilities.md +0 -199
- package/.docs/reference/memory/cloneThread.md +0 -130
- package/.docs/reference/memory/createThread.md +0 -68
- package/.docs/reference/memory/deleteMessages.md +0 -40
- package/.docs/reference/memory/getThreadById.md +0 -24
- package/.docs/reference/memory/listThreads.md +0 -145
- package/.docs/reference/memory/memory-class.md +0 -147
- package/.docs/reference/memory/observational-memory.md +0 -565
- package/.docs/reference/memory/recall.md +0 -91
- package/.docs/reference/observability/tracing/bridges/otel.md +0 -131
- package/.docs/reference/observability/tracing/configuration.md +0 -178
- package/.docs/reference/observability/tracing/exporters/arize.md +0 -141
- package/.docs/reference/observability/tracing/exporters/braintrust.md +0 -93
- package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +0 -163
- package/.docs/reference/observability/tracing/exporters/console-exporter.md +0 -138
- package/.docs/reference/observability/tracing/exporters/datadog.md +0 -116
- package/.docs/reference/observability/tracing/exporters/default-exporter.md +0 -174
- package/.docs/reference/observability/tracing/exporters/laminar.md +0 -78
- package/.docs/reference/observability/tracing/exporters/langfuse.md +0 -134
- package/.docs/reference/observability/tracing/exporters/langsmith.md +0 -110
- package/.docs/reference/observability/tracing/exporters/otel.md +0 -199
- package/.docs/reference/observability/tracing/exporters/posthog.md +0 -92
- package/.docs/reference/observability/tracing/exporters/sentry.md +0 -184
- package/.docs/reference/observability/tracing/instances.md +0 -109
- package/.docs/reference/observability/tracing/interfaces.md +0 -749
- package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +0 -144
- package/.docs/reference/observability/tracing/spans.md +0 -224
- package/.docs/reference/processors/batch-parts-processor.md +0 -61
- package/.docs/reference/processors/language-detector.md +0 -81
- package/.docs/reference/processors/message-history-processor.md +0 -85
- package/.docs/reference/processors/moderation-processor.md +0 -104
- package/.docs/reference/processors/pii-detector.md +0 -107
- package/.docs/reference/processors/processor-interface.md +0 -525
- package/.docs/reference/processors/prompt-injection-detector.md +0 -71
- package/.docs/reference/processors/semantic-recall-processor.md +0 -123
- package/.docs/reference/processors/system-prompt-scrubber.md +0 -80
- package/.docs/reference/processors/token-limiter-processor.md +0 -113
- package/.docs/reference/processors/tool-call-filter.md +0 -85
- package/.docs/reference/processors/tool-search-processor.md +0 -113
- package/.docs/reference/processors/unicode-normalizer.md +0 -62
- package/.docs/reference/processors/working-memory-processor.md +0 -154
- package/.docs/reference/rag/chunk.md +0 -221
- package/.docs/reference/rag/database-config.md +0 -264
- package/.docs/reference/rag/document.md +0 -114
- package/.docs/reference/rag/embeddings.md +0 -92
- package/.docs/reference/rag/extract-params.md +0 -168
- package/.docs/reference/rag/graph-rag.md +0 -111
- package/.docs/reference/rag/metadata-filters.md +0 -216
- package/.docs/reference/rag/rerank.md +0 -80
- package/.docs/reference/rag/rerankWithScorer.md +0 -80
- package/.docs/reference/server/create-route.md +0 -260
- package/.docs/reference/server/express-adapter.md +0 -176
- package/.docs/reference/server/fastify-adapter.md +0 -90
- package/.docs/reference/server/hono-adapter.md +0 -162
- package/.docs/reference/server/koa-adapter.md +0 -127
- package/.docs/reference/server/mastra-server.md +0 -298
- package/.docs/reference/server/register-api-route.md +0 -249
- package/.docs/reference/server/routes.md +0 -306
- package/.docs/reference/storage/cloudflare-d1.md +0 -218
- package/.docs/reference/storage/cloudflare.md +0 -88
- package/.docs/reference/storage/composite.md +0 -235
- package/.docs/reference/storage/convex.md +0 -161
- package/.docs/reference/storage/dynamodb.md +0 -282
- package/.docs/reference/storage/lance.md +0 -131
- package/.docs/reference/storage/libsql.md +0 -135
- package/.docs/reference/storage/mongodb.md +0 -262
- package/.docs/reference/storage/mssql.md +0 -155
- package/.docs/reference/storage/overview.md +0 -121
- package/.docs/reference/storage/postgresql.md +0 -529
- package/.docs/reference/storage/upstash.md +0 -160
- package/.docs/reference/streaming/ChunkType.md +0 -292
- package/.docs/reference/streaming/agents/MastraModelOutput.md +0 -182
- package/.docs/reference/streaming/agents/stream.md +0 -212
- package/.docs/reference/streaming/agents/streamLegacy.md +0 -142
- package/.docs/reference/streaming/workflows/observeStream.md +0 -42
- package/.docs/reference/streaming/workflows/resumeStream.md +0 -61
- package/.docs/reference/streaming/workflows/stream.md +0 -88
- package/.docs/reference/streaming/workflows/timeTravelStream.md +0 -142
- package/.docs/reference/templates/overview.md +0 -194
- package/.docs/reference/tools/create-tool.md +0 -237
- package/.docs/reference/tools/document-chunker-tool.md +0 -89
- package/.docs/reference/tools/graph-rag-tool.md +0 -185
- package/.docs/reference/tools/mcp-client.md +0 -962
- package/.docs/reference/tools/mcp-server.md +0 -1275
- package/.docs/reference/tools/vector-query-tool.md +0 -459
- package/.docs/reference/vectors/astra.md +0 -121
- package/.docs/reference/vectors/chroma.md +0 -267
- package/.docs/reference/vectors/convex.md +0 -303
- package/.docs/reference/vectors/couchbase.md +0 -226
- package/.docs/reference/vectors/duckdb.md +0 -318
- package/.docs/reference/vectors/elasticsearch.md +0 -189
- package/.docs/reference/vectors/lance.md +0 -220
- package/.docs/reference/vectors/libsql.md +0 -305
- package/.docs/reference/vectors/mongodb.md +0 -295
- package/.docs/reference/vectors/opensearch.md +0 -99
- package/.docs/reference/vectors/pg.md +0 -408
- package/.docs/reference/vectors/pinecone.md +0 -168
- package/.docs/reference/vectors/qdrant.md +0 -222
- package/.docs/reference/vectors/s3vectors.md +0 -277
- package/.docs/reference/vectors/turbopuffer.md +0 -157
- package/.docs/reference/vectors/upstash.md +0 -294
- package/.docs/reference/vectors/vectorize.md +0 -147
- package/.docs/reference/voice/azure.md +0 -148
- package/.docs/reference/voice/cloudflare.md +0 -83
- package/.docs/reference/voice/composite-voice.md +0 -121
- package/.docs/reference/voice/deepgram.md +0 -79
- package/.docs/reference/voice/elevenlabs.md +0 -98
- package/.docs/reference/voice/google-gemini-live.md +0 -378
- package/.docs/reference/voice/google.md +0 -228
- package/.docs/reference/voice/mastra-voice.md +0 -313
- package/.docs/reference/voice/murf.md +0 -122
- package/.docs/reference/voice/openai-realtime.md +0 -203
- package/.docs/reference/voice/openai.md +0 -88
- package/.docs/reference/voice/playai.md +0 -80
- package/.docs/reference/voice/sarvam.md +0 -126
- package/.docs/reference/voice/speechify.md +0 -75
- package/.docs/reference/voice/voice.addInstructions.md +0 -56
- package/.docs/reference/voice/voice.addTools.md +0 -67
- package/.docs/reference/voice/voice.answer.md +0 -54
- package/.docs/reference/voice/voice.close.md +0 -51
- package/.docs/reference/voice/voice.connect.md +0 -94
- package/.docs/reference/voice/voice.events.md +0 -37
- package/.docs/reference/voice/voice.getSpeakers.md +0 -129
- package/.docs/reference/voice/voice.listen.md +0 -164
- package/.docs/reference/voice/voice.off.md +0 -54
- package/.docs/reference/voice/voice.on.md +0 -111
- package/.docs/reference/voice/voice.send.md +0 -65
- package/.docs/reference/voice/voice.speak.md +0 -157
- package/.docs/reference/voice/voice.updateConfig.md +0 -60
- package/.docs/reference/workflows/run-methods/cancel.md +0 -86
- package/.docs/reference/workflows/run-methods/restart.md +0 -33
- package/.docs/reference/workflows/run-methods/resume.md +0 -59
- package/.docs/reference/workflows/run-methods/start.md +0 -58
- package/.docs/reference/workflows/run-methods/startAsync.md +0 -67
- package/.docs/reference/workflows/run-methods/timeTravel.md +0 -142
- package/.docs/reference/workflows/run.md +0 -59
- package/.docs/reference/workflows/step.md +0 -119
- package/.docs/reference/workflows/workflow-methods/branch.md +0 -25
- package/.docs/reference/workflows/workflow-methods/commit.md +0 -17
- package/.docs/reference/workflows/workflow-methods/create-run.md +0 -63
- package/.docs/reference/workflows/workflow-methods/dountil.md +0 -25
- package/.docs/reference/workflows/workflow-methods/dowhile.md +0 -25
- package/.docs/reference/workflows/workflow-methods/foreach.md +0 -118
- package/.docs/reference/workflows/workflow-methods/map.md +0 -93
- package/.docs/reference/workflows/workflow-methods/parallel.md +0 -21
- package/.docs/reference/workflows/workflow-methods/sleep.md +0 -35
- package/.docs/reference/workflows/workflow-methods/sleepUntil.md +0 -35
- package/.docs/reference/workflows/workflow-methods/then.md +0 -21
- package/.docs/reference/workflows/workflow.md +0 -157
- package/.docs/reference/workspace/e2b-sandbox.md +0 -288
- package/.docs/reference/workspace/filesystem.md +0 -202
- package/.docs/reference/workspace/gcs-filesystem.md +0 -170
- package/.docs/reference/workspace/local-filesystem.md +0 -327
- package/.docs/reference/workspace/local-sandbox.md +0 -285
- package/.docs/reference/workspace/s3-filesystem.md +0 -169
- package/.docs/reference/workspace/sandbox.md +0 -81
- package/.docs/reference/workspace/workspace-class.md +0 -226
package/.docs/reference/index.md
DELETED
|
@@ -1,276 +0,0 @@
|
|
|
1
|
-
# Reference
|
|
2
|
-
|
|
3
|
-
The Reference section provides documentation of Mastra's API, including parameters, types and usage examples.
|
|
4
|
-
|
|
5
|
-
- [Agent Class](https://mastra.ai/reference/agents/agent)
|
|
6
|
-
- [.generate()](https://mastra.ai/reference/agents/generate)
|
|
7
|
-
- [.generateLegacy()](https://mastra.ai/reference/agents/generateLegacy)
|
|
8
|
-
- [.getDefaultGenerateOptionsLegacy()](https://mastra.ai/reference/agents/getDefaultGenerateOptions)
|
|
9
|
-
- [.getDefaultOptions()](https://mastra.ai/reference/agents/getDefaultOptions)
|
|
10
|
-
- [.getDefaultStreamOptionsLegacy()](https://mastra.ai/reference/agents/getDefaultStreamOptions)
|
|
11
|
-
- [.getDescription()](https://mastra.ai/reference/agents/getDescription)
|
|
12
|
-
- [.getInstructions()](https://mastra.ai/reference/agents/getInstructions)
|
|
13
|
-
- [.getLLM()](https://mastra.ai/reference/agents/getLLM)
|
|
14
|
-
- [.getMemory()](https://mastra.ai/reference/agents/getMemory)
|
|
15
|
-
- [.getModel()](https://mastra.ai/reference/agents/getModel)
|
|
16
|
-
- [.getVoice()](https://mastra.ai/reference/agents/getVoice)
|
|
17
|
-
- [.getTools()](https://mastra.ai/reference/agents/getTools)
|
|
18
|
-
- [.listAgents()](https://mastra.ai/reference/agents/listAgents)
|
|
19
|
-
- [.listScorers()](https://mastra.ai/reference/agents/listScorers)
|
|
20
|
-
- [.listTools()](https://mastra.ai/reference/agents/listTools)
|
|
21
|
-
- [.listWorkflows()](https://mastra.ai/reference/agents/listWorkflows)
|
|
22
|
-
- [.network()](https://mastra.ai/reference/agents/network)
|
|
23
|
-
- [chatRoute()](https://mastra.ai/reference/ai-sdk/chat-route)
|
|
24
|
-
- [handleChatStream()](https://mastra.ai/reference/ai-sdk/handle-chat-stream)
|
|
25
|
-
- [handleNetworkStream()](https://mastra.ai/reference/ai-sdk/handle-network-stream)
|
|
26
|
-
- [handleWorkflowStream()](https://mastra.ai/reference/ai-sdk/handle-workflow-stream)
|
|
27
|
-
- [networkRoute()](https://mastra.ai/reference/ai-sdk/network-route)
|
|
28
|
-
- [toAISdkStream()](https://mastra.ai/reference/ai-sdk/to-ai-sdk-stream)
|
|
29
|
-
- [toAISdkV4Messages()](https://mastra.ai/reference/ai-sdk/to-ai-sdk-v4-messages)
|
|
30
|
-
- [toAISdkV5Messages()](https://mastra.ai/reference/ai-sdk/to-ai-sdk-v5-messages)
|
|
31
|
-
- [withMastra()](https://mastra.ai/reference/ai-sdk/with-mastra)
|
|
32
|
-
- [workflowRoute()](https://mastra.ai/reference/ai-sdk/workflow-route)
|
|
33
|
-
- [Auth0](https://mastra.ai/reference/auth/auth0)
|
|
34
|
-
- [Better Auth](https://mastra.ai/reference/auth/better-auth)
|
|
35
|
-
- [Clerk](https://mastra.ai/reference/auth/clerk)
|
|
36
|
-
- [Firebase](https://mastra.ai/reference/auth/firebase)
|
|
37
|
-
- [JSON Web Token](https://mastra.ai/reference/auth/jwt)
|
|
38
|
-
- [Supabase](https://mastra.ai/reference/auth/supabase)
|
|
39
|
-
- [WorkOS](https://mastra.ai/reference/auth/workos)
|
|
40
|
-
- [create-mastra](https://mastra.ai/reference/cli/create-mastra)
|
|
41
|
-
- [mastra](https://mastra.ai/reference/cli/mastra)
|
|
42
|
-
- [Agents API](https://mastra.ai/reference/client-js/agents)
|
|
43
|
-
- [Error Handling](https://mastra.ai/reference/client-js/error-handling)
|
|
44
|
-
- [Logs API](https://mastra.ai/reference/client-js/logs)
|
|
45
|
-
- [Mastra Client SDK](https://mastra.ai/reference/client-js/mastra-client)
|
|
46
|
-
- [Memory API](https://mastra.ai/reference/client-js/memory)
|
|
47
|
-
- [Observability API](https://mastra.ai/reference/client-js/observability)
|
|
48
|
-
- [Telemetry API](https://mastra.ai/reference/client-js/telemetry)
|
|
49
|
-
- [Tools API](https://mastra.ai/reference/client-js/tools)
|
|
50
|
-
- [Vectors API](https://mastra.ai/reference/client-js/vectors)
|
|
51
|
-
- [Workflows API](https://mastra.ai/reference/client-js/workflows)
|
|
52
|
-
- [Mastra Class](https://mastra.ai/reference/core/mastra-class)
|
|
53
|
-
- [MastraModelGateway](https://mastra.ai/reference/core/mastra-model-gateway)
|
|
54
|
-
- [.addGateway()](https://mastra.ai/reference/core/addGateway)
|
|
55
|
-
- [.getAgent()](https://mastra.ai/reference/core/getAgent)
|
|
56
|
-
- [.getAgentById()](https://mastra.ai/reference/core/getAgentById)
|
|
57
|
-
- [.getDeployer()](https://mastra.ai/reference/core/getDeployer)
|
|
58
|
-
- [.getGateway()](https://mastra.ai/reference/core/getGateway)
|
|
59
|
-
- [.getGatewayById()](https://mastra.ai/reference/core/getGatewayById)
|
|
60
|
-
- [.getLogger()](https://mastra.ai/reference/core/getLogger)
|
|
61
|
-
- [.getMCPServer()](https://mastra.ai/reference/core/getMCPServer)
|
|
62
|
-
- [.getMCPServerById()](https://mastra.ai/reference/core/getMCPServerById)
|
|
63
|
-
- [.getMemory()](https://mastra.ai/reference/core/getMemory)
|
|
64
|
-
- [.getScorer()](https://mastra.ai/reference/core/getScorer)
|
|
65
|
-
- [.getScorerById()](https://mastra.ai/reference/core/getScorerById)
|
|
66
|
-
- [.getServer()](https://mastra.ai/reference/core/getServer)
|
|
67
|
-
- [.getStorage()](https://mastra.ai/reference/core/getStorage)
|
|
68
|
-
- [.getStoredAgentById()](https://mastra.ai/reference/core/getStoredAgentById)
|
|
69
|
-
- [.getTelemetry()](https://mastra.ai/reference/core/getTelemetry)
|
|
70
|
-
- [.getVector()](https://mastra.ai/reference/core/getVector)
|
|
71
|
-
- [.getWorkflow()](https://mastra.ai/reference/core/getWorkflow)
|
|
72
|
-
- [.listAgents()](https://mastra.ai/reference/core/listAgents)
|
|
73
|
-
- [.listGateways()](https://mastra.ai/reference/core/listGateways)
|
|
74
|
-
- [.listLogs()](https://mastra.ai/reference/core/listLogs)
|
|
75
|
-
- [.listLogsByRunId()](https://mastra.ai/reference/core/listLogsByRunId)
|
|
76
|
-
- [.listMCPServers()](https://mastra.ai/reference/core/listMCPServers)
|
|
77
|
-
- [.listMemory()](https://mastra.ai/reference/core/listMemory)
|
|
78
|
-
- [.listScorers()](https://mastra.ai/reference/core/listScorers)
|
|
79
|
-
- [.listStoredAgents()](https://mastra.ai/reference/core/listStoredAgents)
|
|
80
|
-
- [.listVectors()](https://mastra.ai/reference/core/listVectors)
|
|
81
|
-
- [.listWorkflows()](https://mastra.ai/reference/core/listWorkflows)
|
|
82
|
-
- [.setLogger()](https://mastra.ai/reference/core/setLogger)
|
|
83
|
-
- [.setStorage()](https://mastra.ai/reference/core/setStorage)
|
|
84
|
-
- [Cloudflare](https://mastra.ai/reference/deployer/cloudflare)
|
|
85
|
-
- [Deployer](https://mastra.ai/reference/deployer)
|
|
86
|
-
- [Netlify](https://mastra.ai/reference/deployer/netlify)
|
|
87
|
-
- [Vercel](https://mastra.ai/reference/deployer/vercel)
|
|
88
|
-
- [Answer Relevancy Scorer](https://mastra.ai/reference/evals/answer-relevancy)
|
|
89
|
-
- [Answer Similarity Scorer](https://mastra.ai/reference/evals/answer-similarity)
|
|
90
|
-
- [Bias](https://mastra.ai/reference/evals/bias)
|
|
91
|
-
- [Completeness](https://mastra.ai/reference/evals/completeness)
|
|
92
|
-
- [Content Similarity Scorer](https://mastra.ai/reference/evals/content-similarity)
|
|
93
|
-
- [Context Precision Scorer](https://mastra.ai/reference/evals/context-precision)
|
|
94
|
-
- [Context Relevance Scorer](https://mastra.ai/reference/evals/context-relevance)
|
|
95
|
-
- [createScorer](https://mastra.ai/reference/evals/create-scorer)
|
|
96
|
-
- [Faithfulness](https://mastra.ai/reference/evals/faithfulness)
|
|
97
|
-
- [Hallucination](https://mastra.ai/reference/evals/hallucination)
|
|
98
|
-
- [Keyword Coverage Scorer](https://mastra.ai/reference/evals/keyword-coverage)
|
|
99
|
-
- [MastraScorer](https://mastra.ai/reference/evals/mastra-scorer)
|
|
100
|
-
- [Noise Sensitivity Scorer](https://mastra.ai/reference/evals/noise-sensitivity)
|
|
101
|
-
- [Prompt Alignment Scorer](https://mastra.ai/reference/evals/prompt-alignment)
|
|
102
|
-
- [runEvals](https://mastra.ai/reference/evals/run-evals)
|
|
103
|
-
- [Scorer Utils](https://mastra.ai/reference/evals/scorer-utils)
|
|
104
|
-
- [Textual Difference Scorer](https://mastra.ai/reference/evals/textual-difference)
|
|
105
|
-
- [Tone Consistency Scorer](https://mastra.ai/reference/evals/tone-consistency)
|
|
106
|
-
- [Tool Call Accuracy Scorers](https://mastra.ai/reference/evals/tool-call-accuracy)
|
|
107
|
-
- [Toxicity](https://mastra.ai/reference/evals/toxicity)
|
|
108
|
-
- [Memory Class](https://mastra.ai/reference/memory/memory-class)
|
|
109
|
-
- [Observational Memory](https://mastra.ai/reference/memory/observational-memory)
|
|
110
|
-
- [Cloned Thread Utilities](https://mastra.ai/reference/memory/clone-utilities)
|
|
111
|
-
- [.cloneThread()](https://mastra.ai/reference/memory/cloneThread)
|
|
112
|
-
- [.createThread()](https://mastra.ai/reference/memory/createThread)
|
|
113
|
-
- [.deleteMessages()](https://mastra.ai/reference/memory/deleteMessages)
|
|
114
|
-
- [.getThreadById()](https://mastra.ai/reference/memory/getThreadById)
|
|
115
|
-
- [.listThreads()](https://mastra.ai/reference/memory/listThreads)
|
|
116
|
-
- [.recall()](https://mastra.ai/reference/memory/recall)
|
|
117
|
-
- [PinoLogger](https://mastra.ai/reference/logging/pino-logger)
|
|
118
|
-
- [Configuration](https://mastra.ai/reference/observability/tracing/configuration)
|
|
119
|
-
- [Instances](https://mastra.ai/reference/observability/tracing/instances)
|
|
120
|
-
- [Interfaces](https://mastra.ai/reference/observability/tracing/interfaces)
|
|
121
|
-
- [Spans](https://mastra.ai/reference/observability/tracing/spans)
|
|
122
|
-
- [Dataset Class](https://mastra.ai/reference/datasets/dataset)
|
|
123
|
-
- [DatasetsManager Class](https://mastra.ai/reference/datasets/datasets-manager)
|
|
124
|
-
- [.addItem()](https://mastra.ai/reference/datasets/addItem)
|
|
125
|
-
- [.addItems()](https://mastra.ai/reference/datasets/addItems)
|
|
126
|
-
- [.compareExperiments()](https://mastra.ai/reference/datasets/compareExperiments)
|
|
127
|
-
- [.create()](https://mastra.ai/reference/datasets/create)
|
|
128
|
-
- [.delete()](https://mastra.ai/reference/datasets/delete)
|
|
129
|
-
- [.deleteExperiment()](https://mastra.ai/reference/datasets/deleteExperiment)
|
|
130
|
-
- [.deleteItem()](https://mastra.ai/reference/datasets/deleteItem)
|
|
131
|
-
- [.deleteItems()](https://mastra.ai/reference/datasets/deleteItems)
|
|
132
|
-
- [.get()](https://mastra.ai/reference/datasets/get)
|
|
133
|
-
- [.getDetails()](https://mastra.ai/reference/datasets/getDetails)
|
|
134
|
-
- [.getExperiment()](https://mastra.ai/reference/datasets/getExperiment)
|
|
135
|
-
- [.getItem()](https://mastra.ai/reference/datasets/getItem)
|
|
136
|
-
- [.getItemHistory()](https://mastra.ai/reference/datasets/getItemHistory)
|
|
137
|
-
- [.list()](https://mastra.ai/reference/datasets/list)
|
|
138
|
-
- [.listExperiments()](https://mastra.ai/reference/datasets/listExperiments)
|
|
139
|
-
- [.listExperimentResults()](https://mastra.ai/reference/datasets/listExperimentResults)
|
|
140
|
-
- [.listItems()](https://mastra.ai/reference/datasets/listItems)
|
|
141
|
-
- [.listVersions()](https://mastra.ai/reference/datasets/listVersions)
|
|
142
|
-
- [.startExperiment()](https://mastra.ai/reference/datasets/startExperiment)
|
|
143
|
-
- [.startExperimentAsync()](https://mastra.ai/reference/datasets/startExperimentAsync)
|
|
144
|
-
- [.update()](https://mastra.ai/reference/datasets/update)
|
|
145
|
-
- [.updateItem()](https://mastra.ai/reference/datasets/updateItem)
|
|
146
|
-
- [BatchPartsProcessor](https://mastra.ai/reference/processors/batch-parts-processor)
|
|
147
|
-
- [LanguageDetector](https://mastra.ai/reference/processors/language-detector)
|
|
148
|
-
- [MessageHistory](https://mastra.ai/reference/processors/message-history-processor)
|
|
149
|
-
- [ModerationProcessor](https://mastra.ai/reference/processors/moderation-processor)
|
|
150
|
-
- [PIIDetector](https://mastra.ai/reference/processors/pii-detector)
|
|
151
|
-
- [Processor Interface](https://mastra.ai/reference/processors/processor-interface)
|
|
152
|
-
- [PromptInjectionDetector](https://mastra.ai/reference/processors/prompt-injection-detector)
|
|
153
|
-
- [SemanticRecall](https://mastra.ai/reference/processors/semantic-recall-processor)
|
|
154
|
-
- [SystemPromptScrubber](https://mastra.ai/reference/processors/system-prompt-scrubber)
|
|
155
|
-
- [TokenLimiterProcessor](https://mastra.ai/reference/processors/token-limiter-processor)
|
|
156
|
-
- [ToolCallFilter](https://mastra.ai/reference/processors/tool-call-filter)
|
|
157
|
-
- [ToolSearchProcessor](https://mastra.ai/reference/processors/tool-search-processor)
|
|
158
|
-
- [UnicodeNormalizer](https://mastra.ai/reference/processors/unicode-normalizer)
|
|
159
|
-
- [WorkingMemory](https://mastra.ai/reference/processors/working-memory-processor)
|
|
160
|
-
- [DatabaseConfig](https://mastra.ai/reference/rag/database-config)
|
|
161
|
-
- [Embed](https://mastra.ai/reference/rag/embeddings)
|
|
162
|
-
- [ExtractParams](https://mastra.ai/reference/rag/extract-params)
|
|
163
|
-
- [GraphRAG](https://mastra.ai/reference/rag/graph-rag)
|
|
164
|
-
- [MDocument](https://mastra.ai/reference/rag/document)
|
|
165
|
-
- [Metadata Filters](https://mastra.ai/reference/rag/metadata-filters)
|
|
166
|
-
- [.chunk()](https://mastra.ai/reference/rag/chunk)
|
|
167
|
-
- [rerank()](https://mastra.ai/reference/rag/rerank)
|
|
168
|
-
- [rerankWithScorer()](https://mastra.ai/reference/rag/rerankWithScorer)
|
|
169
|
-
- [createRoute()](https://mastra.ai/reference/server/create-route)
|
|
170
|
-
- [Express Adapter](https://mastra.ai/reference/server/express-adapter)
|
|
171
|
-
- [Fastify Adapter](https://mastra.ai/reference/server/fastify-adapter)
|
|
172
|
-
- [Hono Adapter](https://mastra.ai/reference/server/hono-adapter)
|
|
173
|
-
- [Koa Adapter](https://mastra.ai/reference/server/koa-adapter)
|
|
174
|
-
- [MastraServer](https://mastra.ai/reference/server/mastra-server)
|
|
175
|
-
- [registerApiRoute()](https://mastra.ai/reference/server/register-api-route)
|
|
176
|
-
- [Server Routes](https://mastra.ai/reference/server/routes)
|
|
177
|
-
- [Overview](https://mastra.ai/reference/storage/overview)
|
|
178
|
-
- [Composite Storage](https://mastra.ai/reference/storage/composite)
|
|
179
|
-
- [Cloudflare D1 Storage](https://mastra.ai/reference/storage/cloudflare-d1)
|
|
180
|
-
- [Cloudflare KV Storage](https://mastra.ai/reference/storage/cloudflare)
|
|
181
|
-
- [Convex Storage](https://mastra.ai/reference/storage/convex)
|
|
182
|
-
- [DynamoDB Storage](https://mastra.ai/reference/storage/dynamodb)
|
|
183
|
-
- [LanceDB Storage](https://mastra.ai/reference/storage/lance)
|
|
184
|
-
- [libSQL Storage](https://mastra.ai/reference/storage/libsql)
|
|
185
|
-
- [MongoDB Storage](https://mastra.ai/reference/storage/mongodb)
|
|
186
|
-
- [MSSQL Storage](https://mastra.ai/reference/storage/mssql)
|
|
187
|
-
- [PostgreSQL Storage](https://mastra.ai/reference/storage/postgresql)
|
|
188
|
-
- [Upstash Storage](https://mastra.ai/reference/storage/upstash)
|
|
189
|
-
- [Workspace Class](https://mastra.ai/reference/workspace/workspace-class)
|
|
190
|
-
- [LocalFilesystem](https://mastra.ai/reference/workspace/local-filesystem)
|
|
191
|
-
- [S3Filesystem](https://mastra.ai/reference/workspace/s3-filesystem)
|
|
192
|
-
- [GCSFilesystem](https://mastra.ai/reference/workspace/gcs-filesystem)
|
|
193
|
-
- [LocalSandbox](https://mastra.ai/reference/workspace/local-sandbox)
|
|
194
|
-
- [E2BSandbox](https://mastra.ai/reference/workspace/e2b-sandbox)
|
|
195
|
-
- [WorkspaceFilesystem](https://mastra.ai/reference/workspace/filesystem)
|
|
196
|
-
- [WorkspaceSandbox](https://mastra.ai/reference/workspace/sandbox)
|
|
197
|
-
- [Harness Class](https://mastra.ai/reference/harness/harness-class)
|
|
198
|
-
- [.stream()](https://mastra.ai/reference/streaming/agents/stream)
|
|
199
|
-
- [.streamLegacy()](https://mastra.ai/reference/streaming/agents/streamLegacy)
|
|
200
|
-
- [MastraModelOutput](https://mastra.ai/reference/streaming/agents/MastraModelOutput)
|
|
201
|
-
- [ChunkType](https://mastra.ai/reference/streaming/ChunkType)
|
|
202
|
-
- [.observeStream()](https://mastra.ai/reference/streaming/workflows/observeStream)
|
|
203
|
-
- [.resumeStream()](https://mastra.ai/reference/streaming/workflows/resumeStream)
|
|
204
|
-
- [.stream()](https://mastra.ai/reference/streaming/workflows/stream)
|
|
205
|
-
- [.timeTravelStream()](https://mastra.ai/reference/streaming/workflows/timeTravelStream)
|
|
206
|
-
- [Overview](https://mastra.ai/reference/templates/overview)
|
|
207
|
-
- [createDocumentChunkerTool()](https://mastra.ai/reference/tools/document-chunker-tool)
|
|
208
|
-
- [createGraphRAGTool()](https://mastra.ai/reference/tools/graph-rag-tool)
|
|
209
|
-
- [createTool()](https://mastra.ai/reference/tools/create-tool)
|
|
210
|
-
- [createVectorQueryTool()](https://mastra.ai/reference/tools/vector-query-tool)
|
|
211
|
-
- [MCPClient](https://mastra.ai/reference/tools/mcp-client)
|
|
212
|
-
- [MCPServer](https://mastra.ai/reference/tools/mcp-server)
|
|
213
|
-
- [Amazon S3 Vectors Store](https://mastra.ai/reference/vectors/s3vectors)
|
|
214
|
-
- [Astra Vector Store](https://mastra.ai/reference/vectors/astra)
|
|
215
|
-
- [Chroma Vector Store](https://mastra.ai/reference/vectors/chroma)
|
|
216
|
-
- [Cloudflare Vector Store](https://mastra.ai/reference/vectors/vectorize)
|
|
217
|
-
- [Convex Vector Store](https://mastra.ai/reference/vectors/convex)
|
|
218
|
-
- [Couchbase Vector Store](https://mastra.ai/reference/vectors/couchbase)
|
|
219
|
-
- [DuckDB Vector Store](https://mastra.ai/reference/vectors/duckdb)
|
|
220
|
-
- [ElasticSearch Vector Store](https://mastra.ai/reference/vectors/elasticsearch)
|
|
221
|
-
- [Lance Vector Store](https://mastra.ai/reference/vectors/lance)
|
|
222
|
-
- [libSQL Vector Store](https://mastra.ai/reference/vectors/libsql)
|
|
223
|
-
- [MongoDB Vector Store](https://mastra.ai/reference/vectors/mongodb)
|
|
224
|
-
- [OpenSearch Vector Store](https://mastra.ai/reference/vectors/opensearch)
|
|
225
|
-
- [PG Vector Store](https://mastra.ai/reference/vectors/pg)
|
|
226
|
-
- [Pinecone Vector Store](https://mastra.ai/reference/vectors/pinecone)
|
|
227
|
-
- [Qdrant Vector Store](https://mastra.ai/reference/vectors/qdrant)
|
|
228
|
-
- [Turbopuffer Vector Store](https://mastra.ai/reference/vectors/turbopuffer)
|
|
229
|
-
- [Upstash Vector Store](https://mastra.ai/reference/vectors/upstash)
|
|
230
|
-
- [.addInstructions()](https://mastra.ai/reference/voice/voice.addInstructions)
|
|
231
|
-
- [.addTools()](https://mastra.ai/reference/voice/voice.addTools)
|
|
232
|
-
- [.answer()](https://mastra.ai/reference/voice/voice.answer)
|
|
233
|
-
- [.close()](https://mastra.ai/reference/voice/voice.close)
|
|
234
|
-
- [.connect()](https://mastra.ai/reference/voice/voice.connect)
|
|
235
|
-
- [.getSpeakers()](https://mastra.ai/reference/voice/voice.getSpeakers)
|
|
236
|
-
- [.listen()](https://mastra.ai/reference/voice/voice.listen)
|
|
237
|
-
- [.off()](https://mastra.ai/reference/voice/voice.off)
|
|
238
|
-
- [.on()](https://mastra.ai/reference/voice/voice.on)
|
|
239
|
-
- [.send()](https://mastra.ai/reference/voice/voice.send)
|
|
240
|
-
- [.speak()](https://mastra.ai/reference/voice/voice.speak)
|
|
241
|
-
- [.updateConfig()](https://mastra.ai/reference/voice/voice.updateConfig)
|
|
242
|
-
- [Azure](https://mastra.ai/reference/voice/azure)
|
|
243
|
-
- [Cloudflare](https://mastra.ai/reference/voice/cloudflare)
|
|
244
|
-
- [Composite Voice](https://mastra.ai/reference/voice/composite-voice)
|
|
245
|
-
- [Deepgram](https://mastra.ai/reference/voice/deepgram)
|
|
246
|
-
- [ElevenLabs](https://mastra.ai/reference/voice/elevenlabs)
|
|
247
|
-
- [Events](https://mastra.ai/reference/voice/voice.events)
|
|
248
|
-
- [Google](https://mastra.ai/reference/voice/google)
|
|
249
|
-
- [Google Gemini Live](https://mastra.ai/reference/voice/google-gemini-live)
|
|
250
|
-
- [Mastra Voice](https://mastra.ai/reference/voice/mastra-voice)
|
|
251
|
-
- [Murf](https://mastra.ai/reference/voice/murf)
|
|
252
|
-
- [OpenAI](https://mastra.ai/reference/voice/openai)
|
|
253
|
-
- [OpenAI Realtime](https://mastra.ai/reference/voice/openai-realtime)
|
|
254
|
-
- [PlayAI](https://mastra.ai/reference/voice/playai)
|
|
255
|
-
- [Sarvam](https://mastra.ai/reference/voice/sarvam)
|
|
256
|
-
- [Speechify](https://mastra.ai/reference/voice/speechify)
|
|
257
|
-
- [.branch()](https://mastra.ai/reference/workflows/workflow-methods/branch)
|
|
258
|
-
- [.commit()](https://mastra.ai/reference/workflows/workflow-methods/commit)
|
|
259
|
-
- [.createRun()](https://mastra.ai/reference/workflows/workflow-methods/create-run)
|
|
260
|
-
- [.dountil()](https://mastra.ai/reference/workflows/workflow-methods/dountil)
|
|
261
|
-
- [.dowhile()](https://mastra.ai/reference/workflows/workflow-methods/dowhile)
|
|
262
|
-
- [.foreach()](https://mastra.ai/reference/workflows/workflow-methods/foreach)
|
|
263
|
-
- [.map()](https://mastra.ai/reference/workflows/workflow-methods/map)
|
|
264
|
-
- [.parallel()](https://mastra.ai/reference/workflows/workflow-methods/parallel)
|
|
265
|
-
- [.sleep()](https://mastra.ai/reference/workflows/workflow-methods/sleep)
|
|
266
|
-
- [.sleepUntil()](https://mastra.ai/reference/workflows/workflow-methods/sleepUntil)
|
|
267
|
-
- [.then()](https://mastra.ai/reference/workflows/workflow-methods/then)
|
|
268
|
-
- [Run Class](https://mastra.ai/reference/workflows/run)
|
|
269
|
-
- [.cancel()](https://mastra.ai/reference/workflows/run-methods/cancel)
|
|
270
|
-
- [.restart()](https://mastra.ai/reference/workflows/run-methods/restart)
|
|
271
|
-
- [.resume()](https://mastra.ai/reference/workflows/run-methods/resume)
|
|
272
|
-
- [.start()](https://mastra.ai/reference/workflows/run-methods/start)
|
|
273
|
-
- [.startAsync()](https://mastra.ai/reference/workflows/run-methods/startAsync)
|
|
274
|
-
- [.timeTravel()](https://mastra.ai/reference/workflows/run-methods/timeTravel)
|
|
275
|
-
- [Step Class](https://mastra.ai/reference/workflows/step)
|
|
276
|
-
- [Workflow Class](https://mastra.ai/reference/workflows/workflow)
|
|
@@ -1,117 +0,0 @@
|
|
|
1
|
-
# PinoLogger
|
|
2
|
-
|
|
3
|
-
A Logger instance is created using `new PinoLogger()` and provides methods to record events at various severity levels.
|
|
4
|
-
|
|
5
|
-
When deploying to Mastra Cloud, logs are displayed on the [Logs](https://mastra.ai/docs/mastra-cloud/observability) page. In self-hosted or custom environments, logs can be directed to files or external services depending on the configured transports.
|
|
6
|
-
|
|
7
|
-
## Usage example
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { Mastra } from "@mastra/core";
|
|
11
|
-
import { PinoLogger } from "@mastra/loggers";
|
|
12
|
-
|
|
13
|
-
export const mastra = new Mastra({
|
|
14
|
-
logger: new PinoLogger({
|
|
15
|
-
name: "Mastra",
|
|
16
|
-
level: "info",
|
|
17
|
-
}),
|
|
18
|
-
});
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Parameters
|
|
22
|
-
|
|
23
|
-
**name:** (`string`): A label used to group and identify logs from this logger.
|
|
24
|
-
|
|
25
|
-
**level:** (`"debug" | "info" | "warn" | "error"`): Sets the minimum log level. Messages below this level are ignored.
|
|
26
|
-
|
|
27
|
-
**transports:** (`Record<string, LoggerTransport>`): A map of transport instances used to persist logs.
|
|
28
|
-
|
|
29
|
-
**overrideDefaultTransports?:** (`boolean`): If true, disables the default console transport.
|
|
30
|
-
|
|
31
|
-
**formatters?:** (`pino.LoggerOptions['formatters']`): Custom Pino formatters for log serialization.
|
|
32
|
-
|
|
33
|
-
## File transport (structured logs)
|
|
34
|
-
|
|
35
|
-
Writes structured logs to a file using the `FileTransport`. The logger accepts a plain message as the first argument and structured metadata as the second argument. These are internally converted to a `BaseLogMessage` and persisted to the configured file path.
|
|
36
|
-
|
|
37
|
-
```typescript
|
|
38
|
-
import { FileTransport } from "@mastra/loggers/file";
|
|
39
|
-
import { PinoLogger } from "@mastra/loggers/pino";
|
|
40
|
-
|
|
41
|
-
export const fileLogger = new PinoLogger({
|
|
42
|
-
name: "Mastra",
|
|
43
|
-
transports: { file: new FileTransport({ path: "test-dir/test.log" }) },
|
|
44
|
-
level: "warn",
|
|
45
|
-
});
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
### File transport usage
|
|
49
|
-
|
|
50
|
-
```typescript
|
|
51
|
-
fileLogger.warn("Low disk space", {
|
|
52
|
-
destinationPath: "system",
|
|
53
|
-
type: "WORKFLOW",
|
|
54
|
-
});
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
## Upstash transport (remote log drain)
|
|
58
|
-
|
|
59
|
-
Streams structured logs to a remote Redis list using the `UpstashTransport`. The logger accepts a string message and a structured metadata object. This enables centralized logging for distributed environments, supporting filtering by `destinationPath`, `type`, and `runId`.
|
|
60
|
-
|
|
61
|
-
```typescript
|
|
62
|
-
import { UpstashTransport } from "@mastra/loggers/upstash";
|
|
63
|
-
import { PinoLogger } from "@mastra/loggers/pino";
|
|
64
|
-
|
|
65
|
-
export const upstashLogger = new PinoLogger({
|
|
66
|
-
name: "Mastra",
|
|
67
|
-
transports: {
|
|
68
|
-
upstash: new UpstashTransport({
|
|
69
|
-
listName: "production-logs",
|
|
70
|
-
upstashUrl: process.env.UPSTASH_URL!,
|
|
71
|
-
upstashToken: process.env.UPSTASH_TOKEN!,
|
|
72
|
-
}),
|
|
73
|
-
},
|
|
74
|
-
level: "info",
|
|
75
|
-
});
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
### Upstash transport usage
|
|
79
|
-
|
|
80
|
-
```typescript
|
|
81
|
-
upstashLogger.info("User signed in", {
|
|
82
|
-
destinationPath: "auth",
|
|
83
|
-
type: "AGENT",
|
|
84
|
-
runId: "run_123",
|
|
85
|
-
});
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
## Custom transport
|
|
89
|
-
|
|
90
|
-
You can create custom transports using the `createCustomTransport` utility to integrate with any logging service or stream.
|
|
91
|
-
|
|
92
|
-
### Sentry transport example
|
|
93
|
-
|
|
94
|
-
Creates a custom transport using `createCustomTransport` and integrates it with a third-party logging stream such as `pino-sentry-transport`. This allows forwarding logs to an external system like Sentry for advanced monitoring and observability.
|
|
95
|
-
|
|
96
|
-
```typescript
|
|
97
|
-
import { createCustomTransport } from "@mastra/core/loggers";
|
|
98
|
-
import { PinoLogger } from "@mastra/loggers/pino";
|
|
99
|
-
import pinoSentry from "pino-sentry-transport";
|
|
100
|
-
|
|
101
|
-
const sentryStream = await pinoSentry({
|
|
102
|
-
sentry: {
|
|
103
|
-
dsn: "YOUR_SENTRY_DSN",
|
|
104
|
-
_experiments: {
|
|
105
|
-
enableLogs: true,
|
|
106
|
-
},
|
|
107
|
-
},
|
|
108
|
-
});
|
|
109
|
-
|
|
110
|
-
const customTransport = createCustomTransport(sentryStream);
|
|
111
|
-
|
|
112
|
-
export const sentryLogger = new PinoLogger({
|
|
113
|
-
name: "Mastra",
|
|
114
|
-
level: "info",
|
|
115
|
-
transports: { sentry: customTransport },
|
|
116
|
-
});
|
|
117
|
-
```
|
|
@@ -1,199 +0,0 @@
|
|
|
1
|
-
# Cloned Thread Utilities
|
|
2
|
-
|
|
3
|
-
The Memory class provides utility methods for working with cloned threads. These methods help you check clone status, retrieve clone metadata, navigate clone relationships, and track clone history.
|
|
4
|
-
|
|
5
|
-
## isClone()
|
|
6
|
-
|
|
7
|
-
Checks whether a thread is a clone of another thread.
|
|
8
|
-
|
|
9
|
-
### Usage
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
const isClonedThread = memory.isClone(thread);
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
### Parameters
|
|
16
|
-
|
|
17
|
-
**thread:** (`StorageThreadType`): The thread object to check.
|
|
18
|
-
|
|
19
|
-
### Example
|
|
20
|
-
|
|
21
|
-
```typescript
|
|
22
|
-
const thread = await memory.getThreadById({ threadId: "some-thread-id" });
|
|
23
|
-
|
|
24
|
-
if (memory.isClone(thread)) {
|
|
25
|
-
console.log("This thread was cloned from another thread");
|
|
26
|
-
} else {
|
|
27
|
-
console.log("This is an original thread");
|
|
28
|
-
}
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
## getCloneMetadata()
|
|
32
|
-
|
|
33
|
-
Retrieves the clone metadata from a thread if it exists.
|
|
34
|
-
|
|
35
|
-
### Usage
|
|
36
|
-
|
|
37
|
-
```typescript
|
|
38
|
-
const metadata = memory.getCloneMetadata(thread);
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### Parameters
|
|
42
|
-
|
|
43
|
-
**thread:** (`StorageThreadType`): The thread object to extract clone metadata from.
|
|
44
|
-
|
|
45
|
-
### Example
|
|
46
|
-
|
|
47
|
-
```typescript
|
|
48
|
-
const thread = await memory.getThreadById({ threadId: "cloned-thread-id" });
|
|
49
|
-
const cloneInfo = memory.getCloneMetadata(thread);
|
|
50
|
-
|
|
51
|
-
if (cloneInfo) {
|
|
52
|
-
console.log(`Cloned from: ${cloneInfo.sourceThreadId}`);
|
|
53
|
-
console.log(`Cloned at: ${cloneInfo.clonedAt}`);
|
|
54
|
-
}
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
## getSourceThread()
|
|
58
|
-
|
|
59
|
-
Retrieves the original source thread that a cloned thread was created from.
|
|
60
|
-
|
|
61
|
-
### Usage
|
|
62
|
-
|
|
63
|
-
```typescript
|
|
64
|
-
const sourceThread = await memory.getSourceThread(threadId);
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
### Parameters
|
|
68
|
-
|
|
69
|
-
**threadId:** (`string`): The ID of the cloned thread.
|
|
70
|
-
|
|
71
|
-
### Example
|
|
72
|
-
|
|
73
|
-
```typescript
|
|
74
|
-
const sourceThread = await memory.getSourceThread("cloned-thread-id");
|
|
75
|
-
|
|
76
|
-
if (sourceThread) {
|
|
77
|
-
console.log(`Original thread title: ${sourceThread.title}`);
|
|
78
|
-
console.log(`Original thread created: ${sourceThread.createdAt}`);
|
|
79
|
-
}
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
## listClones()
|
|
83
|
-
|
|
84
|
-
Lists all threads that were cloned from a specific source thread.
|
|
85
|
-
|
|
86
|
-
### Usage
|
|
87
|
-
|
|
88
|
-
```typescript
|
|
89
|
-
const clones = await memory.listClones(sourceThreadId);
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
### Parameters
|
|
93
|
-
|
|
94
|
-
**sourceThreadId:** (`string`): The ID of the source thread to find clones for.
|
|
95
|
-
|
|
96
|
-
### Example
|
|
97
|
-
|
|
98
|
-
```typescript
|
|
99
|
-
const clones = await memory.listClones("original-thread-id");
|
|
100
|
-
|
|
101
|
-
console.log(`Found ${clones.length} clones`);
|
|
102
|
-
for (const clone of clones) {
|
|
103
|
-
console.log(`- ${clone.id}: ${clone.title}`);
|
|
104
|
-
}
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
## getCloneHistory()
|
|
108
|
-
|
|
109
|
-
Retrieves the full clone history chain for a thread, tracing back to the original.
|
|
110
|
-
|
|
111
|
-
### Usage
|
|
112
|
-
|
|
113
|
-
```typescript
|
|
114
|
-
const history = await memory.getCloneHistory(threadId);
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
### Parameters
|
|
118
|
-
|
|
119
|
-
**threadId:** (`string`): The ID of the thread to get clone history for.
|
|
120
|
-
|
|
121
|
-
### Example
|
|
122
|
-
|
|
123
|
-
```typescript
|
|
124
|
-
// If thread-c was cloned from thread-b, which was cloned from thread-a
|
|
125
|
-
const history = await memory.getCloneHistory("thread-c");
|
|
126
|
-
|
|
127
|
-
// history = [thread-a, thread-b, thread-c]
|
|
128
|
-
console.log(`Clone depth: ${history.length - 1}`);
|
|
129
|
-
console.log(`Original thread: ${history[0].id}`);
|
|
130
|
-
console.log(`Current thread: ${history[history.length - 1].id}`);
|
|
131
|
-
|
|
132
|
-
// Display the clone chain
|
|
133
|
-
for (let i = 0; i < history.length; i++) {
|
|
134
|
-
const prefix = i === 0 ? "Original" : `Clone ${i}`;
|
|
135
|
-
console.log(`${prefix}: ${history[i].title}`);
|
|
136
|
-
}
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
## Complete Example
|
|
140
|
-
|
|
141
|
-
```typescript
|
|
142
|
-
import { mastra } from "./mastra";
|
|
143
|
-
|
|
144
|
-
async function manageClones() {
|
|
145
|
-
const agent = mastra.getAgent("agent");
|
|
146
|
-
const memory = await agent.getMemory();
|
|
147
|
-
|
|
148
|
-
// Create an original conversation
|
|
149
|
-
const originalThread = await memory.createThread({
|
|
150
|
-
resourceId: "user-123",
|
|
151
|
-
title: "Original Conversation",
|
|
152
|
-
});
|
|
153
|
-
|
|
154
|
-
// Have a conversation...
|
|
155
|
-
await agent.generate("Hello! Let's discuss project options.", {
|
|
156
|
-
threadId: originalThread.id,
|
|
157
|
-
resourceId: "user-123",
|
|
158
|
-
});
|
|
159
|
-
|
|
160
|
-
// Create multiple branches (clones) to explore different paths
|
|
161
|
-
const { thread: optionA } = await memory.cloneThread({
|
|
162
|
-
sourceThreadId: originalThread.id,
|
|
163
|
-
title: "Option A - Conservative Approach",
|
|
164
|
-
});
|
|
165
|
-
|
|
166
|
-
const { thread: optionB } = await memory.cloneThread({
|
|
167
|
-
sourceThreadId: originalThread.id,
|
|
168
|
-
title: "Option B - Aggressive Approach",
|
|
169
|
-
});
|
|
170
|
-
|
|
171
|
-
// Check clone status
|
|
172
|
-
console.log(memory.isClone(originalThread)); // false
|
|
173
|
-
console.log(memory.isClone(optionA)); // true
|
|
174
|
-
console.log(memory.isClone(optionB)); // true
|
|
175
|
-
|
|
176
|
-
// Get clone metadata
|
|
177
|
-
const metadataA = memory.getCloneMetadata(optionA);
|
|
178
|
-
console.log(metadataA?.sourceThreadId); // originalThread.id
|
|
179
|
-
|
|
180
|
-
// List all clones of the original
|
|
181
|
-
const allClones = await memory.listClones(originalThread.id);
|
|
182
|
-
console.log(`Total alternatives: ${allClones.length}`); // 2
|
|
183
|
-
|
|
184
|
-
// Get source thread from a clone
|
|
185
|
-
const source = await memory.getSourceThread(optionA.id);
|
|
186
|
-
console.log(source?.id === originalThread.id); // true
|
|
187
|
-
|
|
188
|
-
// Create a deeper clone chain
|
|
189
|
-
const { thread: optionA2 } = await memory.cloneThread({
|
|
190
|
-
sourceThreadId: optionA.id,
|
|
191
|
-
title: "Option A - Variant 2",
|
|
192
|
-
});
|
|
193
|
-
|
|
194
|
-
// Get the full history
|
|
195
|
-
const history = await memory.getCloneHistory(optionA2.id);
|
|
196
|
-
// history = [originalThread, optionA, optionA2]
|
|
197
|
-
console.log(`Clone depth: ${history.length - 1}`); // 2
|
|
198
|
-
}
|
|
199
|
-
```
|