#[non_exhaustive]pub struct EvaluationSummaryBuilder { /* private fields */ }Expand description
A builder for EvaluationSummary.
Implementations§
Source§impl EvaluationSummaryBuilder
impl EvaluationSummaryBuilder
Sourcepub fn job_arn(self, input: impl Into<String>) -> Self
pub fn job_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the evaluation job.
This field is required.Sourcepub fn set_job_arn(self, input: Option<String>) -> Self
pub fn set_job_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the evaluation job.
Sourcepub fn get_job_arn(&self) -> &Option<String>
pub fn get_job_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the evaluation job.
Sourcepub fn job_name(self, input: impl Into<String>) -> Self
pub fn job_name(self, input: impl Into<String>) -> Self
The name for the evaluation job.
This field is required.Sourcepub fn set_job_name(self, input: Option<String>) -> Self
pub fn set_job_name(self, input: Option<String>) -> Self
The name for the evaluation job.
Sourcepub fn get_job_name(&self) -> &Option<String>
pub fn get_job_name(&self) -> &Option<String>
The name for the evaluation job.
Sourcepub fn status(self, input: EvaluationJobStatus) -> Self
pub fn status(self, input: EvaluationJobStatus) -> Self
The current status of the evaluation job.
This field is required.Sourcepub fn set_status(self, input: Option<EvaluationJobStatus>) -> Self
pub fn set_status(self, input: Option<EvaluationJobStatus>) -> Self
The current status of the evaluation job.
Sourcepub fn get_status(&self) -> &Option<EvaluationJobStatus>
pub fn get_status(&self) -> &Option<EvaluationJobStatus>
The current status of the evaluation job.
Sourcepub fn creation_time(self, input: DateTime) -> Self
pub fn creation_time(self, input: DateTime) -> Self
The time the evaluation job was created.
This field is required.Sourcepub fn set_creation_time(self, input: Option<DateTime>) -> Self
pub fn set_creation_time(self, input: Option<DateTime>) -> Self
The time the evaluation job was created.
Sourcepub fn get_creation_time(&self) -> &Option<DateTime>
pub fn get_creation_time(&self) -> &Option<DateTime>
The time the evaluation job was created.
Sourcepub fn job_type(self, input: EvaluationJobType) -> Self
pub fn job_type(self, input: EvaluationJobType) -> Self
Specifies whether the evaluation job is automated or human-based.
This field is required.Sourcepub fn set_job_type(self, input: Option<EvaluationJobType>) -> Self
pub fn set_job_type(self, input: Option<EvaluationJobType>) -> Self
Specifies whether the evaluation job is automated or human-based.
Sourcepub fn get_job_type(&self) -> &Option<EvaluationJobType>
pub fn get_job_type(&self) -> &Option<EvaluationJobType>
Specifies whether the evaluation job is automated or human-based.
Sourcepub fn evaluation_task_types(self, input: EvaluationTaskType) -> Self
pub fn evaluation_task_types(self, input: EvaluationTaskType) -> Self
Appends an item to evaluation_task_types.
To override the contents of this collection use set_evaluation_task_types.
The type of task for model evaluation.
Sourcepub fn set_evaluation_task_types(
self,
input: Option<Vec<EvaluationTaskType>>,
) -> Self
pub fn set_evaluation_task_types( self, input: Option<Vec<EvaluationTaskType>>, ) -> Self
The type of task for model evaluation.
Sourcepub fn get_evaluation_task_types(&self) -> &Option<Vec<EvaluationTaskType>>
pub fn get_evaluation_task_types(&self) -> &Option<Vec<EvaluationTaskType>>
The type of task for model evaluation.
Sourcepub fn model_identifiers(self, input: impl Into<String>) -> Self
👎Deprecated since 2025-03-07: Inference identifiers should be retrieved from the inferenceConfigSummary
pub fn model_identifiers(self, input: impl Into<String>) -> Self
Appends an item to model_identifiers.
To override the contents of this collection use set_model_identifiers.
The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.
Sourcepub fn set_model_identifiers(self, input: Option<Vec<String>>) -> Self
👎Deprecated since 2025-03-07: Inference identifiers should be retrieved from the inferenceConfigSummary
pub fn set_model_identifiers(self, input: Option<Vec<String>>) -> Self
The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.
Sourcepub fn get_model_identifiers(&self) -> &Option<Vec<String>>
👎Deprecated since 2025-03-07: Inference identifiers should be retrieved from the inferenceConfigSummary
pub fn get_model_identifiers(&self) -> &Option<Vec<String>>
The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.
Sourcepub fn rag_identifiers(self, input: impl Into<String>) -> Self
👎Deprecated since 2025-03-07: Inference identifiers should be retrieved from the inferenceConfigSummary
pub fn rag_identifiers(self, input: impl Into<String>) -> Self
Appends an item to rag_identifiers.
To override the contents of this collection use set_rag_identifiers.
The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.
Sourcepub fn set_rag_identifiers(self, input: Option<Vec<String>>) -> Self
👎Deprecated since 2025-03-07: Inference identifiers should be retrieved from the inferenceConfigSummary
pub fn set_rag_identifiers(self, input: Option<Vec<String>>) -> Self
The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.
Sourcepub fn get_rag_identifiers(&self) -> &Option<Vec<String>>
👎Deprecated since 2025-03-07: Inference identifiers should be retrieved from the inferenceConfigSummary
pub fn get_rag_identifiers(&self) -> &Option<Vec<String>>
The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.
Sourcepub fn evaluator_model_identifiers(self, input: impl Into<String>) -> Self
pub fn evaluator_model_identifiers(self, input: impl Into<String>) -> Self
Appends an item to evaluator_model_identifiers.
To override the contents of this collection use set_evaluator_model_identifiers.
The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.
Sourcepub fn set_evaluator_model_identifiers(self, input: Option<Vec<String>>) -> Self
pub fn set_evaluator_model_identifiers(self, input: Option<Vec<String>>) -> Self
The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.
Sourcepub fn get_evaluator_model_identifiers(&self) -> &Option<Vec<String>>
pub fn get_evaluator_model_identifiers(&self) -> &Option<Vec<String>>
The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.
Sourcepub fn custom_metrics_evaluator_model_identifiers(
self,
input: impl Into<String>,
) -> Self
pub fn custom_metrics_evaluator_model_identifiers( self, input: impl Into<String>, ) -> Self
Appends an item to custom_metrics_evaluator_model_identifiers.
To override the contents of this collection use set_custom_metrics_evaluator_model_identifiers.
The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.
Sourcepub fn set_custom_metrics_evaluator_model_identifiers(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_custom_metrics_evaluator_model_identifiers( self, input: Option<Vec<String>>, ) -> Self
The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.
Sourcepub fn get_custom_metrics_evaluator_model_identifiers(
&self,
) -> &Option<Vec<String>>
pub fn get_custom_metrics_evaluator_model_identifiers( &self, ) -> &Option<Vec<String>>
The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.
Sourcepub fn inference_config_summary(
self,
input: EvaluationInferenceConfigSummary,
) -> Self
pub fn inference_config_summary( self, input: EvaluationInferenceConfigSummary, ) -> Self
Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.
Sourcepub fn set_inference_config_summary(
self,
input: Option<EvaluationInferenceConfigSummary>,
) -> Self
pub fn set_inference_config_summary( self, input: Option<EvaluationInferenceConfigSummary>, ) -> Self
Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.
Sourcepub fn get_inference_config_summary(
&self,
) -> &Option<EvaluationInferenceConfigSummary>
pub fn get_inference_config_summary( &self, ) -> &Option<EvaluationInferenceConfigSummary>
Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.
Sourcepub fn application_type(self, input: ApplicationType) -> Self
pub fn application_type(self, input: ApplicationType) -> Self
Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
Sourcepub fn set_application_type(self, input: Option<ApplicationType>) -> Self
pub fn set_application_type(self, input: Option<ApplicationType>) -> Self
Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
Sourcepub fn get_application_type(&self) -> &Option<ApplicationType>
pub fn get_application_type(&self) -> &Option<ApplicationType>
Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
Sourcepub fn build(self) -> Result<EvaluationSummary, BuildError>
pub fn build(self) -> Result<EvaluationSummary, BuildError>
Consumes the builder and constructs a EvaluationSummary.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for EvaluationSummaryBuilder
impl Clone for EvaluationSummaryBuilder
Source§fn clone(&self) -> EvaluationSummaryBuilder
fn clone(&self) -> EvaluationSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for EvaluationSummaryBuilder
impl Debug for EvaluationSummaryBuilder
Source§impl Default for EvaluationSummaryBuilder
impl Default for EvaluationSummaryBuilder
Source§fn default() -> EvaluationSummaryBuilder
fn default() -> EvaluationSummaryBuilder
Source§impl PartialEq for EvaluationSummaryBuilder
impl PartialEq for EvaluationSummaryBuilder
impl StructuralPartialEq for EvaluationSummaryBuilder
Auto Trait Implementations§
impl Freeze for EvaluationSummaryBuilder
impl RefUnwindSafe for EvaluationSummaryBuilder
impl Send for EvaluationSummaryBuilder
impl Sync for EvaluationSummaryBuilder
impl Unpin for EvaluationSummaryBuilder
impl UnwindSafe for EvaluationSummaryBuilder
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);