데이터 세트.listItems()

추가된 항목: @mastra/core@1.4.0

데이터 세트의 항목을 나열합니다. version만 제공하면 해당 버전의 모든 항목에 대한 스냅샷인 DatasetItem[] 배열을 그대로 반환합니다. 그 밖의 모든 경우(인수가 없거나 version의 유무와 관계없이 search / page / perPage가 제공된 경우)에는 { 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[] 배열 스냅샷으로 그대로 반환합니다. version과 함께 search / page / perPage를 전달하면 페이지가 매겨진 구조로 전환됩니다.

page?:

number

페이지네이션의 페이지 번호입니다. 기본값은 0입니다.

perPage?:

number

페이지당 항목 수입니다. 기본값은 20입니다.

search?:

string

항목을 필터링할 검색 문자열입니다.

보고

version만 제공된 경우(search, page, perPage는 제공되지 않음):

result:

Promise<DatasetItem[]>

지정된 데이터 세트 버전의 모든 항목을 담은 배열입니다. 이 구조는 이전 버전과의 호환성을 위해 유지되지만 더 이상 권장되지 않습니다. 항상 아래의 페이지가 매겨진 구조를 받으려면 page / perPage(또는 search)를 전달하세요.

그 밖의 모든 경우(인수가 없거나 version의 유무와 관계없이 search / page / perPage가 제공된 경우):

result:

Promise<object>

페이지가 매겨진 응답입니다.

object

items:

DatasetItem[]

현재 페이지에 있는 항목의 배열입니다.

pagination:

object

페이지네이션 메타데이터입니다.

object

total:

number

전체 항목 수입니다.

page:

number

현재 페이지 번호입니다.

perPage:

number | false

페이지당 항목 수이며, 페이지네이션을 사용하지 않으면 false입니다.

hasMore:

boolean

추가 페이지가 있는지 여부입니다.