Struct RunObject 

pub struct RunObject {

    pub id: String,
    pub object: String,
    pub created_at: i64,
    pub thread_id: String,
    pub assistant_id: String,
    pub status: String,
    pub required_action: Option<RequiredAction>,
    pub last_error: Option<RunLastError>,
    pub expires_at: Option<i64>,
    pub started_at: Option<i64>,
    pub cancelled_at: Option<i64>,
    pub failed_at: Option<i64>,
    pub completed_at: Option<i64>,
    pub incomplete_details: Option<IncompleteDetails>,
    pub model: String,
    pub instructions: Option<String>,
    pub tools: Vec<Tool>,
    pub metadata: Option<Metadata>,
    pub usage: Option<CompletionUsage>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub max_prompt_tokens: Option<i32>,
    pub max_completion_tokens: Option<i32>,
    pub truncation_strategy: Option<TruncationObject>,
    pub tool_choice: Option<AssistantsApiToolChoiceOption>,
    pub parallel_tool_calls: bool,
    pub response_format: Option<AssistantsApiResponseFormatOption>,
}

Represents an execution run on a thread.

Used By

• /threads/runs (POST response)
• /threads/{thread_id}/runs (GET - in ListRunsResponse, POST response)
• /threads/{thread_id}/runs/{run_id} (GET, POST response)
• /threads/{thread_id}/runs/{run_id}/cancel (POST response)
• /threads/{thread_id}/runs/{run_id}/submit_tool_outputs (POST response)
• AssistantStreamEvent::ThreadRunCreated and other run status events

Fields

id: String

The identifier, which can be referenced in API endpoints.

object: String

The object type, which is always thread.run.

created_at: i64

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

thread_id: String

The ID of the thread that was executed on.

assistant_id: String

The ID of the assistant used for execution.

status: String

The status of the run.

required_action: Option<RequiredAction>

Details on the action required to continue the run. Null if no action is required.

last_error: Option<RunLastError>

The last error associated with this run. Null if no errors.

expires_at: Option<i64>

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

started_at: Option<i64>

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

cancelled_at: Option<i64>

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

failed_at: Option<i64>

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

completed_at: Option<i64>

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

incomplete_details: Option<IncompleteDetails>

Details on why the run is incomplete. Null if the run is not incomplete.

model: String

The model that the assistant used for this run.

instructions: Option<String>

The instructions that the assistant used for this run.

tools: Vec<Tool>

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

metadata: Option<Metadata>

Set of 16 key-value pairs attached to the object.

usage: Option<CompletionUsage>

Usage statistics related to the run. Null if the run is not in a terminal state.

temperature: Option<f32>

The sampling temperature used for this run.

top_p: Option<f32>

The nucleus sampling value used for this run.

max_prompt_tokens: Option<i32>

The maximum number of prompt tokens specified for the run.

max_completion_tokens: Option<i32>

The maximum number of completion tokens specified for the run.

truncation_strategy: Option<TruncationObject>

The truncation strategy used for the run.

tool_choice: Option<AssistantsApiToolChoiceOption>

The tool choice strategy used for the run.

parallel_tool_calls: bool

Whether parallel tool calls were enabled for this run.

response_format: Option<AssistantsApiResponseFormatOption>

The response format specified for this run.

Trait Implementations

impl Clone for RunObject

fn clone(&self) -> RunObject

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RunObject

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RunObject

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RunObject

fn eq(&self, other: &RunObject) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RunObject

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RunObject