Skip to main content
Module

x/openai/resources/beta/threads/runs/runs.ts>Run

Deno build of the official Typescript library for the OpenAI API.
openai/openai-deno-build
Extremely Popular
Go to Latest
namespace Run
import { Run } from "https://deno.land/x/openai@v4.33.0/resources/beta/threads/runs/runs.ts";

Interfaces

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

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

Details on the tool outputs needed for this run to continue.

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.).

interface Run
import { type Run } from "https://deno.land/x/openai@v4.33.0/resources/beta/threads/runs/runs.ts";

Represents an execution run on a thread.

Properties

id: string

The identifier, which can be referenced in API endpoints.

assistant_id: string

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

cancelled_at: number | null

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

completed_at: number | null

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

created_at: number

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

expires_at: number | null

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

failed_at: number | null

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

file_ids: Array<string>

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

instructions: string

The instructions that the assistant used for this run.

last_error: Run.LastError | null

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

metadata: unknown | null

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: string

The model that the assistant used for this run.

object: "thread.run"

The object type, which is always thread.run.

required_action: Run.RequiredAction | null

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

started_at: number | null

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

status: RunStatus

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

thread_id: string

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

tools: Array<AssistantsAPI.AssistantTool>

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

usage: Run.Usage | null

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.).

optional
temperature: number | null

The sampling temperature used for this run. If not set, defaults to 1.