@mastra/core 1.9.0 → 1.10.0

package/dist/docs/references/reference-core-listWorkflows.md

@@ -10,11 +10,11 @@ mastra.listWorkflows()
 
 ## Parameters
 
-**options:** (`{ serialized?: boolean }`): Optional configuration object. When \`serialized\` is true, returns simplified workflow objects with only the name property instead of full workflow instances.
+**options** (`{ serialized?: boolean }`): Optional configuration object. When \`serialized\` is true, returns simplified workflow objects with only the name property instead of full workflow instances.
 
 ## Returns
 
-**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).
+**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).
 
 ## Related
 

package/dist/docs/references/reference-core-mastra-class.md

@@ -31,36 +31,36 @@ export const mastra = new Mastra({
 
 Visit the [Configuration reference](https://mastra.ai/reference/configuration) for detailed documentation on all available configuration options.
 
-**agents?:** (`Record<string, Agent>`): Agent instances to register, keyed by name (Default: `{}`)
+**agents** (`Record<string, Agent>`): Agent instances to register, keyed by name (Default: `{}`)
 
-**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: `{}`)
+**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: `{}`)
 
-**storage?:** (`MastraCompositeStore`): Storage engine instance for persisting data
+**storage** (`MastraCompositeStore`): Storage engine instance for persisting data
 
-**vectors?:** (`Record<string, MastraVector>`): Vector store instance, used for semantic search and vector-based tools (eg Pinecone, PgVector or Qdrant)
+**vectors** (`Record<string, MastraVector>`): Vector store instance, used for semantic search and vector-based tools (eg Pinecone, PgVector or Qdrant)
 
-**logger?:** (`Logger`): Logger instance created with new PinoLogger() (Default: `Console logger with INFO level`)
+**logger** (`Logger`): Logger instance created with new PinoLogger() (Default: `Console logger with INFO level`)
 
-**idGenerator?:** (`() => string`): Custom ID generator function. Used by agents, workflows, memory, and other components to generate unique identifiers.
+**idGenerator** (`() => string`): Custom ID generator function. Used by agents, workflows, memory, and other components to generate unique identifiers.
 
-**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: `{}`)
+**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: `{}`)
 
-**tts?:** (`Record<string, MastraVoice>`): Text-to-speech providers for voice synthesis
+**tts** (`Record<string, MastraVoice>`): Text-to-speech providers for voice synthesis
 
-**observability?:** (`ObservabilityEntrypoint`): Observability configuration for tracing and monitoring
+**observability** (`ObservabilityEntrypoint`): Observability configuration for tracing and monitoring
 
-**deployer?:** (`MastraDeployer`): An instance of a MastraDeployer for managing deployments.
+**deployer** (`MastraDeployer`): An instance of a MastraDeployer for managing deployments.
 
-**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.
+**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.
 
-**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().
+**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().
 
-**bundler?:** (`BundlerConfig`): Configuration for the asset bundler with options for externals, sourcemap, and transpilePackages.
+**bundler** (`BundlerConfig`): Configuration for the asset bundler with options for externals, sourcemap, and transpilePackages.
 
-**scorers?:** (`Record<string, Scorer>`): Scorers for evaluating agent responses and workflow outputs (Default: `{}`)
+**scorers** (`Record<string, Scorer>`): Scorers for evaluating agent responses and workflow outputs (Default: `{}`)
 
-**processors?:** (`Record<string, Processor>`): Input/output processors for transforming agent inputs and outputs (Default: `{}`)
+**processors** (`Record<string, Processor>`): Input/output processors for transforming agent inputs and outputs (Default: `{}`)
 
-**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: `{}`)
+**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: `{}`)
 
-**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: `{}`)
+**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: `{}`)

package/dist/docs/references/reference-core-mastra-model-gateway.md

@@ -55,9 +55,9 @@ class MyCustomGateway extends MastraModelGateway {
 
 ## Required Properties
 
-**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.
+**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.
 
-**name:** (`string`): Human-readable name for the gateway.
+**name** (`string`): Human-readable name for the gateway.
 
 ## Required Methods
 
@@ -69,19 +69,19 @@ Fetches provider configurations from the gateway.
 
 **ProviderConfig Structure:**
 
-**name:** (`string`): Display name of the provider
+**name** (`string`): Display name of the provider
 
-**models:** (`string[]`): Array of available model IDs
+**models** (`string[]`): Array of available model IDs
 
-**apiKeyEnvVar:** (`string | string[]`): Environment variable(s) for API key
+**apiKeyEnvVar** (`string | string[]`): Environment variable(s) for API key
 
-**gateway:** (`string`): Gateway identifier
+**gateway** (`string`): Gateway identifier
 
-**url?:** (`string`): Optional base API URL
+**url** (`string`): Optional base API URL
 
-**apiKeyHeader?:** (`string`): Optional custom auth header name
+**apiKeyHeader** (`string`): Optional custom auth header name
 
-**docUrl?:** (`string`): Optional documentation URL
+**docUrl** (`string`): Optional documentation URL
 
 ### buildUrl()
 
@@ -89,9 +89,9 @@ Builds the API URL for a specific model/provider combination.
 
 **Parameters:**
 
-**modelId:** (`string`): Full model ID (e.g., "custom/my-provider/model-1")
+**modelId** (`string`): Full model ID (e.g., "custom/my-provider/model-1")
 
-**envVars?:** (`Record<string, string>`): Optional environment variables
+**envVars** (`Record<string, string>`): Optional environment variables
 
 **Returns:** `string | undefined | Promise<string | undefined>`
 
@@ -101,7 +101,7 @@ Retrieves the API key for authentication.
 
 **Parameters:**
 
-**modelId:** (`string`): Full model ID
+**modelId** (`string`): Full model ID
 
 **Returns:** `Promise<string>`
 
@@ -111,11 +111,11 @@ Creates a language model instance.
 
 **Parameters:**
 
-**modelId:** (`string`): The model ID
+**modelId** (`string`): The model ID
 
-**providerId:** (`string`): The provider ID
+**providerId** (`string`): The provider ID
 
-**apiKey:** (`string`): The API key for authentication
+**apiKey** (`string`): The API key for authentication
 
 **Returns:** `Promise<LanguageModelV2> | LanguageModelV2`
 

package/dist/docs/references/reference-core-setLogger.md

@@ -10,11 +10,9 @@ mastra.setLogger({ logger: new PinoLogger({ name: 'testLogger' }) })
 
 ## Parameters
 
-**options:** (`{ logger: TLogger }`): An object containing the logger instance to set for all components.
+**options** (`{ logger: TLogger }`): An object containing the logger instance to set for all components.
 
-### Options
-
-**logger:** (`TLogger`): The logger instance to set for all components (agents, workflows, etc.).
+**options.logger** (`TLogger`): The logger instance to set for all components (agents, workflows, etc.).
 
 ## Returns
 

package/dist/docs/references/reference-core-setStorage.md

@@ -15,7 +15,7 @@ mastra.setStorage(
 
 ## Parameters
 
-**storage:** (`MastraCompositeStore`): The storage instance to set for the Mastra instance.
+**storage** (`MastraCompositeStore`): The storage instance to set for the Mastra instance.
 
 ## Returns
 

package/dist/docs/references/reference-datasets-addItem.md

@@ -26,12 +26,28 @@ console.log(item.id)
 
 ## Parameters
 
-**input:** (`unknown`): Input data for the item.
+**input** (`unknown`): Input data for the item.
 
-**groundTruth?:** (`unknown`): Expected output or ground truth for scoring.
+**groundTruth** (`unknown`): Expected output or ground truth for scoring.
 
-**metadata?:** (`Record<string, unknown>`): Arbitrary metadata for the item.
+**metadata** (`Record<string, unknown>`): Arbitrary metadata for the item.
 
 ## Returns
 
-**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.
+**result** (`Promise<DatasetItem>`): The created dataset item.
+
+**result.id** (`string`): Unique identifier of the item.
+
+**result.datasetId** (`string`): ID of the parent dataset.
+
+**result.datasetVersion** (`number`): Dataset version when the item was created.
+
+**result.input** (`unknown`): Input data.
+
+**result.groundTruth** (`unknown`): Ground truth data.
+
+**result.metadata** (`Record<string, unknown>`): Item metadata.
+
+**result.createdAt** (`Date`): When the item was created.
+
+**result.updatedAt** (`Date`): When the item was last updated.

package/dist/docs/references/reference-datasets-addItems.md

@@ -28,8 +28,14 @@ console.log(`Added ${items.length} items`)
 
 ## Parameters
 
-**items:** (`Array<object>`): DatasetIteminput:unknownInput data for the item.groundTruth?:unknownExpected output or ground truth.metadata?:Record\<string, unknown>Arbitrary metadata.
+**items** (`Array<object>`): Array of items to add. Each item has the same shape as the dataset.addItem() input.
+
+**items.input** (`unknown`): Input data for the item.
+
+**items.groundTruth** (`unknown`): Expected output or ground truth.
+
+**items.metadata** (`Record<string, unknown>`): Arbitrary metadata.
 
 ## Returns
 
-**result:** (`Promise<DatasetItem[]>`): Array of created dataset items. See dataset.addItem() for the item shape.
+**result** (`Promise<DatasetItem[]>`): Array of created dataset items. See dataset.addItem() for the item shape.

package/dist/docs/references/reference-datasets-compareExperiments.md

@@ -36,15 +36,27 @@ for (const item of comparison.items) {
 
 ## Parameters
 
-**experimentIds:** (`string[]`): Array of experiment IDs to compare. Must contain at least 2.
+**experimentIds** (`string[]`): Array of experiment IDs to compare. Must contain at least 2.
 
-**baselineId?:** (`string`): ID of the baseline experiment. Defaults to the first ID in \`experimentIds\`.
+**baselineId** (`string`): ID of the baseline experiment. Defaults to the first ID in \`experimentIds\`.
 
 ## Returns
 
 Throws `MastraError` if fewer than 2 experiment IDs are provided.
 
-**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.
+**result** (`Promise<object>`): Comparison results.
+
+**result.baselineId** (`string`): ID of the baseline experiment used for comparison.
+
+**result.items** (`Array<object>`): Per-item comparison data.
+
+**result.items.itemId** (`string`): ID of the dataset item.
+
+**result.items.input** (`unknown | null`): Input data for the item.
+
+**result.items.groundTruth** (`unknown | null`): Ground truth for the item.
+
+**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.
 
 ## Related
 

package/dist/docs/references/reference-datasets-create.md

@@ -36,16 +36,16 @@ const typedDataset = await mastra.datasets.create({
 
 ## Parameters
 
-**name:** (`string`): Display name for the dataset.
+**name** (`string`): Display name for the dataset.
 
-**description?:** (`string`): Description of the dataset.
+**description** (`string`): Description of the dataset.
 
-**inputSchema?:** (`unknown`): JSON Schema or Zod schema for item inputs. Zod schemas are auto-converted.
+**inputSchema** (`unknown`): JSON Schema or Zod schema for item inputs. Zod schemas are auto-converted.
 
-**groundTruthSchema?:** (`unknown`): JSON Schema or Zod schema for item ground truths. Zod schemas are auto-converted.
+**groundTruthSchema** (`unknown`): JSON Schema or Zod schema for item ground truths. Zod schemas are auto-converted.
 
-**metadata?:** (`Record<string, unknown>`): Arbitrary metadata.
+**metadata** (`Record<string, unknown>`): Arbitrary metadata.
 
 ## Returns
 
-**result:** (`Promise<Dataset>`): A Dataset instance for the newly created dataset.
+**result** (`Promise<Dataset>`): A Dataset instance for the newly created dataset.

package/dist/docs/references/reference-datasets-dataset.md

@@ -72,7 +72,7 @@ const dataset = await mastra.datasets.create({ name: 'My dataset' })
 
 For the full dataset record (name, description, schemas, version, timestamps), call [`dataset.getDetails()`](https://mastra.ai/reference/datasets/getDetails).
 
-**id:** (`string`): The unique identifier of the dataset. Read-only.
+**id** (`string`): The unique identifier of the dataset. Read-only.
 
 ## Related
 

package/dist/docs/references/reference-datasets-delete.md

@@ -18,8 +18,8 @@ await mastra.datasets.delete({ id: 'dataset-id' })
 
 ## Parameters
 
-**id:** (`string`): ID of the dataset to delete.
+**id** (`string`): ID of the dataset to delete.
 
 ## Returns
 
-**result:** (`Promise<void>`): Resolves when the dataset is deleted.
+**result** (`Promise<void>`): Resolves when the dataset is deleted.

package/dist/docs/references/reference-datasets-deleteExperiment.md

@@ -20,8 +20,8 @@ await dataset.deleteExperiment({ experimentId: 'exp-id' })
 
 ## Parameters
 
-**experimentId:** (`string`): ID of the experiment to delete.
+**experimentId** (`string`): ID of the experiment to delete.
 
 ## Returns
 
-**result:** (`Promise<void>`): Resolves when the experiment and its results are deleted.
+**result** (`Promise<void>`): Resolves when the experiment and its results are deleted.

package/dist/docs/references/reference-datasets-deleteItem.md

@@ -20,8 +20,8 @@ await dataset.deleteItem({ itemId: 'item-id' })
 
 ## Parameters
 
-**itemId:** (`string`): ID of the item to delete.
+**itemId** (`string`): ID of the item to delete.
 
 ## Returns
 
-**result:** (`Promise<void>`): Resolves when the item is deleted.
+**result** (`Promise<void>`): Resolves when the item is deleted.

package/dist/docs/references/reference-datasets-deleteItems.md

@@ -22,8 +22,8 @@ await dataset.deleteItems({
 
 ## Parameters
 
-**itemIds:** (`string[]`): Array of item IDs to delete.
+**itemIds** (`string[]`): Array of item IDs to delete.
 
 ## Returns
 
-**result:** (`Promise<void>`): Resolves when all items are deleted.
+**result** (`Promise<void>`): Resolves when all items are deleted.

package/dist/docs/references/reference-datasets-get.md

@@ -22,10 +22,10 @@ console.log(details.name)
 
 ## Parameters
 
-**id:** (`string`): Unique identifier of the dataset.
+**id** (`string`): Unique identifier of the dataset.
 
 ## Returns
 
 Throws `MastraError` if the dataset is not found.
 
-**result:** (`Promise<Dataset>`): A Dataset instance.
+**result** (`Promise<Dataset>`): A Dataset instance.

package/dist/docs/references/reference-datasets-getDetails.md

@@ -28,20 +28,20 @@ This method takes no parameters.
 
 Returns a `Promise<DatasetRecord>`. Throws `MastraError` if the dataset is not found.
 
-**id:** (`string`): Unique identifier of the dataset.
+**id** (`string`): Unique identifier of the dataset.
 
-**name:** (`string`): Display name of the dataset.
+**name** (`string`): Display name of the dataset.
 
-**description?:** (`string`): Description of the dataset.
+**description** (`string`): Description of the dataset.
 
-**metadata?:** (`Record<string, unknown>`): Arbitrary metadata associated with the dataset.
+**metadata** (`Record<string, unknown>`): Arbitrary metadata associated with the dataset.
 
-**inputSchema?:** (`Record<string, unknown>`): JSON Schema for item inputs.
+**inputSchema** (`Record<string, unknown>`): JSON Schema for item inputs.
 
-**groundTruthSchema?:** (`Record<string, unknown>`): JSON Schema for item ground truths.
+**groundTruthSchema** (`Record<string, unknown>`): JSON Schema for item ground truths.
 
-**version:** (`number`): Current version number of the dataset.
+**version** (`number`): Current version number of the dataset.
 
-**createdAt:** (`Date`): When the dataset was created.
+**createdAt** (`Date`): When the dataset was created.
 
-**updatedAt:** (`Date`): When the dataset was last updated.
+**updatedAt** (`Date`): When the dataset was last updated.

package/dist/docs/references/reference-datasets-getExperiment.md

@@ -23,8 +23,8 @@ console.log(`${experiment.succeededCount}/${experiment.totalItems} succeeded`)
 
 ## Parameters
 
-**experimentId:** (`string`): ID of the experiment to retrieve.
+**experimentId** (`string`): ID of the experiment to retrieve.
 
 ## Returns
 
-**result:** (`Promise<Experiment>`): The experiment record. See dataset.listExperiments() for the full shape.
+**result** (`Promise<Experiment>`): The experiment record. See dataset.listExperiments() for the full shape.

package/dist/docs/references/reference-datasets-getItem.md

@@ -24,10 +24,10 @@ const versionedItem = await dataset.getItem({ itemId: 'item-id', version: 2 })
 
 ## Parameters
 
-**itemId:** (`string`): The unique identifier of the item.
+**itemId** (`string`): The unique identifier of the item.
 
-**version?:** (`number`): Dataset version to retrieve the item at. Defaults to the latest version.
+**version** (`number`): Dataset version to retrieve the item at. Defaults to the latest version.
 
 ## Returns
 
-**result:** (`Promise<DatasetItem | null>`): The dataset item, or null if not found. See dataset.addItem() for the item shape.
+**result** (`Promise<DatasetItem | null>`): The dataset item, or null if not found. See dataset.addItem() for the item shape.

package/dist/docs/references/reference-datasets-getItemHistory.md

@@ -24,8 +24,28 @@ for (const row of history) {
 
 ## Parameters
 
-**itemId:** (`string`): ID of the item to retrieve history for.
+**itemId** (`string`): ID of the item to retrieve history for.
 
 ## Returns
 
-**result:** (`Promise<DatasetItemRow[]>`): DatasetItemRowid:stringUnique row identifier.datasetId:stringID of the parent dataset.datasetVersion:numberDataset version for this row\.validTo:number | nullVersion at which this row was superseded, or \`null\` if still current.isDeleted:booleanWhether this row represents a deletion.input:unknownInput data at this version.groundTruth?:unknownGround truth at this version.metadata?:Record\<string, unknown>Metadata at this version.createdAt:DateWhen this row was created.updatedAt:DateWhen this row was last updated.
+**result** (`Promise<DatasetItemRow[]>`): Array of versioned item rows, ordered by version.
+
+**result.id** (`string`): Unique row identifier.
+
+**result.datasetId** (`string`): ID of the parent dataset.
+
+**result.datasetVersion** (`number`): Dataset version for this row.
+
+**result.validTo** (`number | null`): Version at which this row was superseded, or \`null\` if still current.
+
+**result.isDeleted** (`boolean`): Whether this row represents a deletion.
+
+**result.input** (`unknown`): Input data at this version.
+
+**result.groundTruth** (`unknown`): Ground truth at this version.
+
+**result.metadata** (`Record<string, unknown>`): Metadata at this version.
+
+**result.createdAt** (`Date`): When this row was created.
+
+**result.updatedAt** (`Date`): When this row was last updated.

package/dist/docs/references/reference-datasets-list.md

@@ -22,10 +22,14 @@ for (const ds of datasets) {
 
 ## Parameters
 
-**page?:** (`number`): Page number. Defaults to \`0\`.
+**page** (`number`): Page number. Defaults to \`0\`.
 
-**perPage?:** (`number`): Number of datasets per page. Defaults to \`20\`.
+**perPage** (`number`): Number of datasets per page. Defaults to \`20\`.
 
 ## Returns
 
-**result:** (`Promise<object>`): objectdatasets:DatasetRecord\[]Array of dataset records. See dataset.getDetails() for the record shape.pagination:PaginationInfoPagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
+**result** (`Promise<object>`): Paginated dataset list.
+
+**result.datasets** (`DatasetRecord[]`): Array of dataset records. See dataset.getDetails() for the record shape.
+
+**result.pagination** (`PaginationInfo`): Pagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.

package/dist/docs/references/reference-datasets-listExperimentResults.md

@@ -28,12 +28,42 @@ for (const result of results) {
 
 ## Parameters
 
-**experimentId:** (`string`): ID of the experiment to list results for.
+**experimentId** (`string`): ID of the experiment to list results for.
 
-**page?:** (`number`): Page number. Defaults to \`0\`.
+**page** (`number`): Page number. Defaults to \`0\`.
 
-**perPage?:** (`number`): Number of results per page. Defaults to \`20\`.
+**perPage** (`number`): Number of results per page. Defaults to \`20\`.
 
 ## Returns
 
-**result:** (`Promise<object>`): objectresults:ExperimentResult\[]Array of item-level results.ExperimentResultid:stringUnique result ID.experimentId:stringID of the parent experiment.itemId:stringID of the dataset item.itemDatasetVersion:number | nullDataset version of the item when executed.input:unknownInput data passed to the target.output:unknown | nullOutput from the target.groundTruth:unknown | nullExpected output.error:{ message: string; stack?: string; code?: string } | nullStructured error if execution failed.startedAt:DateWhen execution started.completedAt:DateWhen execution completed.retryCount:numberNumber of retry attempts.traceId:string | nullTrace ID for observability.createdAt:DateWhen the result record was created.pagination:PaginationInfoPagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
+**result** (`Promise<object>`): Paginated experiment results.
+
+**result.results** (`ExperimentResult[]`): Array of item-level results.
+
+**result.results.id** (`string`): Unique result ID.
+
+**result.results.experimentId** (`string`): ID of the parent experiment.
+
+**result.results.itemId** (`string`): ID of the dataset item.
+
+**result.results.itemDatasetVersion** (`number | null`): Dataset version of the item when executed.
+
+**result.results.input** (`unknown`): Input data passed to the target.
+
+**result.results.output** (`unknown | null`): Output from the target.
+
+**result.results.groundTruth** (`unknown | null`): Expected output.
+
+**result.results.error** (`{ message: string; stack?: string; code?: string } | null`): Structured error if execution failed.
+
+**result.results.startedAt** (`Date`): When execution started.
+
+**result.results.completedAt** (`Date`): When execution completed.
+
+**result.results.retryCount** (`number`): Number of retry attempts.
+
+**result.results.traceId** (`string | null`): Trace ID for observability.
+
+**result.results.createdAt** (`Date`): When the result record was created.
+
+**result.pagination** (`PaginationInfo`): Pagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.

package/dist/docs/references/reference-datasets-listExperiments.md

@@ -24,10 +24,48 @@ for (const exp of experiments) {
 
 ## Parameters
 
-**page?:** (`number`): Page number. Defaults to \`0\`.
+**page** (`number`): Page number. Defaults to \`0\`.
 
-**perPage?:** (`number`): Number of experiments per page. Defaults to \`20\`.
+**perPage** (`number`): Number of experiments per page. Defaults to \`20\`.
 
 ## Returns
 
-**result:** (`Promise<object>`): objectexperiments:Experiment\[]Array of experiment records.Experimentid:stringUnique experiment ID.name?:stringDisplay name.description?:stringDescription.metadata?:Record\<string, unknown>Arbitrary metadata.datasetId:stringID of the parent dataset.datasetVersion:number | nullDataset version used for the experiment.targetType:'agent' | 'workflow' | 'scorer' | 'processor'Type of target used.targetId:stringID of the target used.status:'pending' | 'running' | 'completed' | 'failed'Current status of the experiment.totalItems:numberTotal number of items.succeededCount:numberNumber of successful items.failedCount:numberNumber of failed items.skippedCount:numberNumber of skipped items.startedAt:Date | nullWhen the experiment started.completedAt:Date | nullWhen the experiment completed.createdAt:DateWhen the experiment record was created.updatedAt:DateWhen the experiment record was last updated.pagination:PaginationInfoPagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
+**result** (`Promise<object>`): Paginated experiment list.
+
+**result.experiments** (`Experiment[]`): Array of experiment records.
+
+**result.experiments.id** (`string`): Unique experiment ID.
+
+**result.experiments.name** (`string`): Display name.
+
+**result.experiments.description** (`string`): Description.
+
+**result.experiments.metadata** (`Record<string, unknown>`): Arbitrary metadata.
+
+**result.experiments.datasetId** (`string`): ID of the parent dataset.
+
+**result.experiments.datasetVersion** (`number | null`): Dataset version used for the experiment.
+
+**result.experiments.targetType** (`'agent' | 'workflow' | 'scorer' | 'processor'`): Type of target used.
+
+**result.experiments.targetId** (`string`): ID of the target used.
+
+**result.experiments.status** (`'pending' | 'running' | 'completed' | 'failed'`): Current status of the experiment.
+
+**result.experiments.totalItems** (`number`): Total number of items.
+
+**result.experiments.succeededCount** (`number`): Number of successful items.
+
+**result.experiments.failedCount** (`number`): Number of failed items.
+
+**result.experiments.skippedCount** (`number`): Number of skipped items.
+
+**result.experiments.startedAt** (`Date | null`): When the experiment started.
+
+**result.experiments.completedAt** (`Date | null`): When the experiment completed.
+
+**result.experiments.createdAt** (`Date`): When the experiment record was created.
+
+**result.experiments.updatedAt** (`Date`): When the experiment record was last updated.
+
+**result.pagination** (`PaginationInfo`): Pagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.

package/dist/docs/references/reference-datasets-listItems.md

@@ -27,20 +27,32 @@ const versionedItems = await dataset.listItems({ version: 2 })
 
 ## Parameters
 
-**version?:** (`number`): Dataset version to list items at. When set, returns all items at that version (no pagination).
+**version** (`number`): Dataset version to list items at. When set, returns all items at that version (no pagination).
 
-**page?:** (`number`): Page number for pagination. Defaults to \`0\`.
+**page** (`number`): Page number for pagination. Defaults to \`0\`.
 
-**perPage?:** (`number`): Number of items per page. Defaults to \`20\`.
+**perPage** (`number`): Number of items per page. Defaults to \`20\`.
 
-**search?:** (`string`): Search string to filter items.
+**search** (`string`): Search string to filter items.
 
 ## Returns
 
 When `version` is specified:
 
-**result:** (`Promise<DatasetItem[]>`): Array of all items at the specified dataset version.
+**result** (`Promise<DatasetItem[]>`): Array of all items at the specified dataset version.
 
 When `version` is not specified:
 
-**result:** (`Promise<object>`): objectitems:DatasetItem\[]Array of items for the current page.pagination:objectPagination metadata.objecttotal:numberTotal number of items.page:numberCurrent page number.perPage:number | falseItems per page, or \`false\` if unpaginated.hasMore:booleanWhether more pages are available.
+**result** (`Promise<object>`): Paginated response.
+
+**result.items** (`DatasetItem[]`): Array of items for the current page.
+
+**result.pagination** (`object`): Pagination metadata.
+
+**result.pagination.total** (`number`): Total number of items.
+
+**result.pagination.page** (`number`): Current page number.
+
+**result.pagination.perPage** (`number | false`): Items per page, or \`false\` if unpaginated.
+
+**result.pagination.hasMore** (`boolean`): Whether more pages are available.

package/dist/docs/references/reference-datasets-listVersions.md

@@ -24,10 +24,30 @@ for (const version of versions) {
 
 ## Parameters
 
-**page?:** (`number`): Page number. Defaults to \`0\`.
+**page** (`number`): Page number. Defaults to \`0\`.
 
-**perPage?:** (`number`): Number of versions per page. Defaults to \`20\`.
+**perPage** (`number`): Number of versions per page. Defaults to \`20\`.
 
 ## Returns
 
-**result:** (`Promise<object>`): objectversions:DatasetVersion\[]Array of version records.DatasetVersionid:stringUnique identifier of the version record.datasetId:stringID of the parent dataset.version:numberVersion number.createdAt:DateWhen this version was created.pagination:objectPagination metadata.objecttotal:numberTotal number of versions.page:numberCurrent page number.perPage:number | falseVersions per page, or \`false\` if unpaginated.hasMore:booleanWhether more pages are available.
+**result** (`Promise<object>`): Paginated version list.
+
+**result.versions** (`DatasetVersion[]`): Array of version records.
+
+**result.versions.id** (`string`): Unique identifier of the version record.
+
+**result.versions.datasetId** (`string`): ID of the parent dataset.
+
+**result.versions.version** (`number`): Version number.
+
+**result.versions.createdAt** (`Date`): When this version was created.
+
+**result.pagination** (`object`): Pagination metadata.
+
+**result.pagination.total** (`number`): Total number of versions.
+
+**result.pagination.page** (`number`): Current page number.
+
+**result.pagination.perPage** (`number | false`): Versions per page, or \`false\` if unpaginated.
+
+**result.pagination.hasMore** (`boolean`): Whether more pages are available.