Class Threads

constructor

• new Threads(client): Threads

• Parameters

  • client: OpenAI

  Returns Threads

messages

runs

create

• create(body?, options?): APIPromise<OpenAIClient.Beta.Threads.Thread>

• Create a thread.

  Parameters

  • Optionalbody: ThreadCreateParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Thread>
• create(options?): APIPromise<OpenAIClient.Beta.Threads.Thread>

• Parameters

  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Thread>

createAndRun

• createAndRun(body, options?): APIPromise<OpenAIClient.Beta.Threads.Runs.Run>

• Create a thread and run it in one request.

  Parameters

  • body: OpenAIClient.Beta.Threads.ThreadCreateAndRunParamsNonStreaming
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Runs.Run>
• createAndRun(body, options?): APIPromise<Stream<AssistantStreamEvent>>

• Parameters

  • body: OpenAIClient.Beta.Threads.ThreadCreateAndRunParamsStreaming
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<Stream<AssistantStreamEvent>>

• createAndRun(body, options?): APIPromise<OpenAIClient.Beta.Threads.Runs.Run | Stream<AssistantStreamEvent>>

• Parameters

  • body: ThreadCreateAndRunParamsBase
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Runs.Run | Stream<AssistantStreamEvent>>

createAndRunPoll

• createAndRunPoll(body, options?): Promise<OpenAIClient.Beta.Threads.Runs.Run>

• A helper to create a thread, start a run and then poll for a terminal state. More information on Run lifecycles can be found here: https://platform.openai.com/docs/assistants/how-it-works/runs-and-run-steps

  Parameters

  • body: OpenAIClient.Beta.Threads.ThreadCreateAndRunParamsNonStreaming
  • Optionaloptions: RequestOptions<unknown> & {
        pollIntervalMs?: number;
    }

  Returns Promise<OpenAIClient.Beta.Threads.Runs.Run>

createAndRunStream

• createAndRunStream(body, options?): AssistantStream

• Create a thread and stream the run back

  Parameters

  • body: ThreadCreateAndRunParamsBaseStream
  • Optionaloptions: RequestOptions<unknown>

  Returns AssistantStream

del

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

• Delete a thread.

  Parameters

  • threadId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<ThreadDeleted>

retrieve

• retrieve(threadId, options?): APIPromise<OpenAIClient.Beta.Threads.Thread>

• Retrieves a thread.

  Parameters

  • threadId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Thread>

update

• update(threadId, body, options?): APIPromise<OpenAIClient.Beta.Threads.Thread>

• Modifies a thread.

  Parameters

  • threadId: string
  • body: ThreadUpdateParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Thread>