@mastra/mcp-docs-server 1.1.7 → 1.1.8

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 (276) hide show
  1. package/.docs/docs/agents/agent-approval.md +61 -31
  2. package/.docs/docs/agents/supervisor-agents.md +1 -1
  3. package/.docs/docs/getting-started/manual-install.md +1 -1
  4. package/.docs/docs/index.md +68 -24
  5. package/.docs/docs/mastra-cloud/setup.md +1 -1
  6. package/.docs/docs/memory/observational-memory.md +9 -0
  7. package/.docs/docs/memory/semantic-recall.md +17 -1
  8. package/.docs/docs/workspace/skills.md +7 -5
  9. package/.docs/guides/deployment/aws-lambda.md +76 -165
  10. package/.docs/guides/deployment/azure-app-services.md +38 -61
  11. package/.docs/guides/deployment/cloudflare.md +1 -1
  12. package/.docs/guides/deployment/netlify.md +1 -1
  13. package/.docs/guides/deployment/vercel.md +1 -1
  14. package/.docs/models/gateways/netlify.md +5 -1
  15. package/.docs/models/index.md +1 -1
  16. package/.docs/models/providers/anthropic.md +9 -9
  17. package/.docs/models/providers/deepseek.md +1 -1
  18. package/.docs/models/providers/google.md +11 -11
  19. package/.docs/models/providers/openai.md +19 -19
  20. package/.docs/models/providers/opencode.md +33 -33
  21. package/.docs/models/providers/xai.md +3 -3
  22. package/.docs/reference/agents/agent.md +20 -20
  23. package/.docs/reference/agents/generate.md +200 -66
  24. package/.docs/reference/agents/generateLegacy.md +77 -35
  25. package/.docs/reference/agents/getDefaultGenerateOptions.md +4 -6
  26. package/.docs/reference/agents/getDefaultOptions.md +4 -6
  27. package/.docs/reference/agents/getDefaultStreamOptions.md +4 -6
  28. package/.docs/reference/agents/getDescription.md +1 -1
  29. package/.docs/reference/agents/getInstructions.md +4 -6
  30. package/.docs/reference/agents/getLLM.md +6 -8
  31. package/.docs/reference/agents/getMemory.md +4 -6
  32. package/.docs/reference/agents/getModel.md +4 -6
  33. package/.docs/reference/agents/getTools.md +5 -7
  34. package/.docs/reference/agents/getVoice.md +4 -6
  35. package/.docs/reference/agents/listAgents.md +4 -6
  36. package/.docs/reference/agents/listScorers.md +4 -6
  37. package/.docs/reference/agents/listTools.md +4 -6
  38. package/.docs/reference/agents/listWorkflows.md +4 -6
  39. package/.docs/reference/agents/network.md +69 -23
  40. package/.docs/reference/ai-sdk/chat-route.md +7 -7
  41. package/.docs/reference/ai-sdk/handle-chat-stream.md +12 -12
  42. package/.docs/reference/ai-sdk/handle-network-stream.md +4 -4
  43. package/.docs/reference/ai-sdk/handle-workflow-stream.md +11 -11
  44. package/.docs/reference/ai-sdk/network-route.md +3 -3
  45. package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +9 -9
  46. package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +9 -9
  47. package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +5 -5
  48. package/.docs/reference/ai-sdk/with-mastra.md +12 -12
  49. package/.docs/reference/ai-sdk/workflow-route.md +3 -3
  50. package/.docs/reference/auth/auth0.md +6 -6
  51. package/.docs/reference/auth/better-auth.md +5 -5
  52. package/.docs/reference/auth/clerk.md +5 -5
  53. package/.docs/reference/auth/firebase.md +7 -7
  54. package/.docs/reference/auth/jwt.md +1 -1
  55. package/.docs/reference/auth/supabase.md +4 -4
  56. package/.docs/reference/auth/workos.md +6 -6
  57. package/.docs/reference/cli/create-mastra.md +14 -14
  58. package/.docs/reference/client-js/mastra-client.md +23 -23
  59. package/.docs/reference/client-js/workflows.md +3 -3
  60. package/.docs/reference/core/addGateway.md +2 -2
  61. package/.docs/reference/core/getAgent.md +2 -2
  62. package/.docs/reference/core/getAgentById.md +2 -2
  63. package/.docs/reference/core/getDeployer.md +1 -1
  64. package/.docs/reference/core/getGateway.md +2 -2
  65. package/.docs/reference/core/getGatewayById.md +2 -2
  66. package/.docs/reference/core/getLogger.md +1 -1
  67. package/.docs/reference/core/getMCPServer.md +2 -2
  68. package/.docs/reference/core/getMCPServerById.md +3 -3
  69. package/.docs/reference/core/getMemory.md +2 -2
  70. package/.docs/reference/core/getScorer.md +2 -2
  71. package/.docs/reference/core/getScorerById.md +2 -2
  72. package/.docs/reference/core/getServer.md +1 -1
  73. package/.docs/reference/core/getStorage.md +1 -1
  74. package/.docs/reference/core/getStoredAgentById.md +18 -20
  75. package/.docs/reference/core/getTelemetry.md +1 -1
  76. package/.docs/reference/core/getVector.md +2 -2
  77. package/.docs/reference/core/getWorkflow.md +3 -3
  78. package/.docs/reference/core/listAgents.md +1 -1
  79. package/.docs/reference/core/listGateways.md +1 -1
  80. package/.docs/reference/core/listLogs.md +9 -11
  81. package/.docs/reference/core/listLogsByRunId.md +9 -9
  82. package/.docs/reference/core/listMCPServers.md +1 -1
  83. package/.docs/reference/core/listMemory.md +1 -1
  84. package/.docs/reference/core/listScorers.md +1 -1
  85. package/.docs/reference/core/listStoredAgents.md +9 -11
  86. package/.docs/reference/core/listVectors.md +1 -1
  87. package/.docs/reference/core/listWorkflows.md +2 -2
  88. package/.docs/reference/core/mastra-class.md +17 -17
  89. package/.docs/reference/core/mastra-model-gateway.md +15 -15
  90. package/.docs/reference/core/setLogger.md +2 -4
  91. package/.docs/reference/core/setStorage.md +1 -1
  92. package/.docs/reference/datasets/addItem.md +20 -4
  93. package/.docs/reference/datasets/addItems.md +8 -2
  94. package/.docs/reference/datasets/compareExperiments.md +15 -3
  95. package/.docs/reference/datasets/create.md +6 -6
  96. package/.docs/reference/datasets/dataset.md +1 -1
  97. package/.docs/reference/datasets/delete.md +2 -2
  98. package/.docs/reference/datasets/deleteExperiment.md +2 -2
  99. package/.docs/reference/datasets/deleteItem.md +2 -2
  100. package/.docs/reference/datasets/deleteItems.md +2 -2
  101. package/.docs/reference/datasets/get.md +2 -2
  102. package/.docs/reference/datasets/getDetails.md +9 -9
  103. package/.docs/reference/datasets/getExperiment.md +2 -2
  104. package/.docs/reference/datasets/getItem.md +3 -3
  105. package/.docs/reference/datasets/getItemHistory.md +22 -2
  106. package/.docs/reference/datasets/list.md +7 -3
  107. package/.docs/reference/datasets/listExperimentResults.md +34 -4
  108. package/.docs/reference/datasets/listExperiments.md +41 -3
  109. package/.docs/reference/datasets/listItems.md +18 -6
  110. package/.docs/reference/datasets/listVersions.md +23 -3
  111. package/.docs/reference/datasets/startExperiment.md +62 -12
  112. package/.docs/reference/datasets/startExperimentAsync.md +5 -1
  113. package/.docs/reference/datasets/update.md +6 -6
  114. package/.docs/reference/datasets/updateItem.md +5 -5
  115. package/.docs/reference/deployer.md +8 -8
  116. package/.docs/reference/evals/answer-relevancy.md +11 -11
  117. package/.docs/reference/evals/answer-similarity.md +17 -19
  118. package/.docs/reference/evals/bias.md +10 -10
  119. package/.docs/reference/evals/completeness.md +3 -3
  120. package/.docs/reference/evals/content-similarity.md +6 -6
  121. package/.docs/reference/evals/context-precision.md +4 -4
  122. package/.docs/reference/evals/context-relevance.md +4 -4
  123. package/.docs/reference/evals/create-scorer.md +47 -49
  124. package/.docs/reference/evals/faithfulness.md +11 -11
  125. package/.docs/reference/evals/hallucination.md +17 -21
  126. package/.docs/reference/evals/keyword-coverage.md +4 -4
  127. package/.docs/reference/evals/mastra-scorer.md +14 -14
  128. package/.docs/reference/evals/noise-sensitivity.md +4 -4
  129. package/.docs/reference/evals/prompt-alignment.md +4 -4
  130. package/.docs/reference/evals/run-evals.md +16 -16
  131. package/.docs/reference/evals/scorer-utils.md +3 -3
  132. package/.docs/reference/evals/textual-difference.md +3 -3
  133. package/.docs/reference/evals/tone-consistency.md +3 -3
  134. package/.docs/reference/evals/tool-call-accuracy.md +5 -5
  135. package/.docs/reference/evals/toxicity.md +8 -8
  136. package/.docs/reference/harness/harness-class.md +34 -42
  137. package/.docs/reference/logging/pino-logger.md +5 -5
  138. package/.docs/reference/memory/clone-utilities.md +5 -5
  139. package/.docs/reference/memory/cloneThread.md +17 -21
  140. package/.docs/reference/memory/createThread.md +10 -10
  141. package/.docs/reference/memory/deleteMessages.md +2 -2
  142. package/.docs/reference/memory/getThreadById.md +2 -2
  143. package/.docs/reference/memory/listThreads.md +5 -5
  144. package/.docs/reference/memory/memory-class.md +12 -14
  145. package/.docs/reference/memory/observational-memory.md +102 -94
  146. package/.docs/reference/memory/recall.md +14 -16
  147. package/.docs/reference/observability/tracing/configuration.md +27 -10
  148. package/.docs/reference/observability/tracing/exporters/console-exporter.md +4 -7
  149. package/.docs/reference/processors/batch-parts-processor.md +8 -10
  150. package/.docs/reference/processors/language-detector.md +14 -16
  151. package/.docs/reference/processors/message-history-processor.md +7 -9
  152. package/.docs/reference/processors/moderation-processor.md +13 -15
  153. package/.docs/reference/processors/pii-detector.md +14 -16
  154. package/.docs/reference/processors/processor-interface.md +62 -62
  155. package/.docs/reference/processors/prompt-injection-detector.md +11 -13
  156. package/.docs/reference/processors/semantic-recall-processor.md +14 -16
  157. package/.docs/reference/processors/system-prompt-scrubber.md +12 -14
  158. package/.docs/reference/processors/token-limiter-processor.md +11 -13
  159. package/.docs/reference/processors/tool-call-filter.md +5 -7
  160. package/.docs/reference/processors/tool-search-processor.md +9 -11
  161. package/.docs/reference/processors/unicode-normalizer.md +8 -10
  162. package/.docs/reference/processors/working-memory-processor.md +14 -18
  163. package/.docs/reference/rag/chunk.md +38 -38
  164. package/.docs/reference/rag/database-config.md +11 -7
  165. package/.docs/reference/rag/document.md +2 -2
  166. package/.docs/reference/rag/embeddings.md +12 -12
  167. package/.docs/reference/rag/extract-params.md +23 -23
  168. package/.docs/reference/rag/graph-rag.md +12 -12
  169. package/.docs/reference/rag/rerank.md +25 -17
  170. package/.docs/reference/rag/rerankWithScorer.md +25 -17
  171. package/.docs/reference/server/create-route.md +14 -14
  172. package/.docs/reference/server/express-adapter.md +10 -10
  173. package/.docs/reference/server/fastify-adapter.md +10 -10
  174. package/.docs/reference/server/hono-adapter.md +10 -10
  175. package/.docs/reference/server/koa-adapter.md +10 -10
  176. package/.docs/reference/server/mastra-server.md +10 -10
  177. package/.docs/reference/server/register-api-route.md +13 -13
  178. package/.docs/reference/storage/cloudflare-d1.md +5 -5
  179. package/.docs/reference/storage/cloudflare.md +6 -6
  180. package/.docs/reference/storage/composite.md +9 -9
  181. package/.docs/reference/storage/convex.md +3 -3
  182. package/.docs/reference/storage/dynamodb.md +9 -9
  183. package/.docs/reference/storage/lance.md +3 -3
  184. package/.docs/reference/storage/libsql.md +2 -2
  185. package/.docs/reference/storage/mongodb.md +5 -5
  186. package/.docs/reference/storage/mssql.md +2 -2
  187. package/.docs/reference/storage/postgresql.md +25 -25
  188. package/.docs/reference/storage/upstash.md +3 -3
  189. package/.docs/reference/streaming/ChunkType.md +251 -59
  190. package/.docs/reference/streaming/agents/MastraModelOutput.md +86 -16
  191. package/.docs/reference/streaming/agents/stream.md +155 -43
  192. package/.docs/reference/streaming/agents/streamLegacy.md +79 -39
  193. package/.docs/reference/streaming/workflows/resumeStream.md +18 -8
  194. package/.docs/reference/streaming/workflows/stream.md +21 -9
  195. package/.docs/reference/streaming/workflows/timeTravelStream.md +4 -4
  196. package/.docs/reference/tools/create-tool.md +25 -21
  197. package/.docs/reference/tools/document-chunker-tool.md +7 -7
  198. package/.docs/reference/tools/graph-rag-tool.md +16 -18
  199. package/.docs/reference/tools/mcp-client.md +38 -27
  200. package/.docs/reference/tools/mcp-server.md +45 -45
  201. package/.docs/reference/tools/vector-query-tool.md +34 -22
  202. package/.docs/reference/vectors/astra.md +22 -22
  203. package/.docs/reference/vectors/chroma.md +44 -44
  204. package/.docs/reference/vectors/convex.md +26 -26
  205. package/.docs/reference/vectors/couchbase.md +30 -30
  206. package/.docs/reference/vectors/duckdb.md +29 -29
  207. package/.docs/reference/vectors/elasticsearch.md +27 -27
  208. package/.docs/reference/vectors/lance.md +46 -38
  209. package/.docs/reference/vectors/libsql.md +31 -31
  210. package/.docs/reference/vectors/mongodb.md +32 -32
  211. package/.docs/reference/vectors/opensearch.md +27 -27
  212. package/.docs/reference/vectors/pg.md +60 -44
  213. package/.docs/reference/vectors/pinecone.md +38 -38
  214. package/.docs/reference/vectors/qdrant.md +36 -36
  215. package/.docs/reference/vectors/s3vectors.md +24 -24
  216. package/.docs/reference/vectors/turbopuffer.md +29 -29
  217. package/.docs/reference/vectors/upstash.md +25 -25
  218. package/.docs/reference/vectors/vectorize.md +27 -27
  219. package/.docs/reference/voice/azure.md +19 -15
  220. package/.docs/reference/voice/cloudflare.md +10 -12
  221. package/.docs/reference/voice/composite-voice.md +10 -10
  222. package/.docs/reference/voice/deepgram.md +20 -14
  223. package/.docs/reference/voice/elevenlabs.md +20 -22
  224. package/.docs/reference/voice/google-gemini-live.md +42 -44
  225. package/.docs/reference/voice/google.md +25 -21
  226. package/.docs/reference/voice/mastra-voice.md +20 -20
  227. package/.docs/reference/voice/murf.md +24 -28
  228. package/.docs/reference/voice/openai-realtime.md +26 -26
  229. package/.docs/reference/voice/openai.md +14 -12
  230. package/.docs/reference/voice/playai.md +13 -15
  231. package/.docs/reference/voice/sarvam.md +21 -25
  232. package/.docs/reference/voice/speechify.md +11 -13
  233. package/.docs/reference/voice/voice.addInstructions.md +1 -1
  234. package/.docs/reference/voice/voice.addTools.md +1 -1
  235. package/.docs/reference/voice/voice.answer.md +1 -1
  236. package/.docs/reference/voice/voice.connect.md +3 -3
  237. package/.docs/reference/voice/voice.events.md +11 -11
  238. package/.docs/reference/voice/voice.getSpeakers.md +30 -30
  239. package/.docs/reference/voice/voice.listen.md +9 -9
  240. package/.docs/reference/voice/voice.off.md +2 -2
  241. package/.docs/reference/voice/voice.on.md +2 -2
  242. package/.docs/reference/voice/voice.send.md +1 -1
  243. package/.docs/reference/voice/voice.speak.md +11 -11
  244. package/.docs/reference/voice/voice.updateConfig.md +3 -3
  245. package/.docs/reference/workflows/run-methods/cancel.md +2 -2
  246. package/.docs/reference/workflows/run-methods/restart.md +17 -5
  247. package/.docs/reference/workflows/run-methods/resume.md +23 -9
  248. package/.docs/reference/workflows/run-methods/start.md +22 -8
  249. package/.docs/reference/workflows/run-methods/startAsync.md +12 -6
  250. package/.docs/reference/workflows/run-methods/timeTravel.md +29 -13
  251. package/.docs/reference/workflows/run.md +12 -12
  252. package/.docs/reference/workflows/step.md +24 -26
  253. package/.docs/reference/workflows/workflow-methods/branch.md +2 -2
  254. package/.docs/reference/workflows/workflow-methods/commit.md +1 -1
  255. package/.docs/reference/workflows/workflow-methods/create-run.md +4 -4
  256. package/.docs/reference/workflows/workflow-methods/dountil.md +3 -3
  257. package/.docs/reference/workflows/workflow-methods/dowhile.md +3 -3
  258. package/.docs/reference/workflows/workflow-methods/foreach.md +9 -9
  259. package/.docs/reference/workflows/workflow-methods/map.md +2 -2
  260. package/.docs/reference/workflows/workflow-methods/parallel.md +2 -2
  261. package/.docs/reference/workflows/workflow-methods/sleep.md +2 -2
  262. package/.docs/reference/workflows/workflow-methods/sleepUntil.md +2 -2
  263. package/.docs/reference/workflows/workflow-methods/then.md +2 -2
  264. package/.docs/reference/workflows/workflow.md +40 -50
  265. package/.docs/reference/workspace/daytona-sandbox.md +33 -33
  266. package/.docs/reference/workspace/e2b-sandbox.md +20 -20
  267. package/.docs/reference/workspace/filesystem.md +22 -22
  268. package/.docs/reference/workspace/gcs-filesystem.md +15 -15
  269. package/.docs/reference/workspace/local-filesystem.md +35 -35
  270. package/.docs/reference/workspace/local-sandbox.md +26 -26
  271. package/.docs/reference/workspace/s3-filesystem.md +18 -18
  272. package/.docs/reference/workspace/sandbox.md +8 -8
  273. package/.docs/reference/workspace/workspace-class.md +30 -34
  274. package/CHANGELOG.md +16 -0
  275. package/package.json +6 -6
  276. package/.docs/docs/getting-started/start.md +0 -28
