dataset.listItems()

添加于： @mastra/core@1.4.0

列出数据集中的条目。仅提供 version 时，返回该版本中所有条目的 DatasetItem[] 裸数组快照。其他所有情况（不传参数，或提供 search / page / perPage，无论是否同时提供 version）均返回分页的 { items, pagination } 结构。

使用示例

import { Mastra } from '@mastra/core'

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

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

// Paginated list (default: page 0, 20 per page)
const result = await dataset.listItems()

// List with search
const filtered = await dataset.listItems({ search: 'TypeScript', page: 0, perPage: 10 })

// Paginated list scoped to a specific version
const versionedPage = await dataset.listItems({ version: 2, page: 0, perPage: 20 })

// Version-only snapshot returns a bare DatasetItem[] (deprecated form —
// prefer passing page/perPage to receive the paginated shape).
const versionedItems = await dataset.listItems({ version: 2 })

参数

version?:

number

要列出条目时对应的数据集版本。单独传入时，返回该版本所有条目的 DatasetItem[] 裸数组快照。将 search / page / perPage 与 version 一起传入时，则改为返回分页结构。

page?:

number

分页页码。默认为 0。

perPage?:

number

每页的条目数。默认为 20。

search?:

string

用于筛选条目的搜索字符串。

返回值

仅提供 version（不提供 search、page 或 perPage）时：

result:

Promise<DatasetItem[]>

指定数据集版本中所有条目的裸数组。保留此结构是为了向后兼容，但它已弃用——请传入 page / perPage（或 search），以始终接收下方的分页结构。

其他所有情况（不传参数，或提供 search / page / perPage，无论是否同时提供 version）：

result:

Promise<object>

分页响应。

object

items:

DatasetItem[]

当前页面的条目数组。

pagination:

object

分页元数据。

object

total:

number

条目总数。

page:

number

当前页码。

perPage:

number | false

每页条目数；如果未分页则为 false。

hasMore:

boolean

是否还有更多页面。