messages.d.ts 1.5 KB

1234567891011121314151617181920212223242526272829303132333435
  1. import { APIResource } from "../../../resource.js";
  2. import * as Core from "../../../core.js";
  3. import * as CompletionsAPI from "./completions.js";
  4. import { ChatCompletionStoreMessagesPage } from "./completions.js";
  5. import { type CursorPageParams } from "../../../pagination.js";
  6. export declare class Messages extends APIResource {
  7. /**
  8. * Get the messages in a stored chat completion. Only Chat Completions that have
  9. * been created with the `store` parameter set to `true` will be returned.
  10. *
  11. * @example
  12. * ```ts
  13. * // Automatically fetches more pages as needed.
  14. * for await (const chatCompletionStoreMessage of client.chat.completions.messages.list(
  15. * 'completion_id',
  16. * )) {
  17. * // ...
  18. * }
  19. * ```
  20. */
  21. list(completionId: string, query?: MessageListParams, options?: Core.RequestOptions): Core.PagePromise<ChatCompletionStoreMessagesPage, CompletionsAPI.ChatCompletionStoreMessage>;
  22. list(completionId: string, options?: Core.RequestOptions): Core.PagePromise<ChatCompletionStoreMessagesPage, CompletionsAPI.ChatCompletionStoreMessage>;
  23. }
  24. export interface MessageListParams extends CursorPageParams {
  25. /**
  26. * Sort order for messages by timestamp. Use `asc` for ascending order or `desc`
  27. * for descending order. Defaults to `asc`.
  28. */
  29. order?: 'asc' | 'desc';
  30. }
  31. export declare namespace Messages {
  32. export { type MessageListParams as MessageListParams };
  33. }
  34. export { ChatCompletionStoreMessagesPage };
  35. //# sourceMappingURL=messages.d.ts.map