class

OpenAI::RunObject

Inherits JSON::Serializable < Reference < Object

Represents an execution run on a thread.

Constructors

new(pull : JSON::PullParser)

new(id : String = "", object : RunObjectObject = RunObjectObject::ThreadRun, created_at : Int64 = 0, thread_id : String = "", assistant_id : String = "", status : RunStatus = RunStatus::Queued, required_action : RunObjectRequiredAction | Nil = nil, last_error : RunObjectLastError | Nil = nil, expires_at : Int64 | Nil = nil, started_at : Int64 | Nil = nil, cancelled_at : Int64 | Nil = nil, failed_at : Int64 | Nil = nil, completed_at : Int64 | Nil = nil, incomplete_details : RunObjectIncompleteDetails | Nil = nil, model : String = "", instructions : String = "", tools : Array(AssistantTool) = [] of AssistantTool, metadata : Metadata = nil, usage : RunCompletionUsage = nil, temperature : Float64 | Nil = nil, top_p : Float64 | Nil = nil, max_prompt_tokens : Int64 | Nil = nil, max_completion_tokens : Int64 | Nil = nil, truncation_strategy : RunObjectTruncationStrategy = RunObjectTruncationStrategy.new, tool_choice : RunObjectToolChoice = RunObjectToolChoice.new, parallel_tool_calls : ParallelToolCalls = ParallelToolCalls.new, response_format : AssistantsApiResponseFormatOption | Nil = nil)

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

Instance methods

assistant_id

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

assistant_id=(assistant_id : String)

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

cancelled_at

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

cancelled_at=(cancelled_at : Int64 | Nil)

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

completed_at

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

completed_at=(completed_at : Int64 | Nil)

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

created_at

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

created_at=(created_at : Int64)

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

expires_at

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

expires_at=(expires_at : Int64 | Nil)

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

failed_at

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

failed_at=(failed_at : Int64 | Nil)

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

id

The identifier, which can be referenced in API endpoints.

id=(id : String)

The identifier, which can be referenced in API endpoints.

incomplete_details

Details on why the run is incomplete. Will be null if the run is not incomplete.

incomplete_details=(incomplete_details : RunObjectIncompleteDetails | Nil)

Details on why the run is incomplete. Will be null if the run is not incomplete.

instructions

The instructions that the assistant used for this run.

instructions=(instructions : String)

The instructions that the assistant used for this run.

last_error

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

last_error=(last_error : RunObjectLastError | Nil)

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

max_completion_tokens

The maximum number of completion tokens specified to have been used over the course of the run.

max_completion_tokens=(max_completion_tokens : Int64 | Nil)

The maximum number of completion tokens specified to have been used over the course of the run.

max_prompt_tokens

The maximum number of prompt tokens specified to have been used over the course of the run.

max_prompt_tokens=(max_prompt_tokens : Int64 | Nil)

The maximum number of prompt tokens specified to have been used over the course of the run.

metadata

metadata=(metadata : Metadata)

model

The model that the assistant used for this run.

model=(model : String)

The model that the assistant used for this run.

object

The object type, which is always thread.run.

object=(object : RunObjectObject)

The object type, which is always thread.run.

parallel_tool_calls

parallel_tool_calls=(parallel_tool_calls : ParallelToolCalls)

required_action

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

required_action=(required_action : RunObjectRequiredAction | Nil)

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

response_format

response_format=(response_format : AssistantsApiResponseFormatOption | Nil)

started_at

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

started_at=(started_at : Int64 | Nil)

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

status

status=(status : RunStatus)

temperature

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

temperature=(temperature : Float64 | Nil)

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

thread_id

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

thread_id=(thread_id : String)

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

tool_choice

tool_choice=(tool_choice : RunObjectToolChoice)

tools

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

tools=(tools : Array(AssistantTool))

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

top_p

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

top_p=(top_p : Float64 | Nil)

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

truncation_strategy

truncation_strategy=(truncation_strategy : RunObjectTruncationStrategy)

usage

usage=(usage : RunCompletionUsage)

validate!