Skip to main content

AutoraterConfig

Struct AutoraterConfig 

Source
#[non_exhaustive]
pub struct AutoraterConfig { pub sampling_count: Option<i32>, pub flip_enabled: Option<bool>, pub autorater_model: String, pub generation_config: Option<GenerationConfig>, /* private fields */ }
Available on crate feature gen-ai-tuning-service only.
Expand description

The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset.

Fields (Non-exhaustive)§

This struct is marked as 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.
§sampling_count: Option<i32>

Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.

§flip_enabled: Option<bool>

Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.

§autorater_model: String

Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use.

Publisher model format: projects/{project}/locations/{location}/publishers/*/models/*

Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}

§generation_config: Option<GenerationConfig>

Optional. Configuration options for model generation and outputs.

Implementations§

Source§

impl AutoraterConfig

Source

pub fn new() -> Self

Source

pub fn set_sampling_count<T>(self, v: T) -> Self
where T: Into<i32>,

Sets the value of sampling_count.

§Example
let x = AutoraterConfig::new().set_sampling_count(42);
Source

pub fn set_or_clear_sampling_count<T>(self, v: Option<T>) -> Self
where T: Into<i32>,

Sets or clears the value of sampling_count.

§Example
let x = AutoraterConfig::new().set_or_clear_sampling_count(Some(42));
let x = AutoraterConfig::new().set_or_clear_sampling_count(None::<i32>);
Source

pub fn set_flip_enabled<T>(self, v: T) -> Self
where T: Into<bool>,

Sets the value of flip_enabled.

§Example
let x = AutoraterConfig::new().set_flip_enabled(true);
Source

pub fn set_or_clear_flip_enabled<T>(self, v: Option<T>) -> Self
where T: Into<bool>,

Sets or clears the value of flip_enabled.

§Example
let x = AutoraterConfig::new().set_or_clear_flip_enabled(Some(false));
let x = AutoraterConfig::new().set_or_clear_flip_enabled(None::<bool>);
Source

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

Sets the value of autorater_model.

§Example
let x = AutoraterConfig::new().set_autorater_model("example");
Source

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

Sets the value of generation_config.

§Example
use google_cloud_aiplatform_v1::model::GenerationConfig;
let x = AutoraterConfig::new().set_generation_config(GenerationConfig::default()/* use setters */);
Source

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

Sets or clears the value of generation_config.

§Example
use google_cloud_aiplatform_v1::model::GenerationConfig;
let x = AutoraterConfig::new().set_or_clear_generation_config(Some(GenerationConfig::default()/* use setters */));
let x = AutoraterConfig::new().set_or_clear_generation_config(None::<GenerationConfig>);

Trait Implementations§

Source§

impl Clone for AutoraterConfig

Source§

fn clone(&self) -> AutoraterConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AutoraterConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AutoraterConfig

Source§

fn default() -> AutoraterConfig

Returns the “default value” for a type. Read more
Source§

impl Message for AutoraterConfig

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for AutoraterConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for AutoraterConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,