Class Messages

Hierarchy

APIResource
- Messages

Index

Constructors

Methods

Constructors

constructor

new Messages(client): OpenAIClient.Chat.Completions.Messages
Parameters
- client: OpenAI
Returns OpenAIClient.Chat.Completions.Messages
Inherited from APIResource.constructor
- Defined in node_modules/openai/resource.d.ts:4

Methods

list

list(completionId, query?, options?): PagePromise<ChatCompletionStoreMessagesPage, ChatCompletionStoreMessage>
Get the messages in a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.
Parameters
- completionId: string
- Optionalquery: OpenAIClient.Chat.Completions.Messages.MessageListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<ChatCompletionStoreMessagesPage, ChatCompletionStoreMessage>
- Defined in node_modules/openai/resources/chat/completions/messages.d.ts:11
list(completionId, options?): PagePromise<ChatCompletionStoreMessagesPage, ChatCompletionStoreMessage>
Parameters
- completionId: string
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<ChatCompletionStoreMessagesPage, ChatCompletionStoreMessage>
- Defined in node_modules/openai/resources/chat/completions/messages.d.ts:12