/opt/canhelp/node_modules/openai/core
Edit: /opt/canhelp/node_modules/openai/core/pagination.d.mts (3570B)
import { FinalRequestOptions } from "../internal/request-options.mjs";
import { APIPromise } from "./api-promise.mjs";
import { type OpenAI } from "../client.mjs";
import { type APIResponseProps } from "../internal/parse.mjs";
export type PageRequestOptions = Pick
;
export declare abstract class AbstractPage- implements AsyncIterable
- {
#private;
protected options: FinalRequestOptions;
protected response: Response;
protected body: unknown;
constructor(client: OpenAI, response: Response, body: unknown, options: FinalRequestOptions);
abstract nextPageRequestOptions(): PageRequestOptions | null;
abstract getPaginatedItems(): Item[];
hasNextPage(): boolean;
getNextPage(): Promise;
iterPages(): AsyncGenerator;
[Symbol.asyncIterator](): AsyncGenerator
- ;
}
/**
* This subclass of Promise will resolve to an instantiated Page once the request completes.
*
* It also implements AsyncIterable to allow auto-paginating iteration on an unawaited list call, eg:
*
* for await (const item of client.items.list()) {
* console.log(item)
* }
*/
export declare class PagePromise, Item = ReturnType[number]> extends APIPromise implements AsyncIterable
- {
constructor(client: OpenAI, request: Promise, Page: new (...args: ConstructorParameters) => PageClass);
/**
* Allow auto-paginating iteration on an unawaited list call, eg:
*
* for await (const item of client.items.list()) {
* console.log(item)
* }
*/
[Symbol.asyncIterator](): AsyncGenerator
- ;
}
export interface PageResponse
- {
data: Array
- ;
object: string;
}
/**
* Note: no pagination actually occurs yet, this is for forwards-compatibility.
*/
export declare class Page
- extends AbstractPage
- implements PageResponse
- {
data: Array
- ;
object: string;
constructor(client: OpenAI, response: Response, body: PageResponse
- , options: FinalRequestOptions);
getPaginatedItems(): Item[];
nextPageRequestOptions(): PageRequestOptions | null;
}
export interface CursorPageResponse
- {
data: Array
- ;
has_more: boolean;
}
export interface CursorPageParams {
after?: string;
limit?: number;
}
export declare class CursorPage
- extends AbstractPage
- implements CursorPageResponse
- {
data: Array
- ;
has_more: boolean;
constructor(client: OpenAI, response: Response, body: CursorPageResponse
- , options: FinalRequestOptions);
getPaginatedItems(): Item[];
hasNextPage(): boolean;
nextPageRequestOptions(): PageRequestOptions | null;
}
export interface ConversationCursorPageResponse
- {
data: Array
- ;
has_more: boolean;
last_id: string;
}
export interface ConversationCursorPageParams {
after?: string;
limit?: number;
}
export declare class ConversationCursorPage
- extends AbstractPage
- implements ConversationCursorPageResponse
- {
data: Array
- ;
has_more: boolean;
last_id: string;
constructor(client: OpenAI, response: Response, body: ConversationCursorPageResponse
- , options: FinalRequestOptions);
getPaginatedItems(): Item[];
hasNextPage(): boolean;
nextPageRequestOptions(): PageRequestOptions | null;
}
//# sourceMappingURL=pagination.d.mts.map