openaiRtools (version 0.2.2)

ThreadsClient: Threads Client (Beta)

Description

A Thread stores the message history of a conversation with an Assistant. Threads are persistent: they accumulate messages over multiple runs and can be retrieved at any time.

Sub-clients

$runs

RunsClient — Create and manage runs on threads

$messages

MessagesClient — Add and read thread messages

Typical workflow

1. Create a thread: client$threads$create()

2. Add user message: client$threads$messages$create(thread_id, "user", "...")

3. Create a run: client$threads$runs$create(thread_id, assistant_id)

4. Poll run until $status == "completed"

5. Read response: client$threads$messages$list(thread_id)

Methods

Public methods

• ThreadsClient$new()

• ThreadsClient$create()

• ThreadsClient$retrieve()

• ThreadsClient$update()

• ThreadsClient$delete()

• ThreadsClient$create_and_run()

• ThreadsClient$clone()

---

Method new()

Usage

ThreadsClient$new(parent)

---

Method create()

Usage

ThreadsClient$create(messages = NULL, tool_resources = NULL, metadata = NULL)

---

Method retrieve()

Usage

ThreadsClient$retrieve(thread_id)

---

Method update()

Usage

ThreadsClient$update(thread_id, ...)

---

Method delete()

Usage

ThreadsClient$delete(thread_id)

---

Method create_and_run()

Usage

ThreadsClient$create_and_run(
  assistant_id,
  thread = NULL,
  model = NULL,
  instructions = NULL,
  tools = NULL,
  tool_resources = NULL,
  metadata = NULL,
  stream = NULL,
  callback = NULL
)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ThreadsClient$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

Client for the OpenAI Threads API v2 (Beta). Threads are persistent conversation containers for Assistants. Access via client$threads.