@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.
- package/.docs/docs/agents/agent-approval.md +61 -31
- package/.docs/docs/agents/supervisor-agents.md +1 -1
- package/.docs/docs/getting-started/manual-install.md +1 -1
- package/.docs/docs/index.md +68 -24
- package/.docs/docs/mastra-cloud/setup.md +1 -1
- package/.docs/docs/memory/observational-memory.md +9 -0
- package/.docs/docs/memory/semantic-recall.md +17 -1
- package/.docs/docs/workspace/skills.md +7 -5
- package/.docs/guides/deployment/aws-lambda.md +76 -165
- package/.docs/guides/deployment/azure-app-services.md +38 -61
- package/.docs/guides/deployment/cloudflare.md +1 -1
- package/.docs/guides/deployment/netlify.md +1 -1
- package/.docs/guides/deployment/vercel.md +1 -1
- package/.docs/models/gateways/netlify.md +5 -1
- package/.docs/models/index.md +1 -1
- package/.docs/models/providers/anthropic.md +9 -9
- package/.docs/models/providers/deepseek.md +1 -1
- package/.docs/models/providers/google.md +11 -11
- package/.docs/models/providers/openai.md +19 -19
- package/.docs/models/providers/opencode.md +33 -33
- package/.docs/models/providers/xai.md +3 -3
- package/.docs/reference/agents/agent.md +20 -20
- package/.docs/reference/agents/generate.md +200 -66
- package/.docs/reference/agents/generateLegacy.md +77 -35
- package/.docs/reference/agents/getDefaultGenerateOptions.md +4 -6
- package/.docs/reference/agents/getDefaultOptions.md +4 -6
- package/.docs/reference/agents/getDefaultStreamOptions.md +4 -6
- package/.docs/reference/agents/getDescription.md +1 -1
- package/.docs/reference/agents/getInstructions.md +4 -6
- package/.docs/reference/agents/getLLM.md +6 -8
- package/.docs/reference/agents/getMemory.md +4 -6
- package/.docs/reference/agents/getModel.md +4 -6
- package/.docs/reference/agents/getTools.md +5 -7
- package/.docs/reference/agents/getVoice.md +4 -6
- package/.docs/reference/agents/listAgents.md +4 -6
- package/.docs/reference/agents/listScorers.md +4 -6
- package/.docs/reference/agents/listTools.md +4 -6
- package/.docs/reference/agents/listWorkflows.md +4 -6
- package/.docs/reference/agents/network.md +69 -23
- package/.docs/reference/ai-sdk/chat-route.md +7 -7
- package/.docs/reference/ai-sdk/handle-chat-stream.md +12 -12
- package/.docs/reference/ai-sdk/handle-network-stream.md +4 -4
- package/.docs/reference/ai-sdk/handle-workflow-stream.md +11 -11
- package/.docs/reference/ai-sdk/network-route.md +3 -3
- package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +9 -9
- package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +9 -9
- package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +5 -5
- package/.docs/reference/ai-sdk/with-mastra.md +12 -12
- package/.docs/reference/ai-sdk/workflow-route.md +3 -3
- package/.docs/reference/auth/auth0.md +6 -6
- package/.docs/reference/auth/better-auth.md +5 -5
- package/.docs/reference/auth/clerk.md +5 -5
- package/.docs/reference/auth/firebase.md +7 -7
- package/.docs/reference/auth/jwt.md +1 -1
- package/.docs/reference/auth/supabase.md +4 -4
- package/.docs/reference/auth/workos.md +6 -6
- package/.docs/reference/cli/create-mastra.md +14 -14
- package/.docs/reference/client-js/mastra-client.md +23 -23
- package/.docs/reference/client-js/workflows.md +3 -3
- package/.docs/reference/core/addGateway.md +2 -2
- package/.docs/reference/core/getAgent.md +2 -2
- package/.docs/reference/core/getAgentById.md +2 -2
- package/.docs/reference/core/getDeployer.md +1 -1
- package/.docs/reference/core/getGateway.md +2 -2
- package/.docs/reference/core/getGatewayById.md +2 -2
- package/.docs/reference/core/getLogger.md +1 -1
- package/.docs/reference/core/getMCPServer.md +2 -2
- package/.docs/reference/core/getMCPServerById.md +3 -3
- package/.docs/reference/core/getMemory.md +2 -2
- package/.docs/reference/core/getScorer.md +2 -2
- package/.docs/reference/core/getScorerById.md +2 -2
- package/.docs/reference/core/getServer.md +1 -1
- package/.docs/reference/core/getStorage.md +1 -1
- package/.docs/reference/core/getStoredAgentById.md +18 -20
- package/.docs/reference/core/getTelemetry.md +1 -1
- package/.docs/reference/core/getVector.md +2 -2
- package/.docs/reference/core/getWorkflow.md +3 -3
- package/.docs/reference/core/listAgents.md +1 -1
- package/.docs/reference/core/listGateways.md +1 -1
- package/.docs/reference/core/listLogs.md +9 -11
- package/.docs/reference/core/listLogsByRunId.md +9 -9
- package/.docs/reference/core/listMCPServers.md +1 -1
- package/.docs/reference/core/listMemory.md +1 -1
- package/.docs/reference/core/listScorers.md +1 -1
- package/.docs/reference/core/listStoredAgents.md +9 -11
- package/.docs/reference/core/listVectors.md +1 -1
- package/.docs/reference/core/listWorkflows.md +2 -2
- package/.docs/reference/core/mastra-class.md +17 -17
- package/.docs/reference/core/mastra-model-gateway.md +15 -15
- package/.docs/reference/core/setLogger.md +2 -4
- package/.docs/reference/core/setStorage.md +1 -1
- package/.docs/reference/datasets/addItem.md +20 -4
- package/.docs/reference/datasets/addItems.md +8 -2
- package/.docs/reference/datasets/compareExperiments.md +15 -3
- package/.docs/reference/datasets/create.md +6 -6
- package/.docs/reference/datasets/dataset.md +1 -1
- package/.docs/reference/datasets/delete.md +2 -2
- package/.docs/reference/datasets/deleteExperiment.md +2 -2
- package/.docs/reference/datasets/deleteItem.md +2 -2
- package/.docs/reference/datasets/deleteItems.md +2 -2
- package/.docs/reference/datasets/get.md +2 -2
- package/.docs/reference/datasets/getDetails.md +9 -9
- package/.docs/reference/datasets/getExperiment.md +2 -2
- package/.docs/reference/datasets/getItem.md +3 -3
- package/.docs/reference/datasets/getItemHistory.md +22 -2
- package/.docs/reference/datasets/list.md +7 -3
- package/.docs/reference/datasets/listExperimentResults.md +34 -4
- package/.docs/reference/datasets/listExperiments.md +41 -3
- package/.docs/reference/datasets/listItems.md +18 -6
- package/.docs/reference/datasets/listVersions.md +23 -3
- package/.docs/reference/datasets/startExperiment.md +62 -12
- package/.docs/reference/datasets/startExperimentAsync.md +5 -1
- package/.docs/reference/datasets/update.md +6 -6
- package/.docs/reference/datasets/updateItem.md +5 -5
- package/.docs/reference/deployer.md +8 -8
- package/.docs/reference/evals/answer-relevancy.md +11 -11
- package/.docs/reference/evals/answer-similarity.md +17 -19
- package/.docs/reference/evals/bias.md +10 -10
- package/.docs/reference/evals/completeness.md +3 -3
- package/.docs/reference/evals/content-similarity.md +6 -6
- package/.docs/reference/evals/context-precision.md +4 -4
- package/.docs/reference/evals/context-relevance.md +4 -4
- package/.docs/reference/evals/create-scorer.md +47 -49
- package/.docs/reference/evals/faithfulness.md +11 -11
- package/.docs/reference/evals/hallucination.md +17 -21
- package/.docs/reference/evals/keyword-coverage.md +4 -4
- package/.docs/reference/evals/mastra-scorer.md +14 -14
- package/.docs/reference/evals/noise-sensitivity.md +4 -4
- package/.docs/reference/evals/prompt-alignment.md +4 -4
- package/.docs/reference/evals/run-evals.md +16 -16
- package/.docs/reference/evals/scorer-utils.md +3 -3
- package/.docs/reference/evals/textual-difference.md +3 -3
- package/.docs/reference/evals/tone-consistency.md +3 -3
- package/.docs/reference/evals/tool-call-accuracy.md +5 -5
- package/.docs/reference/evals/toxicity.md +8 -8
- package/.docs/reference/harness/harness-class.md +34 -42
- package/.docs/reference/logging/pino-logger.md +5 -5
- package/.docs/reference/memory/clone-utilities.md +5 -5
- package/.docs/reference/memory/cloneThread.md +17 -21
- package/.docs/reference/memory/createThread.md +10 -10
- package/.docs/reference/memory/deleteMessages.md +2 -2
- package/.docs/reference/memory/getThreadById.md +2 -2
- package/.docs/reference/memory/listThreads.md +5 -5
- package/.docs/reference/memory/memory-class.md +12 -14
- package/.docs/reference/memory/observational-memory.md +102 -94
- package/.docs/reference/memory/recall.md +14 -16
- package/.docs/reference/observability/tracing/configuration.md +27 -10
- package/.docs/reference/observability/tracing/exporters/console-exporter.md +4 -7
- package/.docs/reference/processors/batch-parts-processor.md +8 -10
- package/.docs/reference/processors/language-detector.md +14 -16
- package/.docs/reference/processors/message-history-processor.md +7 -9
- package/.docs/reference/processors/moderation-processor.md +13 -15
- package/.docs/reference/processors/pii-detector.md +14 -16
- package/.docs/reference/processors/processor-interface.md +62 -62
- package/.docs/reference/processors/prompt-injection-detector.md +11 -13
- package/.docs/reference/processors/semantic-recall-processor.md +14 -16
- package/.docs/reference/processors/system-prompt-scrubber.md +12 -14
- package/.docs/reference/processors/token-limiter-processor.md +11 -13
- package/.docs/reference/processors/tool-call-filter.md +5 -7
- package/.docs/reference/processors/tool-search-processor.md +9 -11
- package/.docs/reference/processors/unicode-normalizer.md +8 -10
- package/.docs/reference/processors/working-memory-processor.md +14 -18
- package/.docs/reference/rag/chunk.md +38 -38
- package/.docs/reference/rag/database-config.md +11 -7
- package/.docs/reference/rag/document.md +2 -2
- package/.docs/reference/rag/embeddings.md +12 -12
- package/.docs/reference/rag/extract-params.md +23 -23
- package/.docs/reference/rag/graph-rag.md +12 -12
- package/.docs/reference/rag/rerank.md +25 -17
- package/.docs/reference/rag/rerankWithScorer.md +25 -17
- package/.docs/reference/server/create-route.md +14 -14
- package/.docs/reference/server/express-adapter.md +10 -10
- package/.docs/reference/server/fastify-adapter.md +10 -10
- package/.docs/reference/server/hono-adapter.md +10 -10
- package/.docs/reference/server/koa-adapter.md +10 -10
- package/.docs/reference/server/mastra-server.md +10 -10
- package/.docs/reference/server/register-api-route.md +13 -13
- package/.docs/reference/storage/cloudflare-d1.md +5 -5
- package/.docs/reference/storage/cloudflare.md +6 -6
- package/.docs/reference/storage/composite.md +9 -9
- package/.docs/reference/storage/convex.md +3 -3
- package/.docs/reference/storage/dynamodb.md +9 -9
- package/.docs/reference/storage/lance.md +3 -3
- package/.docs/reference/storage/libsql.md +2 -2
- package/.docs/reference/storage/mongodb.md +5 -5
- package/.docs/reference/storage/mssql.md +2 -2
- package/.docs/reference/storage/postgresql.md +25 -25
- package/.docs/reference/storage/upstash.md +3 -3
- package/.docs/reference/streaming/ChunkType.md +251 -59
- package/.docs/reference/streaming/agents/MastraModelOutput.md +86 -16
- package/.docs/reference/streaming/agents/stream.md +155 -43
- package/.docs/reference/streaming/agents/streamLegacy.md +79 -39
- package/.docs/reference/streaming/workflows/resumeStream.md +18 -8
- package/.docs/reference/streaming/workflows/stream.md +21 -9
- package/.docs/reference/streaming/workflows/timeTravelStream.md +4 -4
- package/.docs/reference/tools/create-tool.md +25 -21
- package/.docs/reference/tools/document-chunker-tool.md +7 -7
- package/.docs/reference/tools/graph-rag-tool.md +16 -18
- package/.docs/reference/tools/mcp-client.md +38 -27
- package/.docs/reference/tools/mcp-server.md +45 -45
- package/.docs/reference/tools/vector-query-tool.md +34 -22
- package/.docs/reference/vectors/astra.md +22 -22
- package/.docs/reference/vectors/chroma.md +44 -44
- package/.docs/reference/vectors/convex.md +26 -26
- package/.docs/reference/vectors/couchbase.md +30 -30
- package/.docs/reference/vectors/duckdb.md +29 -29
- package/.docs/reference/vectors/elasticsearch.md +27 -27
- package/.docs/reference/vectors/lance.md +46 -38
- package/.docs/reference/vectors/libsql.md +31 -31
- package/.docs/reference/vectors/mongodb.md +32 -32
- package/.docs/reference/vectors/opensearch.md +27 -27
- package/.docs/reference/vectors/pg.md +60 -44
- package/.docs/reference/vectors/pinecone.md +38 -38
- package/.docs/reference/vectors/qdrant.md +36 -36
- package/.docs/reference/vectors/s3vectors.md +24 -24
- package/.docs/reference/vectors/turbopuffer.md +29 -29
- package/.docs/reference/vectors/upstash.md +25 -25
- package/.docs/reference/vectors/vectorize.md +27 -27
- package/.docs/reference/voice/azure.md +19 -15
- package/.docs/reference/voice/cloudflare.md +10 -12
- package/.docs/reference/voice/composite-voice.md +10 -10
- package/.docs/reference/voice/deepgram.md +20 -14
- package/.docs/reference/voice/elevenlabs.md +20 -22
- package/.docs/reference/voice/google-gemini-live.md +42 -44
- package/.docs/reference/voice/google.md +25 -21
- package/.docs/reference/voice/mastra-voice.md +20 -20
- package/.docs/reference/voice/murf.md +24 -28
- package/.docs/reference/voice/openai-realtime.md +26 -26
- package/.docs/reference/voice/openai.md +14 -12
- package/.docs/reference/voice/playai.md +13 -15
- package/.docs/reference/voice/sarvam.md +21 -25
- package/.docs/reference/voice/speechify.md +11 -13
- package/.docs/reference/voice/voice.addInstructions.md +1 -1
- package/.docs/reference/voice/voice.addTools.md +1 -1
- package/.docs/reference/voice/voice.answer.md +1 -1
- package/.docs/reference/voice/voice.connect.md +3 -3
- package/.docs/reference/voice/voice.events.md +11 -11
- package/.docs/reference/voice/voice.getSpeakers.md +30 -30
- package/.docs/reference/voice/voice.listen.md +9 -9
- package/.docs/reference/voice/voice.off.md +2 -2
- package/.docs/reference/voice/voice.on.md +2 -2
- package/.docs/reference/voice/voice.send.md +1 -1
- package/.docs/reference/voice/voice.speak.md +11 -11
- package/.docs/reference/voice/voice.updateConfig.md +3 -3
- package/.docs/reference/workflows/run-methods/cancel.md +2 -2
- package/.docs/reference/workflows/run-methods/restart.md +17 -5
- package/.docs/reference/workflows/run-methods/resume.md +23 -9
- package/.docs/reference/workflows/run-methods/start.md +22 -8
- package/.docs/reference/workflows/run-methods/startAsync.md +12 -6
- package/.docs/reference/workflows/run-methods/timeTravel.md +29 -13
- package/.docs/reference/workflows/run.md +12 -12
- package/.docs/reference/workflows/step.md +24 -26
- package/.docs/reference/workflows/workflow-methods/branch.md +2 -2
- package/.docs/reference/workflows/workflow-methods/commit.md +1 -1
- package/.docs/reference/workflows/workflow-methods/create-run.md +4 -4
- package/.docs/reference/workflows/workflow-methods/dountil.md +3 -3
- package/.docs/reference/workflows/workflow-methods/dowhile.md +3 -3
- package/.docs/reference/workflows/workflow-methods/foreach.md +9 -9
- package/.docs/reference/workflows/workflow-methods/map.md +2 -2
- package/.docs/reference/workflows/workflow-methods/parallel.md +2 -2
- package/.docs/reference/workflows/workflow-methods/sleep.md +2 -2
- package/.docs/reference/workflows/workflow-methods/sleepUntil.md +2 -2
- package/.docs/reference/workflows/workflow-methods/then.md +2 -2
- package/.docs/reference/workflows/workflow.md +40 -50
- package/.docs/reference/workspace/daytona-sandbox.md +33 -33
- package/.docs/reference/workspace/e2b-sandbox.md +20 -20
- package/.docs/reference/workspace/filesystem.md +22 -22
- package/.docs/reference/workspace/gcs-filesystem.md +15 -15
- package/.docs/reference/workspace/local-filesystem.md +35 -35
- package/.docs/reference/workspace/local-sandbox.md +26 -26
- package/.docs/reference/workspace/s3-filesystem.md +18 -18
- package/.docs/reference/workspace/sandbox.md +8 -8
- package/.docs/reference/workspace/workspace-class.md +30 -34
- package/CHANGELOG.md +16 -0
- package/package.json +6 -6
- package/.docs/docs/getting-started/start.md +0 -28
|
@@ -18,8 +18,8 @@ await mastra.datasets.delete({ id: 'dataset-id' })
|
|
|
18
18
|
|
|
19
19
|
## Parameters
|
|
20
20
|
|
|
21
|
-
**id
|
|
21
|
+
**id** (`string`): ID of the dataset to delete.
|
|
22
22
|
|
|
23
23
|
## Returns
|
|
24
24
|
|
|
25
|
-
**result
|
|
25
|
+
**result** (`Promise<void>`): Resolves when the dataset is deleted.
|
|
@@ -20,8 +20,8 @@ await dataset.deleteExperiment({ experimentId: 'exp-id' })
|
|
|
20
20
|
|
|
21
21
|
## Parameters
|
|
22
22
|
|
|
23
|
-
**experimentId
|
|
23
|
+
**experimentId** (`string`): ID of the experiment to delete.
|
|
24
24
|
|
|
25
25
|
## Returns
|
|
26
26
|
|
|
27
|
-
**result
|
|
27
|
+
**result** (`Promise<void>`): Resolves when the experiment and its results are deleted.
|
|
@@ -20,8 +20,8 @@ await dataset.deleteItem({ itemId: 'item-id' })
|
|
|
20
20
|
|
|
21
21
|
## Parameters
|
|
22
22
|
|
|
23
|
-
**itemId
|
|
23
|
+
**itemId** (`string`): ID of the item to delete.
|
|
24
24
|
|
|
25
25
|
## Returns
|
|
26
26
|
|
|
27
|
-
**result
|
|
27
|
+
**result** (`Promise<void>`): Resolves when the item is deleted.
|
|
@@ -22,8 +22,8 @@ await dataset.deleteItems({
|
|
|
22
22
|
|
|
23
23
|
## Parameters
|
|
24
24
|
|
|
25
|
-
**itemIds
|
|
25
|
+
**itemIds** (`string[]`): Array of item IDs to delete.
|
|
26
26
|
|
|
27
27
|
## Returns
|
|
28
28
|
|
|
29
|
-
**result
|
|
29
|
+
**result** (`Promise<void>`): Resolves when all items are deleted.
|
|
@@ -22,10 +22,10 @@ console.log(details.name)
|
|
|
22
22
|
|
|
23
23
|
## Parameters
|
|
24
24
|
|
|
25
|
-
**id
|
|
25
|
+
**id** (`string`): Unique identifier of the dataset.
|
|
26
26
|
|
|
27
27
|
## Returns
|
|
28
28
|
|
|
29
29
|
Throws `MastraError` if the dataset is not found.
|
|
30
30
|
|
|
31
|
-
**result
|
|
31
|
+
**result** (`Promise<Dataset>`): A Dataset instance.
|
|
@@ -28,20 +28,20 @@ This method takes no parameters.
|
|
|
28
28
|
|
|
29
29
|
Returns a `Promise<DatasetRecord>`. Throws `MastraError` if the dataset is not found.
|
|
30
30
|
|
|
31
|
-
**id
|
|
31
|
+
**id** (`string`): Unique identifier of the dataset.
|
|
32
32
|
|
|
33
|
-
**name
|
|
33
|
+
**name** (`string`): Display name of the dataset.
|
|
34
34
|
|
|
35
|
-
**description
|
|
35
|
+
**description** (`string`): Description of the dataset.
|
|
36
36
|
|
|
37
|
-
**metadata
|
|
37
|
+
**metadata** (`Record<string, unknown>`): Arbitrary metadata associated with the dataset.
|
|
38
38
|
|
|
39
|
-
**inputSchema
|
|
39
|
+
**inputSchema** (`Record<string, unknown>`): JSON Schema for item inputs.
|
|
40
40
|
|
|
41
|
-
**groundTruthSchema
|
|
41
|
+
**groundTruthSchema** (`Record<string, unknown>`): JSON Schema for item ground truths.
|
|
42
42
|
|
|
43
|
-
**version
|
|
43
|
+
**version** (`number`): Current version number of the dataset.
|
|
44
44
|
|
|
45
|
-
**createdAt
|
|
45
|
+
**createdAt** (`Date`): When the dataset was created.
|
|
46
46
|
|
|
47
|
-
**updatedAt
|
|
47
|
+
**updatedAt** (`Date`): When the dataset was last updated.
|
|
@@ -23,8 +23,8 @@ console.log(`${experiment.succeededCount}/${experiment.totalItems} succeeded`)
|
|
|
23
23
|
|
|
24
24
|
## Parameters
|
|
25
25
|
|
|
26
|
-
**experimentId
|
|
26
|
+
**experimentId** (`string`): ID of the experiment to retrieve.
|
|
27
27
|
|
|
28
28
|
## Returns
|
|
29
29
|
|
|
30
|
-
**result
|
|
30
|
+
**result** (`Promise<Experiment>`): The experiment record. See dataset.listExperiments() for the full shape.
|
|
@@ -24,10 +24,10 @@ const versionedItem = await dataset.getItem({ itemId: 'item-id', version: 2 })
|
|
|
24
24
|
|
|
25
25
|
## Parameters
|
|
26
26
|
|
|
27
|
-
**itemId
|
|
27
|
+
**itemId** (`string`): The unique identifier of the item.
|
|
28
28
|
|
|
29
|
-
**version
|
|
29
|
+
**version** (`number`): Dataset version to retrieve the item at. Defaults to the latest version.
|
|
30
30
|
|
|
31
31
|
## Returns
|
|
32
32
|
|
|
33
|
-
**result
|
|
33
|
+
**result** (`Promise<DatasetItem | null>`): The dataset item, or null if not found. See dataset.addItem() for the item shape.
|
|
@@ -24,8 +24,28 @@ for (const row of history) {
|
|
|
24
24
|
|
|
25
25
|
## Parameters
|
|
26
26
|
|
|
27
|
-
**itemId
|
|
27
|
+
**itemId** (`string`): ID of the item to retrieve history for.
|
|
28
28
|
|
|
29
29
|
## Returns
|
|
30
30
|
|
|
31
|
-
**result
|
|
31
|
+
**result** (`Promise<DatasetItemRow[]>`): Array of versioned item rows, ordered by version.
|
|
32
|
+
|
|
33
|
+
**result.id** (`string`): Unique row identifier.
|
|
34
|
+
|
|
35
|
+
**result.datasetId** (`string`): ID of the parent dataset.
|
|
36
|
+
|
|
37
|
+
**result.datasetVersion** (`number`): Dataset version for this row.
|
|
38
|
+
|
|
39
|
+
**result.validTo** (`number | null`): Version at which this row was superseded, or \`null\` if still current.
|
|
40
|
+
|
|
41
|
+
**result.isDeleted** (`boolean`): Whether this row represents a deletion.
|
|
42
|
+
|
|
43
|
+
**result.input** (`unknown`): Input data at this version.
|
|
44
|
+
|
|
45
|
+
**result.groundTruth** (`unknown`): Ground truth at this version.
|
|
46
|
+
|
|
47
|
+
**result.metadata** (`Record<string, unknown>`): Metadata at this version.
|
|
48
|
+
|
|
49
|
+
**result.createdAt** (`Date`): When this row was created.
|
|
50
|
+
|
|
51
|
+
**result.updatedAt** (`Date`): When this row was last updated.
|
|
@@ -22,10 +22,14 @@ for (const ds of datasets) {
|
|
|
22
22
|
|
|
23
23
|
## Parameters
|
|
24
24
|
|
|
25
|
-
**page
|
|
25
|
+
**page** (`number`): Page number. Defaults to \`0\`.
|
|
26
26
|
|
|
27
|
-
**perPage
|
|
27
|
+
**perPage** (`number`): Number of datasets per page. Defaults to \`20\`.
|
|
28
28
|
|
|
29
29
|
## Returns
|
|
30
30
|
|
|
31
|
-
**result
|
|
31
|
+
**result** (`Promise<object>`): Paginated dataset list.
|
|
32
|
+
|
|
33
|
+
**result.datasets** (`DatasetRecord[]`): Array of dataset records. See dataset.getDetails() for the record shape.
|
|
34
|
+
|
|
35
|
+
**result.pagination** (`PaginationInfo`): Pagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
|
|
@@ -28,12 +28,42 @@ for (const result of results) {
|
|
|
28
28
|
|
|
29
29
|
## Parameters
|
|
30
30
|
|
|
31
|
-
**experimentId
|
|
31
|
+
**experimentId** (`string`): ID of the experiment to list results for.
|
|
32
32
|
|
|
33
|
-
**page
|
|
33
|
+
**page** (`number`): Page number. Defaults to \`0\`.
|
|
34
34
|
|
|
35
|
-
**perPage
|
|
35
|
+
**perPage** (`number`): Number of results per page. Defaults to \`20\`.
|
|
36
36
|
|
|
37
37
|
## Returns
|
|
38
38
|
|
|
39
|
-
**result
|
|
39
|
+
**result** (`Promise<object>`): Paginated experiment results.
|
|
40
|
+
|
|
41
|
+
**result.results** (`ExperimentResult[]`): Array of item-level results.
|
|
42
|
+
|
|
43
|
+
**result.results.id** (`string`): Unique result ID.
|
|
44
|
+
|
|
45
|
+
**result.results.experimentId** (`string`): ID of the parent experiment.
|
|
46
|
+
|
|
47
|
+
**result.results.itemId** (`string`): ID of the dataset item.
|
|
48
|
+
|
|
49
|
+
**result.results.itemDatasetVersion** (`number | null`): Dataset version of the item when executed.
|
|
50
|
+
|
|
51
|
+
**result.results.input** (`unknown`): Input data passed to the target.
|
|
52
|
+
|
|
53
|
+
**result.results.output** (`unknown | null`): Output from the target.
|
|
54
|
+
|
|
55
|
+
**result.results.groundTruth** (`unknown | null`): Expected output.
|
|
56
|
+
|
|
57
|
+
**result.results.error** (`{ message: string; stack?: string; code?: string } | null`): Structured error if execution failed.
|
|
58
|
+
|
|
59
|
+
**result.results.startedAt** (`Date`): When execution started.
|
|
60
|
+
|
|
61
|
+
**result.results.completedAt** (`Date`): When execution completed.
|
|
62
|
+
|
|
63
|
+
**result.results.retryCount** (`number`): Number of retry attempts.
|
|
64
|
+
|
|
65
|
+
**result.results.traceId** (`string | null`): Trace ID for observability.
|
|
66
|
+
|
|
67
|
+
**result.results.createdAt** (`Date`): When the result record was created.
|
|
68
|
+
|
|
69
|
+
**result.pagination** (`PaginationInfo`): Pagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
|
|
@@ -24,10 +24,48 @@ for (const exp of experiments) {
|
|
|
24
24
|
|
|
25
25
|
## Parameters
|
|
26
26
|
|
|
27
|
-
**page
|
|
27
|
+
**page** (`number`): Page number. Defaults to \`0\`.
|
|
28
28
|
|
|
29
|
-
**perPage
|
|
29
|
+
**perPage** (`number`): Number of experiments per page. Defaults to \`20\`.
|
|
30
30
|
|
|
31
31
|
## Returns
|
|
32
32
|
|
|
33
|
-
**result
|
|
33
|
+
**result** (`Promise<object>`): Paginated experiment list.
|
|
34
|
+
|
|
35
|
+
**result.experiments** (`Experiment[]`): Array of experiment records.
|
|
36
|
+
|
|
37
|
+
**result.experiments.id** (`string`): Unique experiment ID.
|
|
38
|
+
|
|
39
|
+
**result.experiments.name** (`string`): Display name.
|
|
40
|
+
|
|
41
|
+
**result.experiments.description** (`string`): Description.
|
|
42
|
+
|
|
43
|
+
**result.experiments.metadata** (`Record<string, unknown>`): Arbitrary metadata.
|
|
44
|
+
|
|
45
|
+
**result.experiments.datasetId** (`string`): ID of the parent dataset.
|
|
46
|
+
|
|
47
|
+
**result.experiments.datasetVersion** (`number | null`): Dataset version used for the experiment.
|
|
48
|
+
|
|
49
|
+
**result.experiments.targetType** (`'agent' | 'workflow' | 'scorer' | 'processor'`): Type of target used.
|
|
50
|
+
|
|
51
|
+
**result.experiments.targetId** (`string`): ID of the target used.
|
|
52
|
+
|
|
53
|
+
**result.experiments.status** (`'pending' | 'running' | 'completed' | 'failed'`): Current status of the experiment.
|
|
54
|
+
|
|
55
|
+
**result.experiments.totalItems** (`number`): Total number of items.
|
|
56
|
+
|
|
57
|
+
**result.experiments.succeededCount** (`number`): Number of successful items.
|
|
58
|
+
|
|
59
|
+
**result.experiments.failedCount** (`number`): Number of failed items.
|
|
60
|
+
|
|
61
|
+
**result.experiments.skippedCount** (`number`): Number of skipped items.
|
|
62
|
+
|
|
63
|
+
**result.experiments.startedAt** (`Date | null`): When the experiment started.
|
|
64
|
+
|
|
65
|
+
**result.experiments.completedAt** (`Date | null`): When the experiment completed.
|
|
66
|
+
|
|
67
|
+
**result.experiments.createdAt** (`Date`): When the experiment record was created.
|
|
68
|
+
|
|
69
|
+
**result.experiments.updatedAt** (`Date`): When the experiment record was last updated.
|
|
70
|
+
|
|
71
|
+
**result.pagination** (`PaginationInfo`): Pagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
|
|
@@ -27,20 +27,32 @@ const versionedItems = await dataset.listItems({ version: 2 })
|
|
|
27
27
|
|
|
28
28
|
## Parameters
|
|
29
29
|
|
|
30
|
-
**version
|
|
30
|
+
**version** (`number`): Dataset version to list items at. When set, returns all items at that version (no pagination).
|
|
31
31
|
|
|
32
|
-
**page
|
|
32
|
+
**page** (`number`): Page number for pagination. Defaults to \`0\`.
|
|
33
33
|
|
|
34
|
-
**perPage
|
|
34
|
+
**perPage** (`number`): Number of items per page. Defaults to \`20\`.
|
|
35
35
|
|
|
36
|
-
**search
|
|
36
|
+
**search** (`string`): Search string to filter items.
|
|
37
37
|
|
|
38
38
|
## Returns
|
|
39
39
|
|
|
40
40
|
When `version` is specified:
|
|
41
41
|
|
|
42
|
-
**result
|
|
42
|
+
**result** (`Promise<DatasetItem[]>`): Array of all items at the specified dataset version.
|
|
43
43
|
|
|
44
44
|
When `version` is not specified:
|
|
45
45
|
|
|
46
|
-
**result
|
|
46
|
+
**result** (`Promise<object>`): Paginated response.
|
|
47
|
+
|
|
48
|
+
**result.items** (`DatasetItem[]`): Array of items for the current page.
|
|
49
|
+
|
|
50
|
+
**result.pagination** (`object`): Pagination metadata.
|
|
51
|
+
|
|
52
|
+
**result.pagination.total** (`number`): Total number of items.
|
|
53
|
+
|
|
54
|
+
**result.pagination.page** (`number`): Current page number.
|
|
55
|
+
|
|
56
|
+
**result.pagination.perPage** (`number | false`): Items per page, or \`false\` if unpaginated.
|
|
57
|
+
|
|
58
|
+
**result.pagination.hasMore** (`boolean`): Whether more pages are available.
|
|
@@ -24,10 +24,30 @@ for (const version of versions) {
|
|
|
24
24
|
|
|
25
25
|
## Parameters
|
|
26
26
|
|
|
27
|
-
**page
|
|
27
|
+
**page** (`number`): Page number. Defaults to \`0\`.
|
|
28
28
|
|
|
29
|
-
**perPage
|
|
29
|
+
**perPage** (`number`): Number of versions per page. Defaults to \`20\`.
|
|
30
30
|
|
|
31
31
|
## Returns
|
|
32
32
|
|
|
33
|
-
**result
|
|
33
|
+
**result** (`Promise<object>`): Paginated version list.
|
|
34
|
+
|
|
35
|
+
**result.versions** (`DatasetVersion[]`): Array of version records.
|
|
36
|
+
|
|
37
|
+
**result.versions.id** (`string`): Unique identifier of the version record.
|
|
38
|
+
|
|
39
|
+
**result.versions.datasetId** (`string`): ID of the parent dataset.
|
|
40
|
+
|
|
41
|
+
**result.versions.version** (`number`): Version number.
|
|
42
|
+
|
|
43
|
+
**result.versions.createdAt** (`Date`): When this version was created.
|
|
44
|
+
|
|
45
|
+
**result.pagination** (`object`): Pagination metadata.
|
|
46
|
+
|
|
47
|
+
**result.pagination.total** (`number`): Total number of versions.
|
|
48
|
+
|
|
49
|
+
**result.pagination.page** (`number`): Current page number.
|
|
50
|
+
|
|
51
|
+
**result.pagination.perPage** (`number | false`): Versions per page, or \`false\` if unpaginated.
|
|
52
|
+
|
|
53
|
+
**result.pagination.hasMore** (`boolean`): Whether more pages are available.
|
|
@@ -29,31 +29,81 @@ console.log(`Status: ${summary.status}`)
|
|
|
29
29
|
|
|
30
30
|
## Parameters
|
|
31
31
|
|
|
32
|
-
**targetType
|
|
32
|
+
**targetType** (`'agent' | 'workflow' | 'scorer'`): Type of registered target to run items against. Use with \`targetId\`.
|
|
33
33
|
|
|
34
|
-
**targetId
|
|
34
|
+
**targetId** (`string`): ID of the registered target. Use with \`targetType\`.
|
|
35
35
|
|
|
36
|
-
**scorers
|
|
36
|
+
**scorers** (`(MastraScorer | string)[]`): Scorers to evaluate each result. Pass \`MastraScorer\` instances or registered scorer IDs.
|
|
37
37
|
|
|
38
|
-
**name
|
|
38
|
+
**name** (`string`): Display name for the experiment.
|
|
39
39
|
|
|
40
|
-
**description
|
|
40
|
+
**description** (`string`): Description of the experiment.
|
|
41
41
|
|
|
42
|
-
**metadata
|
|
42
|
+
**metadata** (`Record<string, unknown>`): Arbitrary metadata for the experiment.
|
|
43
43
|
|
|
44
|
-
**version
|
|
44
|
+
**version** (`number`): Pin to a specific dataset version. Defaults to the latest version.
|
|
45
45
|
|
|
46
|
-
**maxConcurrency
|
|
46
|
+
**maxConcurrency** (`number`): Maximum concurrent item executions. Defaults to \`5\`.
|
|
47
47
|
|
|
48
|
-
**signal
|
|
48
|
+
**signal** (`AbortSignal`): AbortSignal for cancelling the experiment.
|
|
49
49
|
|
|
50
|
-
**itemTimeout
|
|
50
|
+
**itemTimeout** (`number`): Per-item execution timeout in milliseconds.
|
|
51
51
|
|
|
52
|
-
**maxRetries
|
|
52
|
+
**maxRetries** (`number`): Maximum retries per item on failure. Defaults to \`0\` (no retries). Abort errors are never retried.
|
|
53
53
|
|
|
54
54
|
## Returns
|
|
55
55
|
|
|
56
|
-
**result
|
|
56
|
+
**result** (`Promise<ExperimentSummary>`): Summary of the completed experiment.
|
|
57
|
+
|
|
58
|
+
**result.experimentId** (`string`): Unique ID of the experiment.
|
|
59
|
+
|
|
60
|
+
**result.status** (`'pending' | 'running' | 'completed' | 'failed'`): Final status of the experiment.
|
|
61
|
+
|
|
62
|
+
**result.totalItems** (`number`): Total number of items in the dataset.
|
|
63
|
+
|
|
64
|
+
**result.succeededCount** (`number`): Number of items that succeeded.
|
|
65
|
+
|
|
66
|
+
**result.failedCount** (`number`): Number of items that failed.
|
|
67
|
+
|
|
68
|
+
**result.skippedCount** (`number`): Number of items skipped (e.g., due to abort).
|
|
69
|
+
|
|
70
|
+
**result.completedWithErrors** (`boolean`): \`true\` if the run completed but some items failed.
|
|
71
|
+
|
|
72
|
+
**result.startedAt** (`Date`): When the experiment started.
|
|
73
|
+
|
|
74
|
+
**result.completedAt** (`Date`): When the experiment completed.
|
|
75
|
+
|
|
76
|
+
**result.results** (`ItemWithScores[]`): All item results with their scores.
|
|
77
|
+
|
|
78
|
+
**result.results.itemId** (`string`): ID of the dataset item.
|
|
79
|
+
|
|
80
|
+
**result.results.itemVersion** (`number`): Dataset version of the item when executed.
|
|
81
|
+
|
|
82
|
+
**result.results.input** (`unknown`): Input data passed to the target.
|
|
83
|
+
|
|
84
|
+
**result.results.output** (`unknown | null`): Output from the target, or \`null\` if failed.
|
|
85
|
+
|
|
86
|
+
**result.results.groundTruth** (`unknown | null`): Expected output from the dataset item.
|
|
87
|
+
|
|
88
|
+
**result.results.error** (`{ message: string; stack?: string; code?: string } | null`): Structured error if execution failed.
|
|
89
|
+
|
|
90
|
+
**result.results.startedAt** (`Date`): When item execution started.
|
|
91
|
+
|
|
92
|
+
**result.results.completedAt** (`Date`): When item execution completed.
|
|
93
|
+
|
|
94
|
+
**result.results.retryCount** (`number`): Number of retry attempts.
|
|
95
|
+
|
|
96
|
+
**result.results.scores** (`ScorerResult[]`): Results from all scorers for this item.
|
|
97
|
+
|
|
98
|
+
**result.results.scores.scorerId** (`string`): ID of the scorer.
|
|
99
|
+
|
|
100
|
+
**result.results.scores.scorerName** (`string`): Display name of the scorer.
|
|
101
|
+
|
|
102
|
+
**result.results.scores.score** (`number | null`): Computed score, or \`null\` if the scorer failed.
|
|
103
|
+
|
|
104
|
+
**result.results.scores.reason** (`string | null`): Reason/explanation for the score.
|
|
105
|
+
|
|
106
|
+
**result.results.scores.error** (`string | null`): Error message if the scorer failed.
|
|
57
107
|
|
|
58
108
|
## Related
|
|
59
109
|
|
|
@@ -35,7 +35,11 @@ Takes the same `StartExperimentConfig` as [`dataset.startExperiment()`](https://
|
|
|
35
35
|
|
|
36
36
|
## Returns
|
|
37
37
|
|
|
38
|
-
**result
|
|
38
|
+
**result** (`Promise<object>`): Immediate response with experiment ID.
|
|
39
|
+
|
|
40
|
+
**result.experimentId** (`string`): Unique ID of the created experiment.
|
|
41
|
+
|
|
42
|
+
**result.status** (`'pending'`): Always \`'pending'\` since the experiment hasn't started executing yet.
|
|
39
43
|
|
|
40
44
|
## Related
|
|
41
45
|
|
|
@@ -33,16 +33,16 @@ const updated2 = await dataset.update({
|
|
|
33
33
|
|
|
34
34
|
## Parameters
|
|
35
35
|
|
|
36
|
-
**name
|
|
36
|
+
**name** (`string`): New display name.
|
|
37
37
|
|
|
38
|
-
**description
|
|
38
|
+
**description** (`string`): New description.
|
|
39
39
|
|
|
40
|
-
**metadata
|
|
40
|
+
**metadata** (`Record<string, unknown>`): Updated metadata.
|
|
41
41
|
|
|
42
|
-
**inputSchema
|
|
42
|
+
**inputSchema** (`unknown`): JSON Schema or Zod schema for item inputs.
|
|
43
43
|
|
|
44
|
-
**groundTruthSchema
|
|
44
|
+
**groundTruthSchema** (`unknown`): JSON Schema or Zod schema for item ground truths.
|
|
45
45
|
|
|
46
46
|
## Returns
|
|
47
47
|
|
|
48
|
-
**result
|
|
48
|
+
**result** (`Promise<DatasetRecord>`): The updated dataset record. See dataset.getDetails() for the full shape.
|
|
@@ -25,14 +25,14 @@ const updated = await dataset.updateItem({
|
|
|
25
25
|
|
|
26
26
|
## Parameters
|
|
27
27
|
|
|
28
|
-
**itemId
|
|
28
|
+
**itemId** (`string`): ID of the item to update.
|
|
29
29
|
|
|
30
|
-
**input
|
|
30
|
+
**input** (`unknown`): Updated input data.
|
|
31
31
|
|
|
32
|
-
**groundTruth
|
|
32
|
+
**groundTruth** (`unknown`): Updated ground truth.
|
|
33
33
|
|
|
34
|
-
**metadata
|
|
34
|
+
**metadata** (`Record<string, unknown>`): Updated metadata.
|
|
35
35
|
|
|
36
36
|
## Returns
|
|
37
37
|
|
|
38
|
-
**result
|
|
38
|
+
**result** (`Promise<DatasetItem>`): The updated dataset item. See dataset.addItem() for the item shape.
|
|
@@ -30,29 +30,29 @@ class CustomDeployer extends Deployer {
|
|
|
30
30
|
|
|
31
31
|
### Constructor Parameters
|
|
32
32
|
|
|
33
|
-
**args
|
|
33
|
+
**args** (`object`): Configuration options for the Deployer.
|
|
34
34
|
|
|
35
|
-
**args.name
|
|
35
|
+
**args.name** (`string`): A unique name for the deployer instance.
|
|
36
36
|
|
|
37
37
|
### deploy Parameters
|
|
38
38
|
|
|
39
|
-
**outputDirectory
|
|
39
|
+
**outputDirectory** (`string`): The directory where the bundled and deployment-ready application will be output.
|
|
40
40
|
|
|
41
41
|
## Methods
|
|
42
42
|
|
|
43
|
-
**getEnvFiles
|
|
43
|
+
**getEnvFiles** (`() => Promise<string[]>`): Returns a list of environment files to be used during deployment. By default, it looks for '.env.production' and '.env' files.
|
|
44
44
|
|
|
45
|
-
**deploy
|
|
45
|
+
**deploy** (`(outputDirectory: string) => Promise<void>`): Abstract method that must be implemented by subclasses. Handles the deployment process to the specified output directory.
|
|
46
46
|
|
|
47
47
|
## Inherited Methods from Bundler
|
|
48
48
|
|
|
49
49
|
The Deployer class inherits the following key methods from the Bundler class:
|
|
50
50
|
|
|
51
|
-
**prepare
|
|
51
|
+
**prepare** (`(outputDirectory: string) => Promise<void>`): Prepares the output directory by cleaning it and creating necessary subdirectories.
|
|
52
52
|
|
|
53
|
-
**writePackageJson
|
|
53
|
+
**writePackageJson** (`(outputDirectory: string, dependencies: Map<string, string>) => Promise<void>`): Generates a package.json file in the output directory with the specified dependencies.
|
|
54
54
|
|
|
55
|
-
**\_bundle
|
|
55
|
+
**\_bundle** (`(serverFile: string, mastraEntryFile: string, outputDirectory: string, bundleLocation?: string) => Promise<void>`): Bundles the application using the specified server and Mastra entry files.
|
|
56
56
|
|
|
57
57
|
## Core Concepts
|
|
58
58
|
|
|
@@ -4,31 +4,31 @@ The `createAnswerRelevancyScorer()` function accepts a single options object wit
|
|
|
4
4
|
|
|
5
5
|
## Parameters
|
|
6
6
|
|
|
7
|
-
**model
|
|
7
|
+
**model** (`LanguageModel`): Configuration for the model used to evaluate relevancy.
|
|
8
8
|
|
|
9
|
-
**uncertaintyWeight
|
|
9
|
+
**uncertaintyWeight** (`number`): Weight given to 'unsure' verdicts in scoring (0-1). (Default: `0.3`)
|
|
10
10
|
|
|
11
|
-
**scale
|
|
11
|
+
**scale** (`number`): Maximum score value. (Default: `1`)
|
|
12
12
|
|
|
13
13
|
This function returns an instance of the MastraScorer class. The `.run()` method accepts the same input as other scorers (see the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer)), but the return value includes LLM-specific fields as documented below.
|
|
14
14
|
|
|
15
15
|
## .run() Returns
|
|
16
16
|
|
|
17
|
-
**runId
|
|
17
|
+
**runId** (`string`): The id of the run (optional).
|
|
18
18
|
|
|
19
|
-
**score
|
|
19
|
+
**score** (`number`): Relevancy score (0 to scale, default 0-1)
|
|
20
20
|
|
|
21
|
-
**preprocessPrompt
|
|
21
|
+
**preprocessPrompt** (`string`): The prompt sent to the LLM for the preprocess step (optional).
|
|
22
22
|
|
|
23
|
-
**preprocessStepResult
|
|
23
|
+
**preprocessStepResult** (`object`): Object with extracted statements: { statements: string\[] }
|
|
24
24
|
|
|
25
|
-
**analyzePrompt
|
|
25
|
+
**analyzePrompt** (`string`): The prompt sent to the LLM for the analyze step (optional).
|
|
26
26
|
|
|
27
|
-
**analyzeStepResult
|
|
27
|
+
**analyzeStepResult** (`object`): Object with results: { results: Array<{ result: 'yes' | 'unsure' | 'no', reason: string }> }
|
|
28
28
|
|
|
29
|
-
**generateReasonPrompt
|
|
29
|
+
**generateReasonPrompt** (`string`): The prompt sent to the LLM for the reason step (optional).
|
|
30
30
|
|
|
31
|
-
**reason
|
|
31
|
+
**reason** (`string`): Explanation of the score.
|
|
32
32
|
|
|
33
33
|
## Scoring Details
|
|
34
34
|
|