diff --git a/src/data/list.ts b/src/data/list.ts index 68f49101..6ee8302d 100644 --- a/src/data/list.ts +++ b/src/data/list.ts @@ -3,9 +3,15 @@ import { Type } from '@sinclair/typebox'; import { DataOperationsProvider } from './dataOperationsProvider'; import type { ListRequest, ListResponse } from '../pinecone-generated-ts-fetch'; +/** + * See [List record IDs](https://docs.pinecone.io/guides/data/list-record-ids) + */ export type ListOptions = { + /** The id prefix to match. If unspecified, an empty string prefix will be used with the effect of listing all ids in a namespace. */ prefix?: string; + /** The maximum number of ids to return. If unspecified, the server will use a default value. */ limit?: number; + /** A token needed to fetch the next page of results. This token is returned in the response if additional results are available. */ paginationToken?: string; }; diff --git a/src/index.ts b/src/index.ts index ad23fdaf..7cc19178 100644 --- a/src/index.ts +++ b/src/index.ts @@ -51,6 +51,7 @@ export type { FetchAPI, IndexList, IndexModel, + ListResponse, ServerlessSpec, ServerlessSpecCloudEnum, PodSpec,