@ralphschuler.ai function caller.index.<internal>.OpenAI.Beta.Threads.Messages

Class: Messages

Beta.Threads.Messages

Hierarchy

• APIResource

  ↳ Messages

Table of contents

Constructors

• constructor

Properties

• _client
• files

Methods

• create
• list
• retrieve
• update

Constructors

constructor

• new Messages(client): Messages

Parameters

Name	Type
client	OpenAI

Returns

Messages

Inherited from

APIResource.constructor

Defined in

node_modules/openai/resource.d.ts:4

Properties

_client

• Protected _client: OpenAI

Inherited from

APIResource._client

Defined in

node_modules/openai/resource.d.ts:3

---

files

• files: Files

Defined in

node_modules/openai/resources/beta/threads/messages/messages.d.ts:7

Methods

create

▸ create(threadId, body, options?): APIPromise<ThreadMessage>

Create a message.

Parameters

Name	Type
threadId	string
body	MessageCreateParams
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<ThreadMessage>

Defined in

node_modules/openai/resources/beta/threads/messages/messages.d.ts:11

---

list

▸ list(threadId, query?, options?): PagePromise<ThreadMessagesPage, ThreadMessage>

Returns a list of messages for a given thread.

Parameters

Name	Type
threadId	string
query?	MessageListParams
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

PagePromise<ThreadMessagesPage, ThreadMessage>

Defined in

node_modules/openai/resources/beta/threads/messages/messages.d.ts:23

▸ list(threadId, options?): PagePromise<ThreadMessagesPage, ThreadMessage>

Parameters

Name	Type
threadId	string
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

PagePromise<ThreadMessagesPage, ThreadMessage>

Defined in

node_modules/openai/resources/beta/threads/messages/messages.d.ts:24

---

retrieve

▸ retrieve(threadId, messageId, options?): APIPromise<ThreadMessage>

Retrieve a message.

Parameters

Name	Type
threadId	string
messageId	string
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<ThreadMessage>

Defined in

node_modules/openai/resources/beta/threads/messages/messages.d.ts:15

---

update

▸ update(threadId, messageId, body, options?): APIPromise<ThreadMessage>

Modifies a message.

Parameters

Name	Type
threadId	string
messageId	string
body	MessageUpdateParams
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<ThreadMessage>

Defined in

node_modules/openai/resources/beta/threads/messages/messages.d.ts:19