#[non_exhaustive]pub struct ChatPromptTemplateConfigurationBuilder { /* private fields */ }Expand description
A builder for ChatPromptTemplateConfiguration.
Implementations§
Source§impl ChatPromptTemplateConfigurationBuilder
impl ChatPromptTemplateConfigurationBuilder
Sourcepub fn messages(self, input: Message) -> Self
pub fn messages(self, input: Message) -> Self
Appends an item to messages.
To override the contents of this collection use set_messages.
Contains messages in the chat for the prompt.
Sourcepub fn set_messages(self, input: Option<Vec<Message>>) -> Self
pub fn set_messages(self, input: Option<Vec<Message>>) -> Self
Contains messages in the chat for the prompt.
Sourcepub fn get_messages(&self) -> &Option<Vec<Message>>
pub fn get_messages(&self) -> &Option<Vec<Message>>
Contains messages in the chat for the prompt.
Sourcepub fn system(self, input: SystemContentBlock) -> Self
pub fn system(self, input: SystemContentBlock) -> Self
Appends an item to system.
To override the contents of this collection use set_system.
Contains system prompts to provide context to the model or to describe how it should behave.
Sourcepub fn set_system(self, input: Option<Vec<SystemContentBlock>>) -> Self
pub fn set_system(self, input: Option<Vec<SystemContentBlock>>) -> Self
Contains system prompts to provide context to the model or to describe how it should behave.
Sourcepub fn get_system(&self) -> &Option<Vec<SystemContentBlock>>
pub fn get_system(&self) -> &Option<Vec<SystemContentBlock>>
Contains system prompts to provide context to the model or to describe how it should behave.
Sourcepub fn input_variables(self, input: PromptInputVariable) -> Self
pub fn input_variables(self, input: PromptInputVariable) -> Self
Appends an item to input_variables.
To override the contents of this collection use set_input_variables.
An array of the variables in the prompt template.
Sourcepub fn set_input_variables(
self,
input: Option<Vec<PromptInputVariable>>,
) -> Self
pub fn set_input_variables( self, input: Option<Vec<PromptInputVariable>>, ) -> Self
An array of the variables in the prompt template.
Sourcepub fn get_input_variables(&self) -> &Option<Vec<PromptInputVariable>>
pub fn get_input_variables(&self) -> &Option<Vec<PromptInputVariable>>
An array of the variables in the prompt template.
Sourcepub fn tool_configuration(self, input: ToolConfiguration) -> Self
pub fn tool_configuration(self, input: ToolConfiguration) -> Self
Configuration information for the tools that the model can use when generating a response.
Sourcepub fn set_tool_configuration(self, input: Option<ToolConfiguration>) -> Self
pub fn set_tool_configuration(self, input: Option<ToolConfiguration>) -> Self
Configuration information for the tools that the model can use when generating a response.
Sourcepub fn get_tool_configuration(&self) -> &Option<ToolConfiguration>
pub fn get_tool_configuration(&self) -> &Option<ToolConfiguration>
Configuration information for the tools that the model can use when generating a response.
Sourcepub fn build(self) -> Result<ChatPromptTemplateConfiguration, BuildError>
pub fn build(self) -> Result<ChatPromptTemplateConfiguration, BuildError>
Consumes the builder and constructs a ChatPromptTemplateConfiguration.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ChatPromptTemplateConfigurationBuilder
impl Clone for ChatPromptTemplateConfigurationBuilder
Source§fn clone(&self) -> ChatPromptTemplateConfigurationBuilder
fn clone(&self) -> ChatPromptTemplateConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for ChatPromptTemplateConfigurationBuilder
impl Default for ChatPromptTemplateConfigurationBuilder
Source§fn default() -> ChatPromptTemplateConfigurationBuilder
fn default() -> ChatPromptTemplateConfigurationBuilder
Source§impl PartialEq for ChatPromptTemplateConfigurationBuilder
impl PartialEq for ChatPromptTemplateConfigurationBuilder
Source§fn eq(&self, other: &ChatPromptTemplateConfigurationBuilder) -> bool
fn eq(&self, other: &ChatPromptTemplateConfigurationBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for ChatPromptTemplateConfigurationBuilder
Auto Trait Implementations§
impl Freeze for ChatPromptTemplateConfigurationBuilder
impl RefUnwindSafe for ChatPromptTemplateConfigurationBuilder
impl Send for ChatPromptTemplateConfigurationBuilder
impl Sync for ChatPromptTemplateConfigurationBuilder
impl Unpin for ChatPromptTemplateConfigurationBuilder
impl UnwindSafe for ChatPromptTemplateConfigurationBuilder
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<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);