#[non_exhaustive]pub struct ConverseOutputBuilder { /* private fields */ }
Expand description
A builder for ConverseOutput
.
Implementations§
Source§impl ConverseOutputBuilder
impl ConverseOutputBuilder
Sourcepub fn output(self, input: ConverseOutput) -> Self
pub fn output(self, input: ConverseOutput) -> Self
The result from the call to Converse
.
Sourcepub fn set_output(self, input: Option<ConverseOutput>) -> Self
pub fn set_output(self, input: Option<ConverseOutput>) -> Self
The result from the call to Converse
.
Sourcepub fn get_output(&self) -> &Option<ConverseOutput>
pub fn get_output(&self) -> &Option<ConverseOutput>
The result from the call to Converse
.
Sourcepub fn stop_reason(self, input: StopReason) -> Self
pub fn stop_reason(self, input: StopReason) -> Self
The reason why the model stopped generating output.
This field is required.Sourcepub fn set_stop_reason(self, input: Option<StopReason>) -> Self
pub fn set_stop_reason(self, input: Option<StopReason>) -> Self
The reason why the model stopped generating output.
Sourcepub fn get_stop_reason(&self) -> &Option<StopReason>
pub fn get_stop_reason(&self) -> &Option<StopReason>
The reason why the model stopped generating output.
Sourcepub fn usage(self, input: TokenUsage) -> Self
pub fn usage(self, input: TokenUsage) -> Self
The total number of tokens used in the call to Converse
. The total includes the tokens input to the model and the tokens generated by the model.
Sourcepub fn set_usage(self, input: Option<TokenUsage>) -> Self
pub fn set_usage(self, input: Option<TokenUsage>) -> Self
The total number of tokens used in the call to Converse
. The total includes the tokens input to the model and the tokens generated by the model.
Sourcepub fn get_usage(&self) -> &Option<TokenUsage>
pub fn get_usage(&self) -> &Option<TokenUsage>
The total number of tokens used in the call to Converse
. The total includes the tokens input to the model and the tokens generated by the model.
Sourcepub fn metrics(self, input: ConverseMetrics) -> Self
pub fn metrics(self, input: ConverseMetrics) -> Self
Metrics for the call to Converse
.
Sourcepub fn set_metrics(self, input: Option<ConverseMetrics>) -> Self
pub fn set_metrics(self, input: Option<ConverseMetrics>) -> Self
Metrics for the call to Converse
.
Sourcepub fn get_metrics(&self) -> &Option<ConverseMetrics>
pub fn get_metrics(&self) -> &Option<ConverseMetrics>
Metrics for the call to Converse
.
Sourcepub fn additional_model_response_fields(self, input: Document) -> Self
pub fn additional_model_response_fields(self, input: Document) -> Self
Additional fields in the response that are unique to the model.
Sourcepub fn set_additional_model_response_fields(
self,
input: Option<Document>,
) -> Self
pub fn set_additional_model_response_fields( self, input: Option<Document>, ) -> Self
Additional fields in the response that are unique to the model.
Sourcepub fn get_additional_model_response_fields(&self) -> &Option<Document>
pub fn get_additional_model_response_fields(&self) -> &Option<Document>
Additional fields in the response that are unique to the model.
Sourcepub fn trace(self, input: ConverseTrace) -> Self
pub fn trace(self, input: ConverseTrace) -> Self
A trace object that contains information about the Guardrail behavior.
Sourcepub fn set_trace(self, input: Option<ConverseTrace>) -> Self
pub fn set_trace(self, input: Option<ConverseTrace>) -> Self
A trace object that contains information about the Guardrail behavior.
Sourcepub fn get_trace(&self) -> &Option<ConverseTrace>
pub fn get_trace(&self) -> &Option<ConverseTrace>
A trace object that contains information about the Guardrail behavior.
Sourcepub fn performance_config(self, input: PerformanceConfiguration) -> Self
pub fn performance_config(self, input: PerformanceConfiguration) -> Self
Model performance settings for the request.
Sourcepub fn set_performance_config(
self,
input: Option<PerformanceConfiguration>,
) -> Self
pub fn set_performance_config( self, input: Option<PerformanceConfiguration>, ) -> Self
Model performance settings for the request.
Sourcepub fn get_performance_config(&self) -> &Option<PerformanceConfiguration>
pub fn get_performance_config(&self) -> &Option<PerformanceConfiguration>
Model performance settings for the request.
Sourcepub fn build(self) -> Result<ConverseOutput, BuildError>
pub fn build(self) -> Result<ConverseOutput, BuildError>
Consumes the builder and constructs a ConverseOutput
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ConverseOutputBuilder
impl Clone for ConverseOutputBuilder
Source§fn clone(&self) -> ConverseOutputBuilder
fn clone(&self) -> ConverseOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ConverseOutputBuilder
impl Debug for ConverseOutputBuilder
Source§impl Default for ConverseOutputBuilder
impl Default for ConverseOutputBuilder
Source§fn default() -> ConverseOutputBuilder
fn default() -> ConverseOutputBuilder
Source§impl PartialEq for ConverseOutputBuilder
impl PartialEq for ConverseOutputBuilder
impl StructuralPartialEq for ConverseOutputBuilder
Auto Trait Implementations§
impl Freeze for ConverseOutputBuilder
impl RefUnwindSafe for ConverseOutputBuilder
impl Send for ConverseOutputBuilder
impl Sync for ConverseOutputBuilder
impl Unpin for ConverseOutputBuilder
impl UnwindSafe for ConverseOutputBuilder
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);