Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Export ListResponse type from generated core, add docstring for ListOptions #210

Merged
merged 1 commit into from
Mar 25, 2024
Merged

Export ListResponse type from generated core, add docstring for ListOptions #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/data/list.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
};

Expand Down
1 change: 1 addition & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ export type {
FetchAPI,
IndexList,
IndexModel,
ListResponse,
ServerlessSpec,
ServerlessSpecCloudEnum,
PodSpec,
Expand Down
Loading