ChatGPT-Java-API/com.cjcrafter.openai.threads.runs/RunStep

RunStep

data class RunStep(val id: String, val createdAt: Int, val assistantId: String, val threadId: String, val runId: String, val type: RunStep.Type, val status: RunStatus, val stepDetails: RunStep.Details, val lastError: RunError?, val expiredAt: Int?, val cancelledAt: Int?, val failedAt: Int?, val completedAt: Int?, val metadata: Map<String, String> = emptyMap())

Each Run is broken down into steps. It is common for a Run to only have 1 step; creating a message. But with tool calls involved, an Assistant can create an arbitrary number of steps.

Constructors

RunStep

constructor(id: String, createdAt: Int, assistantId: String, threadId: String, runId: String, type: RunStep.Type, status: RunStatus, stepDetails: RunStep.Details, lastError: RunError?, expiredAt: Int?, cancelledAt: Int?, failedAt: Int?, completedAt: Int?, metadata: Map<String, String> = emptyMap())

Types

Details

sealed class Details

A sealed class that represents the details of a step.

Type

enum Type : Enum<RunStep.Type>

An enum that holds all possible types of steps.

Properties

assistantId

val assistantId: String

The ID of the Assistant that created this step

cancelledAt

val cancelledAt: Int?

The unix timestamp for when the step was cancelled.

completedAt

val completedAt: Int?

The unix timestamp for when the step completed.

createdAt

val createdAt: Int

The unix timestamp of when this step was created

expiredAt

val expiredAt: Int?

The unix timestamp of when this step expired. This is only present if the parent run has expired.

failedAt

val failedAt: Int?

The unix timestamp for when the step failed.

val id: String

The unique id of this step, which can be used in RunStepHandler.retrieve. Always starts with 'step_'. This is different from Run.id, which is also stored in this class as runId

lastError

val lastError: RunError?

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

metadata

val metadata: Map<String, String>

Metadata for this step. This can be useful for storing additional information about the object.

runId

val runId: String

The ID of the Run that this step was created in

status

val status: RunStatus

The status of this step (Can be either IN_PROGRESS, CANCELLED, FAILED, COMPLETED, or EXPIRED)

stepDetails

val stepDetails: RunStep.Details

The data generated at this step. The type of this data is determined by type. Make sure to check the type of this data before using it.

threadId

val threadId: String

The ID of the Thread that this step was created in

type

val type: RunStep.Type

The type of data stored by this step. This will match Details.type stored in stepDetails