#[non_exhaustive]pub struct InferenceConfigurationBuilder { /* private fields */ }
Expand description
A builder for InferenceConfiguration
.
Implementations§
Source§impl InferenceConfigurationBuilder
impl InferenceConfigurationBuilder
Sourcepub fn max_tokens(self, input: i32) -> Self
pub fn max_tokens(self, input: i32) -> Self
The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see Inference parameters for foundation models.
Sourcepub fn set_max_tokens(self, input: Option<i32>) -> Self
pub fn set_max_tokens(self, input: Option<i32>) -> Self
The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see Inference parameters for foundation models.
Sourcepub fn get_max_tokens(&self) -> &Option<i32>
pub fn get_max_tokens(&self) -> &Option<i32>
The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see Inference parameters for foundation models.
Sourcepub fn temperature(self, input: f32) -> Self
pub fn temperature(self, input: f32) -> Self
The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.
Sourcepub fn set_temperature(self, input: Option<f32>) -> Self
pub fn set_temperature(self, input: Option<f32>) -> Self
The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.
Sourcepub fn get_temperature(&self) -> &Option<f32>
pub fn get_temperature(&self) -> &Option<f32>
The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.
Sourcepub fn top_p(self, input: f32) -> Self
pub fn top_p(self, input: f32) -> Self
The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for topP
, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.
The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.
Sourcepub fn set_top_p(self, input: Option<f32>) -> Self
pub fn set_top_p(self, input: Option<f32>) -> Self
The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for topP
, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.
The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.
Sourcepub fn get_top_p(&self) -> &Option<f32>
pub fn get_top_p(&self) -> &Option<f32>
The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for topP
, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.
The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.
Sourcepub fn stop_sequences(self, input: impl Into<String>) -> Self
pub fn stop_sequences(self, input: impl Into<String>) -> Self
Appends an item to stop_sequences
.
To override the contents of this collection use set_stop_sequences
.
A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
Sourcepub fn set_stop_sequences(self, input: Option<Vec<String>>) -> Self
pub fn set_stop_sequences(self, input: Option<Vec<String>>) -> Self
A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
Sourcepub fn get_stop_sequences(&self) -> &Option<Vec<String>>
pub fn get_stop_sequences(&self) -> &Option<Vec<String>>
A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
Sourcepub fn build(self) -> InferenceConfiguration
pub fn build(self) -> InferenceConfiguration
Consumes the builder and constructs a InferenceConfiguration
.
Trait Implementations§
Source§impl Clone for InferenceConfigurationBuilder
impl Clone for InferenceConfigurationBuilder
Source§fn clone(&self) -> InferenceConfigurationBuilder
fn clone(&self) -> InferenceConfigurationBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for InferenceConfigurationBuilder
impl Default for InferenceConfigurationBuilder
Source§fn default() -> InferenceConfigurationBuilder
fn default() -> InferenceConfigurationBuilder
Source§impl PartialEq for InferenceConfigurationBuilder
impl PartialEq for InferenceConfigurationBuilder
Source§fn eq(&self, other: &InferenceConfigurationBuilder) -> bool
fn eq(&self, other: &InferenceConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for InferenceConfigurationBuilder
Auto Trait Implementations§
impl Freeze for InferenceConfigurationBuilder
impl RefUnwindSafe for InferenceConfigurationBuilder
impl Send for InferenceConfigurationBuilder
impl Sync for InferenceConfigurationBuilder
impl Unpin for InferenceConfigurationBuilder
impl UnwindSafe for InferenceConfigurationBuilder
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);