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

Class: Threads

OpenAI.Beta.Threads

Hierarchy

• APIResource

  ↳ Threads

Table of contents

Constructors

• constructor

Properties

• _client
• messages
• runs

Methods

• create
• createAndRun
• del
• retrieve
• update

Constructors

constructor

• new Threads(client): Threads

Parameters

Name	Type
client	OpenAI

Returns

Threads

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

---

messages

• messages: Messages

Defined in

node_modules/openai/resources/beta/threads/threads.d.ts:9

---

runs

• runs: Runs

Defined in

node_modules/openai/resources/beta/threads/threads.d.ts:8

Methods

create

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

Create a thread.

Parameters

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

Returns

APIPromise<Thread>

Defined in

node_modules/openai/resources/beta/threads/threads.d.ts:13

▸ create(options?): APIPromise<Thread>

Parameters

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

Returns

APIPromise<Thread>

Defined in

node_modules/openai/resources/beta/threads/threads.d.ts:14

---

createAndRun

▸ createAndRun(body, options?): APIPromise<Run>

Create a thread and run it in one request.

Parameters

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

Returns

APIPromise<Run>

Defined in

node_modules/openai/resources/beta/threads/threads.d.ts:30

---

del

▸ del(threadId, options?): APIPromise<ThreadDeleted>

Delete a thread.

Parameters

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

Returns

APIPromise<ThreadDeleted>

Defined in

node_modules/openai/resources/beta/threads/threads.d.ts:26

---

retrieve

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

Retrieves a thread.

Parameters

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

Returns

APIPromise<Thread>

Defined in

node_modules/openai/resources/beta/threads/threads.d.ts:18

---

update

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

Modifies a thread.

Parameters

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

Returns

APIPromise<Thread>

Defined in

node_modules/openai/resources/beta/threads/threads.d.ts:22