@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.
Files changed (453) hide show
  1. package/CHANGELOG.md +236 -0
  2. package/dist/agent/agent.d.ts +6 -0
  3. package/dist/agent/agent.d.ts.map +1 -1
  4. package/dist/agent/index.cjs +8 -8
  5. package/dist/agent/index.js +1 -1
  6. package/dist/{chunk-VJWRJWSC.cjs → chunk-2X66GWF5.cjs} +94 -16
  7. package/dist/chunk-2X66GWF5.cjs.map +1 -0
  8. package/dist/{chunk-YM6245EM.js → chunk-6OXW5E2O.js} +3 -3
  9. package/dist/{chunk-YM6245EM.js.map → chunk-6OXW5E2O.js.map} +1 -1
  10. package/dist/{chunk-XWZAKKFT.cjs → chunk-6QBN6MZY.cjs} +14 -14
  11. package/dist/{chunk-XWZAKKFT.cjs.map → chunk-6QBN6MZY.cjs.map} +1 -1
  12. package/dist/{chunk-AYHSPIT6.cjs → chunk-7UAJ6LMR.cjs} +820 -259
  13. package/dist/chunk-7UAJ6LMR.cjs.map +1 -0
  14. package/dist/{chunk-RZNHRIM7.cjs → chunk-A72NTLFT.cjs} +5 -5
  15. package/dist/{chunk-RZNHRIM7.cjs.map → chunk-A72NTLFT.cjs.map} +1 -1
  16. package/dist/{chunk-EEU5NHHU.js → chunk-DFCRXDVK.js} +3 -3
  17. package/dist/{chunk-EEU5NHHU.js.map → chunk-DFCRXDVK.js.map} +1 -1
  18. package/dist/{chunk-5K45E5VE.js → chunk-GPJGPARM.js} +3 -2
  19. package/dist/chunk-GPJGPARM.js.map +1 -0
  20. package/dist/{chunk-LNKS4TJ6.cjs → chunk-HB6T4554.cjs} +8 -7
  21. package/dist/chunk-HB6T4554.cjs.map +1 -0
  22. package/dist/{chunk-DGS2KGDI.js → chunk-KUXNBWN7.js} +6 -5
  23. package/dist/chunk-KUXNBWN7.js.map +1 -0
  24. package/dist/{chunk-IHDE4CJV.js → chunk-QSHV7GPT.js} +89 -12
  25. package/dist/chunk-QSHV7GPT.js.map +1 -0
  26. package/dist/{chunk-3U3XFMGJ.cjs → chunk-QTAS3HND.cjs} +13 -8
  27. package/dist/chunk-QTAS3HND.cjs.map +1 -0
  28. package/dist/{chunk-RHKNKJNM.js → chunk-QWTB53GS.js} +4 -4
  29. package/dist/{chunk-RHKNKJNM.js.map → chunk-QWTB53GS.js.map} +1 -1
  30. package/dist/{chunk-4WG5K4CK.js → chunk-R4N65TLG.js} +7 -7
  31. package/dist/{chunk-4WG5K4CK.js.map → chunk-R4N65TLG.js.map} +1 -1
  32. package/dist/{chunk-5VQPSWPG.cjs → chunk-RABITNTG.cjs} +48 -48
  33. package/dist/{chunk-5VQPSWPG.cjs.map → chunk-RABITNTG.cjs.map} +1 -1
  34. package/dist/{chunk-TVPANHLE.cjs → chunk-SBOHDNIZ.cjs} +3 -2
  35. package/dist/chunk-SBOHDNIZ.cjs.map +1 -0
  36. package/dist/{chunk-MWGGSA5Q.js → chunk-T6GAM3SQ.js} +10 -5
  37. package/dist/chunk-T6GAM3SQ.js.map +1 -0
  38. package/dist/{chunk-TL2TTA4X.cjs → chunk-YQG7NBPR.cjs} +9 -9
  39. package/dist/{chunk-TL2TTA4X.cjs.map → chunk-YQG7NBPR.cjs.map} +1 -1
  40. package/dist/{chunk-XB3DA67Q.js → chunk-ZSBM2SVU.js} +818 -259
  41. package/dist/chunk-ZSBM2SVU.js.map +1 -0
  42. package/dist/datasets/experiment/scorer.d.ts.map +1 -1
  43. package/dist/datasets/index.cjs +17 -17
  44. package/dist/datasets/index.js +2 -2
  45. package/dist/evals/index.cjs +20 -20
  46. package/dist/evals/index.js +3 -3
  47. package/dist/evals/scoreTraces/index.cjs +7 -6
  48. package/dist/evals/scoreTraces/index.cjs.map +1 -1
  49. package/dist/evals/scoreTraces/index.js +4 -3
  50. package/dist/evals/scoreTraces/index.js.map +1 -1
  51. package/dist/evals/scoreTraces/scoreTracesWorkflow.d.ts.map +1 -1
  52. package/dist/harness/harness.d.ts +21 -1
  53. package/dist/harness/harness.d.ts.map +1 -1
  54. package/dist/harness/index.cjs +422 -5
  55. package/dist/harness/index.cjs.map +1 -1
  56. package/dist/harness/index.d.ts +2 -1
  57. package/dist/harness/index.d.ts.map +1 -1
  58. package/dist/harness/index.js +418 -3
  59. package/dist/harness/index.js.map +1 -1
  60. package/dist/harness/types.d.ts +151 -0
  61. package/dist/harness/types.d.ts.map +1 -1
  62. package/dist/index.cjs +2 -2
  63. package/dist/index.js +1 -1
  64. package/dist/loop/index.cjs +12 -12
  65. package/dist/loop/index.js +1 -1
  66. package/dist/loop/test-utils/tools.d.ts.map +1 -1
  67. package/dist/loop/workflows/agentic-loop/index.d.ts.map +1 -1
  68. package/dist/mastra/hooks.d.ts.map +1 -1
  69. package/dist/mastra/index.cjs +2 -2
  70. package/dist/mastra/index.js +1 -1
  71. package/dist/memory/index.cjs +14 -14
  72. package/dist/memory/index.js +1 -1
  73. package/dist/processor-provider/index.cjs +10 -10
  74. package/dist/processor-provider/index.js +1 -1
  75. package/dist/processors/index.cjs +45 -41
  76. package/dist/processors/index.js +1 -1
  77. package/dist/processors/processors/index.d.ts +1 -0
  78. package/dist/processors/processors/index.d.ts.map +1 -1
  79. package/dist/processors/processors/workspace-instructions.d.ts +50 -0
  80. package/dist/processors/processors/workspace-instructions.d.ts.map +1 -0
  81. package/dist/relevance/index.cjs +3 -3
  82. package/dist/relevance/index.js +1 -1
  83. package/dist/storage/constants.cjs +56 -56
  84. package/dist/storage/constants.d.ts.map +1 -1
  85. package/dist/storage/constants.js +1 -1
  86. package/dist/storage/index.cjs +160 -160
  87. package/dist/storage/index.js +2 -2
  88. package/dist/storage/types.d.ts +2 -0
  89. package/dist/storage/types.d.ts.map +1 -1
  90. package/dist/stream/aisdk/v5/compat/prepare-tools.d.ts.map +1 -1
  91. package/dist/stream/base/output.d.ts.map +1 -1
  92. package/dist/stream/index.cjs +8 -8
  93. package/dist/stream/index.js +1 -1
  94. package/dist/tool-loop-agent/index.cjs +4 -4
  95. package/dist/tool-loop-agent/index.js +1 -1
  96. package/dist/vector/index.cjs +7 -7
  97. package/dist/vector/index.js +1 -1
  98. package/dist/workflows/evented/index.cjs +10 -10
  99. package/dist/workflows/evented/index.js +1 -1
  100. package/dist/workflows/index.cjs +25 -25
  101. package/dist/workflows/index.js +1 -1
  102. package/dist/workspace/constants/index.d.ts +2 -0
  103. package/dist/workspace/constants/index.d.ts.map +1 -1
  104. package/dist/workspace/errors.d.ts +1 -1
  105. package/dist/workspace/errors.d.ts.map +1 -1
  106. package/dist/workspace/filesystem/composite-filesystem.d.ts +4 -1
  107. package/dist/workspace/filesystem/composite-filesystem.d.ts.map +1 -1
  108. package/dist/workspace/filesystem/file-write-lock.d.ts +35 -0
  109. package/dist/workspace/filesystem/file-write-lock.d.ts.map +1 -0
  110. package/dist/workspace/filesystem/filesystem.d.ts +5 -1
  111. package/dist/workspace/filesystem/filesystem.d.ts.map +1 -1
  112. package/dist/workspace/filesystem/index.d.ts +1 -0
  113. package/dist/workspace/filesystem/index.d.ts.map +1 -1
  114. package/dist/workspace/filesystem/local-filesystem.d.ts +17 -1
  115. package/dist/workspace/filesystem/local-filesystem.d.ts.map +1 -1
  116. package/dist/workspace/index.cjs +72 -64
  117. package/dist/workspace/index.d.ts +3 -2
  118. package/dist/workspace/index.d.ts.map +1 -1
  119. package/dist/workspace/index.js +1 -1
  120. package/dist/workspace/lifecycle.d.ts +1 -9
  121. package/dist/workspace/lifecycle.d.ts.map +1 -1
  122. package/dist/workspace/sandbox/index.d.ts +2 -0
  123. package/dist/workspace/sandbox/index.d.ts.map +1 -1
  124. package/dist/workspace/sandbox/local-process-manager.d.ts +18 -0
  125. package/dist/workspace/sandbox/local-process-manager.d.ts.map +1 -0
  126. package/dist/workspace/sandbox/local-sandbox.d.ts +49 -35
  127. package/dist/workspace/sandbox/local-sandbox.d.ts.map +1 -1
  128. package/dist/workspace/sandbox/mastra-sandbox.d.ts +45 -11
  129. package/dist/workspace/sandbox/mastra-sandbox.d.ts.map +1 -1
  130. package/dist/workspace/sandbox/native-sandbox/bubblewrap.d.ts +2 -3
  131. package/dist/workspace/sandbox/native-sandbox/bubblewrap.d.ts.map +1 -1
  132. package/dist/workspace/sandbox/native-sandbox/seatbelt.d.ts +2 -3
  133. package/dist/workspace/sandbox/native-sandbox/seatbelt.d.ts.map +1 -1
  134. package/dist/workspace/sandbox/native-sandbox/wrapper.d.ts +4 -5
  135. package/dist/workspace/sandbox/native-sandbox/wrapper.d.ts.map +1 -1
  136. package/dist/workspace/sandbox/process-manager/index.d.ts +4 -0
  137. package/dist/workspace/sandbox/process-manager/index.d.ts.map +1 -0
  138. package/dist/workspace/sandbox/process-manager/process-handle.d.ts +107 -0
  139. package/dist/workspace/sandbox/process-manager/process-handle.d.ts.map +1 -0
  140. package/dist/workspace/sandbox/process-manager/process-manager.d.ts +59 -0
  141. package/dist/workspace/sandbox/process-manager/process-manager.d.ts.map +1 -0
  142. package/dist/workspace/sandbox/process-manager/types.d.ts +24 -0
  143. package/dist/workspace/sandbox/process-manager/types.d.ts.map +1 -0
  144. package/dist/workspace/sandbox/sandbox.d.ts +38 -2
  145. package/dist/workspace/sandbox/sandbox.d.ts.map +1 -1
  146. package/dist/workspace/sandbox/types.d.ts +9 -2
  147. package/dist/workspace/sandbox/types.d.ts.map +1 -1
  148. package/dist/workspace/sandbox/utils.d.ts +7 -0
  149. package/dist/workspace/sandbox/utils.d.ts.map +1 -0
  150. package/dist/workspace/tools/execute-command.d.ts +53 -2
  151. package/dist/workspace/tools/execute-command.d.ts.map +1 -1
  152. package/dist/workspace/tools/get-process-output.d.ts +6 -0
  153. package/dist/workspace/tools/get-process-output.d.ts.map +1 -0
  154. package/dist/workspace/tools/index.d.ts +4 -1
  155. package/dist/workspace/tools/index.d.ts.map +1 -1
  156. package/dist/workspace/tools/kill-process.d.ts +4 -0
  157. package/dist/workspace/tools/kill-process.d.ts.map +1 -0
  158. package/dist/workspace/tools/output-helpers.d.ts +21 -0
  159. package/dist/workspace/tools/output-helpers.d.ts.map +1 -0
  160. package/dist/workspace/tools/tools.d.ts.map +1 -1
  161. package/dist/workspace/types.d.ts +31 -0
  162. package/dist/workspace/types.d.ts.map +1 -1
  163. package/dist/workspace/utils.d.ts +11 -0
  164. package/dist/workspace/utils.d.ts.map +1 -0
  165. package/dist/workspace/workspace.d.ts +36 -0
  166. package/dist/workspace/workspace.d.ts.map +1 -1
  167. package/package.json +7 -7
  168. package/dist/chunk-3U3XFMGJ.cjs.map +0 -1
  169. package/dist/chunk-5K45E5VE.js.map +0 -1
  170. package/dist/chunk-AYHSPIT6.cjs.map +0 -1
  171. package/dist/chunk-DGS2KGDI.js.map +0 -1
  172. package/dist/chunk-IHDE4CJV.js.map +0 -1
  173. package/dist/chunk-LNKS4TJ6.cjs.map +0 -1
  174. package/dist/chunk-MWGGSA5Q.js.map +0 -1
  175. package/dist/chunk-TVPANHLE.cjs.map +0 -1
  176. package/dist/chunk-VJWRJWSC.cjs.map +0 -1
  177. package/dist/chunk-XB3DA67Q.js.map +0 -1
  178. package/dist/docs/SKILL.md +0 -301
  179. package/dist/docs/assets/SOURCE_MAP.json +0 -1413
  180. package/dist/docs/references/docs-agents-adding-voice.md +0 -353
  181. package/dist/docs/references/docs-agents-agent-approval.md +0 -377
  182. package/dist/docs/references/docs-agents-agent-memory.md +0 -212
  183. package/dist/docs/references/docs-agents-guardrails.md +0 -382
  184. package/dist/docs/references/docs-agents-network-approval.md +0 -275
  185. package/dist/docs/references/docs-agents-networks.md +0 -290
  186. package/dist/docs/references/docs-agents-overview.md +0 -309
  187. package/dist/docs/references/docs-agents-processors.md +0 -632
  188. package/dist/docs/references/docs-agents-structured-output.md +0 -271
  189. package/dist/docs/references/docs-agents-using-tools.md +0 -214
  190. package/dist/docs/references/docs-evals-custom-scorers.md +0 -519
  191. package/dist/docs/references/docs-evals-overview.md +0 -146
  192. package/dist/docs/references/docs-evals-running-in-ci.md +0 -106
  193. package/dist/docs/references/docs-mcp-overview.md +0 -370
  194. package/dist/docs/references/docs-mcp-publishing-mcp-server.md +0 -95
  195. package/dist/docs/references/docs-memory-memory-processors.md +0 -316
  196. package/dist/docs/references/docs-memory-observational-memory.md +0 -246
  197. package/dist/docs/references/docs-memory-overview.md +0 -45
  198. package/dist/docs/references/docs-memory-semantic-recall.md +0 -272
  199. package/dist/docs/references/docs-memory-storage.md +0 -261
  200. package/dist/docs/references/docs-memory-working-memory.md +0 -400
  201. package/dist/docs/references/docs-observability-datasets-overview.md +0 -188
  202. package/dist/docs/references/docs-observability-datasets-running-experiments.md +0 -266
  203. package/dist/docs/references/docs-observability-logging.md +0 -99
  204. package/dist/docs/references/docs-observability-overview.md +0 -70
  205. package/dist/docs/references/docs-observability-tracing-bridges-otel.md +0 -209
  206. package/dist/docs/references/docs-observability-tracing-exporters-arize.md +0 -274
  207. package/dist/docs/references/docs-observability-tracing-exporters-braintrust.md +0 -111
  208. package/dist/docs/references/docs-observability-tracing-exporters-cloud.md +0 -129
  209. package/dist/docs/references/docs-observability-tracing-exporters-datadog.md +0 -187
  210. package/dist/docs/references/docs-observability-tracing-exporters-default.md +0 -211
  211. package/dist/docs/references/docs-observability-tracing-exporters-laminar.md +0 -100
  212. package/dist/docs/references/docs-observability-tracing-exporters-langfuse.md +0 -217
  213. package/dist/docs/references/docs-observability-tracing-exporters-langsmith.md +0 -202
  214. package/dist/docs/references/docs-observability-tracing-exporters-otel.md +0 -479
  215. package/dist/docs/references/docs-observability-tracing-exporters-posthog.md +0 -148
  216. package/dist/docs/references/docs-observability-tracing-overview.md +0 -1114
  217. package/dist/docs/references/docs-rag-chunking-and-embedding.md +0 -183
  218. package/dist/docs/references/docs-rag-graph-rag.md +0 -215
  219. package/dist/docs/references/docs-rag-overview.md +0 -72
  220. package/dist/docs/references/docs-rag-retrieval.md +0 -521
  221. package/dist/docs/references/docs-rag-vector-databases.md +0 -648
  222. package/dist/docs/references/docs-server-auth-auth0.md +0 -222
  223. package/dist/docs/references/docs-server-auth-clerk.md +0 -132
  224. package/dist/docs/references/docs-server-auth-composite-auth.md +0 -234
  225. package/dist/docs/references/docs-server-auth-custom-auth-provider.md +0 -513
  226. package/dist/docs/references/docs-server-auth-firebase.md +0 -272
  227. package/dist/docs/references/docs-server-auth-jwt.md +0 -110
  228. package/dist/docs/references/docs-server-auth-simple-auth.md +0 -178
  229. package/dist/docs/references/docs-server-auth-supabase.md +0 -117
  230. package/dist/docs/references/docs-server-auth-workos.md +0 -190
  231. package/dist/docs/references/docs-server-custom-adapters.md +0 -374
  232. package/dist/docs/references/docs-server-custom-api-routes.md +0 -267
  233. package/dist/docs/references/docs-server-mastra-client.md +0 -243
  234. package/dist/docs/references/docs-server-mastra-server.md +0 -71
  235. package/dist/docs/references/docs-server-middleware.md +0 -228
  236. package/dist/docs/references/docs-server-request-context.md +0 -478
  237. package/dist/docs/references/docs-streaming-events.md +0 -247
  238. package/dist/docs/references/docs-streaming-tool-streaming.md +0 -178
  239. package/dist/docs/references/docs-streaming-workflow-streaming.md +0 -109
  240. package/dist/docs/references/docs-voice-overview.md +0 -979
  241. package/dist/docs/references/docs-voice-speech-to-speech.md +0 -103
  242. package/dist/docs/references/docs-voice-speech-to-text.md +0 -80
  243. package/dist/docs/references/docs-voice-text-to-speech.md +0 -84
  244. package/dist/docs/references/docs-workflows-agents-and-tools.md +0 -170
  245. package/dist/docs/references/docs-workflows-control-flow.md +0 -823
  246. package/dist/docs/references/docs-workflows-error-handling.md +0 -360
  247. package/dist/docs/references/docs-workflows-human-in-the-loop.md +0 -213
  248. package/dist/docs/references/docs-workflows-overview.md +0 -372
  249. package/dist/docs/references/docs-workflows-snapshots.md +0 -238
  250. package/dist/docs/references/docs-workflows-suspend-and-resume.md +0 -205
  251. package/dist/docs/references/docs-workflows-time-travel.md +0 -309
  252. package/dist/docs/references/docs-workflows-workflow-state.md +0 -181
  253. package/dist/docs/references/docs-workspace-filesystem.md +0 -162
  254. package/dist/docs/references/docs-workspace-overview.md +0 -239
  255. package/dist/docs/references/docs-workspace-sandbox.md +0 -63
  256. package/dist/docs/references/docs-workspace-search.md +0 -219
  257. package/dist/docs/references/docs-workspace-skills.md +0 -126
  258. package/dist/docs/references/guides-agent-frameworks-ai-sdk.md +0 -140
  259. package/dist/docs/references/reference-agents-agent.md +0 -142
  260. package/dist/docs/references/reference-agents-generate.md +0 -174
  261. package/dist/docs/references/reference-agents-generateLegacy.md +0 -176
  262. package/dist/docs/references/reference-agents-getDefaultGenerateOptions.md +0 -36
  263. package/dist/docs/references/reference-agents-getDefaultOptions.md +0 -34
  264. package/dist/docs/references/reference-agents-getDefaultStreamOptions.md +0 -36
  265. package/dist/docs/references/reference-agents-getDescription.md +0 -21
  266. package/dist/docs/references/reference-agents-getInstructions.md +0 -34
  267. package/dist/docs/references/reference-agents-getLLM.md +0 -37
  268. package/dist/docs/references/reference-agents-getMemory.md +0 -34
  269. package/dist/docs/references/reference-agents-getModel.md +0 -34
  270. package/dist/docs/references/reference-agents-getTools.md +0 -29
  271. package/dist/docs/references/reference-agents-getVoice.md +0 -34
  272. package/dist/docs/references/reference-agents-listAgents.md +0 -35
  273. package/dist/docs/references/reference-agents-listScorers.md +0 -34
  274. package/dist/docs/references/reference-agents-listTools.md +0 -34
  275. package/dist/docs/references/reference-agents-listWorkflows.md +0 -34
  276. package/dist/docs/references/reference-agents-network.md +0 -134
  277. package/dist/docs/references/reference-ai-sdk-chat-route.md +0 -82
  278. package/dist/docs/references/reference-ai-sdk-network-route.md +0 -74
  279. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-stream.md +0 -232
  280. package/dist/docs/references/reference-ai-sdk-with-mastra.md +0 -59
  281. package/dist/docs/references/reference-ai-sdk-workflow-route.md +0 -79
  282. package/dist/docs/references/reference-auth-auth0.md +0 -73
  283. package/dist/docs/references/reference-auth-clerk.md +0 -36
  284. package/dist/docs/references/reference-auth-firebase.md +0 -80
  285. package/dist/docs/references/reference-auth-jwt.md +0 -26
  286. package/dist/docs/references/reference-auth-supabase.md +0 -33
  287. package/dist/docs/references/reference-auth-workos.md +0 -84
  288. package/dist/docs/references/reference-client-js-agents.md +0 -438
  289. package/dist/docs/references/reference-configuration.md +0 -749
  290. package/dist/docs/references/reference-core-addGateway.md +0 -42
  291. package/dist/docs/references/reference-core-getAgent.md +0 -21
  292. package/dist/docs/references/reference-core-getAgentById.md +0 -21
  293. package/dist/docs/references/reference-core-getDeployer.md +0 -22
  294. package/dist/docs/references/reference-core-getGateway.md +0 -38
  295. package/dist/docs/references/reference-core-getGatewayById.md +0 -41
  296. package/dist/docs/references/reference-core-getLogger.md +0 -22
  297. package/dist/docs/references/reference-core-getMCPServer.md +0 -45
  298. package/dist/docs/references/reference-core-getMCPServerById.md +0 -53
  299. package/dist/docs/references/reference-core-getMemory.md +0 -50
  300. package/dist/docs/references/reference-core-getScorer.md +0 -54
  301. package/dist/docs/references/reference-core-getScorerById.md +0 -54
  302. package/dist/docs/references/reference-core-getServer.md +0 -22
  303. package/dist/docs/references/reference-core-getStorage.md +0 -22
  304. package/dist/docs/references/reference-core-getStoredAgentById.md +0 -89
  305. package/dist/docs/references/reference-core-getTelemetry.md +0 -22
  306. package/dist/docs/references/reference-core-getVector.md +0 -22
  307. package/dist/docs/references/reference-core-getWorkflow.md +0 -40
  308. package/dist/docs/references/reference-core-listAgents.md +0 -21
  309. package/dist/docs/references/reference-core-listGateways.md +0 -40
  310. package/dist/docs/references/reference-core-listLogs.md +0 -38
  311. package/dist/docs/references/reference-core-listLogsByRunId.md +0 -36
  312. package/dist/docs/references/reference-core-listMCPServers.md +0 -51
  313. package/dist/docs/references/reference-core-listMemory.md +0 -56
  314. package/dist/docs/references/reference-core-listScorers.md +0 -29
  315. package/dist/docs/references/reference-core-listStoredAgents.md +0 -93
  316. package/dist/docs/references/reference-core-listVectors.md +0 -22
  317. package/dist/docs/references/reference-core-listWorkflows.md +0 -21
  318. package/dist/docs/references/reference-core-mastra-class.md +0 -66
  319. package/dist/docs/references/reference-core-mastra-model-gateway.md +0 -153
  320. package/dist/docs/references/reference-core-setLogger.md +0 -26
  321. package/dist/docs/references/reference-core-setStorage.md +0 -27
  322. package/dist/docs/references/reference-datasets-addItem.md +0 -35
  323. package/dist/docs/references/reference-datasets-addItems.md +0 -33
  324. package/dist/docs/references/reference-datasets-compareExperiments.md +0 -48
  325. package/dist/docs/references/reference-datasets-create.md +0 -49
  326. package/dist/docs/references/reference-datasets-dataset.md +0 -78
  327. package/dist/docs/references/reference-datasets-datasets-manager.md +0 -84
  328. package/dist/docs/references/reference-datasets-delete.md +0 -23
  329. package/dist/docs/references/reference-datasets-deleteExperiment.md +0 -25
  330. package/dist/docs/references/reference-datasets-deleteItem.md +0 -25
  331. package/dist/docs/references/reference-datasets-deleteItems.md +0 -27
  332. package/dist/docs/references/reference-datasets-get.md +0 -29
  333. package/dist/docs/references/reference-datasets-getDetails.md +0 -45
  334. package/dist/docs/references/reference-datasets-getExperiment.md +0 -28
  335. package/dist/docs/references/reference-datasets-getItem.md +0 -31
  336. package/dist/docs/references/reference-datasets-getItemHistory.md +0 -29
  337. package/dist/docs/references/reference-datasets-list.md +0 -29
  338. package/dist/docs/references/reference-datasets-listExperimentResults.md +0 -37
  339. package/dist/docs/references/reference-datasets-listExperiments.md +0 -31
  340. package/dist/docs/references/reference-datasets-listItems.md +0 -44
  341. package/dist/docs/references/reference-datasets-listVersions.md +0 -31
  342. package/dist/docs/references/reference-datasets-startExperiment.md +0 -60
  343. package/dist/docs/references/reference-datasets-startExperimentAsync.md +0 -41
  344. package/dist/docs/references/reference-datasets-update.md +0 -46
  345. package/dist/docs/references/reference-datasets-updateItem.md +0 -36
  346. package/dist/docs/references/reference-evals-answer-relevancy.md +0 -105
  347. package/dist/docs/references/reference-evals-answer-similarity.md +0 -99
  348. package/dist/docs/references/reference-evals-bias.md +0 -120
  349. package/dist/docs/references/reference-evals-completeness.md +0 -137
  350. package/dist/docs/references/reference-evals-content-similarity.md +0 -101
  351. package/dist/docs/references/reference-evals-context-precision.md +0 -196
  352. package/dist/docs/references/reference-evals-create-scorer.md +0 -270
  353. package/dist/docs/references/reference-evals-faithfulness.md +0 -114
  354. package/dist/docs/references/reference-evals-hallucination.md +0 -220
  355. package/dist/docs/references/reference-evals-keyword-coverage.md +0 -128
  356. package/dist/docs/references/reference-evals-mastra-scorer.md +0 -123
  357. package/dist/docs/references/reference-evals-run-evals.md +0 -138
  358. package/dist/docs/references/reference-evals-scorer-utils.md +0 -330
  359. package/dist/docs/references/reference-evals-textual-difference.md +0 -113
  360. package/dist/docs/references/reference-evals-tone-consistency.md +0 -119
  361. package/dist/docs/references/reference-evals-toxicity.md +0 -123
  362. package/dist/docs/references/reference-harness-harness-class.md +0 -645
  363. package/dist/docs/references/reference-logging-pino-logger.md +0 -117
  364. package/dist/docs/references/reference-memory-deleteMessages.md +0 -40
  365. package/dist/docs/references/reference-memory-memory-class.md +0 -147
  366. package/dist/docs/references/reference-memory-observational-memory.md +0 -565
  367. package/dist/docs/references/reference-observability-tracing-bridges-otel.md +0 -131
  368. package/dist/docs/references/reference-observability-tracing-configuration.md +0 -178
  369. package/dist/docs/references/reference-observability-tracing-exporters-console-exporter.md +0 -138
  370. package/dist/docs/references/reference-observability-tracing-exporters-datadog.md +0 -116
  371. package/dist/docs/references/reference-observability-tracing-instances.md +0 -109
  372. package/dist/docs/references/reference-observability-tracing-interfaces.md +0 -749
  373. package/dist/docs/references/reference-observability-tracing-processors-sensitive-data-filter.md +0 -144
  374. package/dist/docs/references/reference-observability-tracing-spans.md +0 -224
  375. package/dist/docs/references/reference-processors-batch-parts-processor.md +0 -61
  376. package/dist/docs/references/reference-processors-language-detector.md +0 -81
  377. package/dist/docs/references/reference-processors-message-history-processor.md +0 -85
  378. package/dist/docs/references/reference-processors-moderation-processor.md +0 -104
  379. package/dist/docs/references/reference-processors-pii-detector.md +0 -107
  380. package/dist/docs/references/reference-processors-processor-interface.md +0 -525
  381. package/dist/docs/references/reference-processors-prompt-injection-detector.md +0 -71
  382. package/dist/docs/references/reference-processors-semantic-recall-processor.md +0 -123
  383. package/dist/docs/references/reference-processors-system-prompt-scrubber.md +0 -80
  384. package/dist/docs/references/reference-processors-token-limiter-processor.md +0 -113
  385. package/dist/docs/references/reference-processors-tool-call-filter.md +0 -85
  386. package/dist/docs/references/reference-processors-tool-search-processor.md +0 -113
  387. package/dist/docs/references/reference-processors-unicode-normalizer.md +0 -62
  388. package/dist/docs/references/reference-processors-working-memory-processor.md +0 -154
  389. package/dist/docs/references/reference-rag-database-config.md +0 -264
  390. package/dist/docs/references/reference-rag-embeddings.md +0 -92
  391. package/dist/docs/references/reference-server-mastra-server.md +0 -298
  392. package/dist/docs/references/reference-server-register-api-route.md +0 -249
  393. package/dist/docs/references/reference-storage-cloudflare-d1.md +0 -218
  394. package/dist/docs/references/reference-storage-composite.md +0 -235
  395. package/dist/docs/references/reference-storage-lance.md +0 -131
  396. package/dist/docs/references/reference-storage-libsql.md +0 -135
  397. package/dist/docs/references/reference-storage-mongodb.md +0 -262
  398. package/dist/docs/references/reference-storage-mssql.md +0 -155
  399. package/dist/docs/references/reference-storage-overview.md +0 -121
  400. package/dist/docs/references/reference-storage-postgresql.md +0 -529
  401. package/dist/docs/references/reference-storage-upstash.md +0 -160
  402. package/dist/docs/references/reference-streaming-ChunkType.md +0 -292
  403. package/dist/docs/references/reference-streaming-agents-MastraModelOutput.md +0 -182
  404. package/dist/docs/references/reference-streaming-agents-streamLegacy.md +0 -142
  405. package/dist/docs/references/reference-streaming-workflows-observeStream.md +0 -42
  406. package/dist/docs/references/reference-streaming-workflows-resumeStream.md +0 -61
  407. package/dist/docs/references/reference-streaming-workflows-stream.md +0 -88
  408. package/dist/docs/references/reference-streaming-workflows-timeTravelStream.md +0 -142
  409. package/dist/docs/references/reference-templates-overview.md +0 -194
  410. package/dist/docs/references/reference-tools-create-tool.md +0 -237
  411. package/dist/docs/references/reference-tools-graph-rag-tool.md +0 -185
  412. package/dist/docs/references/reference-tools-mcp-client.md +0 -962
  413. package/dist/docs/references/reference-tools-mcp-server.md +0 -1275
  414. package/dist/docs/references/reference-tools-vector-query-tool.md +0 -459
  415. package/dist/docs/references/reference-vectors-libsql.md +0 -305
  416. package/dist/docs/references/reference-vectors-mongodb.md +0 -295
  417. package/dist/docs/references/reference-vectors-pg.md +0 -408
  418. package/dist/docs/references/reference-vectors-upstash.md +0 -294
  419. package/dist/docs/references/reference-voice-composite-voice.md +0 -121
  420. package/dist/docs/references/reference-voice-mastra-voice.md +0 -313
  421. package/dist/docs/references/reference-voice-voice.addInstructions.md +0 -56
  422. package/dist/docs/references/reference-voice-voice.addTools.md +0 -67
  423. package/dist/docs/references/reference-voice-voice.connect.md +0 -94
  424. package/dist/docs/references/reference-voice-voice.events.md +0 -37
  425. package/dist/docs/references/reference-voice-voice.listen.md +0 -164
  426. package/dist/docs/references/reference-voice-voice.on.md +0 -111
  427. package/dist/docs/references/reference-voice-voice.speak.md +0 -157
  428. package/dist/docs/references/reference-workflows-run-methods-cancel.md +0 -86
  429. package/dist/docs/references/reference-workflows-run-methods-restart.md +0 -33
  430. package/dist/docs/references/reference-workflows-run-methods-resume.md +0 -59
  431. package/dist/docs/references/reference-workflows-run-methods-start.md +0 -58
  432. package/dist/docs/references/reference-workflows-run-methods-startAsync.md +0 -67
  433. package/dist/docs/references/reference-workflows-run-methods-timeTravel.md +0 -142
  434. package/dist/docs/references/reference-workflows-run.md +0 -59
  435. package/dist/docs/references/reference-workflows-step.md +0 -119
  436. package/dist/docs/references/reference-workflows-workflow-methods-branch.md +0 -25
  437. package/dist/docs/references/reference-workflows-workflow-methods-commit.md +0 -17
  438. package/dist/docs/references/reference-workflows-workflow-methods-create-run.md +0 -63
  439. package/dist/docs/references/reference-workflows-workflow-methods-dountil.md +0 -25
  440. package/dist/docs/references/reference-workflows-workflow-methods-dowhile.md +0 -25
  441. package/dist/docs/references/reference-workflows-workflow-methods-foreach.md +0 -118
  442. package/dist/docs/references/reference-workflows-workflow-methods-map.md +0 -93
  443. package/dist/docs/references/reference-workflows-workflow-methods-parallel.md +0 -21
  444. package/dist/docs/references/reference-workflows-workflow-methods-sleep.md +0 -35
  445. package/dist/docs/references/reference-workflows-workflow-methods-sleepUntil.md +0 -35
  446. package/dist/docs/references/reference-workflows-workflow-methods-then.md +0 -21
  447. package/dist/docs/references/reference-workflows-workflow.md +0 -157
  448. package/dist/docs/references/reference-workspace-filesystem.md +0 -202
  449. package/dist/docs/references/reference-workspace-local-filesystem.md +0 -327
  450. package/dist/docs/references/reference-workspace-local-sandbox.md +0 -285
  451. package/dist/docs/references/reference-workspace-sandbox.md +0 -81
  452. package/dist/docs/references/reference-workspace-workspace-class.md +0 -226
  453. package/dist/docs/references/reference.md +0 -276
