Struct RagRetrievalConfig 

#[non_exhaustive]
pub struct RagRetrievalConfig {
    pub top_k: i32,
    pub filter: Option<Filter>,
    pub ranking: Option<Ranking>,
    /* private fields */
}

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

Specifies the context retrieval config.

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.

top_k: i32

Optional. The number of contexts to retrieve.

filter: Option<Filter>

Optional. Config for filters.

ranking: Option<Ranking>

Optional. Config for ranking and reranking.

Implementations

impl RagRetrievalConfig

pub fn new() -> Self

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

Sets the value of top_k.

Example

let x = RagRetrievalConfig::new().set_top_k(42);

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

where T: Into<Filter>,

Sets the value of filter.

Example

use google_cloud_aiplatform_v1::model::rag_retrieval_config::Filter;
let x = RagRetrievalConfig::new().set_filter(Filter::default()/* use setters */);

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

where T: Into<Filter>,

Sets or clears the value of filter.

Example

use google_cloud_aiplatform_v1::model::rag_retrieval_config::Filter;
let x = RagRetrievalConfig::new().set_or_clear_filter(Some(Filter::default()/* use setters */));
let x = RagRetrievalConfig::new().set_or_clear_filter(None::<Filter>);

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

where T: Into<Ranking>,

Sets the value of ranking.

Example

use google_cloud_aiplatform_v1::model::rag_retrieval_config::Ranking;
let x = RagRetrievalConfig::new().set_ranking(Ranking::default()/* use setters */);

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

where T: Into<Ranking>,

Sets or clears the value of ranking.

Example

use google_cloud_aiplatform_v1::model::rag_retrieval_config::Ranking;
let x = RagRetrievalConfig::new().set_or_clear_ranking(Some(Ranking::default()/* use setters */));
let x = RagRetrievalConfig::new().set_or_clear_ranking(None::<Ranking>);

Trait Implementations

impl Clone for RagRetrievalConfig

fn clone(&self) -> RagRetrievalConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RagRetrievalConfig

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

Formats the value using the given formatter.

impl Default for RagRetrievalConfig

fn default() -> RagRetrievalConfig

Returns the “default value” for a type.

impl Message for RagRetrievalConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RagRetrievalConfig

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