Interface Run

Represents an execution run on a thread.

interface Run {
    assistant_id: string;
    cancelled_at: null | number;
    completed_at: null | number;
    created_at: number;
    expires_at: number;
    failed_at: null | number;
    file_ids: string[];
    id: string;
    instructions: string;
    last_error: null | openai.OpenAI.Beta.Threads.Runs.Run.LastError;
    metadata: unknown;
    model: string;
    object: "thread.run";
    required_action: null | RequiredAction;
    started_at: null | number;
    status: "queued" | "failed" | "cancelled" | "in_progress" | "requires_action" | "cancelling" | "completed" | "expired";
    thread_id: string;
    tools: (openai.OpenAI.Beta.Threads.Runs.Run.AssistantToolsCode | openai.OpenAI.Beta.Threads.Runs.Run.AssistantToolsRetrieval | openai.OpenAI.Beta.Threads.Runs.Run.AssistantToolsFunction)[];
    usage: null | openai.OpenAI.Beta.Threads.Runs.Run.Usage;
}

Properties

assistant_id cancelled_at completed_at created_at expires_at failed_at file_ids id instructions last_error metadata model object required_action started_at status thread_id tools usage

Properties

assistant_id

assistant_id: string

The ID of the assistant used for execution of this run.

cancelled_at

cancelled_at: null | number

The Unix timestamp (in seconds) for when the run was cancelled.

completed_at

completed_at: null | number

The Unix timestamp (in seconds) for when the run was completed.

created_at

created_at: number

The Unix timestamp (in seconds) for when the run was created.

expires_at

expires_at: number

The Unix timestamp (in seconds) for when the run will expire.

failed_at

failed_at: null | number

The Unix timestamp (in seconds) for when the run failed.

file_ids

file_ids: string[]

The list of File IDs the assistant used for this run.

id

id: string

The identifier, which can be referenced in API endpoints.

instructions

instructions: string

The instructions that the assistant used for this run.

last_error

last_error: null | openai.OpenAI.Beta.Threads.Runs.Run.LastError

The last error associated with this run. Will be null if there are no errors.

metadata

metadata: unknown

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

model

model: string

The model that the assistant used for this run.

object

object: "thread.run"

The object type, which is always thread.run.

required_action

required_action: null | RequiredAction

Details on the action required to continue the run. Will be null if no action is required.

started_at

started_at: null | number

The Unix timestamp (in seconds) for when the run was started.

status

status: "queued" | "failed" | "cancelled" | "in_progress" | "requires_action" | "cancelling" | "completed" | "expired"

The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, or expired.

thread_id

thread_id: string

The ID of the thread that was executed on as a part of this run.

tools

tools: (openai.OpenAI.Beta.Threads.Runs.Run.AssistantToolsCode | openai.OpenAI.Beta.Threads.Runs.Run.AssistantToolsRetrieval | openai.OpenAI.Beta.Threads.Runs.Run.AssistantToolsFunction)[]

The list of tools that the assistant used for this run.

usage

usage: null | openai.OpenAI.Beta.Threads.Runs.Run.Usage

Usage statistics related to the run. This value will be null if the run is not in a terminal state (i.e. in_progress, queued, etc.).

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc