Struct async_openai::types::CreateRunRequest

pub struct CreateRunRequest {

    pub assistant_id: String,
    pub model: Option<String>,
    pub instructions: Option<String>,
    pub additional_instructions: Option<String>,
    pub additional_messages: Option<Vec<CreateMessageRequest>>,
    pub tools: Option<Vec<AssistantTools>>,
    pub metadata: Option<HashMap<String, Value>>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub stream: Option<bool>,
    pub max_prompt_tokens: Option<u32>,
    pub max_completion_tokens: Option<u32>,
    pub truncation_strategy: Option<TruncationObject>,
    pub tool_choice: Option<AssistantsApiToolChoiceOption>,
    pub parallel_tool_calls: Option<bool>,
    pub response_format: Option<AssistantsApiResponseFormatOption>,
}

Fields

assistant_id: String

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

model: Option<String>

The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

instructions: Option<String>

Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.

additional_instructions: Option<String>

Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.

additional_messages: Option<Vec<CreateMessageRequest>>

Adds additional messages to the thread before creating the run.

tools: Option<Vec<AssistantTools>>

Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

metadata: Option<HashMap<String, Value>>

temperature: Option<f32>

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

top_p: Option<f32>

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or temperature but not both.

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<u32>

The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status incomplete. See incomplete_details for more info.

max_completion_tokens: Option<u32>

The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status incomplete. See incomplete_details for more info.

truncation_strategy: Option<TruncationObject>

Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.

tool_choice: Option<AssistantsApiToolChoiceOption>

parallel_tool_calls: Option<bool>

Whether to enable parallel function calling during tool use.

response_format: Option<AssistantsApiResponseFormatOption>

Trait Implementations

impl Clone for CreateRunRequest

fn clone(&self) -> CreateRunRequest

Returns a copy 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.

impl<'de> Deserialize<'de> for CreateRunRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateRunRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CreateRunRequest

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 CreateRunRequest