Struct CreateRunRequest

pub struct CreateRunRequest {

    pub assistant_id: String,
    pub model: Option<CreateRunRequest_Model>,
    pub reasoning_effort: Option<ReasoningEffort>,
    pub instructions: Option<String>,
    pub additional_instructions: Option<String>,
    pub additional_messages: Option<Vec<CreateMessageRequest>>,
    pub tools: Option<Vec<CreateRunRequest_Tools>>,
    pub metadata: Option<Metadata>,
    pub temperature: Option<f64>,
    pub top_p: Option<f64>,
    pub stream: Option<bool>,
    pub max_prompt_tokens: Option<i64>,
    pub max_completion_tokens: Option<i64>,
    pub truncation_strategy: Option<TruncationObject>,
    pub tool_choice: Option<AssistantsApiToolChoiceOption>,
    pub parallel_tool_calls: Option<ParallelToolCalls>,
    pub response_format: Option<AssistantsApiResponseFormatOption>,
}

Fields

assistant_id: String

The ID of the assistant to use to execute this run.

model: Option<CreateRunRequest_Model>

reasoning_effort: Option<ReasoningEffort>

instructions: Option<String>

Overrides the instructions of the assistant.

additional_instructions: Option<String>

Appends additional instructions at the end of the instructions for the run.

additional_messages: Option<Vec<CreateMessageRequest>>

Adds additional messages to the thread before creating the run.

tools: Option<Vec<CreateRunRequest_Tools>>

Override the tools the assistant can use for this run.

metadata: Option<Metadata>

temperature: Option<f64>

What sampling temperature to use, between 0 and 2.

top_p: Option<f64>

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.

stream: Option<bool>

If true, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a data: [DONE] message.

max_prompt_tokens: Option<i64>

The maximum number of prompt tokens that may be used over the course of the run.

max_completion_tokens: Option<i64>

The maximum number of completion tokens that may be used over the course of the run.

truncation_strategy: Option<TruncationObject>

tool_choice: Option<AssistantsApiToolChoiceOption>

parallel_tool_calls: Option<ParallelToolCalls>

response_format: Option<AssistantsApiResponseFormatOption>

Trait Implementations

impl Clone for CreateRunRequest

fn clone(&self) -> CreateRunRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateRunRequest

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

Formats the value using the given formatter.

impl Default for CreateRunRequest

fn default() -> CreateRunRequest

Returns the “default value” for a type.