Struct CustomMetricDefinition 

#[non_exhaustive]
pub struct CustomMetricDefinition {
    pub name: String,
    pub instructions: String,
    pub rating_scale: Option<Vec<RatingScaleItem>>,
}

The definition of a custom metric for use in an Amazon Bedrock evaluation job. A custom metric definition includes a metric name, prompt (instructions) and optionally, a rating scale. Your prompt must include a task description and input variables. The required input variables are different for model-as-a-judge and RAG evaluations.

For more information about how to define a custom metric in Amazon Bedrock, see Create a prompt for a custom metrics (LLM-as-a-judge model evaluations) and Create a prompt for a custom metrics (RAG evaluations).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name for a custom metric. Names must be unique in your Amazon Web Services region.

instructions: String

The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.

rating_scale: Option<Vec<RatingScaleItem>>

Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).

Implementations

impl CustomMetricDefinition

pub fn name(&self) -> &str

The name for a custom metric. Names must be unique in your Amazon Web Services region.

pub fn instructions(&self) -> &str

The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.

pub fn rating_scale(&self) -> &[RatingScaleItem]

Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .rating_scale.is_none().

impl CustomMetricDefinition

pub fn builder() -> CustomMetricDefinitionBuilder

Creates a new builder-style object to manufacture CustomMetricDefinition.

Trait Implementations

impl Clone for CustomMetricDefinition

fn clone(&self) -> CustomMetricDefinition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CustomMetricDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CustomMetricDefinition

fn eq(&self, other: &CustomMetricDefinition) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CustomMetricDefinition