@mastra/core 1.9.0 → 1.10.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 +202 -0
- package/dist/agent/agent.d.ts +22 -3
- package/dist/agent/agent.d.ts.map +1 -1
- package/dist/agent/index.cjs +13 -13
- package/dist/agent/index.js +2 -2
- package/dist/agent/message-list/index.cjs +18 -18
- package/dist/agent/message-list/index.js +1 -1
- package/dist/agent/message-list/message-list.d.ts.map +1 -1
- package/dist/{chunk-IOY7Y5GV.js → chunk-3VVNJPTO.js} +602 -187
- package/dist/chunk-3VVNJPTO.js.map +1 -0
- package/dist/{chunk-VDKWYUGC.cjs → chunk-5WBEMKE2.cjs} +7 -3
- package/dist/chunk-5WBEMKE2.cjs.map +1 -0
- package/dist/{chunk-H5S4PS44.cjs → chunk-76Q75VI4.cjs} +602 -187
- package/dist/chunk-76Q75VI4.cjs.map +1 -0
- package/dist/{chunk-ZBESCKPX.cjs → chunk-7AHCLTZZ.cjs} +1572 -36
- package/dist/chunk-7AHCLTZZ.cjs.map +1 -0
- package/dist/{chunk-SEKQJ447.js → chunk-ACAILOJE.js} +166 -68
- package/dist/chunk-ACAILOJE.js.map +1 -0
- package/dist/{chunk-YIJZBU54.cjs → chunk-BCSVBOAN.cjs} +240 -463
- package/dist/chunk-BCSVBOAN.cjs.map +1 -0
- package/dist/{chunk-ZVWVQ6MG.js → chunk-CY4ZWL2X.js} +8 -3
- package/dist/chunk-CY4ZWL2X.js.map +1 -0
- package/dist/{chunk-ET7GXCHS.js → chunk-DIKRJVK6.js} +5 -5
- package/dist/{chunk-ET7GXCHS.js.map → chunk-DIKRJVK6.js.map} +1 -1
- package/dist/{chunk-P6ZX7OKT.cjs → chunk-E6I5LBDM.cjs} +7 -7
- package/dist/{chunk-P6ZX7OKT.cjs.map → chunk-E6I5LBDM.cjs.map} +1 -1
- package/dist/{chunk-BFV3GSGS.js → chunk-FT5Q6XTK.js} +1546 -22
- package/dist/chunk-FT5Q6XTK.js.map +1 -0
- package/dist/{chunk-K54LFB4P.js → chunk-FXOWXS4O.js} +3 -3
- package/dist/{chunk-K54LFB4P.js.map → chunk-FXOWXS4O.js.map} +1 -1
- package/dist/{chunk-QNXY3J6B.cjs → chunk-GCRPNAAR.cjs} +22 -19
- package/dist/chunk-GCRPNAAR.cjs.map +1 -0
- package/dist/{chunk-5M3RMO7U.js → chunk-GTA5BKXZ.js} +8 -8
- package/dist/{chunk-5M3RMO7U.js.map → chunk-GTA5BKXZ.js.map} +1 -1
- package/dist/{chunk-G5R2755Q.cjs → chunk-HAIQ57YB.cjs} +53 -20
- package/dist/chunk-HAIQ57YB.cjs.map +1 -0
- package/dist/{chunk-3ZBLD2Y4.cjs → chunk-HH76UOJL.cjs} +2 -2
- package/dist/{chunk-3ZBLD2Y4.cjs.map → chunk-HH76UOJL.cjs.map} +1 -1
- package/dist/{chunk-HAGCXIBX.cjs → chunk-HNYQITSV.cjs} +9 -9
- package/dist/{chunk-HAGCXIBX.cjs.map → chunk-HNYQITSV.cjs.map} +1 -1
- package/dist/{chunk-GJTLWOKJ.js → chunk-HQA3IBLZ.js} +51 -18
- package/dist/chunk-HQA3IBLZ.js.map +1 -0
- package/dist/{chunk-4BXXAZ75.js → chunk-HQTHWVAK.js} +15 -7
- package/dist/chunk-HQTHWVAK.js.map +1 -0
- package/dist/{chunk-CCLV5CAA.js → chunk-JGOH7RWL.js} +7 -3
- package/dist/chunk-JGOH7RWL.js.map +1 -0
- package/dist/{chunk-Y6TGIUGL.js → chunk-LSF5WJ6G.js} +2 -2
- package/dist/{chunk-Y6TGIUGL.js.map → chunk-LSF5WJ6G.js.map} +1 -1
- package/dist/{chunk-D6HO5QAM.cjs → chunk-M26GEN4C.cjs} +14 -9
- package/dist/chunk-M26GEN4C.cjs.map +1 -0
- package/dist/{chunk-4P35AVPE.cjs → chunk-MEMYFFOL.cjs} +256 -157
- package/dist/chunk-MEMYFFOL.cjs.map +1 -0
- package/dist/{chunk-BQ355Z3O.js → chunk-NUZWQA4J.js} +4 -4
- package/dist/{chunk-BQ355Z3O.js.map → chunk-NUZWQA4J.js.map} +1 -1
- package/dist/{chunk-JIRB5LX4.js → chunk-OHX36YXF.js} +5 -3
- package/dist/chunk-OHX36YXF.js.map +1 -0
- package/dist/{chunk-PKORY4ZZ.cjs → chunk-OOTLMVNN.cjs} +107 -7
- package/dist/chunk-OOTLMVNN.cjs.map +1 -0
- package/dist/{chunk-D4M6E4OQ.cjs → chunk-OWZ6QT24.cjs} +16 -8
- package/dist/chunk-OWZ6QT24.cjs.map +1 -0
- package/dist/{chunk-6OHS6ZQ3.js → chunk-PDJCIONR.js} +8 -8
- package/dist/{chunk-6OHS6ZQ3.js.map → chunk-PDJCIONR.js.map} +1 -1
- package/dist/{chunk-WU2P7XOU.cjs → chunk-PP4G2TZZ.cjs} +20 -20
- package/dist/{chunk-WU2P7XOU.cjs.map → chunk-PP4G2TZZ.cjs.map} +1 -1
- package/dist/{chunk-VWAK25TU.js → chunk-SBBWRNZA.js} +10 -7
- package/dist/chunk-SBBWRNZA.js.map +1 -0
- package/dist/{chunk-TU4YMXOQ.js → chunk-TJIFNVPX.js} +6 -6
- package/dist/{chunk-TU4YMXOQ.js.map → chunk-TJIFNVPX.js.map} +1 -1
- package/dist/{chunk-V5YNS2QO.cjs → chunk-XJNQHPBJ.cjs} +15 -15
- package/dist/{chunk-V5YNS2QO.cjs.map → chunk-XJNQHPBJ.cjs.map} +1 -1
- package/dist/{chunk-MVYP55NA.js → chunk-YC6Z75K2.js} +113 -336
- package/dist/chunk-YC6Z75K2.js.map +1 -0
- package/dist/{chunk-3ZF7IC6Q.cjs → chunk-YZMSJKAK.cjs} +5 -3
- package/dist/chunk-YZMSJKAK.cjs.map +1 -0
- package/dist/{chunk-L3WDI7HP.cjs → chunk-Z2X5VTYJ.cjs} +65 -65
- package/dist/{chunk-L3WDI7HP.cjs.map → chunk-Z2X5VTYJ.cjs.map} +1 -1
- package/dist/{chunk-BN5MV2QK.cjs → chunk-Z52OAJ73.cjs} +4 -4
- package/dist/{chunk-BN5MV2QK.cjs.map → chunk-Z52OAJ73.cjs.map} +1 -1
- package/dist/{chunk-WYPSC6CO.js → chunk-ZBU6P4JV.js} +104 -4
- package/dist/chunk-ZBU6P4JV.js.map +1 -0
- package/dist/datasets/experiment/index.d.ts.map +1 -1
- 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/di/index.cjs +4 -4
- package/dist/di/index.js +1 -1
- package/dist/docs/SKILL.md +1 -1
- package/dist/docs/assets/SOURCE_MAP.json +443 -384
- package/dist/docs/references/docs-agents-agent-approval.md +61 -31
- package/dist/docs/references/docs-agents-supervisor-agents.md +1 -1
- package/dist/docs/references/docs-memory-observational-memory.md +9 -0
- package/dist/docs/references/docs-memory-semantic-recall.md +17 -1
- package/dist/docs/references/docs-workspace-skills.md +7 -5
- package/dist/docs/references/reference-agents-agent.md +20 -20
- package/dist/docs/references/reference-agents-generate.md +200 -66
- package/dist/docs/references/reference-agents-generateLegacy.md +77 -35
- package/dist/docs/references/reference-agents-getDefaultGenerateOptions.md +4 -6
- package/dist/docs/references/reference-agents-getDefaultOptions.md +4 -6
- package/dist/docs/references/reference-agents-getDefaultStreamOptions.md +4 -6
- package/dist/docs/references/reference-agents-getDescription.md +1 -1
- package/dist/docs/references/reference-agents-getInstructions.md +4 -6
- package/dist/docs/references/reference-agents-getLLM.md +6 -8
- package/dist/docs/references/reference-agents-getMemory.md +4 -6
- package/dist/docs/references/reference-agents-getModel.md +4 -6
- package/dist/docs/references/reference-agents-getTools.md +5 -7
- package/dist/docs/references/reference-agents-getVoice.md +4 -6
- package/dist/docs/references/reference-agents-listAgents.md +4 -6
- package/dist/docs/references/reference-agents-listScorers.md +4 -6
- package/dist/docs/references/reference-agents-listTools.md +4 -6
- package/dist/docs/references/reference-agents-listWorkflows.md +4 -6
- package/dist/docs/references/reference-agents-network.md +69 -23
- package/dist/docs/references/reference-ai-sdk-chat-route.md +7 -7
- package/dist/docs/references/reference-ai-sdk-network-route.md +3 -3
- package/dist/docs/references/reference-ai-sdk-to-ai-sdk-stream.md +9 -9
- package/dist/docs/references/reference-ai-sdk-with-mastra.md +12 -12
- package/dist/docs/references/reference-ai-sdk-workflow-route.md +3 -3
- package/dist/docs/references/reference-auth-auth0.md +6 -6
- package/dist/docs/references/reference-auth-clerk.md +5 -5
- package/dist/docs/references/reference-auth-firebase.md +7 -7
- package/dist/docs/references/reference-auth-jwt.md +1 -1
- package/dist/docs/references/reference-auth-supabase.md +4 -4
- package/dist/docs/references/reference-auth-workos.md +6 -6
- package/dist/docs/references/reference-core-addGateway.md +2 -2
- package/dist/docs/references/reference-core-getAgent.md +2 -2
- package/dist/docs/references/reference-core-getAgentById.md +2 -2
- package/dist/docs/references/reference-core-getDeployer.md +1 -1
- package/dist/docs/references/reference-core-getGateway.md +2 -2
- package/dist/docs/references/reference-core-getGatewayById.md +2 -2
- package/dist/docs/references/reference-core-getLogger.md +1 -1
- package/dist/docs/references/reference-core-getMCPServer.md +2 -2
- package/dist/docs/references/reference-core-getMCPServerById.md +3 -3
- package/dist/docs/references/reference-core-getMemory.md +2 -2
- package/dist/docs/references/reference-core-getScorer.md +2 -2
- package/dist/docs/references/reference-core-getScorerById.md +2 -2
- package/dist/docs/references/reference-core-getServer.md +1 -1
- package/dist/docs/references/reference-core-getStorage.md +1 -1
- package/dist/docs/references/reference-core-getStoredAgentById.md +18 -20
- package/dist/docs/references/reference-core-getTelemetry.md +1 -1
- package/dist/docs/references/reference-core-getVector.md +2 -2
- package/dist/docs/references/reference-core-getWorkflow.md +3 -3
- package/dist/docs/references/reference-core-listAgents.md +1 -1
- package/dist/docs/references/reference-core-listGateways.md +1 -1
- package/dist/docs/references/reference-core-listLogs.md +9 -11
- package/dist/docs/references/reference-core-listLogsByRunId.md +9 -9
- package/dist/docs/references/reference-core-listMCPServers.md +1 -1
- package/dist/docs/references/reference-core-listMemory.md +1 -1
- package/dist/docs/references/reference-core-listScorers.md +1 -1
- package/dist/docs/references/reference-core-listStoredAgents.md +9 -11
- package/dist/docs/references/reference-core-listVectors.md +1 -1
- package/dist/docs/references/reference-core-listWorkflows.md +2 -2
- package/dist/docs/references/reference-core-mastra-class.md +17 -17
- package/dist/docs/references/reference-core-mastra-model-gateway.md +15 -15
- package/dist/docs/references/reference-core-setLogger.md +2 -4
- package/dist/docs/references/reference-core-setStorage.md +1 -1
- package/dist/docs/references/reference-datasets-addItem.md +20 -4
- package/dist/docs/references/reference-datasets-addItems.md +8 -2
- package/dist/docs/references/reference-datasets-compareExperiments.md +15 -3
- package/dist/docs/references/reference-datasets-create.md +6 -6
- package/dist/docs/references/reference-datasets-dataset.md +1 -1
- package/dist/docs/references/reference-datasets-delete.md +2 -2
- package/dist/docs/references/reference-datasets-deleteExperiment.md +2 -2
- package/dist/docs/references/reference-datasets-deleteItem.md +2 -2
- package/dist/docs/references/reference-datasets-deleteItems.md +2 -2
- package/dist/docs/references/reference-datasets-get.md +2 -2
- package/dist/docs/references/reference-datasets-getDetails.md +9 -9
- package/dist/docs/references/reference-datasets-getExperiment.md +2 -2
- package/dist/docs/references/reference-datasets-getItem.md +3 -3
- package/dist/docs/references/reference-datasets-getItemHistory.md +22 -2
- package/dist/docs/references/reference-datasets-list.md +7 -3
- package/dist/docs/references/reference-datasets-listExperimentResults.md +34 -4
- package/dist/docs/references/reference-datasets-listExperiments.md +41 -3
- package/dist/docs/references/reference-datasets-listItems.md +18 -6
- package/dist/docs/references/reference-datasets-listVersions.md +23 -3
- package/dist/docs/references/reference-datasets-startExperiment.md +62 -12
- package/dist/docs/references/reference-datasets-startExperimentAsync.md +5 -1
- package/dist/docs/references/reference-datasets-update.md +6 -6
- package/dist/docs/references/reference-datasets-updateItem.md +5 -5
- package/dist/docs/references/reference-evals-answer-relevancy.md +11 -11
- package/dist/docs/references/reference-evals-answer-similarity.md +17 -19
- package/dist/docs/references/reference-evals-bias.md +10 -10
- package/dist/docs/references/reference-evals-completeness.md +3 -3
- package/dist/docs/references/reference-evals-content-similarity.md +6 -6
- package/dist/docs/references/reference-evals-context-precision.md +4 -4
- package/dist/docs/references/reference-evals-create-scorer.md +47 -49
- package/dist/docs/references/reference-evals-faithfulness.md +11 -11
- package/dist/docs/references/reference-evals-hallucination.md +17 -21
- package/dist/docs/references/reference-evals-keyword-coverage.md +4 -4
- package/dist/docs/references/reference-evals-mastra-scorer.md +14 -14
- package/dist/docs/references/reference-evals-run-evals.md +16 -16
- package/dist/docs/references/reference-evals-scorer-utils.md +3 -3
- package/dist/docs/references/reference-evals-textual-difference.md +3 -3
- package/dist/docs/references/reference-evals-tone-consistency.md +3 -3
- package/dist/docs/references/reference-evals-toxicity.md +8 -8
- package/dist/docs/references/reference-harness-harness-class.md +34 -42
- package/dist/docs/references/reference-logging-pino-logger.md +5 -5
- package/dist/docs/references/reference-memory-deleteMessages.md +2 -2
- package/dist/docs/references/reference-memory-memory-class.md +12 -14
- package/dist/docs/references/reference-memory-observational-memory.md +102 -94
- package/dist/docs/references/reference-observability-tracing-configuration.md +27 -10
- package/dist/docs/references/reference-observability-tracing-exporters-console-exporter.md +4 -7
- package/dist/docs/references/reference-processors-batch-parts-processor.md +8 -10
- package/dist/docs/references/reference-processors-language-detector.md +14 -16
- package/dist/docs/references/reference-processors-message-history-processor.md +7 -9
- package/dist/docs/references/reference-processors-moderation-processor.md +13 -15
- package/dist/docs/references/reference-processors-pii-detector.md +14 -16
- package/dist/docs/references/reference-processors-processor-interface.md +62 -62
- package/dist/docs/references/reference-processors-prompt-injection-detector.md +11 -13
- package/dist/docs/references/reference-processors-semantic-recall-processor.md +14 -16
- package/dist/docs/references/reference-processors-system-prompt-scrubber.md +12 -14
- package/dist/docs/references/reference-processors-token-limiter-processor.md +11 -13
- package/dist/docs/references/reference-processors-tool-call-filter.md +5 -7
- package/dist/docs/references/reference-processors-tool-search-processor.md +9 -11
- package/dist/docs/references/reference-processors-unicode-normalizer.md +8 -10
- package/dist/docs/references/reference-processors-working-memory-processor.md +14 -18
- package/dist/docs/references/reference-rag-database-config.md +11 -7
- package/dist/docs/references/reference-rag-embeddings.md +12 -12
- package/dist/docs/references/reference-server-mastra-server.md +10 -10
- package/dist/docs/references/reference-server-register-api-route.md +13 -13
- package/dist/docs/references/reference-storage-cloudflare-d1.md +5 -5
- package/dist/docs/references/reference-storage-composite.md +9 -9
- package/dist/docs/references/reference-storage-lance.md +3 -3
- package/dist/docs/references/reference-storage-libsql.md +2 -2
- package/dist/docs/references/reference-storage-mongodb.md +5 -5
- package/dist/docs/references/reference-storage-mssql.md +2 -2
- package/dist/docs/references/reference-storage-postgresql.md +25 -25
- package/dist/docs/references/reference-storage-upstash.md +3 -3
- package/dist/docs/references/reference-streaming-ChunkType.md +251 -59
- package/dist/docs/references/reference-streaming-agents-MastraModelOutput.md +86 -16
- package/dist/docs/references/reference-streaming-agents-streamLegacy.md +79 -39
- package/dist/docs/references/reference-streaming-workflows-resumeStream.md +18 -8
- package/dist/docs/references/reference-streaming-workflows-stream.md +21 -9
- package/dist/docs/references/reference-streaming-workflows-timeTravelStream.md +4 -4
- package/dist/docs/references/reference-tools-create-tool.md +25 -21
- package/dist/docs/references/reference-tools-graph-rag-tool.md +16 -18
- package/dist/docs/references/reference-tools-mcp-client.md +38 -27
- package/dist/docs/references/reference-tools-mcp-server.md +45 -45
- package/dist/docs/references/reference-tools-vector-query-tool.md +34 -22
- package/dist/docs/references/reference-vectors-libsql.md +31 -31
- package/dist/docs/references/reference-vectors-mongodb.md +32 -32
- package/dist/docs/references/reference-vectors-pg.md +60 -44
- package/dist/docs/references/reference-vectors-upstash.md +25 -25
- package/dist/docs/references/reference-voice-composite-voice.md +10 -10
- package/dist/docs/references/reference-voice-mastra-voice.md +20 -20
- package/dist/docs/references/reference-voice-voice.addInstructions.md +1 -1
- package/dist/docs/references/reference-voice-voice.addTools.md +1 -1
- package/dist/docs/references/reference-voice-voice.connect.md +3 -3
- package/dist/docs/references/reference-voice-voice.events.md +11 -11
- package/dist/docs/references/reference-voice-voice.listen.md +9 -9
- package/dist/docs/references/reference-voice-voice.on.md +2 -2
- package/dist/docs/references/reference-voice-voice.speak.md +11 -11
- package/dist/docs/references/reference-workflows-run-methods-cancel.md +2 -2
- package/dist/docs/references/reference-workflows-run-methods-restart.md +17 -5
- package/dist/docs/references/reference-workflows-run-methods-resume.md +23 -9
- package/dist/docs/references/reference-workflows-run-methods-start.md +22 -8
- package/dist/docs/references/reference-workflows-run-methods-startAsync.md +12 -6
- package/dist/docs/references/reference-workflows-run-methods-timeTravel.md +29 -13
- package/dist/docs/references/reference-workflows-run.md +12 -12
- package/dist/docs/references/reference-workflows-step.md +24 -26
- package/dist/docs/references/reference-workflows-workflow-methods-branch.md +2 -2
- package/dist/docs/references/reference-workflows-workflow-methods-commit.md +1 -1
- package/dist/docs/references/reference-workflows-workflow-methods-create-run.md +4 -4
- package/dist/docs/references/reference-workflows-workflow-methods-dountil.md +3 -3
- package/dist/docs/references/reference-workflows-workflow-methods-dowhile.md +3 -3
- package/dist/docs/references/reference-workflows-workflow-methods-foreach.md +9 -9
- package/dist/docs/references/reference-workflows-workflow-methods-map.md +2 -2
- package/dist/docs/references/reference-workflows-workflow-methods-parallel.md +2 -2
- package/dist/docs/references/reference-workflows-workflow-methods-sleep.md +2 -2
- package/dist/docs/references/reference-workflows-workflow-methods-sleepUntil.md +2 -2
- package/dist/docs/references/reference-workflows-workflow-methods-then.md +2 -2
- package/dist/docs/references/reference-workflows-workflow.md +40 -50
- package/dist/docs/references/reference-workspace-filesystem.md +22 -22
- package/dist/docs/references/reference-workspace-local-filesystem.md +35 -35
- package/dist/docs/references/reference-workspace-local-sandbox.md +26 -26
- package/dist/docs/references/reference-workspace-sandbox.md +8 -8
- package/dist/docs/references/reference-workspace-workspace-class.md +30 -34
- package/dist/editor/types.d.ts +1 -0
- package/dist/editor/types.d.ts.map +1 -1
- package/dist/evals/index.cjs +20 -20
- package/dist/evals/index.js +3 -3
- package/dist/evals/scoreTraces/index.cjs +5 -5
- package/dist/evals/scoreTraces/index.js +2 -2
- package/dist/harness/harness.d.ts.map +1 -1
- package/dist/harness/index.cjs +25 -21
- package/dist/harness/index.cjs.map +1 -1
- package/dist/harness/index.js +15 -11
- package/dist/harness/index.js.map +1 -1
- package/dist/index.cjs +2 -2
- package/dist/index.js +1 -1
- package/dist/integration/index.cjs +2 -2
- package/dist/integration/index.js +1 -1
- package/dist/llm/index.cjs +12 -12
- package/dist/llm/index.js +3 -3
- package/dist/llm/model/model.d.ts.map +1 -1
- package/dist/llm/model/model.loop.d.ts.map +1 -1
- package/dist/llm/model/provider-types.generated.d.ts +5 -1
- package/dist/loop/index.cjs +14 -14
- package/dist/loop/index.js +1 -1
- package/dist/loop/workflows/agentic-loop/index.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/models-dev-2FJK72J2.cjs +12 -0
- package/dist/{models-dev-UVWCKPA2.cjs.map → models-dev-2FJK72J2.cjs.map} +1 -1
- package/dist/models-dev-CMQG6EMO.js +3 -0
- package/dist/{models-dev-W3LXZTEB.js.map → models-dev-CMQG6EMO.js.map} +1 -1
- package/dist/processor-provider/index.cjs +10 -10
- package/dist/processor-provider/index.js +1 -1
- package/dist/processors/index.cjs +42 -42
- package/dist/processors/index.js +1 -1
- package/dist/processors/processors/skills.d.ts +9 -42
- package/dist/processors/processors/skills.d.ts.map +1 -1
- package/dist/provider-registry-EHOAWHFE.cjs +40 -0
- package/dist/{provider-registry-4HLP2JRR.cjs.map → provider-registry-EHOAWHFE.cjs.map} +1 -1
- package/dist/provider-registry-LVP6T63V.js +3 -0
- package/dist/{provider-registry-K3DWQSMH.js.map → provider-registry-LVP6T63V.js.map} +1 -1
- package/dist/provider-registry.json +12 -4
- package/dist/relevance/index.cjs +3 -3
- package/dist/relevance/index.js +1 -1
- package/dist/request-context/index.cjs +4 -4
- package/dist/request-context/index.d.ts.map +1 -1
- package/dist/request-context/index.js +1 -1
- package/dist/storage/base.d.ts +34 -1
- package/dist/storage/base.d.ts.map +1 -1
- package/dist/storage/constants.cjs +56 -56
- package/dist/storage/constants.js +1 -1
- package/dist/storage/domains/agents/filesystem.d.ts +28 -0
- package/dist/storage/domains/agents/filesystem.d.ts.map +1 -0
- package/dist/storage/domains/agents/index.d.ts +1 -0
- package/dist/storage/domains/agents/index.d.ts.map +1 -1
- package/dist/storage/domains/experiments/inmemory.d.ts.map +1 -1
- package/dist/storage/domains/mcp-clients/filesystem.d.ts +28 -0
- package/dist/storage/domains/mcp-clients/filesystem.d.ts.map +1 -0
- package/dist/storage/domains/mcp-clients/index.d.ts +1 -0
- package/dist/storage/domains/mcp-clients/index.d.ts.map +1 -1
- package/dist/storage/domains/mcp-servers/filesystem.d.ts +28 -0
- package/dist/storage/domains/mcp-servers/filesystem.d.ts.map +1 -0
- package/dist/storage/domains/mcp-servers/index.d.ts +1 -0
- package/dist/storage/domains/mcp-servers/index.d.ts.map +1 -1
- package/dist/storage/domains/prompt-blocks/filesystem.d.ts +28 -0
- package/dist/storage/domains/prompt-blocks/filesystem.d.ts.map +1 -0
- package/dist/storage/domains/prompt-blocks/index.d.ts +1 -0
- package/dist/storage/domains/prompt-blocks/index.d.ts.map +1 -1
- package/dist/storage/domains/scorer-definitions/filesystem.d.ts +28 -0
- package/dist/storage/domains/scorer-definitions/filesystem.d.ts.map +1 -0
- package/dist/storage/domains/scorer-definitions/index.d.ts +1 -0
- package/dist/storage/domains/scorer-definitions/index.d.ts.map +1 -1
- package/dist/storage/domains/skills/filesystem.d.ts +28 -0
- package/dist/storage/domains/skills/filesystem.d.ts.map +1 -0
- package/dist/storage/domains/skills/index.d.ts +1 -0
- package/dist/storage/domains/skills/index.d.ts.map +1 -1
- package/dist/storage/domains/workspaces/filesystem.d.ts +28 -0
- package/dist/storage/domains/workspaces/filesystem.d.ts.map +1 -0
- package/dist/storage/domains/workspaces/index.d.ts +1 -0
- package/dist/storage/domains/workspaces/index.d.ts.map +1 -1
- package/dist/storage/filesystem-db.d.ts +82 -0
- package/dist/storage/filesystem-db.d.ts.map +1 -0
- package/dist/storage/filesystem-versioned.d.ts +148 -0
- package/dist/storage/filesystem-versioned.d.ts.map +1 -0
- package/dist/storage/filesystem.d.ts +39 -0
- package/dist/storage/filesystem.d.ts.map +1 -0
- package/dist/storage/git-history.d.ts +68 -0
- package/dist/storage/git-history.d.ts.map +1 -0
- package/dist/storage/index.cjs +208 -160
- package/dist/storage/index.d.ts +4 -0
- package/dist/storage/index.d.ts.map +1 -1
- package/dist/storage/index.js +2 -2
- package/dist/storage/types.d.ts +1 -0
- package/dist/storage/types.d.ts.map +1 -1
- package/dist/stream/RunOutput.d.ts +1 -1
- package/dist/stream/aisdk/v5/output-helpers.d.ts +6 -6
- package/dist/stream/base/output.d.ts +3 -3
- package/dist/stream/base/schema.d.ts +1 -1
- package/dist/stream/index.cjs +11 -11
- package/dist/stream/index.js +2 -2
- package/dist/test-utils/llm-mock.cjs +4 -4
- package/dist/test-utils/llm-mock.js +1 -1
- package/dist/tool-loop-agent/index.cjs +4 -4
- package/dist/tool-loop-agent/index.js +1 -1
- package/dist/tools/index.cjs +6 -6
- package/dist/tools/index.js +1 -1
- package/dist/tools/is-vercel-tool.cjs +2 -2
- package/dist/tools/is-vercel-tool.js +1 -1
- package/dist/tools/tool-builder/builder.d.ts.map +1 -1
- package/dist/tools/tool.d.ts +6 -0
- package/dist/tools/tool.d.ts.map +1 -1
- package/dist/tools/types.d.ts +27 -0
- package/dist/tools/types.d.ts.map +1 -1
- package/dist/utils.cjs +23 -23
- package/dist/utils.js +1 -1
- package/dist/vector/index.cjs +9 -9
- package/dist/vector/index.js +2 -2
- 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/index.cjs +70 -66
- package/dist/workspace/index.d.ts +1 -0
- package/dist/workspace/index.d.ts.map +1 -1
- package/dist/workspace/index.js +1 -1
- package/dist/workspace/sandbox/execa.d.ts +9 -0
- package/dist/workspace/sandbox/execa.d.ts.map +1 -0
- package/dist/workspace/sandbox/local-process-manager.d.ts.map +1 -1
- package/dist/workspace/skills/index.d.ts +1 -0
- package/dist/workspace/skills/index.d.ts.map +1 -1
- package/dist/workspace/skills/tools.d.ts +36 -0
- package/dist/workspace/skills/tools.d.ts.map +1 -0
- package/dist/workspace/tools/execute-command.d.ts.map +1 -1
- package/dist/workspace/tools/output-helpers.d.ts +4 -3
- package/dist/workspace/tools/output-helpers.d.ts.map +1 -1
- package/package.json +9 -9
- package/src/llm/model/provider-types.generated.d.ts +5 -1
- package/dist/chunk-3ZF7IC6Q.cjs.map +0 -1
- package/dist/chunk-4BXXAZ75.js.map +0 -1
- package/dist/chunk-4P35AVPE.cjs.map +0 -1
- package/dist/chunk-BFV3GSGS.js.map +0 -1
- package/dist/chunk-CCLV5CAA.js.map +0 -1
- package/dist/chunk-D4M6E4OQ.cjs.map +0 -1
- package/dist/chunk-D6HO5QAM.cjs.map +0 -1
- package/dist/chunk-G5R2755Q.cjs.map +0 -1
- package/dist/chunk-GJTLWOKJ.js.map +0 -1
- package/dist/chunk-H5S4PS44.cjs.map +0 -1
- package/dist/chunk-IOY7Y5GV.js.map +0 -1
- package/dist/chunk-JIRB5LX4.js.map +0 -1
- package/dist/chunk-MVYP55NA.js.map +0 -1
- package/dist/chunk-PKORY4ZZ.cjs.map +0 -1
- package/dist/chunk-QNXY3J6B.cjs.map +0 -1
- package/dist/chunk-SEKQJ447.js.map +0 -1
- package/dist/chunk-VDKWYUGC.cjs.map +0 -1
- package/dist/chunk-VWAK25TU.js.map +0 -1
- package/dist/chunk-WYPSC6CO.js.map +0 -1
- package/dist/chunk-YIJZBU54.cjs.map +0 -1
- package/dist/chunk-ZBESCKPX.cjs.map +0 -1
- package/dist/chunk-ZVWVQ6MG.js.map +0 -1
- package/dist/models-dev-UVWCKPA2.cjs +0 -12
- package/dist/models-dev-W3LXZTEB.js +0 -3
- package/dist/provider-registry-4HLP2JRR.cjs +0 -40
- package/dist/provider-registry-K3DWQSMH.js +0 -3
|
@@ -4,27 +4,27 @@ The PgVector class provides vector search using [PostgreSQL](https://www.postgre
|
|
|
4
4
|
|
|
5
5
|
## Constructor Options
|
|
6
6
|
|
|
7
|
-
**connectionString
|
|
7
|
+
**connectionString** (`string`): PostgreSQL connection URL
|
|
8
8
|
|
|
9
|
-
**host
|
|
9
|
+
**host** (`string`): PostgreSQL server host
|
|
10
10
|
|
|
11
|
-
**port
|
|
11
|
+
**port** (`number`): PostgreSQL server port
|
|
12
12
|
|
|
13
|
-
**database
|
|
13
|
+
**database** (`string`): PostgreSQL database name
|
|
14
14
|
|
|
15
|
-
**user
|
|
15
|
+
**user** (`string`): PostgreSQL user
|
|
16
16
|
|
|
17
|
-
**password
|
|
17
|
+
**password** (`string`): PostgreSQL password
|
|
18
18
|
|
|
19
|
-
**ssl
|
|
19
|
+
**ssl** (`boolean | ConnectionOptions`): Enable SSL or provide custom SSL configuration
|
|
20
20
|
|
|
21
|
-
**schemaName
|
|
21
|
+
**schemaName** (`string`): The name of the schema you want the vector store to use. Will use the default schema if not provided.
|
|
22
22
|
|
|
23
|
-
**max
|
|
23
|
+
**max** (`number`): Maximum number of pool connections (default: 20)
|
|
24
24
|
|
|
25
|
-
**idleTimeoutMillis
|
|
25
|
+
**idleTimeoutMillis** (`number`): Idle connection timeout in milliseconds (default: 30000)
|
|
26
26
|
|
|
27
|
-
**pgPoolOptions
|
|
27
|
+
**pgPoolOptions** (`PoolConfig`): Additional pg pool configuration options
|
|
28
28
|
|
|
29
29
|
## Constructor Examples
|
|
30
30
|
|
|
@@ -72,23 +72,35 @@ const vectorStore = new PgVector({
|
|
|
72
72
|
|
|
73
73
|
### createIndex()
|
|
74
74
|
|
|
75
|
-
**indexName
|
|
75
|
+
**indexName** (`string`): Name of the index to create
|
|
76
76
|
|
|
77
|
-
**dimension
|
|
77
|
+
**dimension** (`number`): Vector dimension (must match your embedding model)
|
|
78
78
|
|
|
79
|
-
**metric
|
|
79
|
+
**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
|
|
80
80
|
|
|
81
|
-
**indexConfig
|
|
81
|
+
**indexConfig** (`IndexConfig`): Index configuration (Default: `{ type: 'ivfflat' }`)
|
|
82
82
|
|
|
83
|
-
**buildIndex
|
|
83
|
+
**buildIndex** (`boolean`): Whether to build the index (Default: `true`)
|
|
84
84
|
|
|
85
85
|
#### IndexConfig
|
|
86
86
|
|
|
87
|
-
**type
|
|
87
|
+
**type** (`'flat' | 'hnsw' | 'ivfflat'`): Index type (Default: `ivfflat`)
|
|
88
88
|
|
|
89
|
-
**
|
|
89
|
+
**type.flat** (`flat`): Sequential scan (no index) that performs exhaustive search.
|
|
90
90
|
|
|
91
|
-
**
|
|
91
|
+
**type.ivfflat** (`ivfflat`): Clusters vectors into lists for approximate search.
|
|
92
|
+
|
|
93
|
+
**type.hnsw** (`hnsw`): Graph-based index offering fast search times and high recall.
|
|
94
|
+
|
|
95
|
+
**ivf** (`IVFConfig`): IVF configuration
|
|
96
|
+
|
|
97
|
+
**ivf.lists** (`number`): Number of lists. If not specified, automatically calculated based on dataset size. (Minimum 100, Maximum 4000)
|
|
98
|
+
|
|
99
|
+
**hnsw** (`HNSWConfig`): HNSW configuration
|
|
100
|
+
|
|
101
|
+
**hnsw\.m** (`number`): Maximum number of connections per node (default: 8)
|
|
102
|
+
|
|
103
|
+
**hnsw\.efConstruction** (`number`): Build-time complexity (default: 32)
|
|
92
104
|
|
|
93
105
|
#### Memory Requirements
|
|
94
106
|
|
|
@@ -102,29 +114,33 @@ Higher M values or efConstruction values will increase memory requirements signi
|
|
|
102
114
|
|
|
103
115
|
### upsert()
|
|
104
116
|
|
|
105
|
-
**indexName
|
|
117
|
+
**indexName** (`string`): Name of the index to upsert vectors into
|
|
106
118
|
|
|
107
|
-
**vectors
|
|
119
|
+
**vectors** (`number[][]`): Array of embedding vectors
|
|
108
120
|
|
|
109
|
-
**metadata
|
|
121
|
+
**metadata** (`Record<string, any>[]`): Metadata for each vector
|
|
110
122
|
|
|
111
|
-
**ids
|
|
123
|
+
**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
|
|
112
124
|
|
|
113
125
|
### query()
|
|
114
126
|
|
|
115
|
-
**indexName
|
|
127
|
+
**indexName** (`string`): Name of the index to query
|
|
128
|
+
|
|
129
|
+
**queryVector** (`number[]`): Query vector
|
|
130
|
+
|
|
131
|
+
**topK** (`number`): Number of results to return (Default: `10`)
|
|
116
132
|
|
|
117
|
-
**
|
|
133
|
+
**filter** (`Record<string, any>`): Metadata filters
|
|
118
134
|
|
|
119
|
-
**
|
|
135
|
+
**includeVector** (`boolean`): Whether to include the vector in the result (Default: `false`)
|
|
120
136
|
|
|
121
|
-
**
|
|
137
|
+
**minScore** (`number`): Minimum similarity score threshold (Default: `0`)
|
|
122
138
|
|
|
123
|
-
**
|
|
139
|
+
**options** (`{ ef?: number; probes?: number }`): Additional options for HNSW and IVF indexes
|
|
124
140
|
|
|
125
|
-
**
|
|
141
|
+
**options.ef** (`number`): HNSW search parameter
|
|
126
142
|
|
|
127
|
-
**options
|
|
143
|
+
**options.probes** (`number`): IVF search parameter
|
|
128
144
|
|
|
129
145
|
### listIndexes()
|
|
130
146
|
|
|
@@ -132,7 +148,7 @@ Returns an array of index names as strings.
|
|
|
132
148
|
|
|
133
149
|
### describeIndex()
|
|
134
150
|
|
|
135
|
-
**indexName
|
|
151
|
+
**indexName** (`string`): Name of the index to describe
|
|
136
152
|
|
|
137
153
|
Returns:
|
|
138
154
|
|
|
@@ -153,19 +169,19 @@ interface PGIndexStats {
|
|
|
153
169
|
|
|
154
170
|
### deleteIndex()
|
|
155
171
|
|
|
156
|
-
**indexName
|
|
172
|
+
**indexName** (`string`): Name of the index to delete
|
|
157
173
|
|
|
158
174
|
### updateVector()
|
|
159
175
|
|
|
160
176
|
Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
|
|
161
177
|
|
|
162
|
-
**indexName
|
|
178
|
+
**indexName** (`string`): Name of the index containing the vector
|
|
163
179
|
|
|
164
|
-
**id
|
|
180
|
+
**id** (`string`): ID of the vector to update (mutually exclusive with filter)
|
|
165
181
|
|
|
166
|
-
**filter
|
|
182
|
+
**filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
|
|
167
183
|
|
|
168
|
-
**update
|
|
184
|
+
**update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
|
|
169
185
|
|
|
170
186
|
Updates an existing vector by ID or filter. At least one of vector or metadata must be provided in the update object.
|
|
171
187
|
|
|
@@ -192,9 +208,9 @@ await pgVector.updateVector({
|
|
|
192
208
|
|
|
193
209
|
### deleteVector()
|
|
194
210
|
|
|
195
|
-
**indexName
|
|
211
|
+
**indexName** (`string`): Name of the index containing the vector
|
|
196
212
|
|
|
197
|
-
**id
|
|
213
|
+
**id** (`string`): ID of the vector to delete
|
|
198
214
|
|
|
199
215
|
Deletes a single vector by ID from the specified index.
|
|
200
216
|
|
|
@@ -206,11 +222,11 @@ await pgVector.deleteVector({ indexName: 'my_vectors', id: 'vector123' })
|
|
|
206
222
|
|
|
207
223
|
Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
|
|
208
224
|
|
|
209
|
-
**indexName
|
|
225
|
+
**indexName** (`string`): Name of the index containing the vectors to delete
|
|
210
226
|
|
|
211
|
-
**ids
|
|
227
|
+
**ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
|
|
212
228
|
|
|
213
|
-
**filter
|
|
229
|
+
**filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
|
|
214
230
|
|
|
215
231
|
### disconnect()
|
|
216
232
|
|
|
@@ -218,11 +234,11 @@ Closes the database connection pool. Should be called when done using the store.
|
|
|
218
234
|
|
|
219
235
|
### buildIndex()
|
|
220
236
|
|
|
221
|
-
**indexName
|
|
237
|
+
**indexName** (`string`): Name of the index to define
|
|
222
238
|
|
|
223
|
-
**metric
|
|
239
|
+
**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
|
|
224
240
|
|
|
225
|
-
**indexConfig
|
|
241
|
+
**indexConfig** (`IndexConfig`): Configuration for the index type and parameters
|
|
226
242
|
|
|
227
243
|
Builds or rebuilds an index with specified metric and configuration. Will drop any existing index before creating the new one.
|
|
228
244
|
|
|
@@ -4,9 +4,9 @@ The UpstashVector class provides vector search using [Upstash Vector](https://up
|
|
|
4
4
|
|
|
5
5
|
## Constructor Options
|
|
6
6
|
|
|
7
|
-
**url
|
|
7
|
+
**url** (`string`): Upstash Vector database URL
|
|
8
8
|
|
|
9
|
-
**token
|
|
9
|
+
**token** (`string`): Upstash Vector API token
|
|
10
10
|
|
|
11
11
|
## Methods
|
|
12
12
|
|
|
@@ -14,41 +14,41 @@ The UpstashVector class provides vector search using [Upstash Vector](https://up
|
|
|
14
14
|
|
|
15
15
|
Note: This method is a no-op for Upstash as indexes are created automatically.
|
|
16
16
|
|
|
17
|
-
**indexName
|
|
17
|
+
**indexName** (`string`): Name of the index to create
|
|
18
18
|
|
|
19
|
-
**dimension
|
|
19
|
+
**dimension** (`number`): Vector dimension (must match your embedding model)
|
|
20
20
|
|
|
21
|
-
**metric
|
|
21
|
+
**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
|
|
22
22
|
|
|
23
23
|
### upsert()
|
|
24
24
|
|
|
25
|
-
**indexName
|
|
25
|
+
**indexName** (`string`): Name of the index to upsert into
|
|
26
26
|
|
|
27
|
-
**vectors
|
|
27
|
+
**vectors** (`number[][]`): Array of embedding vectors
|
|
28
28
|
|
|
29
|
-
**sparseVectors
|
|
29
|
+
**sparseVectors** (`{ indices: number[], values: number[] }[]`): Array of sparse vectors for hybrid search. Each sparse vector must have matching indices and values arrays.
|
|
30
30
|
|
|
31
|
-
**metadata
|
|
31
|
+
**metadata** (`Record<string, any>[]`): Metadata for each vector
|
|
32
32
|
|
|
33
|
-
**ids
|
|
33
|
+
**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
|
|
34
34
|
|
|
35
35
|
### query()
|
|
36
36
|
|
|
37
|
-
**indexName
|
|
37
|
+
**indexName** (`string`): Name of the index to query
|
|
38
38
|
|
|
39
|
-
**queryVector
|
|
39
|
+
**queryVector** (`number[]`): Query vector to find similar vectors
|
|
40
40
|
|
|
41
|
-
**sparseVector
|
|
41
|
+
**sparseVector** (`{ indices: number[], values: number[] }`): Optional sparse vector for hybrid search. Must have matching indices and values arrays.
|
|
42
42
|
|
|
43
|
-
**topK
|
|
43
|
+
**topK** (`number`): Number of results to return (Default: `10`)
|
|
44
44
|
|
|
45
|
-
**filter
|
|
45
|
+
**filter** (`Record<string, any>`): Metadata filters for the query
|
|
46
46
|
|
|
47
|
-
**includeVector
|
|
47
|
+
**includeVector** (`boolean`): Whether to include vectors in the results (Default: `false`)
|
|
48
48
|
|
|
49
|
-
**fusionAlgorithm
|
|
49
|
+
**fusionAlgorithm** (`FusionAlgorithm`): Algorithm used to combine dense and sparse search results in hybrid search (e.g., RRF - Reciprocal Rank Fusion)
|
|
50
50
|
|
|
51
|
-
**queryMode
|
|
51
|
+
**queryMode** (`QueryMode`): Search mode: 'DENSE' for dense-only, 'SPARSE' for sparse-only, or 'HYBRID' for combined search
|
|
52
52
|
|
|
53
53
|
### listIndexes()
|
|
54
54
|
|
|
@@ -56,7 +56,7 @@ Returns an array of index names (namespaces) as strings.
|
|
|
56
56
|
|
|
57
57
|
### describeIndex()
|
|
58
58
|
|
|
59
|
-
**indexName
|
|
59
|
+
**indexName** (`string`): Name of the index to describe
|
|
60
60
|
|
|
61
61
|
Returns:
|
|
62
62
|
|
|
@@ -70,15 +70,15 @@ interface IndexStats {
|
|
|
70
70
|
|
|
71
71
|
### deleteIndex()
|
|
72
72
|
|
|
73
|
-
**indexName
|
|
73
|
+
**indexName** (`string`): Name of the index (namespace) to delete
|
|
74
74
|
|
|
75
75
|
### updateVector()
|
|
76
76
|
|
|
77
|
-
**indexName
|
|
77
|
+
**indexName** (`string`): Name of the index to update
|
|
78
78
|
|
|
79
|
-
**id
|
|
79
|
+
**id** (`string`): ID of the item to update
|
|
80
80
|
|
|
81
|
-
**update
|
|
81
|
+
**update** (`object`): Update object containing vector, sparse vector, and/or metadata
|
|
82
82
|
|
|
83
83
|
The `update` object can have the following properties:
|
|
84
84
|
|
|
@@ -88,9 +88,9 @@ The `update` object can have the following properties:
|
|
|
88
88
|
|
|
89
89
|
### deleteVector()
|
|
90
90
|
|
|
91
|
-
**indexName
|
|
91
|
+
**indexName** (`string`): Name of the index from which to delete the item
|
|
92
92
|
|
|
93
|
-
**id
|
|
93
|
+
**id** (`string`): ID of the item to delete
|
|
94
94
|
|
|
95
95
|
Attempts to delete an item by its ID from the specified index. Logs an error message if the deletion fails.
|
|
96
96
|
|
|
@@ -6,13 +6,13 @@ CompositeVoice supports both Mastra voice providers and AI SDK model providers
|
|
|
6
6
|
|
|
7
7
|
## Constructor Parameters
|
|
8
8
|
|
|
9
|
-
**config
|
|
9
|
+
**config** (`object`): Configuration object for the composite voice service
|
|
10
10
|
|
|
11
|
-
**config.input
|
|
11
|
+
**config.input** (`MastraVoice | TranscriptionModel`): Voice provider or AI SDK transcription model to use for speech-to-text operations. AI SDK models are automatically wrapped.
|
|
12
12
|
|
|
13
|
-
**config.output
|
|
13
|
+
**config.output** (`MastraVoice | SpeechModel`): Voice provider or AI SDK speech model to use for text-to-speech operations. AI SDK models are automatically wrapped.
|
|
14
14
|
|
|
15
|
-
**config.realtime
|
|
15
|
+
**config.realtime** (`MastraVoice`): Voice provider to use for real-time speech-to-speech operations
|
|
16
16
|
|
|
17
17
|
## Methods
|
|
18
18
|
|
|
@@ -20,9 +20,9 @@ CompositeVoice supports both Mastra voice providers and AI SDK model providers
|
|
|
20
20
|
|
|
21
21
|
Converts text to speech using the configured speaking provider.
|
|
22
22
|
|
|
23
|
-
**input
|
|
23
|
+
**input** (`string | NodeJS.ReadableStream`): Text to convert to speech
|
|
24
24
|
|
|
25
|
-
**options
|
|
25
|
+
**options** (`object`): Provider-specific options passed to the speaking provider
|
|
26
26
|
|
|
27
27
|
Notes:
|
|
28
28
|
|
|
@@ -34,9 +34,9 @@ Notes:
|
|
|
34
34
|
|
|
35
35
|
Converts speech to text using the configured listening provider.
|
|
36
36
|
|
|
37
|
-
**audioStream
|
|
37
|
+
**audioStream** (`NodeJS.ReadableStream`): Audio stream to convert to text
|
|
38
38
|
|
|
39
|
-
**options
|
|
39
|
+
**options** (`object`): Provider-specific options passed to the listening provider
|
|
40
40
|
|
|
41
41
|
Notes:
|
|
42
42
|
|
|
@@ -48,9 +48,9 @@ Notes:
|
|
|
48
48
|
|
|
49
49
|
Returns a list of available voices from the speaking provider, where each node contains:
|
|
50
50
|
|
|
51
|
-
**voiceId
|
|
51
|
+
**voiceId** (`string`): Unique identifier for the voice
|
|
52
52
|
|
|
53
|
-
**key
|
|
53
|
+
**key** (`value`): Additional voice properties that vary by provider (e.g., name, language)
|
|
54
54
|
|
|
55
55
|
Notes:
|
|
56
56
|
|
|
@@ -79,31 +79,31 @@ class MyVoiceProvider extends MastraVoice {
|
|
|
79
79
|
|
|
80
80
|
## Constructor Parameters
|
|
81
81
|
|
|
82
|
-
**config
|
|
82
|
+
**config** (`VoiceConfig`): Configuration object for the voice service
|
|
83
83
|
|
|
84
|
-
**config.speechModel
|
|
84
|
+
**config.speechModel** (`BuiltInModelConfig`): Configuration for the text-to-speech model
|
|
85
85
|
|
|
86
|
-
**config.
|
|
86
|
+
**config.speechModel.name** (`string`): Name of the model to use
|
|
87
87
|
|
|
88
|
-
**config.
|
|
88
|
+
**config.speechModel.apiKey** (`string`): API key for the model service
|
|
89
89
|
|
|
90
|
-
**config.
|
|
90
|
+
**config.listeningModel** (`BuiltInModelConfig`): Configuration for the speech-to-text model
|
|
91
91
|
|
|
92
|
-
**config.
|
|
92
|
+
**config.listeningModel.name** (`string`): Name of the model to use
|
|
93
93
|
|
|
94
|
-
|
|
94
|
+
**config.listeningModel.apiKey** (`string`): API key for the model service
|
|
95
95
|
|
|
96
|
-
**
|
|
96
|
+
**config.speaker** (`string`): Default speaker/voice ID to use
|
|
97
97
|
|
|
98
|
-
**
|
|
98
|
+
**config.name** (`string`): Name for the voice provider instance
|
|
99
99
|
|
|
100
|
-
|
|
100
|
+
**config.realtimeConfig** (`object`): Configuration for real-time speech-to-speech capabilities
|
|
101
101
|
|
|
102
|
-
**model
|
|
102
|
+
**config.realtimeConfig.model** (`string`): Model to use for real-time speech-to-speech capabilities
|
|
103
103
|
|
|
104
|
-
**apiKey
|
|
104
|
+
**config.realtimeConfig.apiKey** (`string`): API key for the real-time service
|
|
105
105
|
|
|
106
|
-
**options
|
|
106
|
+
**config.realtimeConfig.options** (`unknown`): Provider-specific options for real-time capabilities
|
|
107
107
|
|
|
108
108
|
## Abstract Methods
|
|
109
109
|
|
|
@@ -281,21 +281,21 @@ Purpose:
|
|
|
281
281
|
|
|
282
282
|
The MastraVoice class includes an event system for real-time communication. Standard event types include:
|
|
283
283
|
|
|
284
|
-
**speaking
|
|
284
|
+
**speaking** (`{ text: string; audioStream?: NodeJS.ReadableStream; audio?: Int16Array }`): Emitted when the voice provider is speaking, contains audio data
|
|
285
285
|
|
|
286
|
-
**writing
|
|
286
|
+
**writing** (`{ text: string, role: string }`): Emitted when text is transcribed from speech
|
|
287
287
|
|
|
288
|
-
**error
|
|
288
|
+
**error** (`{ message: string; code?: string; details?: unknown }`): Emitted when an error occurs
|
|
289
289
|
|
|
290
290
|
## Protected Properties
|
|
291
291
|
|
|
292
|
-
**listeningModel
|
|
292
|
+
**listeningModel** (`BuiltInModelConfig | undefined`): Configuration for the speech-to-text model
|
|
293
293
|
|
|
294
|
-
**speechModel
|
|
294
|
+
**speechModel** (`BuiltInModelConfig | undefined`): Configuration for the text-to-speech model
|
|
295
295
|
|
|
296
|
-
**speaker
|
|
296
|
+
**speaker** (`string | undefined`): Default speaker/voice ID
|
|
297
297
|
|
|
298
|
-
**realtimeConfig
|
|
298
|
+
**realtimeConfig** (`{ model?: string; apiKey?: string; options?: unknown } | undefined`): Configuration for real-time speech-to-speech capabilities
|
|
299
299
|
|
|
300
300
|
## Telemetry Support
|
|
301
301
|
|
|
@@ -50,7 +50,7 @@ await voice.connect()
|
|
|
50
50
|
|
|
51
51
|
## Parameters
|
|
52
52
|
|
|
53
|
-
**tools
|
|
53
|
+
**tools** (`ToolsInput`): Object containing tool definitions that can be called by the voice model
|
|
54
54
|
|
|
55
55
|
## Return Value
|
|
56
56
|
|
|
@@ -46,7 +46,7 @@ await voice.connect({
|
|
|
46
46
|
|
|
47
47
|
## Parameters
|
|
48
48
|
|
|
49
|
-
**options
|
|
49
|
+
**options** (`Record<string, unknown>`): Provider-specific connection options
|
|
50
50
|
|
|
51
51
|
## Return Value
|
|
52
52
|
|
|
@@ -58,9 +58,9 @@ Each real-time voice provider may support different options for the `connect()`
|
|
|
58
58
|
|
|
59
59
|
### OpenAI Realtime
|
|
60
60
|
|
|
61
|
-
**options.timeout
|
|
61
|
+
**options.timeout** (`number`): Connection timeout in milliseconds (Default: `30000`)
|
|
62
62
|
|
|
63
|
-
**options.reconnect
|
|
63
|
+
**options.reconnect** (`boolean`): Whether to automatically reconnect on connection loss (Default: `false`)
|
|
64
64
|
|
|
65
65
|
## Using with CompositeVoice
|
|
66
66
|
|
|
@@ -6,27 +6,27 @@ Voice providers emit various events during real-time voice interactions. These e
|
|
|
6
6
|
|
|
7
7
|
These events are commonly implemented across real-time voice providers:
|
|
8
8
|
|
|
9
|
-
**error
|
|
9
|
+
**error** (`Error`): Emitted when an error occurs during voice processing or when audio data format is unsupported
|
|
10
10
|
|
|
11
|
-
**session.created
|
|
11
|
+
**session.created** (`object`): Emitted when a new session is created with the OpenAI service
|
|
12
12
|
|
|
13
|
-
**session.updated
|
|
13
|
+
**session.updated** (`object`): Emitted when the session configuration is updated
|
|
14
14
|
|
|
15
|
-
**response.created
|
|
15
|
+
**response.created** (`object`): Emitted when a new response is created by the AI assistant
|
|
16
16
|
|
|
17
|
-
**response.done
|
|
17
|
+
**response.done** (`object`): Emitted when the AI assistant has completed its response
|
|
18
18
|
|
|
19
|
-
**speaker
|
|
19
|
+
**speaker** (`StreamWithId`): Emitted with a new audio stream that can be piped to an audio output
|
|
20
20
|
|
|
21
|
-
**writing
|
|
21
|
+
**writing** (`object`): Emitted when text is being transcribed (user) or generated (assistant)
|
|
22
22
|
|
|
23
|
-
**speaking
|
|
23
|
+
**speaking** (`object`): Emitted when audio data is available from the voice provider
|
|
24
24
|
|
|
25
|
-
**speaking.done
|
|
25
|
+
**speaking.done** (`object`): Emitted when the voice provider has finished speaking
|
|
26
26
|
|
|
27
|
-
**tool-call-start
|
|
27
|
+
**tool-call-start** (`object`): Emitted when the AI assistant starts executing a tool
|
|
28
28
|
|
|
29
|
-
**tool-call-result
|
|
29
|
+
**tool-call-result** (`object`): Emitted when a tool execution is complete with its result
|
|
30
30
|
|
|
31
31
|
## Notes
|
|
32
32
|
|
|
@@ -4,9 +4,9 @@ The `listen()` method is a core function available in all Mastra voice providers
|
|
|
4
4
|
|
|
5
5
|
## Parameters
|
|
6
6
|
|
|
7
|
-
**audioStream
|
|
7
|
+
**audioStream** (`NodeJS.ReadableStream`): Audio stream to transcribe. This can be a file stream or a microphone stream.
|
|
8
8
|
|
|
9
|
-
**options
|
|
9
|
+
**options** (`object`): Provider-specific options for speech recognition
|
|
10
10
|
|
|
11
11
|
## Return Value
|
|
12
12
|
|
|
@@ -22,23 +22,23 @@ Each voice provider may support additional options specific to their implementat
|
|
|
22
22
|
|
|
23
23
|
### OpenAI
|
|
24
24
|
|
|
25
|
-
**options.filetype
|
|
25
|
+
**options.filetype** (`string`): Audio file format (e.g., 'mp3', 'wav', 'm4a') (Default: `'mp3'`)
|
|
26
26
|
|
|
27
|
-
**options.prompt
|
|
27
|
+
**options.prompt** (`string`): Text to guide the model's transcription
|
|
28
28
|
|
|
29
|
-
**options.language
|
|
29
|
+
**options.language** (`string`): Language code (e.g., 'en', 'fr', 'de')
|
|
30
30
|
|
|
31
31
|
### Google
|
|
32
32
|
|
|
33
|
-
**options.stream
|
|
33
|
+
**options.stream** (`boolean`): Whether to use streaming recognition (Default: `false`)
|
|
34
34
|
|
|
35
|
-
**options.config
|
|
35
|
+
**options.config** (`object`): Recognition configuration from Google Cloud Speech-to-Text API (Default: `{ encoding: 'LINEAR16', languageCode: 'en-US' }`)
|
|
36
36
|
|
|
37
37
|
### Deepgram
|
|
38
38
|
|
|
39
|
-
**options.model
|
|
39
|
+
**options.model** (`string`): Deepgram model to use for transcription (Default: `'nova-2'`)
|
|
40
40
|
|
|
41
|
-
**options.language
|
|
41
|
+
**options.language** (`string`): Language code for transcription (Default: `'en'`)
|
|
42
42
|
|
|
43
43
|
## Usage Example
|
|
44
44
|
|
|
@@ -48,9 +48,9 @@ voice.on('error', ({ message, code, details }) => {
|
|
|
48
48
|
|
|
49
49
|
## Parameters
|
|
50
50
|
|
|
51
|
-
**event
|
|
51
|
+
**event** (`string`): Name of the event to listen for. See the \[Voice Events]\(./voice.events) documentation for a list of available events.
|
|
52
52
|
|
|
53
|
-
**callback
|
|
53
|
+
**callback** (`function`): Callback function that will be called when the event occurs. The callback signature depends on the specific event.
|
|
54
54
|
|
|
55
55
|
## Return Value
|
|
56
56
|
|
|
@@ -4,11 +4,11 @@ The `speak()` method is a core function available in all Mastra voice providers
|
|
|
4
4
|
|
|
5
5
|
## Parameters
|
|
6
6
|
|
|
7
|
-
**input
|
|
7
|
+
**input** (`string | NodeJS.ReadableStream`): Text to convert to speech. Can be a string or a readable stream of text.
|
|
8
8
|
|
|
9
|
-
**options
|
|
9
|
+
**options** (`object`): Options for speech synthesis
|
|
10
10
|
|
|
11
|
-
**options.speaker
|
|
11
|
+
**options.speaker** (`string`): Voice ID to use for this specific request. Overrides the default speaker set in the constructor.
|
|
12
12
|
|
|
13
13
|
## Return Value
|
|
14
14
|
|
|
@@ -23,27 +23,27 @@ Each voice provider may support additional options specific to their implementat
|
|
|
23
23
|
|
|
24
24
|
### OpenAI
|
|
25
25
|
|
|
26
|
-
**options.speed
|
|
26
|
+
**options.speed** (`number`): Speech speed multiplier. Values between 0.25 and 4.0 are supported. (Default: `1.0`)
|
|
27
27
|
|
|
28
28
|
### ElevenLabs
|
|
29
29
|
|
|
30
|
-
**options.stability
|
|
30
|
+
**options.stability** (`number`): Voice stability. Higher values result in more stable, less expressive speech. (Default: `0.5`)
|
|
31
31
|
|
|
32
|
-
**options.similarity\_boost
|
|
32
|
+
**options.similarity\_boost** (`number`): Voice clarity and similarity to the original voice. (Default: `0.75`)
|
|
33
33
|
|
|
34
34
|
### Google
|
|
35
35
|
|
|
36
|
-
**options.languageCode
|
|
36
|
+
**options.languageCode** (`string`): Language code for the voice (e.g., 'en-US').
|
|
37
37
|
|
|
38
|
-
**options.audioConfig
|
|
38
|
+
**options.audioConfig** (`object`): Audio configuration options from Google Cloud Text-to-Speech API. (Default: `{ audioEncoding: 'LINEAR16' }`)
|
|
39
39
|
|
|
40
40
|
### Murf
|
|
41
41
|
|
|
42
|
-
**options.properties.rate
|
|
42
|
+
**options.properties.rate** (`number`): Speech rate multiplier.
|
|
43
43
|
|
|
44
|
-
**options.properties.pitch
|
|
44
|
+
**options.properties.pitch** (`number`): Voice pitch adjustment.
|
|
45
45
|
|
|
46
|
-
**options.properties.format
|
|
46
|
+
**options.properties.format** (`'MP3' | 'WAV' | 'FLAC' | 'ALAW' | 'ULAW'`): Output audio format.
|
|
47
47
|
|
|
48
48
|
## Usage Example
|
|
49
49
|
|
|
@@ -15,11 +15,11 @@ await run.cancel()
|
|
|
15
15
|
|
|
16
16
|
## Parameters
|
|
17
17
|
|
|
18
|
-
**No parameters
|
|
18
|
+
**No parameters** (`void`): This method takes no parameters
|
|
19
19
|
|
|
20
20
|
## Returns
|
|
21
21
|
|
|
22
|
-
**result
|
|
22
|
+
**result** (`Promise<{ message: string }>`): A promise that resolves with { message: 'Workflow run canceled' } when cancellation succeeds
|
|
23
23
|
|
|
24
24
|
## How cancellation works
|
|
25
25
|
|