@@ -24,11 +24,11 @@ await weatherAgent.generate('What is the weather in Rome', {
24
24
 
25
25
  ## Parameters
26
26
 
27
- **key:** (`string`): The registration key of the scorer to retrieve. This should match a key used when registering scorers in the Mastra constructor.
27
+ **key** (`string`): The registration key of the scorer to retrieve. This should match a key used when registering scorers in the Mastra constructor.
28
28
 
29
29
  ## Returns
30
30
 
31
- **scorer:** (`MastraScorer`): The MastraScorer instance associated with the provided key.
31
+ **scorer** (`MastraScorer`): The MastraScorer instance associated with the provided key.
32
32
 
33
33
  ## Error Handling
34
34
 
@@ -24,11 +24,11 @@ await weatherAgent.generate('What is the weather in Rome', {
24
24
 
25
25
  ## Parameters
26
26
 
27
- **id:** (`string`): The id property of the scorer to retrieve. This should match the 'id' field specified when creating the scorer with createScorer(). The method will also search by 'name' property as a fallback.
27
+ **id** (`string`): The id property of the scorer to retrieve. This should match the 'id' field specified when creating the scorer with createScorer(). The method will also search by 'name' property as a fallback.
28
28
 
29
29
  ## Returns
30
30
 
31
- **scorer:** (`MastraScorer`): The MastraScorer instance that has the matching id (or name) property.
31
+ **scorer** (`MastraScorer`): The MastraScorer instance that has the matching id (or name) property.
32
32
 
33
33
  ## Error Handling
34
34
 
@@ -14,7 +14,7 @@ This method does not accept any parameters.
14
14
 
15
15
  ## Returns
16
16
 
17
- **server:** (`ServerConfig | undefined`): The configured server configuration including port, host, studioBase, timeout, API routes, middleware, CORS settings, and build options, or undefined if no server has been configured.
17
+ **server** (`ServerConfig | undefined`): The configured server configuration including port, host, studioBase, timeout, API routes, middleware, CORS settings, and build options, or undefined if no server has been configured.
18
18
 
19
19
  ## Related
20
20
 
@@ -14,7 +14,7 @@ This method does not accept any parameters.
14
14
 
15
15
  ## Returns
16
16
 
17
- **storage:** (`MastraCompositeStore | undefined`): The configured storage instance, or undefined if no storage has been configured.
17
+ **storage** (`MastraCompositeStore | undefined`): The configured storage instance, or undefined if no storage has been configured.
18
18
 
19
19
  ## Related
20
20
 
@@ -26,17 +26,15 @@ if (storedConfig) {
26
26
 
27
27
  ## Parameters
28
28
 
29
- **id:** (`string`): The unique identifier of the stored agent to retrieve.
29
+ **id** (`string`): The unique identifier of the stored agent to retrieve.
30
30
 
31
- **options?:** (`{ raw?: boolean }`): Optional configuration object.
31
+ **options** (`{ raw?: boolean }`): Optional configuration object.
32
32
 
33
- ### Options
34
-
35
- **raw?:** (`boolean`): When \`true\`, returns the raw \`StorageAgentType\` object from storage instead of creating an \`Agent\` instance. Useful for inspecting stored configuration or metadata. (Default: `false`)
33
+ **options.raw** (`boolean`): When \`true\`, returns the raw \`StorageAgentType\` object from storage instead of creating an \`Agent\` instance. Useful for inspecting stored configuration or metadata.
36
34
 
37
35
  ## Returns
38
36
 
39
- **result:** (`Agent | StorageAgentType | null`): Returns an \`Agent\` instance by default, or \`StorageAgentType\` when \`raw: true\`. Returns \`null\` if no agent with the given ID exists.
37
+ **result** (`Agent | StorageAgentType | null`): Returns an \`Agent\` instance by default, or \`StorageAgentType\` when \`raw: true\`. Returns \`null\` if no agent with the given ID exists.
40
38
 
41
39
  ## Primitive Resolution
42
40
 
@@ -54,33 +52,33 @@ If a referenced primitive is not found in the registry, a warning is logged but
54
52
 
55
53
  When using `raw: true`, the returned object has the following structure:
56
54
 
57
- **id:** (`string`): Unique identifier for the agent.
55
+ **id** (`string`): Unique identifier for the agent.
58
56
 
59
- **name:** (`string`): Display name of the agent.
57
+ **name** (`string`): Display name of the agent.
60
58
 
61
- **description?:** (`string`): Optional description of the agent.
59
+ **description** (`string`): Optional description of the agent.
62
60
 
63
- **instructions:** (`string`): System instructions for the agent.
61
+ **instructions** (`string`): System instructions for the agent.
64
62
 
65
- **model:** (`Record<string, unknown>`): Model configuration with provider and name.
63
+ **model** (`Record<string, unknown>`): Model configuration with provider and name.
66
64
 
67
- **tools?:** (`Record<string, unknown>`): Tool references to resolve from registry.
65
+ **tools** (`Record<string, unknown>`): Tool references to resolve from registry.
68
66
 
69
- **workflows?:** (`Record<string, unknown>`): Workflow references to resolve from registry.
67
+ **workflows** (`Record<string, unknown>`): Workflow references to resolve from registry.
70
68
 
71
- **agents?:** (`Record<string, unknown>`): Subagent references to resolve from registry.
69
+ **agents** (`Record<string, unknown>`): Subagent references to resolve from registry.
72
70
 
73
- **memory?:** (`Record<string, unknown>`): Memory reference to resolve from registry.
71
+ **memory** (`Record<string, unknown>`): Memory reference to resolve from registry.
74
72
 
75
- **scorers?:** (`Record<string, unknown>`): Scorer references with optional sampling config.
73
+ **scorers** (`Record<string, unknown>`): Scorer references with optional sampling config.
76
74
 
77
- **defaultOptions?:** (`Record<string, unknown>`): Default options passed to agent execution.
75
+ **defaultOptions** (`Record<string, unknown>`): Default options passed to agent execution.
78
76
 
79
- **metadata?:** (`Record<string, unknown>`): Custom metadata stored with the agent.
77
+ **metadata** (`Record<string, unknown>`): Custom metadata stored with the agent.
80
78
 
81
- **createdAt:** (`Date`): Timestamp when the agent was created.
79
+ **createdAt** (`Date`): Timestamp when the agent was created.
82
80
 
83
- **updatedAt:** (`Date`): Timestamp when the agent was last updated.
81
+ **updatedAt** (`Date`): Timestamp when the agent was last updated.
84
82
 
85
83
  ## Related
86
84
 
@@ -14,7 +14,7 @@ This method does not accept any parameters.
14
14
 
15
15
  ## Returns
16
16
 
17
- **telemetry:** (`Telemetry | undefined`): The configured telemetry instance used for tracing and observability across all components, or undefined if no telemetry has been configured.
17
+ **telemetry** (`Telemetry | undefined`): The configured telemetry instance used for tracing and observability across all components, or undefined if no telemetry has been configured.
18
18
 
19
19
  ## Related
20
20
 
@@ -10,11 +10,11 @@ mastra.getVector('testVectorStore')
10
10
 
11
11
  ## Parameters
12
12
 
13
- **name:** (`TVectorName extends keyof TVectors`): The name of the vector store to retrieve. Must be a valid vector store name that exists in the Mastra configuration.
13
+ **name** (`TVectorName extends keyof TVectors`): The name of the vector store to retrieve. Must be a valid vector store name that exists in the Mastra configuration.
14
14
 
15
15
  ## Returns
16
16
 
17
- **vector:** (`TVectors[TVectorName]`): The vector store instance with the specified name. Throws an error if the vector store is not found.
17
+ **vector** (`TVectors[TVectorName]`): The vector store instance with the specified name. Throws an error if the vector store is not found.
18
18
 
19
19
  ## Related
20
20
 
@@ -29,13 +29,13 @@ If you need to retrieve a workflow by its `id` property instead of its registrat
29
29
 
30
30
  ## Parameters
31
31
 
32
- **id:** (`TWorkflowId extends keyof TWorkflows`): The ID of the workflow to retrieve. Must be a valid workflow ID that exists in the Mastra configuration.
32
+ **id** (`TWorkflowId extends keyof TWorkflows`): The ID of the workflow to retrieve. Must be a valid workflow ID that exists in the Mastra configuration.
33
33
 
34
- **options:** (`{ serialized?: boolean }`): Optional configuration object. When \`serialized\` is true, returns only the workflow name instead of the full workflow instance.
34
+ **options** (`{ serialized?: boolean }`): Optional configuration object. When \`serialized\` is true, returns only the workflow name instead of the full workflow instance.
35
35
 
36
36
  ## Returns
37
37
 
38
- **workflow:** (`TWorkflows[TWorkflowId]`): The workflow instance with the specified ID. Throws an error if the workflow is not found.
38
+ **workflow** (`TWorkflows[TWorkflowId]`): The workflow instance with the specified ID. Throws an error if the workflow is not found.
39
39
 
40
40
  ## Related
41
41
 
@@ -14,7 +14,7 @@ This method does not accept any parameters.
14
14
 
15
15
  ## Returns
16
16
 
17
- **agents:** (`TAgents`): A record of all configured agents, where keys are agent names and values are agent instances.
17
+ **agents** (`TAgents`): A record of all configured agents, where keys are agent names and values are agent instances.
18
18
 
19
19
  ## Related
20
20
 
@@ -29,7 +29,7 @@ None.
29
29
 
30
30
  ## Returns
31
31
 
32
- **gateways:** (`Record<string, MastraModelGateway>`): A record of gateway instances indexed by registration key
32
+ **gateways** (`Record<string, MastraModelGateway>`): A record of gateway instances indexed by registration key
33
33
 
34
34
  ## Related
35
35
 
@@ -10,27 +10,25 @@ mastra.listLogs('456')
10
10
 
11
11
  ## Parameters
12
12
 
13
- **transportId:** (`string`): The transport ID to retrieve logs from.
13
+ **transportId** (`string`): The transport ID to retrieve logs from.
14
14
 
15
- **options:** (`object`): Optional parameters for filtering and pagination. See Options section below for details.
15
+ **options** (`object`): Optional parameters for filtering and pagination.
16
16
 
17
- ### Options
17
+ **options.fromDate** (`Date`): Optional start date for filtering logs. e.g., new Date('2024-01-01').
18
18
 
19
- **fromDate:** (`Date`): Optional start date for filtering logs. e.g., new Date('2024-01-01').
19
+ **options.toDate** (`Date`): Optional end date for filtering logs. e.g., new Date('2024-01-31').
20
20
 
21
- **toDate:** (`Date`): Optional end date for filtering logs. e.g., new Date('2024-01-31').
21
+ **options.logLevel** (`LogLevel`): Optional log level to filter by.
22
22
 
23
- **logLevel:** (`LogLevel`): Optional log level to filter by.
23
+ **options.filters** (`Record<string, any>`): Optional additional filters to apply to the log query.
24
24
 
25
- **filters:** (`Record<string, any>`): Optional additional filters to apply to the log query.
25
+ **options.page** (`number`): Optional page number for pagination.
26
26
 
27
- **page:** (`number`): Optional page number for pagination.
28
-
29
- **perPage:** (`number`): Optional number of logs per page for pagination.
27
+ **options.perPage** (`number`): Optional number of logs per page for pagination.
30
28
 
31
29
  ## Returns
32
30
 
33
- **logs:** (`Promise<any>`): A promise that resolves to the logs for the specified transport ID.
31
+ **logs** (`Promise<any>`): A promise that resolves to the logs for the specified transport ID.
34
32
 
35
33
  ## Related
36
34
 
@@ -10,25 +10,25 @@ mastra.listLogsByRunId({ runId: '123', transportId: '456' })
10
10
 
11
11
  ## Parameters
12
12
 
13
- **runId:** (`string`): The run ID to retrieve logs for.
13
+ **runId** (`string`): The run ID to retrieve logs for.
14
14
 
15
- **transportId:** (`string`): The transport ID to retrieve logs from.
15
+ **transportId** (`string`): The transport ID to retrieve logs from.
16
16
 
17
- **fromDate:** (`Date`): Optional start date for filtering logs. e.g., new Date('2024-01-01').
17
+ **fromDate** (`Date`): Optional start date for filtering logs. e.g., new Date('2024-01-01').
18
18
 
19
- **toDate:** (`Date`): Optional end date for filtering logs. e.g., new Date('2024-01-31').
19
+ **toDate** (`Date`): Optional end date for filtering logs. e.g., new Date('2024-01-31').
20
20
 
21
- **logLevel:** (`LogLevel`): Optional log level to filter by.
21
+ **logLevel** (`LogLevel`): Optional log level to filter by.
22
22
 
23
- **filters:** (`Record<string, any>`): Optional additional filters to apply to the log query.
23
+ **filters** (`Record<string, any>`): Optional additional filters to apply to the log query.
24
24
 
25
- **page:** (`number`): Optional page number for pagination.
25
+ **page** (`number`): Optional page number for pagination.
26
26
 
27
- **perPage:** (`number`): Optional number of logs per page for pagination.
27
+ **perPage** (`number`): Optional number of logs per page for pagination.
28
28
 
29
29
  ## Returns
30
30
 
31
- **logs:** (`Promise<any>`): A promise that resolves to the logs for the specified run ID and transport ID.
31
+ **logs** (`Promise<any>`): A promise that resolves to the logs for the specified run ID and transport ID.
32
32
 
33
33
  ## Related
34
34
 
@@ -42,7 +42,7 @@ This method does not accept any parameters.
42
42
 
43
43
  ## Returns
44
44
 
45
- **servers:** (`Record<string, MCPServerBase> | undefined`): A record of all registered MCP server instances, where keys are the registry keys (from mcpServers configuration) and values are MCPServerBase instances, or undefined if no servers are registered.
45
+ **servers** (`Record<string, MCPServerBase> | undefined`): A record of all registered MCP server instances, where keys are the registry keys (from mcpServers configuration) and values are MCPServerBase instances, or undefined if no servers are registered.
46
46
 
47
47
  ## Related Methods
48
48
 
@@ -18,7 +18,7 @@ This method takes no parameters.
18
18
 
19
19
  ## Returns
20
20
 
21
- **memory:** (`Record<string, MastraMemory>`): An object containing all registered memory instances, keyed by their registry keys.
21
+ **memory** (`Record<string, MastraMemory>`): An object containing all registered memory instances, keyed by their registry keys.
22
22
 
23
23
  ## Example: Checking Registered Memory
24
24
 
@@ -20,7 +20,7 @@ This method takes no parameters.
20
20
 
21
21
  ## Returns
22
22
 
23
- **scorers:** (`Record<string, MastraScorer> | undefined`): An object containing all registered scorers, where keys are scorer names and values are MastraScorer instances. Returns undefined if no scorers are registered.
23
+ **scorers** (`Record<string, MastraScorer> | undefined`): An object containing all registered scorers, where keys are scorer names and values are MastraScorer instances. Returns undefined if no scorers are registered.
24
24
 
25
25
  ## Related
26
26
 
@@ -33,27 +33,25 @@ for (const config of result.agents) {
33
33
 
34
34
  ## Parameters
35
35
 
36
- **args?:** (`object`): Optional configuration object for pagination and output format.
36
+ **args** (`object`): Optional configuration object for pagination and output format.
37
37
 
38
- ### Args Options
38
+ **args.page** (`number`): Zero-indexed page number for pagination.
39
39
 
40
- **page?:** (`number`): Zero-indexed page number for pagination. (Default: `0`)
40
+ **args.perPage** (`number | false`): Number of items per page. Set to \`false\` to fetch all records without pagination.
41
41
 
42
- **perPage?:** (`number | false`): Number of items per page. Set to \`false\` to fetch all records without pagination. (Default: `100`)
43
-
44
- **raw?:** (`boolean`): When \`true\`, returns raw \`StorageAgentType\` objects instead of \`Agent\` instances. (Default: `false`)
42
+ **args.raw** (`boolean`): When \`true\`, returns raw \`StorageAgentType\` objects instead of \`Agent\` instances.
45
43
 
46
44
  ## Returns
47
45
 
48
- **agents:** (`Agent[] | StorageAgentType[]`): Array of \`Agent\` instances by default, or \`StorageAgentType\` objects when \`raw: true\`.
46
+ **agents** (`Agent[] | StorageAgentType[]`): Array of \`Agent\` instances by default, or \`StorageAgentType\` objects when \`raw: true\`.
49
47
 
50
- **total:** (`number`): Total number of stored agents across all pages.
48
+ **total** (`number`): Total number of stored agents across all pages.
51
49
 
52
- **page:** (`number`): Current page number (zero-indexed).
50
+ **page** (`number`): Current page number (zero-indexed).
53
51
 
54
- **perPage:** (`number | false`): Number of items per page, or \`false\` if fetching all.
52
+ **perPage** (`number | false`): Number of items per page, or \`false\` if fetching all.
55
53
 
56
- **hasMore:** (`boolean`): Whether there are more pages available.
54
+ **hasMore** (`boolean`): Whether there are more pages available.
57
55
 
58
56
  ## Primitive Resolution
59
57
 
@@ -14,7 +14,7 @@ This method does not accept any parameters.
14
14
 
15
15
  ## Returns
16
16
 
17
- **vectors:** (`TVectors`): A record of all configured vector stores, where keys are vector store names and values are vector store instances.
17
+ **vectors** (`TVectors`): A record of all configured vector stores, where keys are vector store names and values are vector store instances.
18
18
 
19
19
  ## Related
20
20
 
@@ -10,11 +10,11 @@ mastra.listWorkflows()
10
10
 
11
11
  ## Parameters
12
12
 
13
- **options:** (`{ serialized?: boolean }`): Optional configuration object. When \`serialized\` is true, returns simplified workflow objects with only the name property instead of full workflow instances.
13
+ **options** (`{ serialized?: boolean }`): Optional configuration object. When \`serialized\` is true, returns simplified workflow objects with only the name property instead of full workflow instances.
14
14
 
15
15
  ## Returns
16
16
 
17
- **workflows:** (`Record<string, Workflow>`): A record of all configured workflows, where keys are workflow IDs and values are workflow instances (or simplified objects if serialized is true).
17
+ **workflows** (`Record<string, Workflow>`): A record of all configured workflows, where keys are workflow IDs and values are workflow instances (or simplified objects if serialized is true).
18
18
 
19
19
  ## Related
20
20
 
@@ -31,36 +31,36 @@ export const mastra = new Mastra({
31
31
 
32
32
  Visit the [Configuration reference](https://mastra.ai/reference/configuration) for detailed documentation on all available configuration options.
33
33
 
34
- **agents?:** (`Record<string, Agent>`): Agent instances to register, keyed by name (Default: `{}`)
34
+ **agents** (`Record<string, Agent>`): Agent instances to register, keyed by name (Default: `{}`)
35
35
 
36
- **tools?:** (`Record<string, ToolApi>`): Custom tools to register. Structured as a key-value pair, with keys being the tool name and values being the tool function. (Default: `{}`)
36
+ **tools** (`Record<string, ToolApi>`): Custom tools to register. Structured as a key-value pair, with keys being the tool name and values being the tool function. (Default: `{}`)
37
37
 
38
- **storage?:** (`MastraCompositeStore`): Storage engine instance for persisting data
38
+ **storage** (`MastraCompositeStore`): Storage engine instance for persisting data
39
39
 
40
- **vectors?:** (`Record<string, MastraVector>`): Vector store instance, used for semantic search and vector-based tools (eg Pinecone, PgVector or Qdrant)
40
+ **vectors** (`Record<string, MastraVector>`): Vector store instance, used for semantic search and vector-based tools (eg Pinecone, PgVector or Qdrant)
41
41
 
42
- **logger?:** (`Logger`): Logger instance created with new PinoLogger() (Default: `Console logger with INFO level`)
42
+ **logger** (`Logger`): Logger instance created with new PinoLogger() (Default: `Console logger with INFO level`)
43
43
 
44
- **idGenerator?:** (`() => string`): Custom ID generator function. Used by agents, workflows, memory, and other components to generate unique identifiers.
44
+ **idGenerator** (`() => string`): Custom ID generator function. Used by agents, workflows, memory, and other components to generate unique identifiers.
45
45
 
46
- **workflows?:** (`Record<string, Workflow>`): Workflows to register. Structured as a key-value pair, with keys being the workflow name and values being the workflow instance. (Default: `{}`)
46
+ **workflows** (`Record<string, Workflow>`): Workflows to register. Structured as a key-value pair, with keys being the workflow name and values being the workflow instance. (Default: `{}`)
47
47
 
48
- **tts?:** (`Record<string, MastraVoice>`): Text-to-speech providers for voice synthesis
48
+ **tts** (`Record<string, MastraVoice>`): Text-to-speech providers for voice synthesis
49
49
 
50
- **observability?:** (`ObservabilityEntrypoint`): Observability configuration for tracing and monitoring
50
+ **observability** (`ObservabilityEntrypoint`): Observability configuration for tracing and monitoring
51
51
 
52
- **deployer?:** (`MastraDeployer`): An instance of a MastraDeployer for managing deployments.
52
+ **deployer** (`MastraDeployer`): An instance of a MastraDeployer for managing deployments.
53
53
 
54
- **server?:** (`ServerConfig`): Server configuration including port, host, timeout, API routes, middleware, CORS settings, and build options for Swagger UI, API request logging, and OpenAPI docs.
54
+ **server** (`ServerConfig`): Server configuration including port, host, timeout, API routes, middleware, CORS settings, and build options for Swagger UI, API request logging, and OpenAPI docs.
55
55
 
56
- **mcpServers?:** (`Record<string, MCPServerBase>`): An object where keys are registry keys (used for getMCPServer()) and values are instances of MCPServer or classes extending MCPServerBase. Each MCPServer must have an id property. Servers can be retrieved by registry key using getMCPServer() or by their intrinsic id using getMCPServerById().
56
+ **mcpServers** (`Record<string, MCPServerBase>`): An object where keys are registry keys (used for getMCPServer()) and values are instances of MCPServer or classes extending MCPServerBase. Each MCPServer must have an id property. Servers can be retrieved by registry key using getMCPServer() or by their intrinsic id using getMCPServerById().
57
57
 
58
- **bundler?:** (`BundlerConfig`): Configuration for the asset bundler with options for externals, sourcemap, and transpilePackages.
58
+ **bundler** (`BundlerConfig`): Configuration for the asset bundler with options for externals, sourcemap, and transpilePackages.
59
59
 
60
- **scorers?:** (`Record<string, Scorer>`): Scorers for evaluating agent responses and workflow outputs (Default: `{}`)
60
+ **scorers** (`Record<string, Scorer>`): Scorers for evaluating agent responses and workflow outputs (Default: `{}`)
61
61
 
62
- **processors?:** (`Record<string, Processor>`): Input/output processors for transforming agent inputs and outputs (Default: `{}`)
62
+ **processors** (`Record<string, Processor>`): Input/output processors for transforming agent inputs and outputs (Default: `{}`)
63
63
 
64
- **gateways?:** (`Record<string, MastraModelGateway>`): Custom model gateways to register for accessing AI models through alternative providers or private deployments. Structured as a key-value pair, with keys being the registry key (used for getGateway()) and values being gateway instances. (Default: `{}`)
64
+ **gateways** (`Record<string, MastraModelGateway>`): Custom model gateways to register for accessing AI models through alternative providers or private deployments. Structured as a key-value pair, with keys being the registry key (used for getGateway()) and values being gateway instances. (Default: `{}`)
65
65
 
66
- **memory?:** (`Record<string, MastraMemory>`): Memory instances to register. These can be referenced by stored agents and resolved at runtime. Structured as a key-value pair, with keys being the registry key and values being memory instances. (Default: `{}`)
66
+ **memory** (`Record<string, MastraMemory>`): Memory instances to register. These can be referenced by stored agents and resolved at runtime. Structured as a key-value pair, with keys being the registry key and values being memory instances. (Default: `{}`)
@@ -55,9 +55,9 @@ class MyCustomGateway extends MastraModelGateway {
55
55
 
56
56
  ## Required Properties
57
57
 
58
- **id:** (`string`): Unique identifier for the gateway. This ID is used as the prefix for all providers from this gateway (e.g., "netlify/anthropic"). Exception: models.dev is a provider registry and doesn't use a prefix.
58
+ **id** (`string`): Unique identifier for the gateway. This ID is used as the prefix for all providers from this gateway (e.g., "netlify/anthropic"). Exception: models.dev is a provider registry and doesn't use a prefix.
59
59
 
60
- **name:** (`string`): Human-readable name for the gateway.
60
+ **name** (`string`): Human-readable name for the gateway.
61
61
 
62
62
  ## Required Methods
63
63
 
@@ -69,19 +69,19 @@ Fetches provider configurations from the gateway.
69
69
 
70
70
  **ProviderConfig Structure:**
71
71
 
72
- **name:** (`string`): Display name of the provider
72
+ **name** (`string`): Display name of the provider
73
73
 
74
- **models:** (`string[]`): Array of available model IDs
74
+ **models** (`string[]`): Array of available model IDs
75
75
 
76
- **apiKeyEnvVar:** (`string | string[]`): Environment variable(s) for API key
76
+ **apiKeyEnvVar** (`string | string[]`): Environment variable(s) for API key
77
77
 
78
- **gateway:** (`string`): Gateway identifier
78
+ **gateway** (`string`): Gateway identifier
79
79
 
80
- **url?:** (`string`): Optional base API URL
80
+ **url** (`string`): Optional base API URL
81
81
 
82
- **apiKeyHeader?:** (`string`): Optional custom auth header name
82
+ **apiKeyHeader** (`string`): Optional custom auth header name
83
83
 
84
- **docUrl?:** (`string`): Optional documentation URL
84
+ **docUrl** (`string`): Optional documentation URL
85
85
 
86
86
  ### buildUrl()
87
87
 
@@ -89,9 +89,9 @@ Builds the API URL for a specific model/provider combination.
89
89
 
90
90
  **Parameters:**
91
91
 
92
- **modelId:** (`string`): Full model ID (e.g., "custom/my-provider/model-1")
92
+ **modelId** (`string`): Full model ID (e.g., "custom/my-provider/model-1")
93
93
 
94
- **envVars?:** (`Record<string, string>`): Optional environment variables
94
+ **envVars** (`Record<string, string>`): Optional environment variables
95
95
 
96
96
  **Returns:** `string | undefined | Promise<string | undefined>`
97
97
 
@@ -101,7 +101,7 @@ Retrieves the API key for authentication.
101
101
 
102
102
  **Parameters:**
103
103
 
104
- **modelId:** (`string`): Full model ID
104
+ **modelId** (`string`): Full model ID
105
105
 
106
106
  **Returns:** `Promise<string>`
107
107
 
@@ -111,11 +111,11 @@ Creates a language model instance.
111
111
 
112
112
  **Parameters:**
113
113
 
114
- **modelId:** (`string`): The model ID
114
+ **modelId** (`string`): The model ID
115
115
 
116
- **providerId:** (`string`): The provider ID
116
+ **providerId** (`string`): The provider ID
117
117
 
118
- **apiKey:** (`string`): The API key for authentication
118
+ **apiKey** (`string`): The API key for authentication
119
119
 
120
120
  **Returns:** `Promise<LanguageModelV2> | LanguageModelV2`
121
121
 
@@ -10,11 +10,9 @@ mastra.setLogger({ logger: new PinoLogger({ name: 'testLogger' }) })
10
10
 
11
11
  ## Parameters
12
12
 
13
- **options:** (`{ logger: TLogger }`): An object containing the logger instance to set for all components.
13
+ **options** (`{ logger: TLogger }`): An object containing the logger instance to set for all components.
14
14
 
15
- ### Options
16
-
17
- **logger:** (`TLogger`): The logger instance to set for all components (agents, workflows, etc.).
15
+ **options.logger** (`TLogger`): The logger instance to set for all components (agents, workflows, etc.).
18
16
 
19
17
  ## Returns
20
18
 
@@ -15,7 +15,7 @@ mastra.setStorage(
15
15
 
16
16
  ## Parameters
17
17
 
18
- **storage:** (`MastraCompositeStore`): The storage instance to set for the Mastra instance.
18
+ **storage** (`MastraCompositeStore`): The storage instance to set for the Mastra instance.
19
19
 
20
20
  ## Returns
21
21
 
@@ -26,12 +26,28 @@ console.log(item.id)
26
26
 
27
27
  ## Parameters
28
28
 
29
- **input:** (`unknown`): Input data for the item.
29
+ **input** (`unknown`): Input data for the item.
30
30
 
31
- **groundTruth?:** (`unknown`): Expected output or ground truth for scoring.
31
+ **groundTruth** (`unknown`): Expected output or ground truth for scoring.
32
32
 
33
- **metadata?:** (`Record<string, unknown>`): Arbitrary metadata for the item.
33
+ **metadata** (`Record<string, unknown>`): Arbitrary metadata for the item.
34
34
 
35
35
  ## Returns
36
36
 
37
- **result:** (`Promise<DatasetItem>`): DatasetItemid:stringUnique identifier of the item.datasetId:stringID of the parent dataset.datasetVersion:numberDataset version when the item was created.input:unknownInput data.groundTruth?:unknownGround truth data.metadata?:Record\<string, unknown>Item metadata.createdAt:DateWhen the item was created.updatedAt:DateWhen the item was last updated.
37
+ **result** (`Promise<DatasetItem>`): The created dataset item.
38
+
39
+ **result.id** (`string`): Unique identifier of the item.
40
+
41
+ **result.datasetId** (`string`): ID of the parent dataset.
42
+
43
+ **result.datasetVersion** (`number`): Dataset version when the item was created.
44
+
45
+ **result.input** (`unknown`): Input data.
46
+
47
+ **result.groundTruth** (`unknown`): Ground truth data.
48
+
49
+ **result.metadata** (`Record<string, unknown>`): Item metadata.
50
+
51
+ **result.createdAt** (`Date`): When the item was created.
52
+
53
+ **result.updatedAt** (`Date`): When the item was last updated.
@@ -28,8 +28,14 @@ console.log(`Added ${items.length} items`)
28
28
 
29
29
  ## Parameters
30
30
 
31
- **items:** (`Array<object>`): DatasetIteminput:unknownInput data for the item.groundTruth?:unknownExpected output or ground truth.metadata?:Record\<string, unknown>Arbitrary metadata.
31
+ **items** (`Array<object>`): Array of items to add. Each item has the same shape as the dataset.addItem() input.
32
+
33
+ **items.input** (`unknown`): Input data for the item.
34
+
35
+ **items.groundTruth** (`unknown`): Expected output or ground truth.
36
+
37
+ **items.metadata** (`Record<string, unknown>`): Arbitrary metadata.
32
38
 
33
39
  ## Returns
34
40
 
35
- **result:** (`Promise<DatasetItem[]>`): Array of created dataset items. See dataset.addItem() for the item shape.
41
+ **result** (`Promise<DatasetItem[]>`): Array of created dataset items. See dataset.addItem() for the item shape.
@@ -36,15 +36,27 @@ for (const item of comparison.items) {
36
36
 
37
37
  ## Parameters
38
38
 
39
- **experimentIds:** (`string[]`): Array of experiment IDs to compare. Must contain at least 2.
39
+ **experimentIds** (`string[]`): Array of experiment IDs to compare. Must contain at least 2.
40
40
 
41
- **baselineId?:** (`string`): ID of the baseline experiment. Defaults to the first ID in \`experimentIds\`.
41
+ **baselineId** (`string`): ID of the baseline experiment. Defaults to the first ID in \`experimentIds\`.
42
42
 
43
43
  ## Returns
44
44
 
45
45
  Throws `MastraError` if fewer than 2 experiment IDs are provided.
46
46
 
47
- **result:** (`Promise<object>`): objectbaselineId:stringID of the baseline experiment used for comparison.items:Array\<object>Per-item comparison data.objectitemId:stringID of the dataset item.input:unknown | nullInput data for the item.groundTruth:unknown | nullGround truth for the item.results:Record\<string, { output: unknown; scores: Record\<string, number | null> } | null>Results keyed by experiment ID. Each entry contains the output and scorer results for that experiment.
47
+ **result** (`Promise<object>`): Comparison results.
48
+
49
+ **result.baselineId** (`string`): ID of the baseline experiment used for comparison.
50
+
51
+ **result.items** (`Array<object>`): Per-item comparison data.
52
+
53
+ **result.items.itemId** (`string`): ID of the dataset item.
54
+
55
+ **result.items.input** (`unknown | null`): Input data for the item.
56
+
57
+ **result.items.groundTruth** (`unknown | null`): Ground truth for the item.
58
+
59
+ **result.items.results** (`Record<string, { output: unknown; scores: Record<string, number | null> } | null>`): Results keyed by experiment ID. Each entry contains the output and scorer results for that experiment.
48
60
 
49
61
  ## Related
50
62
 
@@ -36,16 +36,16 @@ const typedDataset = await mastra.datasets.create({
36
36
 
37
37
  ## Parameters
38
38
 
39
- **name:** (`string`): Display name for the dataset.
39
+ **name** (`string`): Display name for the dataset.
40
40
 
41
- **description?:** (`string`): Description of the dataset.
41
+ **description** (`string`): Description of the dataset.
42
42
 
43
- **inputSchema?:** (`unknown`): JSON Schema or Zod schema for item inputs. Zod schemas are auto-converted.
43
+ **inputSchema** (`unknown`): JSON Schema or Zod schema for item inputs. Zod schemas are auto-converted.
44
44
 
45
- **groundTruthSchema?:** (`unknown`): JSON Schema or Zod schema for item ground truths. Zod schemas are auto-converted.
45
+ **groundTruthSchema** (`unknown`): JSON Schema or Zod schema for item ground truths. Zod schemas are auto-converted.
46
46
 
47
- **metadata?:** (`Record<string, unknown>`): Arbitrary metadata.
47
+ **metadata** (`Record<string, unknown>`): Arbitrary metadata.
48
48
 
49
49
  ## Returns
50
50
 
51
- **result:** (`Promise<Dataset>`): A Dataset instance for the newly created dataset.
51
+ **result** (`Promise<Dataset>`): A Dataset instance for the newly created dataset.
@@ -72,7 +72,7 @@ const dataset = await mastra.datasets.create({ name: 'My dataset' })
72
72
 
73
73
  For the full dataset record (name, description, schemas, version, timestamps), call [`dataset.getDetails()`](https://mastra.ai/reference/datasets/getDetails).
74
74
 
75
- **id:** (`string`): The unique identifier of the dataset. Read-only.
75
+ **id** (`string`): The unique identifier of the dataset. Read-only.
76
76
 
77
77
  ## Related
78
78