Class Messages

Hierarchy

APIResource
- Messages

Index

Constructors

Properties

Methods

create del list retrieve update

Constructors

constructor

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

Properties

`Protected`_client

_client: OpenAI

Methods

create

create(threadId, body, options?): APIPromise<OpenAI.Beta.Threads.Messages.Message>
Create a message.
Parameters
- threadId: string
- body: MessageCreateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<OpenAI.Beta.Threads.Messages.Message>
- Defined in node_modules/openai/resources/beta/threads/messages.d.ts:10

del

del(threadId, messageId, options?): APIPromise<MessageDeleted>
Deletes a message.
Parameters
- threadId: string
- messageId: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<MessageDeleted>
- Defined in node_modules/openai/resources/beta/threads/messages.d.ts:27

list

list(threadId, query?, options?): PagePromise<MessagesPage, OpenAI.Beta.Threads.Messages.Message>
Returns a list of messages for a given thread.
Parameters
- threadId: string
- Optionalquery: MessageListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<MessagesPage, OpenAI.Beta.Threads.Messages.Message>
- Defined in node_modules/openai/resources/beta/threads/messages.d.ts:22
list(threadId, options?): PagePromise<MessagesPage, OpenAI.Beta.Threads.Messages.Message>
Parameters
- threadId: string
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<MessagesPage, OpenAI.Beta.Threads.Messages.Message>
- Defined in node_modules/openai/resources/beta/threads/messages.d.ts:23

retrieve

retrieve(threadId, messageId, options?): APIPromise<OpenAI.Beta.Threads.Messages.Message>
Retrieve a message.
Parameters
- threadId: string
- messageId: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<OpenAI.Beta.Threads.Messages.Message>
- Defined in node_modules/openai/resources/beta/threads/messages.d.ts:14

update

update(threadId, messageId, body, options?): APIPromise<OpenAI.Beta.Threads.Messages.Message>
Modifies a message.
Parameters
- threadId: string
- messageId: string
- body: MessageUpdateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<OpenAI.Beta.Threads.Messages.Message>
- Defined in node_modules/openai/resources/beta/threads/messages.d.ts:18