#[non_exhaustive]pub struct EvaluationSummary {
pub job_arn: String,
pub job_name: String,
pub status: EvaluationJobStatus,
pub creation_time: DateTime,
pub job_type: EvaluationJobType,
pub evaluation_task_types: Vec<EvaluationTaskType>,
pub model_identifiers: Vec<String>,
pub rag_identifiers: Option<Vec<String>>,
pub evaluator_model_identifiers: Option<Vec<String>>,
pub custom_metrics_evaluator_model_identifiers: Option<Vec<String>>,
pub inference_config_summary: Option<EvaluationInferenceConfigSummary>,
pub application_type: Option<ApplicationType>,
}Expand description
Summary information of an evaluation job.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.job_arn: StringThe Amazon Resource Name (ARN) of the evaluation job.
job_name: StringThe name for the evaluation job.
status: EvaluationJobStatusThe current status of the evaluation job.
creation_time: DateTimeThe time the evaluation job was created.
job_type: EvaluationJobTypeSpecifies whether the evaluation job is automated or human-based.
evaluation_task_types: Vec<EvaluationTaskType>The type of task for model evaluation.
model_identifiers: Vec<String>The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.
rag_identifiers: Option<Vec<String>>The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.
evaluator_model_identifiers: Option<Vec<String>>The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.
custom_metrics_evaluator_model_identifiers: Option<Vec<String>>The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.
inference_config_summary: Option<EvaluationInferenceConfigSummary>Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.
application_type: Option<ApplicationType>Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
Implementations§
Source§impl EvaluationSummary
impl EvaluationSummary
Sourcepub fn status(&self) -> &EvaluationJobStatus
pub fn status(&self) -> &EvaluationJobStatus
The current status of the evaluation job.
Sourcepub fn creation_time(&self) -> &DateTime
pub fn creation_time(&self) -> &DateTime
The time the evaluation job was created.
Sourcepub fn job_type(&self) -> &EvaluationJobType
pub fn job_type(&self) -> &EvaluationJobType
Specifies whether the evaluation job is automated or human-based.
Sourcepub fn evaluation_task_types(&self) -> &[EvaluationTaskType]
pub fn evaluation_task_types(&self) -> &[EvaluationTaskType]
The type of task for model evaluation.
Sourcepub fn model_identifiers(&self) -> &[String]
👎Deprecated since 2025-03-07: Inference identifiers should be retrieved from the inferenceConfigSummary
pub fn model_identifiers(&self) -> &[String]
The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.
Sourcepub fn rag_identifiers(&self) -> &[String]
👎Deprecated since 2025-03-07: Inference identifiers should be retrieved from the inferenceConfigSummary
pub fn rag_identifiers(&self) -> &[String]
The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .rag_identifiers.is_none().
Sourcepub fn evaluator_model_identifiers(&self) -> &[String]
pub fn evaluator_model_identifiers(&self) -> &[String]
The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .evaluator_model_identifiers.is_none().
Sourcepub fn custom_metrics_evaluator_model_identifiers(&self) -> &[String]
pub fn custom_metrics_evaluator_model_identifiers(&self) -> &[String]
The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .custom_metrics_evaluator_model_identifiers.is_none().
Sourcepub fn inference_config_summary(
&self,
) -> Option<&EvaluationInferenceConfigSummary>
pub fn 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) -> Option<&ApplicationType>
pub fn application_type(&self) -> Option<&ApplicationType>
Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
Source§impl EvaluationSummary
impl EvaluationSummary
Sourcepub fn builder() -> EvaluationSummaryBuilder
pub fn builder() -> EvaluationSummaryBuilder
Creates a new builder-style object to manufacture EvaluationSummary.
Trait Implementations§
Source§impl Clone for EvaluationSummary
impl Clone for EvaluationSummary
Source§fn clone(&self) -> EvaluationSummary
fn clone(&self) -> EvaluationSummary
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for EvaluationSummary
impl Debug for EvaluationSummary
Source§impl PartialEq for EvaluationSummary
impl PartialEq for EvaluationSummary
impl StructuralPartialEq for EvaluationSummary
Auto Trait Implementations§
impl Freeze for EvaluationSummary
impl RefUnwindSafe for EvaluationSummary
impl Send for EvaluationSummary
impl Sync for EvaluationSummary
impl Unpin for EvaluationSummary
impl UnwindSafe for EvaluationSummary
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);