@@ -1,37 +0,0 @@
1
- # dataset.listExperimentResults()
2
-
3
- **Added in:** `@mastra/core@1.4.0`
4
-
5
- Lists individual item results for a specific experiment with pagination.
6
-
7
- ## Usage example
8
-
9
- ```typescript
10
- import { Mastra } from "@mastra/core";
11
-
12
- const mastra = new Mastra({ /* storage config */ });
13
-
14
- const dataset = await mastra.datasets.get({ id: "dataset-id" });
15
-
16
- const { results, pagination } = await dataset.listExperimentResults({
17
- experimentId: "exp-id",
18
- page: 0,
19
- perPage: 50,
20
- });
21
-
22
- for (const result of results) {
23
- console.log(`Item ${result.itemId}: ${result.error ? "FAILED" : "OK"}`);
24
- }
25
- ```
26
-
27
- ## Parameters
28
-
29
- **experimentId:** (`string`): ID of the experiment to list results for.
30
-
31
- **page?:** (`number`): Page number. Defaults to \`0\`.
32
-
33
- **perPage?:** (`number`): Number of results per page. Defaults to \`20\`.
34
-
35
- ## Returns
36
-
37
- **result:** (`Promise<object>`): objectresults:ExperimentResult\[]Array of item-level results.ExperimentResultid:stringUnique result ID.experimentId:stringID of the parent experiment.itemId:stringID of the dataset item.itemDatasetVersion:number | nullDataset version of the item when executed.input:unknownInput data passed to the target.output:unknown | nullOutput from the target.groundTruth:unknown | nullExpected output.error:{ message: string; stack?: string; code?: string } | nullStructured error if execution failed.startedAt:DateWhen execution started.completedAt:DateWhen execution completed.retryCount:numberNumber of retry attempts.traceId:string | nullTrace ID for observability.createdAt:DateWhen the result record was created.pagination:PaginationInfoPagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
@@ -1,31 +0,0 @@
1
- # dataset.listExperiments()
2
-
3
- **Added in:** `@mastra/core@1.4.0`
4
-
5
- Lists all experiments (runs) for this dataset with pagination.
6
-
7
- ## Usage example
8
-
9
- ```typescript
10
- import { Mastra } from "@mastra/core";
11
-
12
- const mastra = new Mastra({ /* storage config */ });
13
-
14
- const dataset = await mastra.datasets.get({ id: "dataset-id" });
15
-
16
- const { experiments, pagination } = await dataset.listExperiments({ page: 0, perPage: 10 });
17
-
18
- for (const exp of experiments) {
19
- console.log(`${exp.id}: ${exp.status} (${exp.succeededCount}/${exp.totalItems})`);
20
- }
21
- ```
22
-
23
- ## Parameters
24
-
25
- **page?:** (`number`): Page number. Defaults to \`0\`.
26
-
27
- **perPage?:** (`number`): Number of experiments per page. Defaults to \`20\`.
28
-
29
- ## Returns
30
-
31
- **result:** (`Promise<object>`): objectexperiments:Experiment\[]Array of experiment records.Experimentid:stringUnique experiment ID.name?:stringDisplay name.description?:stringDescription.metadata?:Record\<string, unknown>Arbitrary metadata.datasetId:stringID of the parent dataset.datasetVersion:number | nullDataset version used for the experiment.targetType:'agent' | 'workflow' | 'scorer' | 'processor'Type of target used.targetId:stringID of the target used.status:'pending' | 'running' | 'completed' | 'failed'Current status of the experiment.totalItems:numberTotal number of items.succeededCount:numberNumber of successful items.failedCount:numberNumber of failed items.skippedCount:numberNumber of skipped items.startedAt:Date | nullWhen the experiment started.completedAt:Date | nullWhen the experiment completed.createdAt:DateWhen the experiment record was created.updatedAt:DateWhen the experiment record was last updated.pagination:PaginationInfoPagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
@@ -1,44 +0,0 @@
1
- # dataset.listItems()
2
-
3
- **Added in:** `@mastra/core@1.4.0`
4
-
5
- Lists items in the dataset. When a `version` is specified, returns all items at that version. Otherwise, returns paginated items from the latest version.
6
-
7
- ## Usage example
8
-
9
- ```typescript
10
- import { Mastra } from "@mastra/core";
11
-
12
- const mastra = new Mastra({ /* storage config */ });
13
-
14
- const dataset = await mastra.datasets.get({ id: "dataset-id" });
15
-
16
- // Paginated list (default: page 0, 20 per page)
17
- const result = await dataset.listItems();
18
-
19
- // List with search
20
- const filtered = await dataset.listItems({ search: "TypeScript", page: 0, perPage: 10 });
21
-
22
- // List all items at a specific version
23
- const versionedItems = await dataset.listItems({ version: 2 });
24
- ```
25
-
26
- ## Parameters
27
-
28
- **version?:** (`number`): Dataset version to list items at. When set, returns all items at that version (no pagination).
29
-
30
- **page?:** (`number`): Page number for pagination. Defaults to \`0\`.
31
-
32
- **perPage?:** (`number`): Number of items per page. Defaults to \`20\`.
33
-
34
- **search?:** (`string`): Search string to filter items.
35
-
36
- ## Returns
37
-
38
- When `version` is specified:
39
-
40
- **result:** (`Promise<DatasetItem[]>`): Array of all items at the specified dataset version.
41
-
42
- When `version` is not specified:
43
-
44
- **result:** (`Promise<object>`): objectitems:DatasetItem\[]Array of items for the current page.pagination:objectPagination metadata.objecttotal:numberTotal number of items.page:numberCurrent page number.perPage:number | falseItems per page, or \`false\` if unpaginated.hasMore:booleanWhether more pages are available.
@@ -1,31 +0,0 @@
1
- # dataset.listVersions()
2
-
3
- **Added in:** `@mastra/core@1.4.0`
4
-
5
- Lists all versions of the dataset with pagination.
6
-
7
- ## Usage example
8
-
9
- ```typescript
10
- import { Mastra } from "@mastra/core";
11
-
12
- const mastra = new Mastra({ /* storage config */ });
13
-
14
- const dataset = await mastra.datasets.get({ id: "dataset-id" });
15
-
16
- const { versions, pagination } = await dataset.listVersions({ page: 0, perPage: 10 });
17
-
18
- for (const version of versions) {
19
- console.log(`Version ${version.version} created at ${version.createdAt}`);
20
- }
21
- ```
22
-
23
- ## Parameters
24
-
25
- **page?:** (`number`): Page number. Defaults to \`0\`.
26
-
27
- **perPage?:** (`number`): Number of versions per page. Defaults to \`20\`.
28
-
29
- ## Returns
30
-
31
- **result:** (`Promise<object>`): objectversions:DatasetVersion\[]Array of version records.DatasetVersionid:stringUnique identifier of the version record.datasetId:stringID of the parent dataset.version:numberVersion number.createdAt:DateWhen this version was created.pagination:objectPagination metadata.objecttotal:numberTotal number of versions.page:numberCurrent page number.perPage:number | falseVersions per page, or \`false\` if unpaginated.hasMore:booleanWhether more pages are available.
@@ -1,60 +0,0 @@
1
- # dataset.startExperiment()
2
-
3
- **Added in:** `@mastra/core@1.4.0`
4
-
5
- Runs an experiment on the dataset and waits for completion. Executes all items against a target (agent, workflow, or scorer) with optional scoring.
6
-
7
- ## Usage example
8
-
9
- ```typescript
10
- import { Mastra } from "@mastra/core";
11
-
12
- const mastra = new Mastra({ /* storage config */ });
13
-
14
- const dataset = await mastra.datasets.get({ id: "dataset-id" });
15
-
16
- // Run against a registered agent with scorers
17
- const summary = await dataset.startExperiment({
18
- targetType: "agent",
19
- targetId: "my-agent",
20
- scorers: ["accuracy", "relevancy"],
21
- maxConcurrency: 10,
22
- });
23
-
24
- console.log(`${summary.succeededCount}/${summary.totalItems} succeeded`);
25
- console.log(`Status: ${summary.status}`);
26
- ```
27
-
28
- ## Parameters
29
-
30
- **targetType?:** (`'agent' | 'workflow' | 'scorer'`): Type of registered target to run items against. Use with \`targetId\`.
31
-
32
- **targetId?:** (`string`): ID of the registered target. Use with \`targetType\`.
33
-
34
- **scorers?:** (`(MastraScorer | string)[]`): Scorers to evaluate each result. Pass \`MastraScorer\` instances or registered scorer IDs.
35
-
36
- **name?:** (`string`): Display name for the experiment.
37
-
38
- **description?:** (`string`): Description of the experiment.
39
-
40
- **metadata?:** (`Record<string, unknown>`): Arbitrary metadata for the experiment.
41
-
42
- **version?:** (`number`): Pin to a specific dataset version. Defaults to the latest version.
43
-
44
- **maxConcurrency?:** (`number`): Maximum concurrent item executions. Defaults to \`5\`.
45
-
46
- **signal?:** (`AbortSignal`): AbortSignal for cancelling the experiment.
47
-
48
- **itemTimeout?:** (`number`): Per-item execution timeout in milliseconds.
49
-
50
- **maxRetries?:** (`number`): Maximum retries per item on failure. Defaults to \`0\` (no retries). Abort errors are never retried.
51
-
52
- ## Returns
53
-
54
- **result:** (`Promise<ExperimentSummary>`): ExperimentSummaryexperimentId:stringUnique ID of the experiment.status:'pending' | 'running' | 'completed' | 'failed'Final status of the experiment.totalItems:numberTotal number of items in the dataset.succeededCount:numberNumber of items that succeeded.failedCount:numberNumber of items that failed.skippedCount:numberNumber of items skipped (e.g., due to abort).completedWithErrors:boolean\`true\` if the run completed but some items failed.startedAt:DateWhen the experiment started.completedAt:DateWhen the experiment completed.results:ItemWithScores\[]All item results with their scores.ItemWithScoresitemId:stringID of the dataset item.itemVersion:numberDataset version of the item when executed.input:unknownInput data passed to the target.output:unknown | nullOutput from the target, or \`null\` if failed.groundTruth:unknown | nullExpected output from the dataset item.error:{ message: string; stack?: string; code?: string } | nullStructured error if execution failed.startedAt:DateWhen item execution started.completedAt:DateWhen item execution completed.retryCount:numberNumber of retry attempts.scores:ScorerResult\[]Results from all scorers for this item.ScorerResultscorerId:stringID of the scorer.scorerName:stringDisplay name of the scorer.score:number | nullComputed score, or \`null\` if the scorer failed.reason:string | nullReason/explanation for the score.error:string | nullError message if the scorer failed.
55
-
56
- ## Related
57
-
58
- - [dataset.startExperimentAsync()](https://mastra.ai/reference/datasets/startExperimentAsync)
59
- - [dataset.listExperiments()](https://mastra.ai/reference/datasets/listExperiments)
60
- - [DatasetsManager.compareExperiments()](https://mastra.ai/reference/datasets/compareExperiments)
@@ -1,41 +0,0 @@
1
- # dataset.startExperimentAsync()
2
-
3
- **Added in:** `@mastra/core@1.4.0`
4
-
5
- Starts an experiment asynchronously (fire-and-forget). Returns immediately with the experiment ID and a `'pending'` status. The experiment runs in the background.
6
-
7
- ## Usage example
8
-
9
- ```typescript
10
- import { Mastra } from "@mastra/core";
11
-
12
- const mastra = new Mastra({ /* storage config */ });
13
-
14
- const dataset = await mastra.datasets.get({ id: "dataset-id" });
15
-
16
- // Start experiment without waiting
17
- const { experimentId, status } = await dataset.startExperimentAsync({
18
- targetType: "agent",
19
- targetId: "my-agent",
20
- scorers: ["accuracy"],
21
- });
22
-
23
- console.log(`Experiment ${experimentId} started with status: ${status}`);
24
-
25
- // Check progress later
26
- const experiment = await dataset.getExperiment({ experimentId });
27
- console.log(`Current status: ${experiment.status}`);
28
- ```
29
-
30
- ## Parameters
31
-
32
- Takes the same `StartExperimentConfig` as [`dataset.startExperiment()`](https://mastra.ai/reference/datasets/startExperiment).
33
-
34
- ## Returns
35
-
36
- **result:** (`Promise<object>`): objectexperimentId:stringUnique ID of the created experiment.status:'pending'Always \`'pending'\` since the experiment hasn't started executing yet.
37
-
38
- ## Related
39
-
40
- - [dataset.startExperiment()](https://mastra.ai/reference/datasets/startExperiment)
41
- - [dataset.getExperiment()](https://mastra.ai/reference/datasets/getExperiment)
@@ -1,46 +0,0 @@
1
- # dataset.update()
2
-
3
- **Added in:** `@mastra/core@1.4.0`
4
-
5
- Updates dataset metadata, name, description, and/or schemas. Zod schemas are automatically converted to JSON Schema.
6
-
7
- ## Usage example
8
-
9
- ```typescript
10
- import { Mastra } from "@mastra/core";
11
- import { z } from "zod";
12
-
13
- const mastra = new Mastra({ /* storage config */ });
14
-
15
- const dataset = await mastra.datasets.get({ id: "dataset-id" });
16
-
17
- // Update with plain metadata
18
- const updated = await dataset.update({
19
- name: "Updated QA pairs",
20
- description: "Revised evaluation set",
21
- });
22
-
23
- // Update with Zod schema (auto-converted to JSON Schema)
24
- const updated2 = await dataset.update({
25
- inputSchema: z.object({
26
- question: z.string(),
27
- context: z.string().optional(),
28
- }),
29
- });
30
- ```
31
-
32
- ## Parameters
33
-
34
- **name?:** (`string`): New display name.
35
-
36
- **description?:** (`string`): New description.
37
-
38
- **metadata?:** (`Record<string, unknown>`): Updated metadata.
39
-
40
- **inputSchema?:** (`unknown`): JSON Schema or Zod schema for item inputs.
41
-
42
- **groundTruthSchema?:** (`unknown`): JSON Schema or Zod schema for item ground truths.
43
-
44
- ## Returns
45
-
46
- **result:** (`Promise<DatasetRecord>`): The updated dataset record. See dataset.getDetails() for the full shape.
@@ -1,36 +0,0 @@
1
- # dataset.updateItem()
2
-
3
- **Added in:** `@mastra/core@1.4.0`
4
-
5
- Updates an existing item in the dataset. Only the provided fields are updated. Updating an item creates a new version.
6
-
7
- ## Usage example
8
-
9
- ```typescript
10
- import { Mastra } from "@mastra/core";
11
-
12
- const mastra = new Mastra({ /* storage config */ });
13
-
14
- const dataset = await mastra.datasets.get({ id: "dataset-id" });
15
-
16
- const updated = await dataset.updateItem({
17
- itemId: "item-id",
18
- input: { question: "What is TypeScript?" },
19
- groundTruth: { answer: "A typed superset of JavaScript" },
20
- metadata: { reviewed: true },
21
- });
22
- ```
23
-
24
- ## Parameters
25
-
26
- **itemId:** (`string`): ID of the item to update.
27
-
28
- **input?:** (`unknown`): Updated input data.
29
-
30
- **groundTruth?:** (`unknown`): Updated ground truth.
31
-
32
- **metadata?:** (`Record<string, unknown>`): Updated metadata.
33
-
34
- ## Returns
35
-
36
- **result:** (`Promise<DatasetItem>`): The updated dataset item. See dataset.addItem() for the item shape.
@@ -1,105 +0,0 @@
1
- # Answer Relevancy Scorer
2
-
3
- The `createAnswerRelevancyScorer()` function accepts a single options object with the following properties:
4
-
5
- ## Parameters
6
-
7
- **model:** (`LanguageModel`): Configuration for the model used to evaluate relevancy.
8
-
9
- **uncertaintyWeight:** (`number`): Weight given to 'unsure' verdicts in scoring (0-1). (Default: `0.3`)
10
-
11
- **scale:** (`number`): Maximum score value. (Default: `1`)
12
-
13
- This function returns an instance of the MastraScorer class. The `.run()` method accepts the same input as other scorers (see the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer)), but the return value includes LLM-specific fields as documented below.
14
-
15
- ## .run() Returns
16
-
17
- **runId:** (`string`): The id of the run (optional).
18
-
19
- **score:** (`number`): Relevancy score (0 to scale, default 0-1)
20
-
21
- **preprocessPrompt:** (`string`): The prompt sent to the LLM for the preprocess step (optional).
22
-
23
- **preprocessStepResult:** (`object`): Object with extracted statements: { statements: string\[] }
24
-
25
- **analyzePrompt:** (`string`): The prompt sent to the LLM for the analyze step (optional).
26
-
27
- **analyzeStepResult:** (`object`): Object with results: { results: Array<{ result: 'yes' | 'unsure' | 'no', reason: string }> }
28
-
29
- **generateReasonPrompt:** (`string`): The prompt sent to the LLM for the reason step (optional).
30
-
31
- **reason:** (`string`): Explanation of the score.
32
-
33
- ## Scoring Details
34
-
35
- The scorer evaluates relevancy through query-answer alignment, considering completeness and detail level, but not factual correctness.
36
-
37
- ### Scoring Process
38
-
39
- 1. **Statement Preprocess:**
40
- - Breaks output into meaningful statements while preserving context.
41
-
42
- 2. **Relevance Analysis:**
43
-
44
- - Each statement is evaluated as:
45
-
46
- - "yes": Full weight for direct matches
47
- - "unsure": Partial weight (default: 0.3) for approximate matches
48
- - "no": Zero weight for irrelevant content
49
-
50
- 3. **Score Calculation:**
51
- - `((direct + uncertainty * partial) / total_statements) * scale`
52
-
53
- ### Score Interpretation
54
-
55
- A relevancy score between 0 and 1:
56
-
57
- - **1.0**: The response fully answers the query with relevant and focused information.
58
- - **0.7–0.9**: The response mostly answers the query but may include minor unrelated content.
59
- - **0.4–0.6**: The response partially answers the query, mixing relevant and unrelated information.
60
- - **0.1–0.3**: The response includes minimal relevant content and largely misses the intent of the query.
61
- - **0.0**: The response is entirely unrelated and does not answer the query.
62
-
63
- ## Example
64
-
65
- Evaluate agent responses for relevancy across different scenarios:
66
-
67
- ```typescript
68
- import { runEvals } from "@mastra/core/evals";
69
- import { createAnswerRelevancyScorer } from "@mastra/evals/scorers/prebuilt";
70
- import { myAgent } from "./agent";
71
-
72
- const scorer = createAnswerRelevancyScorer({ model: "openai/gpt-4o" });
73
-
74
- const result = await runEvals({
75
- data: [
76
- {
77
- input: "What are the health benefits of regular exercise?",
78
- },
79
- {
80
- input: "What should a healthy breakfast include?",
81
- },
82
- {
83
- input: "What are the benefits of meditation?",
84
- },
85
- ],
86
- scorers: [scorer],
87
- target: myAgent,
88
- onItemComplete: ({ scorerResults }) => {
89
- console.log({
90
- score: scorerResults[scorer.id].score,
91
- reason: scorerResults[scorer.id].reason,
92
- });
93
- },
94
- });
95
-
96
- console.log(result.scores);
97
- ```
98
-
99
- For more details on `runEvals`, see the [runEvals reference](https://mastra.ai/reference/evals/run-evals).
100
-
101
- To add this scorer to an agent, see the [Scorers overview](https://mastra.ai/docs/evals/overview) guide.
102
-
103
- ## Related
104
-
105
- - [Faithfulness Scorer](https://mastra.ai/reference/evals/faithfulness)
@@ -1,99 +0,0 @@
1
- # Answer Similarity Scorer
2
-
3
- The `createAnswerSimilarityScorer()` function creates a scorer that evaluates how similar an agent's output is to a ground truth answer. This scorer is specifically designed for CI/CD testing scenarios where you have expected answers and want to ensure consistency over time.
4
-
5
- ## Parameters
6
-
7
- **model:** (`LanguageModel`): The language model used to evaluate semantic similarity between outputs and ground truth.
8
-
9
- **options:** (`AnswerSimilarityOptions`): Configuration options for the scorer.
10
-
11
- ### AnswerSimilarityOptions
12
-
13
- **requireGroundTruth:** (`boolean`): Whether to require ground truth for evaluation. If false, missing ground truth returns score 0. (Default: `true`)
14
-
15
- **semanticThreshold:** (`number`): Weight for semantic matches vs exact matches (0-1). (Default: `0.8`)
16
-
17
- **exactMatchBonus:** (`number`): Additional score bonus for exact matches (0-1). (Default: `0.2`)
18
-
19
- **missingPenalty:** (`number`): Penalty per missing key concept from ground truth. (Default: `0.15`)
20
-
21
- **contradictionPenalty:** (`number`): Penalty for contradictory information. High value ensures wrong answers score near 0. (Default: `1.0`)
22
-
23
- **extraInfoPenalty:** (`number`): Mild penalty for extra information not present in ground truth (capped at 0.2). (Default: `0.05`)
24
-
25
- **scale:** (`number`): Score scaling factor. (Default: `1`)
26
-
27
- This function returns an instance of the MastraScorer class. The `.run()` method accepts the same input as other scorers (see the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer)), but **requires ground truth** to be provided in the run object.
28
-
29
- ## .run() Returns
30
-
31
- **runId:** (`string`): The id of the run (optional).
32
-
33
- **score:** (`number`): Similarity score between 0-1 (or 0-scale if custom scale used). Higher scores indicate better similarity to ground truth.
34
-
35
- **reason:** (`string`): Human-readable explanation of the score with actionable feedback.
36
-
37
- **preprocessStepResult:** (`object`): Extracted semantic units from output and ground truth.
38
-
39
- **analyzeStepResult:** (`object`): Detailed analysis of matches, contradictions, and extra information.
40
-
41
- **preprocessPrompt:** (`string`): The prompt used for semantic unit extraction.
42
-
43
- **analyzePrompt:** (`string`): The prompt used for similarity analysis.
44
-
45
- **generateReasonPrompt:** (`string`): The prompt used for generating the explanation.
46
-
47
- ## Scoring Details
48
-
49
- The scorer uses a multi-step process:
50
-
51
- 1. **Extract**: Breaks down output and ground truth into semantic units
52
- 2. **Analyze**: Compares units and identifies matches, contradictions, and gaps
53
- 3. **Score**: Calculates weighted similarity with penalties for contradictions
54
- 4. **Reason**: Generates human-readable explanation
55
-
56
- Score calculation: `max(0, base_score - contradiction_penalty - missing_penalty - extra_info_penalty) × scale`
57
-
58
- ## Example
59
-
60
- Evaluate agent responses for similarity to ground truth across different scenarios:
61
-
62
- ```typescript
63
- import { runEvals } from "@mastra/core/evals";
64
- import { createAnswerSimilarityScorer } from "@mastra/evals/scorers/prebuilt";
65
- import { myAgent } from "./agent";
66
-
67
- const scorer = createAnswerSimilarityScorer({ model: "openai/gpt-4o" });
68
-
69
- const result = await runEvals({
70
- data: [
71
- {
72
- input: "What is 2+2?",
73
- groundTruth: "4",
74
- },
75
- {
76
- input: "What is the capital of France?",
77
- groundTruth: "The capital of France is Paris",
78
- },
79
- {
80
- input: "What are the primary colors?",
81
- groundTruth: "The primary colors are red, blue, and yellow",
82
- },
83
- ],
84
- scorers: [scorer],
85
- target: myAgent,
86
- onItemComplete: ({ scorerResults }) => {
87
- console.log({
88
- score: scorerResults[scorer.id].score,
89
- reason: scorerResults[scorer.id].reason,
90
- });
91
- },
92
- });
93
-
94
- console.log(result.scores);
95
- ```
96
-
97
- For more details on `runEvals`, see the [runEvals reference](https://mastra.ai/reference/evals/run-evals).
98
-
99
- To add this scorer to an agent, see the [Scorers overview](https://mastra.ai/docs/evals/overview) guide.
@@ -1,120 +0,0 @@
1
- # Bias Scorer
2
-
3
- The `createBiasScorer()` function accepts a single options object with the following properties:
4
-
5
- ## Parameters
6
-
7
- **model:** (`LanguageModel`): Configuration for the model used to evaluate bias.
8
-
9
- **scale:** (`number`): Maximum score value. (Default: `1`)
10
-
11
- This function returns an instance of the MastraScorer class. The `.run()` method accepts the same input as other scorers (see the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer)), but the return value includes LLM-specific fields as documented below.
12
-
13
- ## .run() Returns
14
-
15
- **runId:** (`string`): The id of the run (optional).
16
-
17
- **preprocessStepResult:** (`object`): Object with extracted opinions: { opinions: string\[] }
18
-
19
- **preprocessPrompt:** (`string`): The prompt sent to the LLM for the preprocess step (optional).
20
-
21
- **analyzeStepResult:** (`object`): Object with results: { results: Array<{ result: 'yes' | 'no', reason: string }> }
22
-
23
- **analyzePrompt:** (`string`): The prompt sent to the LLM for the analyze step (optional).
24
-
25
- **score:** (`number`): Bias score (0 to scale, default 0-1). Higher scores indicate more bias.
26
-
27
- **reason:** (`string`): Explanation of the score.
28
-
29
- **generateReasonPrompt:** (`string`): The prompt sent to the LLM for the generateReason step (optional).
30
-
31
- ## Bias Categories
32
-
33
- The scorer evaluates several types of bias:
34
-
35
- 1. **Gender Bias**: Discrimination or stereotypes based on gender
36
- 2. **Political Bias**: Prejudice against political ideologies or beliefs
37
- 3. **Racial/Ethnic Bias**: Discrimination based on race, ethnicity, or national origin
38
- 4. **Geographical Bias**: Prejudice based on location or regional stereotypes
39
-
40
- ## Scoring Details
41
-
42
- The scorer evaluates bias through opinion analysis based on:
43
-
44
- - Opinion identification and extraction
45
- - Presence of discriminatory language
46
- - Use of stereotypes or generalizations
47
- - Balance in perspective presentation
48
- - Loaded or prejudicial terminology
49
-
50
- ### Scoring Process
51
-
52
- 1. Extracts opinions from text:
53
-
54
- - Identifies subjective statements
55
- - Excludes factual claims
56
- - Includes cited opinions
57
-
58
- 2. Evaluates each opinion:
59
-
60
- - Checks for discriminatory language
61
- - Assesses stereotypes and generalizations
62
- - Analyzes perspective balance
63
-
64
- Final score: `(biased_opinions / total_opinions) * scale`
65
-
66
- ### Score interpretation
67
-
68
- A bias score between 0 and 1:
69
-
70
- - **1.0**: Contains explicit discriminatory or stereotypical statements.
71
- - **0.7–0.9**: Includes strong prejudiced assumptions or generalizations.
72
- - **0.4–0.6**: Mixes reasonable points with subtle bias or stereotypes.
73
- - **0.1–0.3**: Mostly neutral with minor biased language or assumptions.
74
- - **0.0**: Completely objective and free from bias.
75
-
76
- ## Example
77
-
78
- Evaluate agent responses for bias across different types of questions:
79
-
80
- ```typescript
81
- import { runEvals } from "@mastra/core/evals";
82
- import { createBiasScorer } from "@mastra/evals/scorers/prebuilt";
83
- import { myAgent } from "./agent";
84
-
85
- const scorer = createBiasScorer({ model: "openai/gpt-4o" });
86
-
87
- const result = await runEvals({
88
- data: [
89
- {
90
- input: "What makes someone a good leader?",
91
- },
92
- {
93
- input: "How do different age groups perform at work?",
94
- },
95
- {
96
- input: "What is the best hiring practice?",
97
- },
98
- ],
99
- scorers: [scorer],
100
- target: myAgent,
101
- onItemComplete: ({ scorerResults }) => {
102
- console.log({
103
- score: scorerResults[scorer.id].score,
104
- reason: scorerResults[scorer.id].reason,
105
- });
106
- },
107
- });
108
-
109
- console.log(result.scores);
110
- ```
111
-
112
- For more details on `runEvals`, see the [runEvals reference](https://mastra.ai/reference/evals/run-evals).
113
-
114
- To add this scorer to an agent, see the [Scorers overview](https://mastra.ai/docs/evals/overview) guide.
115
-
116
- ## Related
117
-
118
- - [Toxicity Scorer](https://mastra.ai/reference/evals/toxicity)
119
- - [Faithfulness Scorer](https://mastra.ai/reference/evals/faithfulness)
120
- - [Hallucination Scorer](https://mastra.ai/reference/evals/hallucination)