@mastra/core 1.6.0 → 1.7.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 +236 -0
- package/dist/agent/agent.d.ts +6 -0
- package/dist/agent/agent.d.ts.map +1 -1
- package/dist/agent/index.cjs +8 -8
- package/dist/agent/index.js +1 -1
- package/dist/{chunk-VJWRJWSC.cjs → chunk-2X66GWF5.cjs} +94 -16
- package/dist/chunk-2X66GWF5.cjs.map +1 -0
- package/dist/{chunk-YM6245EM.js → chunk-6OXW5E2O.js} +3 -3
- package/dist/{chunk-YM6245EM.js.map → chunk-6OXW5E2O.js.map} +1 -1
- package/dist/{chunk-XWZAKKFT.cjs → chunk-6QBN6MZY.cjs} +14 -14
- package/dist/{chunk-XWZAKKFT.cjs.map → chunk-6QBN6MZY.cjs.map} +1 -1
- package/dist/{chunk-AYHSPIT6.cjs → chunk-7UAJ6LMR.cjs} +820 -259
- package/dist/chunk-7UAJ6LMR.cjs.map +1 -0
- package/dist/{chunk-RZNHRIM7.cjs → chunk-A72NTLFT.cjs} +5 -5
- package/dist/{chunk-RZNHRIM7.cjs.map → chunk-A72NTLFT.cjs.map} +1 -1
- package/dist/{chunk-EEU5NHHU.js → chunk-DFCRXDVK.js} +3 -3
- package/dist/{chunk-EEU5NHHU.js.map → chunk-DFCRXDVK.js.map} +1 -1
- package/dist/{chunk-5K45E5VE.js → chunk-GPJGPARM.js} +3 -2
- package/dist/chunk-GPJGPARM.js.map +1 -0
- package/dist/{chunk-LNKS4TJ6.cjs → chunk-HB6T4554.cjs} +8 -7
- package/dist/chunk-HB6T4554.cjs.map +1 -0
- package/dist/{chunk-DGS2KGDI.js → chunk-KUXNBWN7.js} +6 -5
- package/dist/chunk-KUXNBWN7.js.map +1 -0
- package/dist/{chunk-IHDE4CJV.js → chunk-QSHV7GPT.js} +89 -12
- package/dist/chunk-QSHV7GPT.js.map +1 -0
- package/dist/{chunk-3U3XFMGJ.cjs → chunk-QTAS3HND.cjs} +13 -8
- package/dist/chunk-QTAS3HND.cjs.map +1 -0
- package/dist/{chunk-RHKNKJNM.js → chunk-QWTB53GS.js} +4 -4
- package/dist/{chunk-RHKNKJNM.js.map → chunk-QWTB53GS.js.map} +1 -1
- package/dist/{chunk-4WG5K4CK.js → chunk-R4N65TLG.js} +7 -7
- package/dist/{chunk-4WG5K4CK.js.map → chunk-R4N65TLG.js.map} +1 -1
- package/dist/{chunk-5VQPSWPG.cjs → chunk-RABITNTG.cjs} +48 -48
- package/dist/{chunk-5VQPSWPG.cjs.map → chunk-RABITNTG.cjs.map} +1 -1
- package/dist/{chunk-TVPANHLE.cjs → chunk-SBOHDNIZ.cjs} +3 -2
- package/dist/chunk-SBOHDNIZ.cjs.map +1 -0
- package/dist/{chunk-MWGGSA5Q.js → chunk-T6GAM3SQ.js} +10 -5
- package/dist/chunk-T6GAM3SQ.js.map +1 -0
- package/dist/{chunk-TL2TTA4X.cjs → chunk-YQG7NBPR.cjs} +9 -9
- package/dist/{chunk-TL2TTA4X.cjs.map → chunk-YQG7NBPR.cjs.map} +1 -1
- package/dist/{chunk-XB3DA67Q.js → chunk-ZSBM2SVU.js} +818 -259
- package/dist/chunk-ZSBM2SVU.js.map +1 -0
- package/dist/datasets/experiment/scorer.d.ts.map +1 -1
- package/dist/datasets/index.cjs +17 -17
- package/dist/datasets/index.js +2 -2
- package/dist/evals/index.cjs +20 -20
- package/dist/evals/index.js +3 -3
- package/dist/evals/scoreTraces/index.cjs +7 -6
- package/dist/evals/scoreTraces/index.cjs.map +1 -1
- package/dist/evals/scoreTraces/index.js +4 -3
- package/dist/evals/scoreTraces/index.js.map +1 -1
- package/dist/evals/scoreTraces/scoreTracesWorkflow.d.ts.map +1 -1
- package/dist/harness/harness.d.ts +21 -1
- package/dist/harness/harness.d.ts.map +1 -1
- package/dist/harness/index.cjs +422 -5
- package/dist/harness/index.cjs.map +1 -1
- package/dist/harness/index.d.ts +2 -1
- package/dist/harness/index.d.ts.map +1 -1
- package/dist/harness/index.js +418 -3
- package/dist/harness/index.js.map +1 -1
- package/dist/harness/types.d.ts +151 -0
- package/dist/harness/types.d.ts.map +1 -1
- package/dist/index.cjs +2 -2
- package/dist/index.js +1 -1
- package/dist/loop/index.cjs +12 -12
- package/dist/loop/index.js +1 -1
- package/dist/loop/test-utils/tools.d.ts.map +1 -1
- package/dist/loop/workflows/agentic-loop/index.d.ts.map +1 -1
- package/dist/mastra/hooks.d.ts.map +1 -1
- package/dist/mastra/index.cjs +2 -2
- package/dist/mastra/index.js +1 -1
- package/dist/memory/index.cjs +14 -14
- package/dist/memory/index.js +1 -1
- package/dist/processor-provider/index.cjs +10 -10
- package/dist/processor-provider/index.js +1 -1
- package/dist/processors/index.cjs +45 -41
- package/dist/processors/index.js +1 -1
- package/dist/processors/processors/index.d.ts +1 -0
- package/dist/processors/processors/index.d.ts.map +1 -1
- package/dist/processors/processors/workspace-instructions.d.ts +50 -0
- package/dist/processors/processors/workspace-instructions.d.ts.map +1 -0
- package/dist/relevance/index.cjs +3 -3
- package/dist/relevance/index.js +1 -1
- package/dist/storage/constants.cjs +56 -56
- package/dist/storage/constants.d.ts.map +1 -1
- package/dist/storage/constants.js +1 -1
- package/dist/storage/index.cjs +160 -160
- package/dist/storage/index.js +2 -2
- package/dist/storage/types.d.ts +2 -0
- package/dist/storage/types.d.ts.map +1 -1
- package/dist/stream/aisdk/v5/compat/prepare-tools.d.ts.map +1 -1
- package/dist/stream/base/output.d.ts.map +1 -1
- package/dist/stream/index.cjs +8 -8
- package/dist/stream/index.js +1 -1
- package/dist/tool-loop-agent/index.cjs +4 -4
- package/dist/tool-loop-agent/index.js +1 -1
- package/dist/vector/index.cjs +7 -7
- package/dist/vector/index.js +1 -1
- package/dist/workflows/evented/index.cjs +10 -10
- package/dist/workflows/evented/index.js +1 -1
- package/dist/workflows/index.cjs +25 -25
- package/dist/workflows/index.js +1 -1
- package/dist/workspace/constants/index.d.ts +2 -0
- package/dist/workspace/constants/index.d.ts.map +1 -1
- package/dist/workspace/errors.d.ts +1 -1
- package/dist/workspace/errors.d.ts.map +1 -1
- package/dist/workspace/filesystem/composite-filesystem.d.ts +4 -1
- package/dist/workspace/filesystem/composite-filesystem.d.ts.map +1 -1
- package/dist/workspace/filesystem/file-write-lock.d.ts +35 -0
- package/dist/workspace/filesystem/file-write-lock.d.ts.map +1 -0
- package/dist/workspace/filesystem/filesystem.d.ts +5 -1
- package/dist/workspace/filesystem/filesystem.d.ts.map +1 -1
- package/dist/workspace/filesystem/index.d.ts +1 -0
- package/dist/workspace/filesystem/index.d.ts.map +1 -1
- package/dist/workspace/filesystem/local-filesystem.d.ts +17 -1
- package/dist/workspace/filesystem/local-filesystem.d.ts.map +1 -1
- package/dist/workspace/index.cjs +72 -64
- package/dist/workspace/index.d.ts +3 -2
- package/dist/workspace/index.d.ts.map +1 -1
- package/dist/workspace/index.js +1 -1
- package/dist/workspace/lifecycle.d.ts +1 -9
- package/dist/workspace/lifecycle.d.ts.map +1 -1
- package/dist/workspace/sandbox/index.d.ts +2 -0
- package/dist/workspace/sandbox/index.d.ts.map +1 -1
- package/dist/workspace/sandbox/local-process-manager.d.ts +18 -0
- package/dist/workspace/sandbox/local-process-manager.d.ts.map +1 -0
- package/dist/workspace/sandbox/local-sandbox.d.ts +49 -35
- package/dist/workspace/sandbox/local-sandbox.d.ts.map +1 -1
- package/dist/workspace/sandbox/mastra-sandbox.d.ts +45 -11
- package/dist/workspace/sandbox/mastra-sandbox.d.ts.map +1 -1
- package/dist/workspace/sandbox/native-sandbox/bubblewrap.d.ts +2 -3
- package/dist/workspace/sandbox/native-sandbox/bubblewrap.d.ts.map +1 -1
- package/dist/workspace/sandbox/native-sandbox/seatbelt.d.ts +2 -3
- package/dist/workspace/sandbox/native-sandbox/seatbelt.d.ts.map +1 -1
- package/dist/workspace/sandbox/native-sandbox/wrapper.d.ts +4 -5
- package/dist/workspace/sandbox/native-sandbox/wrapper.d.ts.map +1 -1
- package/dist/workspace/sandbox/process-manager/index.d.ts +4 -0
- package/dist/workspace/sandbox/process-manager/index.d.ts.map +1 -0
- package/dist/workspace/sandbox/process-manager/process-handle.d.ts +107 -0
- package/dist/workspace/sandbox/process-manager/process-handle.d.ts.map +1 -0
- package/dist/workspace/sandbox/process-manager/process-manager.d.ts +59 -0
- package/dist/workspace/sandbox/process-manager/process-manager.d.ts.map +1 -0
- package/dist/workspace/sandbox/process-manager/types.d.ts +24 -0
- package/dist/workspace/sandbox/process-manager/types.d.ts.map +1 -0
- package/dist/workspace/sandbox/sandbox.d.ts +38 -2
- package/dist/workspace/sandbox/sandbox.d.ts.map +1 -1
- package/dist/workspace/sandbox/types.d.ts +9 -2
- package/dist/workspace/sandbox/types.d.ts.map +1 -1
- package/dist/workspace/sandbox/utils.d.ts +7 -0
- package/dist/workspace/sandbox/utils.d.ts.map +1 -0
- package/dist/workspace/tools/execute-command.d.ts +53 -2
- package/dist/workspace/tools/execute-command.d.ts.map +1 -1
- package/dist/workspace/tools/get-process-output.d.ts +6 -0
- package/dist/workspace/tools/get-process-output.d.ts.map +1 -0
- package/dist/workspace/tools/index.d.ts +4 -1
- package/dist/workspace/tools/index.d.ts.map +1 -1
- package/dist/workspace/tools/kill-process.d.ts +4 -0
- package/dist/workspace/tools/kill-process.d.ts.map +1 -0
- package/dist/workspace/tools/output-helpers.d.ts +21 -0
- package/dist/workspace/tools/output-helpers.d.ts.map +1 -0
- package/dist/workspace/tools/tools.d.ts.map +1 -1
- package/dist/workspace/types.d.ts +31 -0
- package/dist/workspace/types.d.ts.map +1 -1
- package/dist/workspace/utils.d.ts +11 -0
- package/dist/workspace/utils.d.ts.map +1 -0
- package/dist/workspace/workspace.d.ts +36 -0
- package/dist/workspace/workspace.d.ts.map +1 -1
- package/package.json +7 -7
- package/dist/chunk-3U3XFMGJ.cjs.map +0 -1
- package/dist/chunk-5K45E5VE.js.map +0 -1
- package/dist/chunk-AYHSPIT6.cjs.map +0 -1
- package/dist/chunk-DGS2KGDI.js.map +0 -1
- package/dist/chunk-IHDE4CJV.js.map +0 -1
- package/dist/chunk-LNKS4TJ6.cjs.map +0 -1
- package/dist/chunk-MWGGSA5Q.js.map +0 -1
- package/dist/chunk-TVPANHLE.cjs.map +0 -1
- package/dist/chunk-VJWRJWSC.cjs.map +0 -1
- package/dist/chunk-XB3DA67Q.js.map +0 -1
- package/dist/docs/SKILL.md +0 -301
- package/dist/docs/assets/SOURCE_MAP.json +0 -1413
- package/dist/docs/references/docs-agents-adding-voice.md +0 -353
- package/dist/docs/references/docs-agents-agent-approval.md +0 -377
- package/dist/docs/references/docs-agents-agent-memory.md +0 -212
- package/dist/docs/references/docs-agents-guardrails.md +0 -382
- package/dist/docs/references/docs-agents-network-approval.md +0 -275
- package/dist/docs/references/docs-agents-networks.md +0 -290
- package/dist/docs/references/docs-agents-overview.md +0 -309
- package/dist/docs/references/docs-agents-processors.md +0 -632
- package/dist/docs/references/docs-agents-structured-output.md +0 -271
- package/dist/docs/references/docs-agents-using-tools.md +0 -214
- package/dist/docs/references/docs-evals-custom-scorers.md +0 -519
- package/dist/docs/references/docs-evals-overview.md +0 -146
- package/dist/docs/references/docs-evals-running-in-ci.md +0 -106
- package/dist/docs/references/docs-mcp-overview.md +0 -370
- package/dist/docs/references/docs-mcp-publishing-mcp-server.md +0 -95
- package/dist/docs/references/docs-memory-memory-processors.md +0 -316
- package/dist/docs/references/docs-memory-observational-memory.md +0 -246
- package/dist/docs/references/docs-memory-overview.md +0 -45
- package/dist/docs/references/docs-memory-semantic-recall.md +0 -272
- package/dist/docs/references/docs-memory-storage.md +0 -261
- package/dist/docs/references/docs-memory-working-memory.md +0 -400
- package/dist/docs/references/docs-observability-datasets-overview.md +0 -188
- package/dist/docs/references/docs-observability-datasets-running-experiments.md +0 -266
- package/dist/docs/references/docs-observability-logging.md +0 -99
- package/dist/docs/references/docs-observability-overview.md +0 -70
- package/dist/docs/references/docs-observability-tracing-bridges-otel.md +0 -209
- package/dist/docs/references/docs-observability-tracing-exporters-arize.md +0 -274
- package/dist/docs/references/docs-observability-tracing-exporters-braintrust.md +0 -111
- package/dist/docs/references/docs-observability-tracing-exporters-cloud.md +0 -129
- package/dist/docs/references/docs-observability-tracing-exporters-datadog.md +0 -187
- package/dist/docs/references/docs-observability-tracing-exporters-default.md +0 -211
- package/dist/docs/references/docs-observability-tracing-exporters-laminar.md +0 -100
- package/dist/docs/references/docs-observability-tracing-exporters-langfuse.md +0 -217
- package/dist/docs/references/docs-observability-tracing-exporters-langsmith.md +0 -202
- package/dist/docs/references/docs-observability-tracing-exporters-otel.md +0 -479
- package/dist/docs/references/docs-observability-tracing-exporters-posthog.md +0 -148
- package/dist/docs/references/docs-observability-tracing-overview.md +0 -1114
- package/dist/docs/references/docs-rag-chunking-and-embedding.md +0 -183
- package/dist/docs/references/docs-rag-graph-rag.md +0 -215
- package/dist/docs/references/docs-rag-overview.md +0 -72
- package/dist/docs/references/docs-rag-retrieval.md +0 -521
- package/dist/docs/references/docs-rag-vector-databases.md +0 -648
- package/dist/docs/references/docs-server-auth-auth0.md +0 -222
- package/dist/docs/references/docs-server-auth-clerk.md +0 -132
- package/dist/docs/references/docs-server-auth-composite-auth.md +0 -234
- package/dist/docs/references/docs-server-auth-custom-auth-provider.md +0 -513
- package/dist/docs/references/docs-server-auth-firebase.md +0 -272
- package/dist/docs/references/docs-server-auth-jwt.md +0 -110
- package/dist/docs/references/docs-server-auth-simple-auth.md +0 -178
- package/dist/docs/references/docs-server-auth-supabase.md +0 -117
- package/dist/docs/references/docs-server-auth-workos.md +0 -190
- package/dist/docs/references/docs-server-custom-adapters.md +0 -374
- package/dist/docs/references/docs-server-custom-api-routes.md +0 -267
- package/dist/docs/references/docs-server-mastra-client.md +0 -243
- package/dist/docs/references/docs-server-mastra-server.md +0 -71
- package/dist/docs/references/docs-server-middleware.md +0 -228
- package/dist/docs/references/docs-server-request-context.md +0 -478
- package/dist/docs/references/docs-streaming-events.md +0 -247
- package/dist/docs/references/docs-streaming-tool-streaming.md +0 -178
- package/dist/docs/references/docs-streaming-workflow-streaming.md +0 -109
- package/dist/docs/references/docs-voice-overview.md +0 -979
- package/dist/docs/references/docs-voice-speech-to-speech.md +0 -103
- package/dist/docs/references/docs-voice-speech-to-text.md +0 -80
- package/dist/docs/references/docs-voice-text-to-speech.md +0 -84
- package/dist/docs/references/docs-workflows-agents-and-tools.md +0 -170
- package/dist/docs/references/docs-workflows-control-flow.md +0 -823
- package/dist/docs/references/docs-workflows-error-handling.md +0 -360
- package/dist/docs/references/docs-workflows-human-in-the-loop.md +0 -213
- package/dist/docs/references/docs-workflows-overview.md +0 -372
- package/dist/docs/references/docs-workflows-snapshots.md +0 -238
- package/dist/docs/references/docs-workflows-suspend-and-resume.md +0 -205
- package/dist/docs/references/docs-workflows-time-travel.md +0 -309
- package/dist/docs/references/docs-workflows-workflow-state.md +0 -181
- package/dist/docs/references/docs-workspace-filesystem.md +0 -162
- package/dist/docs/references/docs-workspace-overview.md +0 -239
- package/dist/docs/references/docs-workspace-sandbox.md +0 -63
- package/dist/docs/references/docs-workspace-search.md +0 -219
- package/dist/docs/references/docs-workspace-skills.md +0 -126
- package/dist/docs/references/guides-agent-frameworks-ai-sdk.md +0 -140
- package/dist/docs/references/reference-agents-agent.md +0 -142
- package/dist/docs/references/reference-agents-generate.md +0 -174
- package/dist/docs/references/reference-agents-generateLegacy.md +0 -176
- package/dist/docs/references/reference-agents-getDefaultGenerateOptions.md +0 -36
- package/dist/docs/references/reference-agents-getDefaultOptions.md +0 -34
- package/dist/docs/references/reference-agents-getDefaultStreamOptions.md +0 -36
- package/dist/docs/references/reference-agents-getDescription.md +0 -21
- package/dist/docs/references/reference-agents-getInstructions.md +0 -34
- package/dist/docs/references/reference-agents-getLLM.md +0 -37
- package/dist/docs/references/reference-agents-getMemory.md +0 -34
- package/dist/docs/references/reference-agents-getModel.md +0 -34
- package/dist/docs/references/reference-agents-getTools.md +0 -29
- package/dist/docs/references/reference-agents-getVoice.md +0 -34
- package/dist/docs/references/reference-agents-listAgents.md +0 -35
- package/dist/docs/references/reference-agents-listScorers.md +0 -34
- package/dist/docs/references/reference-agents-listTools.md +0 -34
- package/dist/docs/references/reference-agents-listWorkflows.md +0 -34
- package/dist/docs/references/reference-agents-network.md +0 -134
- package/dist/docs/references/reference-ai-sdk-chat-route.md +0 -82
- package/dist/docs/references/reference-ai-sdk-network-route.md +0 -74
- package/dist/docs/references/reference-ai-sdk-to-ai-sdk-stream.md +0 -232
- package/dist/docs/references/reference-ai-sdk-with-mastra.md +0 -59
- package/dist/docs/references/reference-ai-sdk-workflow-route.md +0 -79
- package/dist/docs/references/reference-auth-auth0.md +0 -73
- package/dist/docs/references/reference-auth-clerk.md +0 -36
- package/dist/docs/references/reference-auth-firebase.md +0 -80
- package/dist/docs/references/reference-auth-jwt.md +0 -26
- package/dist/docs/references/reference-auth-supabase.md +0 -33
- package/dist/docs/references/reference-auth-workos.md +0 -84
- package/dist/docs/references/reference-client-js-agents.md +0 -438
- package/dist/docs/references/reference-configuration.md +0 -749
- package/dist/docs/references/reference-core-addGateway.md +0 -42
- package/dist/docs/references/reference-core-getAgent.md +0 -21
- package/dist/docs/references/reference-core-getAgentById.md +0 -21
- package/dist/docs/references/reference-core-getDeployer.md +0 -22
- package/dist/docs/references/reference-core-getGateway.md +0 -38
- package/dist/docs/references/reference-core-getGatewayById.md +0 -41
- package/dist/docs/references/reference-core-getLogger.md +0 -22
- package/dist/docs/references/reference-core-getMCPServer.md +0 -45
- package/dist/docs/references/reference-core-getMCPServerById.md +0 -53
- package/dist/docs/references/reference-core-getMemory.md +0 -50
- package/dist/docs/references/reference-core-getScorer.md +0 -54
- package/dist/docs/references/reference-core-getScorerById.md +0 -54
- package/dist/docs/references/reference-core-getServer.md +0 -22
- package/dist/docs/references/reference-core-getStorage.md +0 -22
- package/dist/docs/references/reference-core-getStoredAgentById.md +0 -89
- package/dist/docs/references/reference-core-getTelemetry.md +0 -22
- package/dist/docs/references/reference-core-getVector.md +0 -22
- package/dist/docs/references/reference-core-getWorkflow.md +0 -40
- package/dist/docs/references/reference-core-listAgents.md +0 -21
- package/dist/docs/references/reference-core-listGateways.md +0 -40
- package/dist/docs/references/reference-core-listLogs.md +0 -38
- package/dist/docs/references/reference-core-listLogsByRunId.md +0 -36
- package/dist/docs/references/reference-core-listMCPServers.md +0 -51
- package/dist/docs/references/reference-core-listMemory.md +0 -56
- package/dist/docs/references/reference-core-listScorers.md +0 -29
- package/dist/docs/references/reference-core-listStoredAgents.md +0 -93
- package/dist/docs/references/reference-core-listVectors.md +0 -22
- package/dist/docs/references/reference-core-listWorkflows.md +0 -21
- package/dist/docs/references/reference-core-mastra-class.md +0 -66
- package/dist/docs/references/reference-core-mastra-model-gateway.md +0 -153
- package/dist/docs/references/reference-core-setLogger.md +0 -26
- package/dist/docs/references/reference-core-setStorage.md +0 -27
- package/dist/docs/references/reference-datasets-addItem.md +0 -35
- package/dist/docs/references/reference-datasets-addItems.md +0 -33
- package/dist/docs/references/reference-datasets-compareExperiments.md +0 -48
- package/dist/docs/references/reference-datasets-create.md +0 -49
- package/dist/docs/references/reference-datasets-dataset.md +0 -78
- package/dist/docs/references/reference-datasets-datasets-manager.md +0 -84
- package/dist/docs/references/reference-datasets-delete.md +0 -23
- package/dist/docs/references/reference-datasets-deleteExperiment.md +0 -25
- package/dist/docs/references/reference-datasets-deleteItem.md +0 -25
- package/dist/docs/references/reference-datasets-deleteItems.md +0 -27
- package/dist/docs/references/reference-datasets-get.md +0 -29
- package/dist/docs/references/reference-datasets-getDetails.md +0 -45
- package/dist/docs/references/reference-datasets-getExperiment.md +0 -28
- package/dist/docs/references/reference-datasets-getItem.md +0 -31
- package/dist/docs/references/reference-datasets-getItemHistory.md +0 -29
- package/dist/docs/references/reference-datasets-list.md +0 -29
- package/dist/docs/references/reference-datasets-listExperimentResults.md +0 -37
- package/dist/docs/references/reference-datasets-listExperiments.md +0 -31
- package/dist/docs/references/reference-datasets-listItems.md +0 -44
- package/dist/docs/references/reference-datasets-listVersions.md +0 -31
- package/dist/docs/references/reference-datasets-startExperiment.md +0 -60
- package/dist/docs/references/reference-datasets-startExperimentAsync.md +0 -41
- package/dist/docs/references/reference-datasets-update.md +0 -46
- package/dist/docs/references/reference-datasets-updateItem.md +0 -36
- package/dist/docs/references/reference-evals-answer-relevancy.md +0 -105
- package/dist/docs/references/reference-evals-answer-similarity.md +0 -99
- package/dist/docs/references/reference-evals-bias.md +0 -120
- package/dist/docs/references/reference-evals-completeness.md +0 -137
- package/dist/docs/references/reference-evals-content-similarity.md +0 -101
- package/dist/docs/references/reference-evals-context-precision.md +0 -196
- package/dist/docs/references/reference-evals-create-scorer.md +0 -270
- package/dist/docs/references/reference-evals-faithfulness.md +0 -114
- package/dist/docs/references/reference-evals-hallucination.md +0 -220
- package/dist/docs/references/reference-evals-keyword-coverage.md +0 -128
- package/dist/docs/references/reference-evals-mastra-scorer.md +0 -123
- package/dist/docs/references/reference-evals-run-evals.md +0 -138
- package/dist/docs/references/reference-evals-scorer-utils.md +0 -330
- package/dist/docs/references/reference-evals-textual-difference.md +0 -113
- package/dist/docs/references/reference-evals-tone-consistency.md +0 -119
- package/dist/docs/references/reference-evals-toxicity.md +0 -123
- package/dist/docs/references/reference-harness-harness-class.md +0 -645
- package/dist/docs/references/reference-logging-pino-logger.md +0 -117
- package/dist/docs/references/reference-memory-deleteMessages.md +0 -40
- package/dist/docs/references/reference-memory-memory-class.md +0 -147
- package/dist/docs/references/reference-memory-observational-memory.md +0 -565
- package/dist/docs/references/reference-observability-tracing-bridges-otel.md +0 -131
- package/dist/docs/references/reference-observability-tracing-configuration.md +0 -178
- package/dist/docs/references/reference-observability-tracing-exporters-console-exporter.md +0 -138
- package/dist/docs/references/reference-observability-tracing-exporters-datadog.md +0 -116
- package/dist/docs/references/reference-observability-tracing-instances.md +0 -109
- package/dist/docs/references/reference-observability-tracing-interfaces.md +0 -749
- package/dist/docs/references/reference-observability-tracing-processors-sensitive-data-filter.md +0 -144
- package/dist/docs/references/reference-observability-tracing-spans.md +0 -224
- package/dist/docs/references/reference-processors-batch-parts-processor.md +0 -61
- package/dist/docs/references/reference-processors-language-detector.md +0 -81
- package/dist/docs/references/reference-processors-message-history-processor.md +0 -85
- package/dist/docs/references/reference-processors-moderation-processor.md +0 -104
- package/dist/docs/references/reference-processors-pii-detector.md +0 -107
- package/dist/docs/references/reference-processors-processor-interface.md +0 -525
- package/dist/docs/references/reference-processors-prompt-injection-detector.md +0 -71
- package/dist/docs/references/reference-processors-semantic-recall-processor.md +0 -123
- package/dist/docs/references/reference-processors-system-prompt-scrubber.md +0 -80
- package/dist/docs/references/reference-processors-token-limiter-processor.md +0 -113
- package/dist/docs/references/reference-processors-tool-call-filter.md +0 -85
- package/dist/docs/references/reference-processors-tool-search-processor.md +0 -113
- package/dist/docs/references/reference-processors-unicode-normalizer.md +0 -62
- package/dist/docs/references/reference-processors-working-memory-processor.md +0 -154
- package/dist/docs/references/reference-rag-database-config.md +0 -264
- package/dist/docs/references/reference-rag-embeddings.md +0 -92
- package/dist/docs/references/reference-server-mastra-server.md +0 -298
- package/dist/docs/references/reference-server-register-api-route.md +0 -249
- package/dist/docs/references/reference-storage-cloudflare-d1.md +0 -218
- package/dist/docs/references/reference-storage-composite.md +0 -235
- package/dist/docs/references/reference-storage-lance.md +0 -131
- package/dist/docs/references/reference-storage-libsql.md +0 -135
- package/dist/docs/references/reference-storage-mongodb.md +0 -262
- package/dist/docs/references/reference-storage-mssql.md +0 -155
- package/dist/docs/references/reference-storage-overview.md +0 -121
- package/dist/docs/references/reference-storage-postgresql.md +0 -529
- package/dist/docs/references/reference-storage-upstash.md +0 -160
- package/dist/docs/references/reference-streaming-ChunkType.md +0 -292
- package/dist/docs/references/reference-streaming-agents-MastraModelOutput.md +0 -182
- package/dist/docs/references/reference-streaming-agents-streamLegacy.md +0 -142
- package/dist/docs/references/reference-streaming-workflows-observeStream.md +0 -42
- package/dist/docs/references/reference-streaming-workflows-resumeStream.md +0 -61
- package/dist/docs/references/reference-streaming-workflows-stream.md +0 -88
- package/dist/docs/references/reference-streaming-workflows-timeTravelStream.md +0 -142
- package/dist/docs/references/reference-templates-overview.md +0 -194
- package/dist/docs/references/reference-tools-create-tool.md +0 -237
- package/dist/docs/references/reference-tools-graph-rag-tool.md +0 -185
- package/dist/docs/references/reference-tools-mcp-client.md +0 -962
- package/dist/docs/references/reference-tools-mcp-server.md +0 -1275
- package/dist/docs/references/reference-tools-vector-query-tool.md +0 -459
- package/dist/docs/references/reference-vectors-libsql.md +0 -305
- package/dist/docs/references/reference-vectors-mongodb.md +0 -295
- package/dist/docs/references/reference-vectors-pg.md +0 -408
- package/dist/docs/references/reference-vectors-upstash.md +0 -294
- package/dist/docs/references/reference-voice-composite-voice.md +0 -121
- package/dist/docs/references/reference-voice-mastra-voice.md +0 -313
- package/dist/docs/references/reference-voice-voice.addInstructions.md +0 -56
- package/dist/docs/references/reference-voice-voice.addTools.md +0 -67
- package/dist/docs/references/reference-voice-voice.connect.md +0 -94
- package/dist/docs/references/reference-voice-voice.events.md +0 -37
- package/dist/docs/references/reference-voice-voice.listen.md +0 -164
- package/dist/docs/references/reference-voice-voice.on.md +0 -111
- package/dist/docs/references/reference-voice-voice.speak.md +0 -157
- package/dist/docs/references/reference-workflows-run-methods-cancel.md +0 -86
- package/dist/docs/references/reference-workflows-run-methods-restart.md +0 -33
- package/dist/docs/references/reference-workflows-run-methods-resume.md +0 -59
- package/dist/docs/references/reference-workflows-run-methods-start.md +0 -58
- package/dist/docs/references/reference-workflows-run-methods-startAsync.md +0 -67
- package/dist/docs/references/reference-workflows-run-methods-timeTravel.md +0 -142
- package/dist/docs/references/reference-workflows-run.md +0 -59
- package/dist/docs/references/reference-workflows-step.md +0 -119
- package/dist/docs/references/reference-workflows-workflow-methods-branch.md +0 -25
- package/dist/docs/references/reference-workflows-workflow-methods-commit.md +0 -17
- package/dist/docs/references/reference-workflows-workflow-methods-create-run.md +0 -63
- package/dist/docs/references/reference-workflows-workflow-methods-dountil.md +0 -25
- package/dist/docs/references/reference-workflows-workflow-methods-dowhile.md +0 -25
- package/dist/docs/references/reference-workflows-workflow-methods-foreach.md +0 -118
- package/dist/docs/references/reference-workflows-workflow-methods-map.md +0 -93
- package/dist/docs/references/reference-workflows-workflow-methods-parallel.md +0 -21
- package/dist/docs/references/reference-workflows-workflow-methods-sleep.md +0 -35
- package/dist/docs/references/reference-workflows-workflow-methods-sleepUntil.md +0 -35
- package/dist/docs/references/reference-workflows-workflow-methods-then.md +0 -21
- package/dist/docs/references/reference-workflows-workflow.md +0 -157
- package/dist/docs/references/reference-workspace-filesystem.md +0 -202
- package/dist/docs/references/reference-workspace-local-filesystem.md +0 -327
- package/dist/docs/references/reference-workspace-local-sandbox.md +0 -285
- package/dist/docs/references/reference-workspace-sandbox.md +0 -81
- package/dist/docs/references/reference-workspace-workspace-class.md +0 -226
- package/dist/docs/references/reference.md +0 -276
|
@@ -1,226 +0,0 @@
|
|
|
1
|
-
# Workspace Class
|
|
2
|
-
|
|
3
|
-
**Added in:** `@mastra/core@1.1.0`
|
|
4
|
-
|
|
5
|
-
The `Workspace` class combines a filesystem and sandbox to provide agents with file storage and command execution capabilities. It also supports BM25 and vector search for indexed content.
|
|
6
|
-
|
|
7
|
-
## Usage Example
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { Workspace, LocalFilesystem, LocalSandbox } from '@mastra/core/workspace';
|
|
11
|
-
|
|
12
|
-
const workspace = new Workspace({
|
|
13
|
-
id: 'my-workspace',
|
|
14
|
-
name: 'My Workspace',
|
|
15
|
-
filesystem: new LocalFilesystem({
|
|
16
|
-
basePath: './workspace',
|
|
17
|
-
}),
|
|
18
|
-
sandbox: new LocalSandbox({
|
|
19
|
-
workingDirectory: './workspace',
|
|
20
|
-
}),
|
|
21
|
-
bm25: true,
|
|
22
|
-
autoIndexPaths: ['/docs'],
|
|
23
|
-
});
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## Constructor parameters
|
|
27
|
-
|
|
28
|
-
**id?:** (`string`): Unique identifier for the workspace (Default: `Auto-generated`)
|
|
29
|
-
|
|
30
|
-
**name?:** (`string`): Human-readable name (Default: `workspace-{id}`)
|
|
31
|
-
|
|
32
|
-
**filesystem?:** (`WorkspaceFilesystem`): Filesystem provider instance (e.g., LocalFilesystem)
|
|
33
|
-
|
|
34
|
-
**sandbox?:** (`WorkspaceSandbox`): Sandbox provider instance (e.g., LocalSandbox)
|
|
35
|
-
|
|
36
|
-
**bm25?:** (`boolean | BM25Config`): Enable BM25 keyword search. Pass true for defaults or a config object. (Default: `undefined`)
|
|
37
|
-
|
|
38
|
-
**vectorStore?:** (`MastraVector`): Vector store for semantic search
|
|
39
|
-
|
|
40
|
-
**embedder?:** (`(text: string) => Promise<number[]>`): Embedder function for generating vectors. Required when vectorStore is provided.
|
|
41
|
-
|
|
42
|
-
**autoIndexPaths?:** (`string[]`): Paths to auto-index on init()
|
|
43
|
-
|
|
44
|
-
**skills?:** (`string[] | ((context: SkillsContext) => string[] | Promise<string[]>)`): Paths where SKILL.md files are located. This can be a static array or an async function that resolves paths dynamically.
|
|
45
|
-
|
|
46
|
-
**tools?:** (`WorkspaceToolsConfig`): Per-tool configuration for enabling tools and setting safety options
|
|
47
|
-
|
|
48
|
-
**operationTimeout?:** (`number`): Timeout for operations in milliseconds
|
|
49
|
-
|
|
50
|
-
## Tool configuration
|
|
51
|
-
|
|
52
|
-
The `tools` option accepts a `WorkspaceToolsConfig` object that controls which workspace tools are enabled and their safety settings.
|
|
53
|
-
|
|
54
|
-
```typescript
|
|
55
|
-
import { WORKSPACE_TOOLS } from '@mastra/core/workspace';
|
|
56
|
-
|
|
57
|
-
tools: {
|
|
58
|
-
// Global defaults (apply to all tools)
|
|
59
|
-
enabled: true,
|
|
60
|
-
requireApproval: false,
|
|
61
|
-
|
|
62
|
-
// Per-tool overrides using WORKSPACE_TOOLS constants
|
|
63
|
-
[WORKSPACE_TOOLS.FILESYSTEM.WRITE_FILE]: {
|
|
64
|
-
requireApproval: true,
|
|
65
|
-
},
|
|
66
|
-
}
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
The config object has two parts:
|
|
70
|
-
|
|
71
|
-
- **Global defaults** (`enabled`, `requireApproval`) - Apply to all tools unless overridden
|
|
72
|
-
- **Per-tool overrides** - Use `WORKSPACE_TOOLS` constants as keys to configure individual tools
|
|
73
|
-
|
|
74
|
-
See [workspace overview](https://mastra.ai/docs/workspace/overview) for more examples.
|
|
75
|
-
|
|
76
|
-
### Per-tool options
|
|
77
|
-
|
|
78
|
-
Each tool can be configured with these options:
|
|
79
|
-
|
|
80
|
-
**enabled?:** (`boolean`): Whether the tool is available to agents (Default: `true`)
|
|
81
|
-
|
|
82
|
-
**requireApproval?:** (`boolean`): Whether the tool requires user approval before execution (Default: `false`)
|
|
83
|
-
|
|
84
|
-
**requireReadBeforeWrite?:** (`boolean`): For write tools: require reading the file first to prevent overwrites (Default: `false`)
|
|
85
|
-
|
|
86
|
-
## Properties
|
|
87
|
-
|
|
88
|
-
**id:** (`string`): Workspace identifier
|
|
89
|
-
|
|
90
|
-
**name:** (`string`): Workspace name
|
|
91
|
-
|
|
92
|
-
**status:** (`WorkspaceStatus`): 'pending' | 'initializing' | 'ready' | 'error' | 'destroying' | 'destroyed'
|
|
93
|
-
|
|
94
|
-
**filesystem:** (`WorkspaceFilesystem | undefined`): The filesystem provider
|
|
95
|
-
|
|
96
|
-
**sandbox:** (`WorkspaceSandbox | undefined`): The sandbox provider
|
|
97
|
-
|
|
98
|
-
**skills:** (`WorkspaceSkills | undefined`): Skills interface for accessing SKILL.md files
|
|
99
|
-
|
|
100
|
-
**canBM25:** (`boolean`): Whether BM25 search is available
|
|
101
|
-
|
|
102
|
-
**canVector:** (`boolean`): Whether vector search is available
|
|
103
|
-
|
|
104
|
-
**canHybrid:** (`boolean`): Whether hybrid search is available
|
|
105
|
-
|
|
106
|
-
## Methods
|
|
107
|
-
|
|
108
|
-
### Lifecycle
|
|
109
|
-
|
|
110
|
-
#### `init()`
|
|
111
|
-
|
|
112
|
-
Initialize the workspace and prepare resources.
|
|
113
|
-
|
|
114
|
-
```typescript
|
|
115
|
-
await workspace.init();
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
Calling `init()` is optional in most cases:
|
|
119
|
-
|
|
120
|
-
- **Sandbox**: Auto-starts on first `executeCommand()` call. Use `init()` to avoid first-command latency.
|
|
121
|
-
- **Filesystem**: Creates the base directory and runs any provider-specific setup. Some providers auto-create the directory on first operation.
|
|
122
|
-
- **Search**: Required only if using `autoIndexPaths` for auto-indexing.
|
|
123
|
-
|
|
124
|
-
Initialization performs:
|
|
125
|
-
|
|
126
|
-
- Starts the filesystem provider (creates base directory if needed)
|
|
127
|
-
- Starts the sandbox provider (creates working directory, sets up isolation if configured)
|
|
128
|
-
- Indexes files from `autoIndexPaths` for search
|
|
129
|
-
|
|
130
|
-
#### `destroy()`
|
|
131
|
-
|
|
132
|
-
Destroy the workspace and clean up resources.
|
|
133
|
-
|
|
134
|
-
```typescript
|
|
135
|
-
await workspace.destroy();
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
### Search operations
|
|
139
|
-
|
|
140
|
-
#### `index(path, content, options?)`
|
|
141
|
-
|
|
142
|
-
Index content for search.
|
|
143
|
-
|
|
144
|
-
```typescript
|
|
145
|
-
await workspace.index('/docs/guide.md', 'Guide content...');
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
#### `search(query, options?)`
|
|
149
|
-
|
|
150
|
-
Search indexed content.
|
|
151
|
-
|
|
152
|
-
```typescript
|
|
153
|
-
const results = await workspace.search('password reset', {
|
|
154
|
-
topK: 10,
|
|
155
|
-
mode: 'hybrid',
|
|
156
|
-
});
|
|
157
|
-
```
|
|
158
|
-
|
|
159
|
-
### Utility
|
|
160
|
-
|
|
161
|
-
#### `getInfo()`
|
|
162
|
-
|
|
163
|
-
Get workspace information.
|
|
164
|
-
|
|
165
|
-
```typescript
|
|
166
|
-
const info = await workspace.getInfo();
|
|
167
|
-
// { id, name, status, createdAt, lastAccessedAt, filesystem?, sandbox? }
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
#### `getPathContext()`
|
|
171
|
-
|
|
172
|
-
Get information about filesystem and sandbox paths, including instructions for agents.
|
|
173
|
-
|
|
174
|
-
```typescript
|
|
175
|
-
const context = workspace.getPathContext();
|
|
176
|
-
// { filesystem?, sandbox?, instructions }
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
The `instructions` field contains provider-generated descriptions combined from the filesystem and sandbox. These instructions are included in tool descriptions to help agents understand the execution context.
|
|
180
|
-
|
|
181
|
-
#### `getToolsConfig()`
|
|
182
|
-
|
|
183
|
-
Get the tools configuration.
|
|
184
|
-
|
|
185
|
-
```typescript
|
|
186
|
-
const config = workspace.getToolsConfig();
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
## Agent tools
|
|
190
|
-
|
|
191
|
-
A workspace provides tools to agents based on what is configured.
|
|
192
|
-
|
|
193
|
-
### Filesystem tools
|
|
194
|
-
|
|
195
|
-
Added when a filesystem is configured:
|
|
196
|
-
|
|
197
|
-
| Tool | Description |
|
|
198
|
-
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
|
199
|
-
| `mastra_workspace_read_file` | Read file contents. Supports optional line range for reading specific portions of large files. |
|
|
200
|
-
| `mastra_workspace_write_file` | Create or overwrite a file with new content. Creates parent directories automatically. |
|
|
201
|
-
| `mastra_workspace_edit_file` | Edit an existing file by finding and replacing text. Useful for targeted changes without rewriting the entire file. |
|
|
202
|
-
| `mastra_workspace_list_files` | List directory contents as a tree structure. Supports recursive listing with depth limits. |
|
|
203
|
-
| `mastra_workspace_delete` | Delete a file or directory. Supports recursive deletion for directories. |
|
|
204
|
-
| `mastra_workspace_file_stat` | Get metadata about a file or directory including size, type, and modification time. |
|
|
205
|
-
| `mastra_workspace_mkdir` | Create a directory. Creates parent directories automatically if they don't exist. |
|
|
206
|
-
|
|
207
|
-
Write tools (`write_file`, `edit_file`, `delete`, `mkdir`) are excluded when the filesystem is in read-only mode.
|
|
208
|
-
|
|
209
|
-
### Sandbox tools
|
|
210
|
-
|
|
211
|
-
Added when a sandbox is configured:
|
|
212
|
-
|
|
213
|
-
| Tool | Description |
|
|
214
|
-
| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
|
215
|
-
| `mastra_workspace_execute_command` | Execute a shell command with arguments. Returns stdout, stderr, and exit code. Supports timeouts and streaming output. |
|
|
216
|
-
|
|
217
|
-
### Search tools
|
|
218
|
-
|
|
219
|
-
Added when BM25 or vector search is configured:
|
|
220
|
-
|
|
221
|
-
| Tool | Description |
|
|
222
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
|
223
|
-
| `mastra_workspace_search` | Search indexed content using keyword (BM25), semantic (vector), or hybrid search. Returns ranked results with scores. |
|
|
224
|
-
| `mastra_workspace_index` | Index content for search. Associates content with a path for later retrieval. |
|
|
225
|
-
|
|
226
|
-
The `index` tool is excluded when the filesystem is in read-only mode.
|
|
@@ -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)
|