Struct RunObject

pub struct RunObject {

    pub id: String,
    pub created_at: u64,
    pub thread_id: String,
    pub assistant_id: String,
    pub status: RunObjectStatus,
    pub required_action: Option<RunObjectRequiredAction>,
    pub last_error: Option<RunObjectLastError>,
    pub expires_at: Option<u64>,
    pub started_at: Option<u64>,
    pub cancelled_at: Option<u64>,
    pub failed_at: Option<u64>,
    pub completed_at: Option<u64>,
    pub incomplete_details: Option<RunObjectIncompleteDetails>,
    pub model: String,
    pub instructions: String,
    pub tools: Vec<RunObjectTool>,
    pub metadata: Metadata,
    pub usage: RunCompletionUsage,
    pub temperature: Option<f64>,
    pub top_p: Option<f64>,
    pub max_prompt_tokens: Option<u64>,
    pub max_completion_tokens: Option<u64>,
    pub truncation_strategy: Option<TruncationObject>,
    pub tool_choice: Option<AssistantsApiToolChoiceOption>,
    pub parallel_tool_calls: ParallelToolCalls,
    pub response_format: Option<AssistantsApiResponseFormatOption>,
}

Represents an execution run on a thread.

Fields

id: String

The identifier, which can be referenced in API endpoints.

created_at: u64

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

thread_id: String

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

assistant_id: String

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

status: RunObjectStatus

The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.

required_action: Option<RunObjectRequiredAction>

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

last_error: Option<RunObjectLastError>

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

expires_at: Option<u64>

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

started_at: Option<u64>

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

cancelled_at: Option<u64>

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

failed_at: Option<u64>

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

completed_at: Option<u64>

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

incomplete_details: Option<RunObjectIncompleteDetails>

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

model: String

The model that the assistant used for this run.

instructions: String

The instructions that the assistant used for this run.

tools: Vec<RunObjectTool>

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

metadata: Metadata

usage: RunCompletionUsage

temperature: Option<f64>

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

top_p: Option<f64>

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

max_prompt_tokens: Option<u64>

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

max_completion_tokens: Option<u64>

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

truncation_strategy: Option<TruncationObject>

tool_choice: Option<AssistantsApiToolChoiceOption>

parallel_tool_calls: ParallelToolCalls

response_format: Option<AssistantsApiResponseFormatOption>

Implementations

impl RunObject

pub fn builder() -> RunObjectBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building RunObject. On the builder, call .id(...), .created_at(...), .thread_id(...), .assistant_id(...), .status(...), .required_action(...)(optional), .last_error(...)(optional), .expires_at(...)(optional), .started_at(...)(optional), .cancelled_at(...)(optional), .failed_at(...)(optional), .completed_at(...)(optional), .incomplete_details(...)(optional), .model(...), .instructions(...), .tools(...), .metadata(...), .usage(...), .temperature(...)(optional), .top_p(...)(optional), .max_prompt_tokens(...)(optional), .max_completion_tokens(...)(optional), .truncation_strategy(...)(optional), .tool_choice(...)(optional), .parallel_tool_calls(...), .response_format(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RunObject.

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