Struct DynamicRetrievalConfig 

#[non_exhaustive]
pub struct DynamicRetrievalConfig {
    pub mode: Mode,
    pub dynamic_threshold: Option<f32>,
    /* private fields */
}

Available on crate features gen-ai-cache-service or llm-utility-service or prediction-service only.

Describes the options to customize dynamic retrieval.

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.

mode: Mode

The mode of the predictor to be used in dynamic retrieval.

dynamic_threshold: Option<f32>

Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.

Implementations

impl DynamicRetrievalConfig

pub fn new() -> Self

pub fn set_mode<T: Into<Mode>>(self, v: T) -> Self

Sets the value of mode.

Example

use google_cloud_aiplatform_v1::model::dynamic_retrieval_config::Mode;
let x0 = DynamicRetrievalConfig::new().set_mode(Mode::Dynamic);

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

where T: Into<f32>,

Sets the value of dynamic_threshold.

Example

let x = DynamicRetrievalConfig::new().set_dynamic_threshold(42.0);

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

where T: Into<f32>,

Sets or clears the value of dynamic_threshold.

Example

let x = DynamicRetrievalConfig::new().set_or_clear_dynamic_threshold(Some(42.0));
let x = DynamicRetrievalConfig::new().set_or_clear_dynamic_threshold(None::<f32>);

Trait Implementations

impl Clone for DynamicRetrievalConfig

fn clone(&self) -> DynamicRetrievalConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicRetrievalConfig

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

Formats the value using the given formatter.

impl Default for DynamicRetrievalConfig

fn default() -> DynamicRetrievalConfig

Returns the “default value” for a type.

impl Message for DynamicRetrievalConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DynamicRetrievalConfig

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