@mastra/mcp-docs-server 1.2.4 → 1.2.5-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/docs/agent-builder/deploying.md +1 -1
- package/.docs/docs/agent-controller/overview.md +1 -1
- package/.docs/docs/agent-controller/session.md +1 -1
- package/.docs/docs/agents/overview.md +1 -1
- package/.docs/docs/agents/processors.md +1 -1
- package/.docs/docs/agents/supervisor-agents.md +3 -3
- package/.docs/docs/agents/using-tools.md +1 -1
- package/.docs/docs/{agents → long-running-agents}/background-tasks.md +2 -2
- package/.docs/docs/{agents → long-running-agents}/durable-agents.md +2 -2
- package/.docs/docs/{agents → long-running-agents}/goals.md +1 -1
- package/.docs/docs/{agents → long-running-agents}/heartbeats.md +5 -5
- package/.docs/docs/{agents → long-running-agents}/signal-providers.md +4 -4
- package/.docs/docs/memory/working-memory.md +1 -1
- package/.docs/docs/observability/config.md +1 -2
- package/.docs/docs/server/pubsub.md +2 -2
- package/.docs/docs/voice/overview.md +3 -3
- package/.docs/docs/voice/speech-to-speech.md +81 -1
- package/.docs/docs/voice/speech-to-text.md +19 -1
- package/.docs/docs/voice/text-to-speech.md +21 -1
- package/.docs/docs/workflows/control-flow.md +1 -1
- package/.docs/docs/workflows/error-handling.md +1 -1
- package/.docs/docs/workflows/human-in-the-loop.md +1 -1
- package/.docs/docs/workflows/overview.md +1 -1
- package/.docs/docs/workflows/snapshots.md +1 -1
- package/.docs/docs/workflows/suspend-and-resume.md +1 -1
- package/.docs/docs/workflows/time-travel.md +1 -1
- package/.docs/docs/workflows/workflow-state.md +1 -1
- package/.docs/guides/build-your-ui/copilotkit/channels.md +76 -0
- package/.docs/guides/build-your-ui/copilotkit/generative-ui.md +174 -0
- package/.docs/guides/build-your-ui/copilotkit/overview.md +411 -0
- package/.docs/guides/concepts/streaming.md +1 -1
- package/.docs/guides/deployment/vercel.md +1 -2
- package/.docs/guides/guide/signal-provider.md +5 -5
- package/.docs/models/environment-variables.md +2 -0
- package/.docs/models/index.md +1 -1
- package/.docs/models/providers/alibaba-cn.md +2 -1
- package/.docs/models/providers/friendli.md +1 -2
- package/.docs/models/providers/kenari.md +95 -0
- package/.docs/models/providers/nvidia.md +2 -3
- package/.docs/models/providers/tencent-token-plan.md +7 -7
- package/.docs/models/providers/tencent-tokenhub.md +5 -4
- package/.docs/models/providers.md +2 -0
- package/.docs/reference/acp/acp-agent.md +5 -5
- package/.docs/reference/acp/create-acp-tool.md +5 -5
- package/.docs/reference/agent-controller/agent-controller-class.md +27 -27
- package/.docs/reference/agents/agent.md +34 -34
- package/.docs/reference/agents/channels.md +19 -19
- package/.docs/reference/agents/createSkill.md +2 -2
- package/.docs/reference/agents/durable-agent.md +22 -22
- package/.docs/reference/agents/generate.md +10 -10
- package/.docs/reference/agents/generateLegacy.md +12 -12
- package/.docs/reference/agents/getMetadata.md +1 -1
- package/.docs/reference/agents/getVoice.md +1 -1
- package/.docs/reference/agents/inngest-agent.md +9 -9
- package/.docs/reference/agents/network.md +1 -1
- package/.docs/reference/ai-sdk/chat-route.md +4 -4
- package/.docs/reference/ai-sdk/handle-chat-stream.md +6 -6
- package/.docs/reference/ai-sdk/handle-network-stream.md +3 -3
- package/.docs/reference/ai-sdk/handle-workflow-stream.md +1 -1
- package/.docs/reference/ai-sdk/network-route.md +4 -4
- package/.docs/reference/ai-sdk/to-ai-sdk-messages.md +1 -1
- package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +1 -1
- package/.docs/reference/ai-sdk/with-mastra.md +2 -2
- package/.docs/reference/ai-sdk/workflow-route.md +2 -2
- package/.docs/reference/ai-sdk/workflow-snapshot-to-stream.md +1 -1
- package/.docs/reference/auth/google.md +10 -10
- package/.docs/reference/auth/okta.md +11 -11
- package/.docs/reference/auth/workos.md +3 -3
- package/.docs/reference/channels/slack-provider.md +15 -15
- package/.docs/reference/cli/mastra.md +145 -0
- package/.docs/reference/client-js/agents.md +9 -9
- package/.docs/reference/client-js/mastra-client.md +5 -5
- package/.docs/reference/client-js/responses.md +3 -3
- package/.docs/reference/configuration.md +1 -1
- package/.docs/reference/core/getAgentById.md +3 -3
- package/.docs/reference/core/getWorkflow.md +1 -1
- package/.docs/reference/core/listWorkflows.md +1 -1
- package/.docs/reference/core/mastra-class.md +3 -3
- package/.docs/reference/core/removeWorkspace.md +2 -2
- package/.docs/reference/datasets/compareExperiments.md +1 -1
- package/.docs/reference/datasets/getItemHistory.md +1 -1
- package/.docs/reference/datasets/list.md +5 -5
- package/.docs/reference/datasets/listExperimentResults.md +4 -4
- package/.docs/reference/datasets/listExperiments.md +4 -4
- package/.docs/reference/datasets/listItems.md +5 -5
- package/.docs/reference/datasets/listVersions.md +3 -3
- package/.docs/reference/datasets/startExperiment.md +8 -8
- package/.docs/reference/datasets/startExperimentAsync.md +1 -1
- package/.docs/reference/editor/agent-builder/agent-builder-options.md +4 -4
- package/.docs/reference/editor/agent-builder/builder-agent-defaults.md +7 -7
- package/.docs/reference/editor/agent-builder/builder-models.md +4 -4
- package/.docs/reference/editor/blob-store-provider.md +2 -2
- package/.docs/reference/editor/browser-provider.md +2 -2
- package/.docs/reference/editor/filesystem-provider.md +2 -2
- package/.docs/reference/editor/mastra-editor.md +2 -2
- package/.docs/reference/editor/processor-provider.md +4 -4
- package/.docs/reference/editor/sandbox-provider.md +2 -2
- package/.docs/reference/editor/storage-browser-ref.md +2 -2
- package/.docs/reference/editor/storage-workspace-ref.md +7 -7
- package/.docs/reference/evals/create-scorer.md +8 -8
- package/.docs/reference/evals/rubric.md +1 -1
- package/.docs/reference/evals/run-evals.md +7 -7
- package/.docs/reference/evals/trajectory-accuracy.md +1 -1
- package/.docs/reference/index.md +2 -2
- package/.docs/reference/logging/pino-logger.md +4 -4
- package/.docs/reference/memory/cloneThread.md +35 -4
- package/.docs/reference/memory/memory-class.md +5 -5
- package/.docs/reference/memory/observational-memory.md +43 -43
- package/.docs/reference/memory/recall.md +4 -4
- package/.docs/reference/memory/serialized-memory-config.md +6 -6
- package/.docs/reference/observability/tracing/configuration.md +4 -4
- package/.docs/reference/processors/language-detector.md +1 -1
- package/.docs/reference/processors/moderation-processor.md +1 -1
- package/.docs/reference/processors/pii-detector.md +1 -1
- package/.docs/reference/processors/processor-interface.md +20 -20
- package/.docs/reference/processors/prompt-injection-detector.md +1 -1
- package/.docs/reference/processors/response-cache.md +6 -6
- package/.docs/reference/processors/unicode-normalizer.md +1 -1
- package/.docs/reference/pubsub/base.md +7 -7
- package/.docs/reference/pubsub/caching-pubsub.md +1 -1
- package/.docs/reference/pubsub/event-emitter.md +2 -2
- package/.docs/reference/pubsub/google-cloud-pubsub.md +1 -1
- package/.docs/reference/pubsub/lease-provider.md +3 -3
- package/.docs/reference/pubsub/redis-streams.md +6 -6
- package/.docs/reference/pubsub/unix-socket-pubsub.md +1 -1
- package/.docs/reference/rag/chunk.md +2 -2
- package/.docs/reference/server/create-route.md +3 -3
- package/.docs/reference/server/express-adapter.md +4 -4
- package/.docs/reference/server/fastify-adapter.md +4 -4
- package/.docs/reference/server/hono-adapter.md +4 -4
- package/.docs/reference/server/koa-adapter.md +4 -4
- package/.docs/reference/server/mastra-server.md +1 -1
- package/.docs/reference/server/nestjs-adapter.md +3 -3
- package/.docs/reference/server/register-api-route.md +3 -3
- package/.docs/reference/signals/create-notification-inbox-tool.md +3 -3
- package/.docs/reference/signals/signal-provider.md +7 -7
- package/.docs/reference/signals/webhook-signal-provider.md +2 -2
- package/.docs/reference/storage/clickhouse.md +7 -7
- package/.docs/reference/storage/composite.md +2 -2
- package/.docs/reference/storage/duckdb.md +1 -1
- package/.docs/reference/storage/dynamodb.md +1 -1
- package/.docs/reference/storage/libsql.md +1 -1
- package/.docs/reference/storage/postgresql.md +2 -2
- package/.docs/reference/storage/redis.md +2 -2
- package/.docs/reference/storage/retention.md +5 -5
- package/.docs/reference/storage/spanner.md +6 -6
- package/.docs/reference/streaming/ChunkType.md +3 -3
- package/.docs/reference/streaming/agents/stream.md +14 -14
- package/.docs/reference/streaming/agents/streamLegacy.md +10 -10
- package/.docs/reference/streaming/agents/streamUntilIdle.md +1 -1
- package/.docs/reference/streaming/workflows/resumeStream.md +1 -1
- package/.docs/reference/templates/overview.md +1 -140
- package/.docs/reference/tools/brightdata.md +4 -4
- package/.docs/reference/tools/create-code-mode.md +5 -5
- package/.docs/reference/tools/create-tool.md +15 -15
- package/.docs/reference/tools/graph-rag-tool.md +1 -1
- package/.docs/reference/tools/mcp-client.md +2 -2
- package/.docs/reference/tools/mcp-server.md +12 -12
- package/.docs/reference/tools/perplexity.md +3 -3
- package/.docs/reference/tools/tavily.md +1 -1
- package/.docs/reference/tools/vector-query-tool.md +1 -1
- package/.docs/reference/vectors/chroma.md +1 -1
- package/.docs/reference/vectors/mongodb.md +1 -1
- package/.docs/reference/vectors/pg.md +1 -1
- package/.docs/reference/vectors/s3vectors.md +4 -4
- package/.docs/reference/voice/google-gemini-live.md +3 -3
- package/.docs/reference/voice/inworld-realtime.md +12 -12
- package/.docs/reference/voice/inworld.md +2 -2
- package/.docs/reference/voice/voice.on.md +1 -1
- package/.docs/reference/workflows/run-methods/resume.md +1 -1
- package/.docs/reference/workflows/run-methods/timeTravel.md +1 -1
- package/.docs/reference/workspace/agentcore-runtime-sandbox.md +4 -4
- package/.docs/reference/workspace/agentfs-filesystem.md +1 -1
- package/.docs/reference/workspace/apple-container-sandbox.md +5 -5
- package/.docs/reference/workspace/archil-filesystem.md +5 -5
- package/.docs/reference/workspace/blaxel-sandbox.md +1 -1
- package/.docs/reference/workspace/daytona-sandbox.md +1 -1
- package/.docs/reference/workspace/docker-sandbox.md +2 -2
- package/.docs/reference/workspace/e2b-sandbox.md +2 -2
- package/.docs/reference/workspace/files-sdk-filesystem.md +1 -1
- package/.docs/reference/workspace/filesystem.md +1 -1
- package/.docs/reference/workspace/local-filesystem.md +3 -3
- package/.docs/reference/workspace/local-sandbox.md +1 -1
- package/.docs/reference/workspace/mesa-filesystem.md +3 -3
- package/.docs/reference/workspace/modal-sandbox.md +1 -1
- package/.docs/reference/workspace/railway-sandbox.md +1 -1
- package/.docs/reference/workspace/s3-filesystem.md +4 -4
- package/.docs/reference/workspace/sandbox.md +1 -1
- package/.docs/reference/workspace/{vercel-microvm-sandbox.md → vercel-sandbox.md} +21 -15
- package/.docs/reference/workspace/{vercel.md → vercel-serverless.md} +21 -14
- package/.docs/reference/workspace/workspace-class.md +15 -15
- package/CHANGELOG.md +15 -0
- package/package.json +5 -5
- package/.docs/docs/agents/adding-voice.md +0 -383
- package/.docs/docs/community/contributing-templates.md +0 -5
- package/.docs/docs/community/discord.md +0 -11
- package/.docs/guides/build-your-ui/copilotkit.md +0 -291
- package/LICENSE.md +0 -30
- /package/.docs/docs/{community/licensing.md → license.md} +0 -0
- /package/.docs/docs/{agents → long-running-agents}/signals.md +0 -0
|
@@ -193,8 +193,151 @@ Path to a JSON file containing named [request context](https://mastra.ai/docs/se
|
|
|
193
193
|
mastra studio --request-context-presets ./presets.json
|
|
194
194
|
```
|
|
195
195
|
|
|
196
|
+
## `mastra deploy`
|
|
197
|
+
|
|
198
|
+
Builds and deploys your project to a named environment on Mastra platform. This is the recommended command for all new deploys and replaces both [`mastra studio deploy`](#mastra-studio-deploy) and [`mastra server deploy`](#mastra-server-deploy), which continue to work but should no longer be used for new setups.
|
|
199
|
+
|
|
200
|
+
Requires authentication via [`mastra auth login`](#mastra-auth-login) or a `MASTRA_API_TOKEN` environment variable.
|
|
201
|
+
|
|
202
|
+
```bash
|
|
203
|
+
mastra deploy
|
|
204
|
+
mastra deploy --env staging
|
|
205
|
+
mastra deploy --env production --region eu
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
The command runs `mastra build`, zips the output, uploads it to the selected environment, and then polls the deploy status while streaming build logs until the deploy reaches a terminal state.
|
|
209
|
+
|
|
210
|
+
Organization, project, and environment are resolved in order from: environment variable (`MASTRA_ORG_ID`, `MASTRA_PROJECT_ID`), CLI flag (`--org`, `--project`, `--env`), `.mastra-project.json` config file, current org from credentials, and lastly interactive prompt. On first deploy, the CLI saves the resolved org and project IDs to `.mastra-project.json` so subsequent deploys skip the prompts.
|
|
211
|
+
|
|
212
|
+
If the project doesn't exist yet, the CLI creates it from the `package.json` `name` field after confirmation. If the target environment doesn't exist, the CLI creates it (defaulting to `type: staging` for anything other than `production`) after confirmation. Combined with `--yes`, this creates and deploys everything in one non-interactive command:
|
|
213
|
+
|
|
214
|
+
```bash
|
|
215
|
+
mastra deploy --env staging --yes
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
When `--env <name>` is set and `--env-file` is not, the CLI auto-selects `.env.<name>` from the project directory if present (for example `.env.staging`). The `<name>` value is validated against a strict allowlist before being interpolated into a file path.
|
|
219
|
+
|
|
220
|
+
### Arguments
|
|
221
|
+
|
|
222
|
+
#### `[dir]`
|
|
223
|
+
|
|
224
|
+
Project directory. Defaults to the current directory.
|
|
225
|
+
|
|
226
|
+
### Flags
|
|
227
|
+
|
|
228
|
+
#### `--env`
|
|
229
|
+
|
|
230
|
+
Target environment name. Defaults to `production`. Auto-selects `.env.<name>` from the project directory when `--env-file` is not set. If the environment doesn't exist, the CLI creates it after confirmation.
|
|
231
|
+
|
|
232
|
+
#### `--org`
|
|
233
|
+
|
|
234
|
+
Organization ID. Can also be set via the `MASTRA_ORG_ID` environment variable.
|
|
235
|
+
|
|
236
|
+
#### `--project`
|
|
237
|
+
|
|
238
|
+
Project ID, slug, or name. Can also be set via the `MASTRA_PROJECT_ID` environment variable. If no project matches, the value is used as the name of a new project to create on deploy.
|
|
239
|
+
|
|
240
|
+
#### `-y, --yes`
|
|
241
|
+
|
|
242
|
+
Auto-accept defaults without confirmation prompts, including creating projects and environments.
|
|
243
|
+
|
|
244
|
+
#### `-c, --config`
|
|
245
|
+
|
|
246
|
+
Path to the project config file. Defaults to `.mastra-project.json`.
|
|
247
|
+
|
|
248
|
+
#### `--env-file`
|
|
249
|
+
|
|
250
|
+
Path to the env file to bundle with the deploy (relative to the project directory). When set, disables the `.env.<name>` auto-selection based on `--env`.
|
|
251
|
+
|
|
252
|
+
```bash
|
|
253
|
+
mastra deploy --env staging --env-file .env.staging.local
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
#### `--region`
|
|
257
|
+
|
|
258
|
+
Region for a newly created environment (for example `eu`). Applied only when the CLI creates the environment.
|
|
259
|
+
|
|
260
|
+
#### `--skip-build`
|
|
261
|
+
|
|
262
|
+
Skip the build step and deploy the existing `.mastra/output` directory. The CLI warns if the existing build is stale relative to the current source.
|
|
263
|
+
|
|
264
|
+
#### `--skip-preflight`
|
|
265
|
+
|
|
266
|
+
Skip the pre-upload validation of the built output.
|
|
267
|
+
|
|
268
|
+
#### `--debug`
|
|
269
|
+
|
|
270
|
+
Enable debug logs during the build step.
|
|
271
|
+
|
|
272
|
+
### CI/CD usage
|
|
273
|
+
|
|
274
|
+
Set `MASTRA_API_TOKEN`, `MASTRA_ORG_ID`, and `MASTRA_PROJECT_ID` as environment variables for headless deploys. Interactive prompts are skipped automatically when `MASTRA_API_TOKEN` is set. Combine with `--yes` to auto-accept environment creation.
|
|
275
|
+
|
|
276
|
+
```bash
|
|
277
|
+
export MASTRA_API_TOKEN="..."
|
|
278
|
+
export MASTRA_ORG_ID="..."
|
|
279
|
+
export MASTRA_PROJECT_ID="..."
|
|
280
|
+
mastra deploy --env staging --yes
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
## `mastra env`
|
|
284
|
+
|
|
285
|
+
Manages environments on Mastra platform. Environments are named deploy targets (for example `production`, `staging`, `preview-42`) that belong to a project. Every subcommand takes a `<project>` argument (name, slug, or ID) and resolves the current organization from stored credentials.
|
|
286
|
+
|
|
287
|
+
### `mastra env list`
|
|
288
|
+
|
|
289
|
+
Lists environments for a project.
|
|
290
|
+
|
|
291
|
+
```bash
|
|
292
|
+
mastra env list <project>
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
#### `--json`
|
|
296
|
+
|
|
297
|
+
Emit machine-readable JSON. Only non-sensitive metadata (id, name, slug, type, region, branch, and URLs) is included so the output is safe to log in CI.
|
|
298
|
+
|
|
299
|
+
### `mastra env create`
|
|
300
|
+
|
|
301
|
+
Creates a new environment for a project.
|
|
302
|
+
|
|
303
|
+
```bash
|
|
304
|
+
mastra env create <project> --name staging --type staging --region eu
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
#### `-n, --name`
|
|
308
|
+
|
|
309
|
+
Environment name (required).
|
|
310
|
+
|
|
311
|
+
#### `-t, --type`
|
|
312
|
+
|
|
313
|
+
Environment type. One of `production`, `staging`, or `preview`. Defaults to `staging`.
|
|
314
|
+
|
|
315
|
+
#### `-r, --region`
|
|
316
|
+
|
|
317
|
+
Region for the environment (for example `eu`).
|
|
318
|
+
|
|
319
|
+
#### `--json`
|
|
320
|
+
|
|
321
|
+
Emit machine-readable JSON. Sensitive fields are omitted, as with [`mastra env list`](#mastra-env-list).
|
|
322
|
+
|
|
323
|
+
### `mastra env delete`
|
|
324
|
+
|
|
325
|
+
Deletes an environment.
|
|
326
|
+
|
|
327
|
+
```bash
|
|
328
|
+
mastra env delete <project> <env>
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
`<env>` can be an environment name, slug, or ID. The CLI prompts for confirmation unless `--yes` is passed.
|
|
332
|
+
|
|
333
|
+
#### `-y, --yes`
|
|
334
|
+
|
|
335
|
+
Skip the confirmation prompt.
|
|
336
|
+
|
|
196
337
|
## `mastra studio deploy`
|
|
197
338
|
|
|
339
|
+
> **Info:** `mastra studio deploy` continues to work but is superseded by [`mastra deploy`](#mastra-deploy), which supports named environments (`--env staging`, `--env production`) on a single project. New setups should use `mastra deploy`.
|
|
340
|
+
|
|
198
341
|
Builds and deploys your project to Mastra platform. Requires authentication via [`mastra auth login`](#mastra-auth-login) or a `MASTRA_API_TOKEN` environment variable.
|
|
199
342
|
|
|
200
343
|
```bash
|
|
@@ -311,6 +454,8 @@ Creates a new project through an interactive prompt. This command doesn't accept
|
|
|
311
454
|
|
|
312
455
|
## `mastra server deploy`
|
|
313
456
|
|
|
457
|
+
> **Info:** `mastra server deploy` continues to work but is superseded by [`mastra deploy`](#mastra-deploy), which deploys a single project to multiple named environments instead of separate Studio and Server commands. New setups should use `mastra deploy`.
|
|
458
|
+
|
|
314
459
|
Builds and deploys your project to Server on Mastra platform. Works the same as [`mastra studio deploy`](#mastra-studio-deploy) with the same flags, arguments, and resolution logic.
|
|
315
460
|
|
|
316
461
|
The deploy command auto-loads the project's `.env` file. If `MASTRA_PROJECT_ID` points to a project that was provisioned for Observability, the deploy links to that project instead of creating a new one. Deploying Server to an observability-only project converts it into a Server project on the platform side.
|
|
@@ -237,21 +237,21 @@ await agent.sendSignal({
|
|
|
237
237
|
|
|
238
238
|
Returns `{ accepted: true, runId: string }`.
|
|
239
239
|
|
|
240
|
-
**signal** (`{ type: 'user' | 'reactive' | 'notification' | string; tagName?: string; contents: string | Array<TextPart | FilePart>; attributes?: Record<string, JSONValue>; metadata?: Record<string, unknown>; providerOptions?: ProviderMetadata }`): Lower-level signal payload. Use
|
|
240
|
+
**signal** (`{ type: 'user' | 'reactive' | 'notification' | string; tagName?: string; contents: string | Array<TextPart | FilePart>; attributes?: Record<string, JSONValue>; metadata?: Record<string, unknown>; providerOptions?: ProviderMetadata }`): Lower-level signal payload. Use type for the semantic signal category and tagName for the XML tag shown to the model. providerOptions is attached to the resulting prompt turn and persisted on the stored signal message.
|
|
241
241
|
|
|
242
242
|
**runId** (`string`): Run ID to target directly.
|
|
243
243
|
|
|
244
|
-
**resourceId** (`string`): Resource ID for the memory thread. Use with
|
|
244
|
+
**resourceId** (`string`): Resource ID for the memory thread. Use with threadId for thread-targeted signals.
|
|
245
245
|
|
|
246
|
-
**threadId** (`string`): Thread ID to target. Use with
|
|
246
|
+
**threadId** (`string`): Thread ID to target. Use with resourceId for thread-targeted signals.
|
|
247
247
|
|
|
248
|
-
**ifActive.behavior** (`'deliver' | 'persist' | 'discard'`): Controls what happens when the target thread is active. Defaults to
|
|
248
|
+
**ifActive.behavior** (`'deliver' | 'persist' | 'discard'`): Controls what happens when the target thread is active. Defaults to deliver.
|
|
249
249
|
|
|
250
250
|
**ifActive.attributes** (`Record<string, string | number | boolean>`): Attributes merged into the signal when Mastra accepts it while the target thread is active.
|
|
251
251
|
|
|
252
|
-
**ifIdle.behavior** (`'wake' | 'persist' | 'discard'`): Controls what happens when the target thread is idle. Defaults to
|
|
252
|
+
**ifIdle.behavior** (`'wake' | 'persist' | 'discard'`): Controls what happens when the target thread is idle. Defaults to wake.
|
|
253
253
|
|
|
254
|
-
**ifIdle.streamOptions** (`Omit<AgentExecutionOptions, 'messages'>`): Options for the stream that starts when
|
|
254
|
+
**ifIdle.streamOptions** (`Omit<AgentExecutionOptions, 'messages'>`): Options for the stream that starts when ifIdle.behavior is wake.
|
|
255
255
|
|
|
256
256
|
**ifIdle.attributes** (`Record<string, string | number | boolean>`): Attributes merged into the signal when Mastra accepts it while the target thread is idle.
|
|
257
257
|
|
|
@@ -281,11 +281,11 @@ await subscription.processDataStream({
|
|
|
281
281
|
|
|
282
282
|
**threadId** (`string`): Thread ID to subscribe to.
|
|
283
283
|
|
|
284
|
-
**processDataStream().reconnect** (`boolean | { maxRetries?: number; delayMs?: number }`): Reconnects the subscription stream after it closes or a reconnect request fails.
|
|
284
|
+
**processDataStream().reconnect** (`boolean | { maxRetries?: number; delayMs?: number }`): Reconnects the subscription stream after it closes or a reconnect request fails. true retries indefinitely with a one-second delay.
|
|
285
285
|
|
|
286
286
|
### `streamUntilIdle()`
|
|
287
287
|
|
|
288
|
-
Stream a response and keep the stream open until every [background task](https://mastra.ai/docs/agents/background-tasks) dispatched during the run completes. The server re-enters the agentic loop on each task completion so the LLM can react to results in the same call. Requires background tasks to be [enabled on the Mastra instance](https://mastra.ai/reference/configuration) and a memory thread; otherwise the call falls through to a plain `stream()`.
|
|
288
|
+
Stream a response and keep the stream open until every [background task](https://mastra.ai/docs/long-running-agents/background-tasks) dispatched during the run completes. The server re-enters the agentic loop on each task completion so the LLM can react to results in the same call. Requires background tasks to be [enabled on the Mastra instance](https://mastra.ai/reference/configuration) and a memory thread; otherwise the call falls through to a plain `stream()`.
|
|
289
289
|
|
|
290
290
|
```typescript
|
|
291
291
|
const response = await agent.streamUntilIdle('Research solana for me', {
|
|
@@ -307,7 +307,7 @@ response.processDataStream({
|
|
|
307
307
|
|
|
308
308
|
### `resumeStreamUntilIdle()`
|
|
309
309
|
|
|
310
|
-
Resume a suspended agent stream with custom data and keep the stream open until every [background task](https://mastra.ai/docs/agents/background-tasks) dispatched during the run completes. Use this to continue execution after a suspension point, such as a workflow suspend within an agent. Requires background tasks to be [enabled on the Mastra instance](https://mastra.ai/reference/configuration) and a memory thread; otherwise the call falls through to a plain `resumeStream()`:
|
|
310
|
+
Resume a suspended agent stream with custom data and keep the stream open until every [background task](https://mastra.ai/docs/long-running-agents/background-tasks) dispatched during the run completes. Use this to continue execution after a suspension point, such as a workflow suspend within an agent. Requires background tasks to be [enabled on the Mastra instance](https://mastra.ai/reference/configuration) and a memory thread; otherwise the call falls through to a plain `resumeStream()`:
|
|
311
311
|
|
|
312
312
|
```typescript
|
|
313
313
|
const response = await agent.resumeStreamUntilIdle(
|
|
@@ -57,7 +57,7 @@ You can also pass `requestContext` as a `Record<string, any>`.
|
|
|
57
57
|
|
|
58
58
|
**getAgent(agentId)** (`Agent`): Retrieves a specific agent instance by ID.
|
|
59
59
|
|
|
60
|
-
**listMemoryThreads(params)** (`Promise<StorageThreadType[]>`): Retrieves memory threads for the specified resource and agent. Requires a
|
|
60
|
+
**listMemoryThreads(params)** (`Promise<StorageThreadType[]>`): Retrieves memory threads for the specified resource and agent. Requires a resourceId and an agentId.
|
|
61
61
|
|
|
62
62
|
**createMemoryThread(params)** (`Promise<MemoryThread>`): Creates a new memory thread with the given parameters.
|
|
63
63
|
|
|
@@ -75,13 +75,13 @@ You can also pass `requestContext` as a `Record<string, any>`.
|
|
|
75
75
|
|
|
76
76
|
**getWorkflow(workflowId)** (`Workflow`): Retrieves a specific workflow instance by ID.
|
|
77
77
|
|
|
78
|
-
**getAgentBuilderActions()** (`Promise<Record<string, WorkflowInfo>>`): Returns all available Agent Builder actions. See
|
|
78
|
+
**getAgentBuilderActions()** (`Promise<Record<string, WorkflowInfo>>`): Returns all available Agent Builder actions. See Agent Builder API.
|
|
79
79
|
|
|
80
|
-
**getAgentBuilderAction(actionId)** (`AgentBuilder`): Retrieves an Agent Builder action by ID. See
|
|
80
|
+
**getAgentBuilderAction(actionId)** (`AgentBuilder`): Retrieves an Agent Builder action by ID. See Agent Builder API.
|
|
81
81
|
|
|
82
|
-
**responses** (`Responses`): Provides OpenAI-style Responses API helpers with
|
|
82
|
+
**responses** (`Responses`): Provides OpenAI-style Responses API helpers with create(), retrieve(), stream(), and delete().
|
|
83
83
|
|
|
84
|
-
**conversations** (`Conversations`): Provides conversation helpers with
|
|
84
|
+
**conversations** (`Conversations`): Provides conversation helpers with create(), retrieve(), delete(), and items.list().
|
|
85
85
|
|
|
86
86
|
**getVector(vectorName)** (`MastraVector`): Returns a vector store instance by name.
|
|
87
87
|
|
|
@@ -196,15 +196,15 @@ The returned response object includes:
|
|
|
196
196
|
|
|
197
197
|
## Parameters
|
|
198
198
|
|
|
199
|
-
**agent\_id** (`string`): Required on initial requests. Selects the Mastra agent that executes the request. Stored follow-up turns can omit it when continuing with
|
|
199
|
+
**agent\_id** (`string`): Required on initial requests. Selects the Mastra agent that executes the request. Stored follow-up turns can omit it when continuing with previous\_response\_id.
|
|
200
200
|
|
|
201
|
-
**model** (`string`): Optional model override for this request, such as
|
|
201
|
+
**model** (`string`): Optional model override for this request, such as openai/gpt-5. If omitted, Mastra uses the model configured on the selected agent.
|
|
202
202
|
|
|
203
203
|
**input** (`string | Array<{ role: 'system' | 'developer' | 'user' | 'assistant'; content: string | Array<{ type: 'input_text' | 'text' | 'output_text'; text: string }> }>`): Required. Input text or message array for the response.
|
|
204
204
|
|
|
205
205
|
**instructions** (`string`): Optional instruction override for this request.
|
|
206
206
|
|
|
207
|
-
**text** (`{ format: { type: 'json_object' } | { type: 'json_schema'; name: string; schema: Record<string, unknown>; description?: string; strict?: boolean } }`): Optional text output format. Use
|
|
207
|
+
**text** (`{ format: { type: 'json_object' } | { type: 'json_schema'; name: string; schema: Record<string, unknown>; description?: string; strict?: boolean } }`): Optional text output format. Use json\_object for JSON mode or json\_schema for schema-constrained structured output.
|
|
208
208
|
|
|
209
209
|
**providerOptions** (`Record<string, Record<string, unknown> | undefined>`): Optional provider-specific options passed through to the underlying model call.
|
|
210
210
|
|
|
@@ -44,7 +44,7 @@ export const mastra = new Mastra({
|
|
|
44
44
|
|
|
45
45
|
Enables and configures the background task manager. When enabled, agents can dispatch long-running tool calls (including subagent invocations) to run asynchronously while the agentic loop continues. Tasks are persisted, so a configured `storage` backend is required.
|
|
46
46
|
|
|
47
|
-
Visit the [Background tasks documentation](https://mastra.ai/docs/agents/background-tasks) to learn more.
|
|
47
|
+
Visit the [Background tasks documentation](https://mastra.ai/docs/long-running-agents/background-tasks) to learn more.
|
|
48
48
|
|
|
49
49
|
```typescript
|
|
50
50
|
import { Mastra } from '@mastra/core'
|
|
@@ -34,7 +34,7 @@ const response = await agent.generate('How can I reset my password?')
|
|
|
34
34
|
|
|
35
35
|
## Parameters
|
|
36
36
|
|
|
37
|
-
**id** (`string`): The ID of the agent to retrieve. Mastra first searches registered agents by
|
|
37
|
+
**id** (`string`): The ID of the agent to retrieve. Mastra first searches registered agents by agent.id. If none match, it uses this value as the agent registry key and calls getAgent().
|
|
38
38
|
|
|
39
39
|
**version** (`{ versionId: string } | { status?: 'draft' | 'published' }`): Optional version selector for retrieving a versioned agent. When provided, the method returns a promise.
|
|
40
40
|
|
|
@@ -44,9 +44,9 @@ const response = await agent.generate('How can I reset my password?')
|
|
|
44
44
|
|
|
45
45
|
## Returns
|
|
46
46
|
|
|
47
|
-
**agent** (`TAgents[TAgentName]`): The agent instance with the specified ID when
|
|
47
|
+
**agent** (`TAgents[TAgentName]`): The agent instance with the specified ID when version is omitted.
|
|
48
48
|
|
|
49
|
-
**agent** (`Promise<TAgents[TAgentName]>`): A promise that resolves to the versioned agent instance when
|
|
49
|
+
**agent** (`Promise<TAgents[TAgentName]>`): A promise that resolves to the versioned agent instance when version is provided.
|
|
50
50
|
|
|
51
51
|
Throws a `MastraError` when no agent is found by ID or registry key.
|
|
52
52
|
|
|
@@ -33,7 +33,7 @@ If you need to retrieve a workflow by its `id` property instead of its registrat
|
|
|
33
33
|
|
|
34
34
|
**id** (`TWorkflowId extends keyof TWorkflows`): The ID of the workflow to retrieve. Must be a valid workflow ID that exists in the Mastra configuration.
|
|
35
35
|
|
|
36
|
-
**options** (`{ serialized?: boolean }`): Optional configuration object. When
|
|
36
|
+
**options** (`{ serialized?: boolean }`): Optional configuration object. When serialized is true, returns only the workflow name instead of the full workflow instance.
|
|
37
37
|
|
|
38
38
|
## Returns
|
|
39
39
|
|
|
@@ -12,7 +12,7 @@ mastra.listWorkflows()
|
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
|
-
**options** (`{ serialized?: boolean }`): Optional configuration object. When
|
|
15
|
+
**options** (`{ serialized?: boolean }`): Optional configuration object. When serialized is true, returns simplified workflow objects with only the name property instead of full workflow instances.
|
|
16
16
|
|
|
17
17
|
## Returns
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ Visit the [Configuration reference](https://mastra.ai/reference/configuration) f
|
|
|
69
69
|
|
|
70
70
|
**observability** (`ObservabilityEntrypoint`): Observability configuration for tracing and monitoring
|
|
71
71
|
|
|
72
|
-
**environment** (`string`): Deployment environment name (e.g.
|
|
72
|
+
**environment** (`string`): Deployment environment name (e.g. production, staging, development). When set, automatically attached to all observability signals so they can be filtered by environment without passing tracingOptions.metadata.environment on each call. Falls back to process.env.NODE\_ENV when unset; left undefined if neither is set. Per-call tracingOptions.metadata.environment always takes precedence.
|
|
73
73
|
|
|
74
74
|
**deployer** (`MastraDeployer`): An instance of a MastraDeployer for managing deployments.
|
|
75
75
|
|
|
@@ -91,13 +91,13 @@ Visit the [Configuration reference](https://mastra.ai/reference/configuration) f
|
|
|
91
91
|
|
|
92
92
|
**notifications.dispatch** (`NotificationDispatchConfig`): Scheduled dispatch configuration for deferred notifications and notification summaries. Dispatch is enabled by default.
|
|
93
93
|
|
|
94
|
-
**notifications.dispatch.enabled** (`boolean`): Set to
|
|
94
|
+
**notifications.dispatch.enabled** (`boolean`): Set to false to opt out of automatic scheduled notification dispatch.
|
|
95
95
|
|
|
96
96
|
**notifications.dispatch.cron** (`string`): Cron schedule used by the internal notification dispatcher workflow.
|
|
97
97
|
|
|
98
98
|
**notifications.dispatch.batchSize** (`number`): Maximum number of due notification records to process per dispatch run.
|
|
99
99
|
|
|
100
|
-
**versions** (`VersionOverrides`): Global version overrides for sub-agent delegation. When a supervisor agent delegates to a sub-agent, these overrides determine which stored version of that sub-agent to use instead of the code-defined default. Requires the editor package to be configured. See
|
|
100
|
+
**versions** (`VersionOverrides`): Global version overrides for sub-agent delegation. When a supervisor agent delegates to a sub-agent, these overrides determine which stored version of that sub-agent to use instead of the code-defined default. Requires the editor package to be configured. See Sub-agent versioning for details.
|
|
101
101
|
|
|
102
102
|
**versions.agents** (`Record<string, VersionSelector>`): A map of agent IDs to their version selectors. Each selector can target a specific version by ID or by publication status.
|
|
103
103
|
|
|
@@ -14,11 +14,11 @@ await mastra.removeWorkspace('workspace-123', { destroy: true })
|
|
|
14
14
|
|
|
15
15
|
**id** (`string`): The ID of the workspace to remove.
|
|
16
16
|
|
|
17
|
-
**options** (`{ destroy?: boolean }`): Optional cleanup behavior. Set
|
|
17
|
+
**options** (`{ destroy?: boolean }`): Optional cleanup behavior. Set destroy to true to call workspace.destroy() before removing the workspace.
|
|
18
18
|
|
|
19
19
|
## Returns
|
|
20
20
|
|
|
21
|
-
**removed** (`Promise<boolean>`):
|
|
21
|
+
**removed** (`Promise<boolean>`): true when a workspace was removed. false when no workspace exists for the ID.
|
|
22
22
|
|
|
23
23
|
When `destroy` is `true` and `workspace.destroy()` throws, the call rejects with that error and the workspace remains registered so the caller can retry cleanup.
|
|
24
24
|
|
|
@@ -40,7 +40,7 @@ for (const item of comparison.items) {
|
|
|
40
40
|
|
|
41
41
|
**experimentIds** (`string[]`): Array of experiment IDs to compare. Must contain at least 2.
|
|
42
42
|
|
|
43
|
-
**baselineId** (`string`): ID of the baseline experiment. Defaults to the first ID in
|
|
43
|
+
**baselineId** (`string`): ID of the baseline experiment. Defaults to the first ID in experimentIds.
|
|
44
44
|
|
|
45
45
|
## Returns
|
|
46
46
|
|
|
@@ -38,7 +38,7 @@ for (const row of history) {
|
|
|
38
38
|
|
|
39
39
|
**result.datasetVersion** (`number`): Dataset version for this row.
|
|
40
40
|
|
|
41
|
-
**result.validTo** (`number | null`): Version at which this row was superseded, or
|
|
41
|
+
**result.validTo** (`number | null`): Version at which this row was superseded, or null if still current.
|
|
42
42
|
|
|
43
43
|
**result.isDeleted** (`boolean`): Whether this row represents a deletion.
|
|
44
44
|
|
|
@@ -36,9 +36,9 @@ const forAgents = await mastra.datasets.list({
|
|
|
36
36
|
|
|
37
37
|
## Parameters
|
|
38
38
|
|
|
39
|
-
**page** (`number`): Page number. Defaults to
|
|
39
|
+
**page** (`number`): Page number. Defaults to 0.
|
|
40
40
|
|
|
41
|
-
**perPage** (`number`): Number of datasets per page. Defaults to
|
|
41
|
+
**perPage** (`number`): Number of datasets per page. Defaults to 20.
|
|
42
42
|
|
|
43
43
|
**filters** (`object`): Optional filters applied at the storage layer.
|
|
44
44
|
|
|
@@ -52,9 +52,9 @@ const forAgents = await mastra.datasets.list({
|
|
|
52
52
|
|
|
53
53
|
**filters.targetType** (`'agent' | 'workflow' | 'scorer' | 'processor'`): Restrict to datasets targeting this component type.
|
|
54
54
|
|
|
55
|
-
**filters.targetIds** (`string[]`): Restrict to datasets whose
|
|
55
|
+
**filters.targetIds** (`string[]`): Restrict to datasets whose targetIds intersect this list (any-overlap match). Empty array is treated as no filter.
|
|
56
56
|
|
|
57
|
-
**filters.name** (`string`): Case-insensitive substring match on dataset
|
|
57
|
+
**filters.name** (`string`): Case-insensitive substring match on dataset name. Empty string is treated as no filter.
|
|
58
58
|
|
|
59
59
|
## Returns
|
|
60
60
|
|
|
@@ -62,4 +62,4 @@ const forAgents = await mastra.datasets.list({
|
|
|
62
62
|
|
|
63
63
|
**result.datasets** (`DatasetRecord[]`): Array of dataset records. See dataset.getDetails() for the record shape.
|
|
64
64
|
|
|
65
|
-
**result.pagination** (`PaginationInfo`): Pagination metadata with
|
|
65
|
+
**result.pagination** (`PaginationInfo`): Pagination metadata with total, page, perPage, and hasMore.
|
|
@@ -48,11 +48,11 @@ for (const result of results) {
|
|
|
48
48
|
|
|
49
49
|
**status** (`'needs-review' | 'reviewed' | 'complete'`): Restrict results to this per-result review status.
|
|
50
50
|
|
|
51
|
-
**filters** (`ExperimentTenancyFilters`): Multi-tenant scoping filters (
|
|
51
|
+
**filters** (`ExperimentTenancyFilters`): Multi-tenant scoping filters (organizationId, projectId). Forwarded to the storage layer.
|
|
52
52
|
|
|
53
|
-
**page** (`number`): Page number. Defaults to
|
|
53
|
+
**page** (`number`): Page number. Defaults to 0.
|
|
54
54
|
|
|
55
|
-
**perPage** (`number`): Number of results per page. Defaults to
|
|
55
|
+
**perPage** (`number`): Number of results per page. Defaults to 20.
|
|
56
56
|
|
|
57
57
|
## Returns
|
|
58
58
|
|
|
@@ -86,4 +86,4 @@ for (const result of results) {
|
|
|
86
86
|
|
|
87
87
|
**result.results.createdAt** (`Date`): When the result record was created.
|
|
88
88
|
|
|
89
|
-
**result.pagination** (`PaginationInfo`): Pagination metadata with
|
|
89
|
+
**result.pagination** (`PaginationInfo`): Pagination metadata with total, page, perPage, and hasMore.
|
|
@@ -43,11 +43,11 @@ for (const exp of experiments) {
|
|
|
43
43
|
|
|
44
44
|
**status** (`'pending' | 'running' | 'completed' | 'failed'`): Restrict results to experiments in this status.
|
|
45
45
|
|
|
46
|
-
**filters** (`ExperimentTenancyFilters`): Multi-tenant scoping filters (
|
|
46
|
+
**filters** (`ExperimentTenancyFilters`): Multi-tenant scoping filters (organizationId, projectId). Forwarded to the storage layer.
|
|
47
47
|
|
|
48
|
-
**page** (`number`): Page number. Defaults to
|
|
48
|
+
**page** (`number`): Page number. Defaults to 0.
|
|
49
49
|
|
|
50
|
-
**perPage** (`number`): Number of experiments per page. Defaults to
|
|
50
|
+
**perPage** (`number`): Number of experiments per page. Defaults to 20.
|
|
51
51
|
|
|
52
52
|
## Returns
|
|
53
53
|
|
|
@@ -89,4 +89,4 @@ for (const exp of experiments) {
|
|
|
89
89
|
|
|
90
90
|
**result.experiments.updatedAt** (`Date`): When the experiment record was last updated.
|
|
91
91
|
|
|
92
|
-
**result.pagination** (`PaginationInfo`): Pagination metadata with
|
|
92
|
+
**result.pagination** (`PaginationInfo`): Pagination metadata with total, page, perPage, and hasMore.
|
|
@@ -33,11 +33,11 @@ const versionedItems = await dataset.listItems({ version: 2 })
|
|
|
33
33
|
|
|
34
34
|
## Parameters
|
|
35
35
|
|
|
36
|
-
**version** (`number`): Dataset version to list items at. When passed on its own, returns every item at that version as a bare
|
|
36
|
+
**version** (`number`): Dataset version to list items at. When passed on its own, returns every item at that version as a bare DatasetItem\[] snapshot. Passing search / page / perPage alongside version switches to the paginated shape.
|
|
37
37
|
|
|
38
|
-
**page** (`number`): Page number for pagination. Defaults to
|
|
38
|
+
**page** (`number`): Page number for pagination. Defaults to 0.
|
|
39
39
|
|
|
40
|
-
**perPage** (`number`): Number of items per page. Defaults to
|
|
40
|
+
**perPage** (`number`): Number of items per page. Defaults to 20.
|
|
41
41
|
|
|
42
42
|
**search** (`string`): Search string to filter items.
|
|
43
43
|
|
|
@@ -45,7 +45,7 @@ const versionedItems = await dataset.listItems({ version: 2 })
|
|
|
45
45
|
|
|
46
46
|
When only `version` is provided (no `search`, `page`, or `perPage`):
|
|
47
47
|
|
|
48
|
-
**result** (`Promise<DatasetItem[]>`): Bare array of every item at the specified dataset version. This shape is retained for backwards compatibility and is deprecated — pass
|
|
48
|
+
**result** (`Promise<DatasetItem[]>`): Bare array of every item at the specified dataset version. This shape is retained for backwards compatibility and is deprecated — pass page / perPage (or search) to always receive the paginated shape below.
|
|
49
49
|
|
|
50
50
|
In all other cases (no arguments, or `search` / `page` / `perPage` provided with or without `version`):
|
|
51
51
|
|
|
@@ -59,6 +59,6 @@ In all other cases (no arguments, or `search` / `page` / `perPage` provided with
|
|
|
59
59
|
|
|
60
60
|
**result.pagination.page** (`number`): Current page number.
|
|
61
61
|
|
|
62
|
-
**result.pagination.perPage** (`number | false`): Items per page, or
|
|
62
|
+
**result.pagination.perPage** (`number | false`): Items per page, or false if unpaginated.
|
|
63
63
|
|
|
64
64
|
**result.pagination.hasMore** (`boolean`): Whether more pages are available.
|
|
@@ -26,9 +26,9 @@ for (const version of versions) {
|
|
|
26
26
|
|
|
27
27
|
## Parameters
|
|
28
28
|
|
|
29
|
-
**page** (`number`): Page number. Defaults to
|
|
29
|
+
**page** (`number`): Page number. Defaults to 0.
|
|
30
30
|
|
|
31
|
-
**perPage** (`number`): Number of versions per page. Defaults to
|
|
31
|
+
**perPage** (`number`): Number of versions per page. Defaults to 20.
|
|
32
32
|
|
|
33
33
|
## Returns
|
|
34
34
|
|
|
@@ -50,6 +50,6 @@ for (const version of versions) {
|
|
|
50
50
|
|
|
51
51
|
**result.pagination.page** (`number`): Current page number.
|
|
52
52
|
|
|
53
|
-
**result.pagination.perPage** (`number | false`): Versions per page, or
|
|
53
|
+
**result.pagination.perPage** (`number | false`): Versions per page, or false if unpaginated.
|
|
54
54
|
|
|
55
55
|
**result.pagination.hasMore** (`boolean`): Whether more pages are available.
|
|
@@ -57,11 +57,11 @@ console.log(`Status: ${summary2.status}`)
|
|
|
57
57
|
|
|
58
58
|
## Parameters
|
|
59
59
|
|
|
60
|
-
**targetType** (`'agent' | 'workflow' | 'scorer'`): Type of registered target to run items against. Use with
|
|
60
|
+
**targetType** (`'agent' | 'workflow' | 'scorer'`): Type of registered target to run items against. Use with targetId.
|
|
61
61
|
|
|
62
|
-
**targetId** (`string`): ID of the registered target. Use with
|
|
62
|
+
**targetId** (`string`): ID of the registered target. Use with targetType.
|
|
63
63
|
|
|
64
|
-
**scorers** (`(MastraScorer | string)[] | AgentScorerConfig | WorkflowScorerConfig`): Scorers to evaluate each result. Accepts a flat array of
|
|
64
|
+
**scorers** (`(MastraScorer | string)[] | AgentScorerConfig | WorkflowScorerConfig`): Scorers to evaluate each result. Accepts a flat array of MastraScorer instances or registered scorer IDs, or the same categorised config shape used by runEvals (AgentScorerConfig / WorkflowScorerConfig). Trajectory scorers (type: "trajectory") automatically receive a pre-extracted Trajectory as their output regardless of which form is used. For workflow targets, per-step scorers can be passed via scorers: { steps: { stepId: \[...] } } and run against each step's output; their results carry the originating stepId and keep targetScope: "span" (matching runEvals).
|
|
65
65
|
|
|
66
66
|
**name** (`string`): Display name for the experiment.
|
|
67
67
|
|
|
@@ -71,13 +71,13 @@ console.log(`Status: ${summary2.status}`)
|
|
|
71
71
|
|
|
72
72
|
**version** (`number`): Pin to a specific dataset version. Defaults to the latest version.
|
|
73
73
|
|
|
74
|
-
**maxConcurrency** (`number`): Maximum concurrent item executions. Defaults to
|
|
74
|
+
**maxConcurrency** (`number`): Maximum concurrent item executions. Defaults to 5.
|
|
75
75
|
|
|
76
76
|
**signal** (`AbortSignal`): AbortSignal for cancelling the experiment.
|
|
77
77
|
|
|
78
78
|
**itemTimeout** (`number`): Per-item execution timeout in milliseconds.
|
|
79
79
|
|
|
80
|
-
**maxRetries** (`number`): Maximum retries per item on failure. Defaults to
|
|
80
|
+
**maxRetries** (`number`): Maximum retries per item on failure. Defaults to 0 (no retries). Abort errors are never retried.
|
|
81
81
|
|
|
82
82
|
## Returns
|
|
83
83
|
|
|
@@ -95,7 +95,7 @@ console.log(`Status: ${summary2.status}`)
|
|
|
95
95
|
|
|
96
96
|
**result.skippedCount** (`number`): Number of items skipped (e.g., due to abort).
|
|
97
97
|
|
|
98
|
-
**result.completedWithErrors** (`boolean`):
|
|
98
|
+
**result.completedWithErrors** (`boolean`): true if the run completed but some items failed.
|
|
99
99
|
|
|
100
100
|
**result.startedAt** (`Date`): When the experiment started.
|
|
101
101
|
|
|
@@ -109,7 +109,7 @@ console.log(`Status: ${summary2.status}`)
|
|
|
109
109
|
|
|
110
110
|
**result.results.input** (`unknown`): Input data passed to the target.
|
|
111
111
|
|
|
112
|
-
**result.results.output** (`unknown | null`): Output from the target, or
|
|
112
|
+
**result.results.output** (`unknown | null`): Output from the target, or null if failed.
|
|
113
113
|
|
|
114
114
|
**result.results.groundTruth** (`unknown | null`): Expected output from the dataset item.
|
|
115
115
|
|
|
@@ -127,7 +127,7 @@ console.log(`Status: ${summary2.status}`)
|
|
|
127
127
|
|
|
128
128
|
**result.results.scores.scorerName** (`string`): Display name of the scorer.
|
|
129
129
|
|
|
130
|
-
**result.results.scores.score** (`number | null`): Computed score, or
|
|
130
|
+
**result.results.scores.score** (`number | null`): Computed score, or null if the scorer failed.
|
|
131
131
|
|
|
132
132
|
**result.results.scores.reason** (`string | null`): Reason/explanation for the score.
|
|
133
133
|
|
|
@@ -41,7 +41,7 @@ Takes the same `StartExperimentConfig` as [`dataset.startExperiment()`](https://
|
|
|
41
41
|
|
|
42
42
|
**result.experimentId** (`string`): Unique ID of the created experiment.
|
|
43
43
|
|
|
44
|
-
**result.status** (`'pending'`): Always
|
|
44
|
+
**result.status** (`'pending'`): Always 'pending' since the experiment hasn't started executing yet.
|
|
45
45
|
|
|
46
46
|
## Related
|
|
47
47
|
|
|
@@ -38,9 +38,9 @@ new MastraEditor({
|
|
|
38
38
|
|
|
39
39
|
## Properties
|
|
40
40
|
|
|
41
|
-
**enabled** (`boolean`): Master switch. When false, the Builder UI is disabled and
|
|
41
|
+
**enabled** (`boolean`): Master switch. When false, the Builder UI is disabled and MastraEditor.resolveBuilder() returns undefined. (Default: `true`)
|
|
42
42
|
|
|
43
|
-
**features** (`{ agent?: AgentFeatures }`): UI toggles. Each key on
|
|
43
|
+
**features** (`{ agent?: AgentFeatures }`): UI toggles. Each key on features.agent defaults to true when omitted.
|
|
44
44
|
|
|
45
45
|
**features.agent.tools** (`boolean`): Show the tools tab in the agent editor.
|
|
46
46
|
|
|
@@ -54,7 +54,7 @@ new MastraEditor({
|
|
|
54
54
|
|
|
55
55
|
**features.agent.model** (`boolean`): Show the model picker in the agent editor. When false, the admin-pinned default model applies.
|
|
56
56
|
|
|
57
|
-
**features.agent.browser** (`boolean`): Show the browser tab. Resolves to true only when a valid browser provider is registered on
|
|
57
|
+
**features.agent.browser** (`boolean`): Show the browser tab. Resolves to true only when a valid browser provider is registered on MastraEditor.browsers; otherwise it is downgraded to false and a warning is logged.
|
|
58
58
|
|
|
59
59
|
**features.agent.avatarUpload** (`boolean`): Allow end users to upload an avatar for stored agents.
|
|
60
60
|
|
|
@@ -66,7 +66,7 @@ new MastraEditor({
|
|
|
66
66
|
|
|
67
67
|
**registries.skillsSh** (`{ enabled: boolean }`): Enable the skills.sh registry. When enabled, the Builder shows registry browse UI for skills.sh skills.
|
|
68
68
|
|
|
69
|
-
**registries.skillsSh.enabled** (`boolean`): Set to
|
|
69
|
+
**registries.skillsSh.enabled** (`boolean`): Set to true to opt in. Defaults to false.
|
|
70
70
|
|
|
71
71
|
## Related
|
|
72
72
|
|