Threads | /resources/beta/threads/threads.ts | openai@v4.69.0

namespace Threads

import { Threads } from "https://deno.land/x/openai@v4.69.0/resources/beta/threads/threads.ts";

Type Aliases

T Threads.Annotation
T Threads.AnnotationDelta
T Threads.AssistantResponseFormatOption
T Threads.AssistantToolChoice
T Threads.AssistantToolChoiceFunction
T Threads.AssistantToolChoiceOption
T Threads.FileCitationAnnotation
T Threads.FileCitationDeltaAnnotation
T Threads.FilePathAnnotation
T Threads.FilePathDeltaAnnotation
T Threads.ImageFile
T Threads.ImageFileContentBlock
T Threads.ImageFileDelta
T Threads.ImageFileDeltaBlock
T Threads.ImageURL
T Threads.ImageURLContentBlock
T Threads.ImageURLDelta
T Threads.ImageURLDeltaBlock
T Threads.Message
T Threads.MessageContent
T Threads.MessageContentDelta
T Threads.MessageContentPartParam
T Threads.MessageCreateParams
T Threads.MessageDeleted
T Threads.MessageDelta
T Threads.MessageDeltaEvent
T Threads.MessageListParams
T Threads.MessageUpdateParams
T Threads.RefusalContentBlock
T Threads.RefusalDeltaBlock
T Threads.RequiredActionFunctionToolCall
T Threads.Run
T Threads.RunCreateAndPollParams
T Threads.RunCreateAndStreamParams
T Threads.RunCreateParams
T Threads.RunCreateParamsNonStreaming
T Threads.RunCreateParamsStreaming
T Threads.RunListParams
T Threads.RunStatus
T Threads.RunStreamParams
T Threads.RunSubmitToolOutputsAndPollParams
T Threads.RunSubmitToolOutputsParams
T Threads.RunSubmitToolOutputsParamsNonStreaming
T Threads.RunSubmitToolOutputsParamsStreaming
T Threads.RunSubmitToolOutputsStreamParams
T Threads.RunUpdateParams
T Threads.Text
T Threads.TextContentBlock
T Threads.TextContentBlockParam
T Threads.TextDelta
T Threads.TextDeltaBlock
T Threads.Thread
T Threads.ThreadCreateAndRunParams
T Threads.ThreadCreateAndRunParamsNonStreaming
T Threads.ThreadCreateAndRunParamsStreaming
T Threads.ThreadCreateAndRunPollParams
T Threads.ThreadCreateAndRunStreamParams
T Threads.ThreadCreateParams
T Threads.ThreadDeleted
T Threads.ThreadUpdateParams

class Threads

extends APIResource

import { Threads } from "https://deno.land/x/openai@v4.69.0/resources/beta/threads/threads.ts";

Properties

messages: MessagesAPI.Messages

runs: RunsAPI.Runs

Methods

create(body?: ThreadCreateParams, options?: Core.RequestOptions): Core.APIPromise<Thread>

Create a thread.

create(options?: Core.RequestOptions): Core.APIPromise<Thread>

createAndRun(body: ThreadCreateAndRunParamsNonStreaming, options?: Core.RequestOptions): APIPromise<RunsAPI.Run>

Create a thread and run it in one request.

createAndRun(body: ThreadCreateAndRunParamsStreaming, options?: Core.RequestOptions): APIPromise<Stream<AssistantsAPI.AssistantStreamEvent>>

createAndRun(body: ThreadCreateAndRunParamsBase, options?: Core.RequestOptions): APIPromise<Stream<AssistantsAPI.AssistantStreamEvent> | RunsAPI.Run>

createAndRunPoll(body: ThreadCreateAndRunParamsNonStreaming, options?: Core.RequestOptions & { pollIntervalMs?: number; }): Promise<Threads.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

createAndRunStream(body: ThreadCreateAndRunParamsBaseStream, options?: Core.RequestOptions): AssistantStream

Create a thread and stream the run back

del(threadId: string, options?: Core.RequestOptions): Core.APIPromise<ThreadDeleted>

Delete a thread.

retrieve(threadId: string, options?: Core.RequestOptions): Core.APIPromise<Thread>

Retrieves a thread.

update(

threadId: string,

body: ThreadUpdateParams,

options?: Core.RequestOptions,

): Core.APIPromise<Thread>

Modifies a thread.