Skip to main content

dataset.getDetails()

Added in: @mastra/core@1.4.0

Retrieves the full dataset record from storage, including metadata, schemas, and version information.

Usage example
Direct link to Usage example

import { Mastra } from '@mastra/core'

const mastra = new Mastra({
/* storage config */
})

const dataset = await mastra.datasets.get({ id: 'dataset-id' })

// Get dataset details
const details = await dataset.getDetails()
console.log(details.name, details.version)

Parameters
Direct link to Parameters

This method takes no parameters.

Returns
Direct link to Returns

Returns a Promise<DatasetRecord>. Throws MastraError if the dataset isn't found.

id:

string
Unique identifier of the dataset.

name:

string
Display name of the dataset.

description?:

string
Description of the dataset.

metadata?:

Record<string, unknown>
Arbitrary metadata associated with the dataset.

inputSchema?:

Record<string, unknown>
JSON Schema for item inputs.

groundTruthSchema?:

Record<string, unknown>
JSON Schema for item ground truths.

version:

number
Current version number of the dataset.

createdAt:

Date
When the dataset was created.

updatedAt:

Date
When the dataset was last updated.
On this page