Struct CreateThreadAndRunRequest

Source
pub struct CreateThreadAndRunRequest {
Show 16 fields pub assistant_id: String, pub instructions: Option<String>, pub max_completion_tokens: Option<i32>, pub max_prompt_tokens: Option<i32>, pub metadata: Option<Metadata>, pub model: Option<Value>, pub parallel_tool_calls: Option<ParallelToolCalls>, pub response_format: Option<AssistantsApiResponseFormatOption>, pub stream: Option<bool>, pub temperature: Option<f32>, pub thread: Option<CreateThreadRequest>, pub tool_choice: Option<CreateRunRequestToolChoice>, pub tool_resources: Option<CreateThreadAndRunRequestToolResources>, pub tools: Option<Vec<Value>>, pub top_p: Option<f32>, pub truncation_strategy: Option<CreateRunRequestToolChoice>,
}

Fields§

§assistant_id: String

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

§instructions: Option<String>

Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.

§max_completion_tokens: Option<i32>

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.

§max_prompt_tokens: Option<i32>

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.

§metadata: Option<Metadata>§model: Option<Value>

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.

§parallel_tool_calls: Option<ParallelToolCalls>§response_format: Option<AssistantsApiResponseFormatOption>§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.

§temperature: Option<f32>

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

§thread: Option<CreateThreadRequest>§tool_choice: Option<CreateRunRequestToolChoice>§tool_resources: Option<CreateThreadAndRunRequestToolResources>§tools: Option<Vec<Value>>

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

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

§truncation_strategy: Option<CreateRunRequestToolChoice>

Trait Implementations§

Source§

impl Debug for CreateThreadAndRunRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CreateThreadAndRunRequest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CreateThreadAndRunRequest

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,