Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/openai_deno/mod.ts>RunStep

OpenAI API wrapper for deno.
Latest
interface RunStep
implements HasMetadata
Re-export
import { type RunStep } from "https://deno.land/x/openai_deno@v0.9.8/mod.ts";

Properties

id: string

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

object: "thread.run.step"

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

createdAt: number

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

assistantID: string

The ID of the assistant associated with the run step.

threadID: string

The ID of the thread that was run.

runID: string

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

type: "messageCreation" | "toolCalls" | string

The type of run step, which can be either messageCreation or toolCalls.

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

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

stepDetails: { type: "messageCreation"; messageID: string; } | { type: "toolCalls"; toolCalls: ({ id: string; type: "codeInterpreter"; input: string; outputs: ({ type: "logs"; logs: string; } | { type: "image"; fileID: string; })[]; } | { id: string; type: "retrieval"; retrieval: never; } | { id: string; type: "function"; name: string; arguments: string; output?: string | null; })[]; }

The details of the run step.

optional
lastError: { code: "serverError" | "rateLimitExceeded" | string; message: string; } | null

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

optional
expiresAt: number | null

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

optional
cancelledAt: number | null

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

optional
failedAt: number | null

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

optional
completedAt: number | null

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