Struct CreateRunRequest 

pub struct CreateRunRequest {

    pub assistant_id: String,
    pub model: Option<String>,
    pub instructions: Option<String>,
    pub additional_instructions: Option<String>,
    pub tools: Option<Vec<AssistantTool>>,
    pub metadata: Option<HashMap<String, String>>,
    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<TruncationStrategy>,
    pub tool_choice: Option<ToolChoice>,
    pub response_format: Option<ResponseFormat>,
}

Request to create a run.

Example

use portkey::model::CreateRunRequest;

let request = CreateRunRequest::builder()
    .assistant_id("asst_abc123")
    .build()
    .unwrap();

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.

instructions: Option<String>

Override the default system message of the assistant.

additional_instructions: Option<String>

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

tools: Option<Vec<AssistantTool>>

Override the tools the assistant can use for this run.

metadata: Option<HashMap<String, String>>

Set of key-value pairs that can be attached to an object.

temperature: Option<f32>

What sampling temperature to use, between 0 and 2.

top_p: Option<f32>

An alternative to sampling with temperature.

max_prompt_tokens: Option<i32>

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

max_completion_tokens: Option<i32>

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

truncation_strategy: Option<TruncationStrategy>

Controls for how a thread will be truncated.

tool_choice: Option<ToolChoice>

Controls which (if any) tool is called by the model.

response_format: Option<ResponseFormat>

Specifies the format that the model must output.

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.

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