class

OpenAI::RunStepObject

Inherits JSON::Serializable < Reference < Object

Represents a step in execution of a run.

Constructors

new(pull : JSON::PullParser)

new(id : String = "", object : RunStepObjectObject = RunStepObjectObject::ThreadRunStep, created_at : Int64 = 0, assistant_id : String = "", thread_id : String = "", run_id : String = "", type_value : RunStepObjectType = RunStepObjectType::MessageCreation, status : RunStepObjectStatus = RunStepObjectStatus::InProgress, step_details : RunStepObjectStepDetails = RunStepDetailsMessageCreationObject.new, last_error : RunStepObjectLastError = nil, expired_at : RunStepObjectExpiredAt = nil, cancelled_at : RunStepObjectCancelledAt = nil, failed_at : RunStepObjectFailedAt = nil, completed_at : RunStepObjectCompletedAt = nil, metadata : Metadata = nil, usage : RunStepCompletionUsage = nil)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

assistant_id

The ID of the assistant associated with the run step.

assistant_id=(assistant_id : String)

The ID of the assistant associated with the run step.

cancelled_at

cancelled_at=(cancelled_at : RunStepObjectCancelledAt)

completed_at

completed_at=(completed_at : RunStepObjectCompletedAt)

created_at

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

created_at=(created_at : Int64)

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

expired_at

expired_at=(expired_at : RunStepObjectExpiredAt)

failed_at

failed_at=(failed_at : RunStepObjectFailedAt)

id

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

id=(id : String)

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

last_error

last_error=(last_error : RunStepObjectLastError)

metadata

metadata=(metadata : Metadata)

object

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

object=(object : RunStepObjectObject)

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

run_id

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

run_id=(run_id : String)

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

status

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

status=(status : RunStepObjectStatus)

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

step_details

The details of the run step.

step_details=(step_details : RunStepObjectStepDetails)

The details of the run step.

thread_id

The ID of the thread that was run.

thread_id=(thread_id : String)

The ID of the thread that was run.

type_value

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

type_value=(type_value : RunStepObjectType)

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

usage

usage=(usage : RunStepCompletionUsage)