Struct PredefinedMetricSpec 

#[non_exhaustive]
pub struct PredefinedMetricSpec {
    pub metric_spec_name: String,
    pub metric_spec_parameters: Option<Struct>,
    /* private fields */
}

Available on crate feature gen-ai-tuning-service only.

The spec for a pre-defined metric.

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.

metric_spec_name: String

Required. The name of a pre-defined metric, such as “instruction_following_v1” or “text_quality_v1”.

metric_spec_parameters: Option<Struct>

Optional. The parameters needed to run the pre-defined metric.

Implementations

impl PredefinedMetricSpec

pub fn new() -> Self

pub fn set_metric_spec_name<T: Into<String>>(self, v: T) -> Self

Sets the value of metric_spec_name.

Example

let x = PredefinedMetricSpec::new().set_metric_spec_name("example");

pub fn set_metric_spec_parameters<T>(self, v: T) -> Self

where T: Into<Struct>,

Sets the value of metric_spec_parameters.

Example

use wkt::Struct;
let x = PredefinedMetricSpec::new().set_metric_spec_parameters(Struct::default()/* use setters */);

pub fn set_or_clear_metric_spec_parameters<T>(self, v: Option<T>) -> Self

where T: Into<Struct>,

Sets or clears the value of metric_spec_parameters.

Example

use wkt::Struct;
let x = PredefinedMetricSpec::new().set_or_clear_metric_spec_parameters(Some(Struct::default()/* use setters */));
let x = PredefinedMetricSpec::new().set_or_clear_metric_spec_parameters(None::<Struct>);

Trait Implementations

impl Clone for PredefinedMetricSpec

fn clone(&self) -> PredefinedMetricSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PredefinedMetricSpec

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

Formats the value using the given formatter.

impl Default for PredefinedMetricSpec

fn default() -> PredefinedMetricSpec

Returns the “default value” for a type.

impl Message for PredefinedMetricSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PredefinedMetricSpec

fn eq(&self, other: &PredefinedMetricSpec) -> 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 PredefinedMetricSpec