Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/openai/resources/beta/threads/runs/steps.ts>RunStep

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

Interfaces

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

Usage statistics related to the run step. This value will be null while the run step's status is in_progress.

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

Represents a step in execution of a run.

Properties

id: string

The identifier of the run step, which can be referenced in API endpoints.

assistant_id: string

The ID of the assistant associated with the run step.

cancelled_at: number | null

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

completed_at: number | null

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

created_at: number

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

expired_at: number | null

The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.

failed_at: number | null

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

last_error: RunStep.LastError | null

The last error associated with this run step. 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.

object: "thread.run.step"

The object type, which is always thread.run.step.

run_id: string

The ID of the run that this run step is a part of.

status:
| "in_progress"
| "cancelled"
| "failed"
| "completed"
| "expired"

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

step_details: MessageCreationStepDetails | ToolCallsStepDetails

The details of the run step.

thread_id: string

The ID of the thread that was run.

type: "message_creation" | "tool_calls"

The type of run step, which can be either message_creation or tool_calls.

usage: RunStep.Usage | null

Usage statistics related to the run step. This value will be null while the run step's status is in_progress.