pub struct CreateThreadAndRunRequestArgs { /* private fields */ }
Expand description
Builder for CreateThreadAndRunRequest
.
Implementations§
Source§impl CreateThreadAndRunRequestArgs
impl CreateThreadAndRunRequestArgs
Sourcepub fn assistant_id<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgs
pub fn assistant_id<VALUE>( &mut self, value: VALUE, ) -> &mut CreateThreadAndRunRequestArgs
The ID of the assistant to use to execute this run.
Sourcepub fn thread<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgswhere
VALUE: Into<CreateThreadRequest>,
pub fn thread<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgswhere
VALUE: Into<CreateThreadRequest>,
If no thread is provided, an empty thread will be created.
Sourcepub fn model<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgs
pub fn model<VALUE>( &mut self, value: VALUE, ) -> &mut CreateThreadAndRunRequestArgs
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.
Sourcepub fn instructions<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgs
pub fn instructions<VALUE>( &mut self, value: VALUE, ) -> &mut CreateThreadAndRunRequestArgs
Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.
Sourcepub fn tools<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgs
pub fn tools<VALUE>( &mut self, value: VALUE, ) -> &mut CreateThreadAndRunRequestArgs
Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.
Sourcepub fn tool_resources<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgswhere
VALUE: Into<AssistantToolResources>,
pub fn tool_resources<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgswhere
VALUE: Into<AssistantToolResources>,
A set of resources that are used by the assistant’s tools. The resources are specific to the type of tool. For example, the code_interpreter
tool requires a list of file IDs, while the file_search
tool requires a list of vector store IDs.
pub fn metadata<VALUE>( &mut self, value: VALUE, ) -> &mut CreateThreadAndRunRequestArgs
Sourcepub fn temperature<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgs
pub fn temperature<VALUE>( &mut self, value: VALUE, ) -> &mut CreateThreadAndRunRequestArgs
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.
Sourcepub fn top_p<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgs
pub fn top_p<VALUE>( &mut self, value: VALUE, ) -> &mut CreateThreadAndRunRequestArgs
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.
Sourcepub fn stream<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgs
pub fn stream<VALUE>( &mut self, value: VALUE, ) -> &mut CreateThreadAndRunRequestArgs
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.
Sourcepub fn max_prompt_tokens<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgs
pub fn max_prompt_tokens<VALUE>( &mut self, value: VALUE, ) -> &mut CreateThreadAndRunRequestArgs
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.
Sourcepub fn max_completion_tokens<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgs
pub fn max_completion_tokens<VALUE>( &mut self, value: VALUE, ) -> &mut CreateThreadAndRunRequestArgs
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.
Sourcepub fn truncation_strategy<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgswhere
VALUE: Into<TruncationObject>,
pub fn truncation_strategy<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgswhere
VALUE: Into<TruncationObject>,
Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.
pub fn tool_choice<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgswhere
VALUE: Into<AssistantsApiToolChoiceOption>,
Sourcepub fn parallel_tool_calls<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgs
pub fn parallel_tool_calls<VALUE>( &mut self, value: VALUE, ) -> &mut CreateThreadAndRunRequestArgs
Whether to enable parallel function calling during tool use.
pub fn response_format<VALUE>(
&mut self,
value: VALUE,
) -> &mut CreateThreadAndRunRequestArgswhere
VALUE: Into<AssistantsApiResponseFormatOption>,
Sourcepub fn build(&self) -> Result<CreateThreadAndRunRequest, OpenAIError>
pub fn build(&self) -> Result<CreateThreadAndRunRequest, OpenAIError>
Trait Implementations§
Source§impl Clone for CreateThreadAndRunRequestArgs
impl Clone for CreateThreadAndRunRequestArgs
Source§fn clone(&self) -> CreateThreadAndRunRequestArgs
fn clone(&self) -> CreateThreadAndRunRequestArgs
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for CreateThreadAndRunRequestArgs
impl Default for CreateThreadAndRunRequestArgs
Source§fn default() -> CreateThreadAndRunRequestArgs
fn default() -> CreateThreadAndRunRequestArgs
Auto Trait Implementations§
impl Freeze for CreateThreadAndRunRequestArgs
impl RefUnwindSafe for CreateThreadAndRunRequestArgs
impl Send for CreateThreadAndRunRequestArgs
impl Sync for CreateThreadAndRunRequestArgs
impl Unpin for CreateThreadAndRunRequestArgs
impl UnwindSafe for CreateThreadAndRunRequestArgs
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<D> OwoColorize for D
impl<D> OwoColorize for D
Source§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
Source§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
Source§fn black(&self) -> FgColorDisplay<'_, Black, Self>
fn black(&self) -> FgColorDisplay<'_, Black, Self>
Source§fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
Source§fn red(&self) -> FgColorDisplay<'_, Red, Self>
fn red(&self) -> FgColorDisplay<'_, Red, Self>
Source§fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
Source§fn green(&self) -> FgColorDisplay<'_, Green, Self>
fn green(&self) -> FgColorDisplay<'_, Green, Self>
Source§fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
Source§fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
Source§fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
Source§fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
Source§fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
Source§fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
Source§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
Source§fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
Source§fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
Source§fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
Source§fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
Source§fn white(&self) -> FgColorDisplay<'_, White, Self>
fn white(&self) -> FgColorDisplay<'_, White, Self>
Source§fn on_white(&self) -> BgColorDisplay<'_, White, Self>
fn on_white(&self) -> BgColorDisplay<'_, White, Self>
Source§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
Source§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
Source§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
Source§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
Source§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
Source§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
Source§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
Source§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
Source§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
Source§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
Source§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
Source§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
Source§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Source§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Source§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Source§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Source§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
Source§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
Source§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
Source§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
Source§fn bold(&self) -> BoldDisplay<'_, Self>
fn bold(&self) -> BoldDisplay<'_, Self>
Source§fn dimmed(&self) -> DimDisplay<'_, Self>
fn dimmed(&self) -> DimDisplay<'_, Self>
Source§fn italic(&self) -> ItalicDisplay<'_, Self>
fn italic(&self) -> ItalicDisplay<'_, Self>
Source§fn underline(&self) -> UnderlineDisplay<'_, Self>
fn underline(&self) -> UnderlineDisplay<'_, Self>
Source§fn blink(&self) -> BlinkDisplay<'_, Self>
fn blink(&self) -> BlinkDisplay<'_, Self>
Source§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
Source§fn reversed(&self) -> ReversedDisplay<'_, Self>
fn reversed(&self) -> ReversedDisplay<'_, Self>
Source§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
Source§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::fg
or
a color-specific method, such as OwoColorize::green
, Read moreSource§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::bg
or
a color-specific method, such as OwoColorize::on_yellow
, Read more