Struct VertexRagStore 

#[non_exhaustive]
pub struct VertexRagStore {
    pub rag_resources: Vec<RagResource>,
    pub similarity_top_k: Option<i32>,
    pub vector_distance_threshold: Option<f64>,
    pub rag_retrieval_config: Option<RagRetrievalConfig>,
    /* private fields */
}

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

Retrieve from Vertex RAG Store for grounding.

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.

rag_resources: Vec<RagResource>

Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.

similarity_top_k: Option<i32>

👎Deprecated

Optional. Number of top k results to return from the selected corpora.

vector_distance_threshold: Option<f64>

👎Deprecated

Optional. Only return results with vector distance smaller than the threshold.

rag_retrieval_config: Option<RagRetrievalConfig>

Optional. The retrieval config for the Rag query.

Implementations

impl VertexRagStore

pub fn new() -> Self

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

where T: IntoIterator<Item = V>, V: Into<RagResource>,

Sets the value of rag_resources.

Example

use google_cloud_aiplatform_v1::model::vertex_rag_store::RagResource;
let x = VertexRagStore::new()
    .set_rag_resources([
        RagResource::default()/* use setters */,
        RagResource::default()/* use (different) setters */,
    ]);

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

where T: Into<i32>,

👎Deprecated

Sets the value of similarity_top_k.

Example

let x = VertexRagStore::new().set_similarity_top_k(42);

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

where T: Into<i32>,

👎Deprecated

Sets or clears the value of similarity_top_k.

Example

let x = VertexRagStore::new().set_or_clear_similarity_top_k(Some(42));
let x = VertexRagStore::new().set_or_clear_similarity_top_k(None::<i32>);

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

where T: Into<f64>,

👎Deprecated

Sets the value of vector_distance_threshold.

Example

let x = VertexRagStore::new().set_vector_distance_threshold(42.0);

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

where T: Into<f64>,

👎Deprecated

Sets or clears the value of vector_distance_threshold.

Example

let x = VertexRagStore::new().set_or_clear_vector_distance_threshold(Some(42.0));
let x = VertexRagStore::new().set_or_clear_vector_distance_threshold(None::<f32>);

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

where T: Into<RagRetrievalConfig>,

Sets the value of rag_retrieval_config.

Example

use google_cloud_aiplatform_v1::model::RagRetrievalConfig;
let x = VertexRagStore::new().set_rag_retrieval_config(RagRetrievalConfig::default()/* use setters */);

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

where T: Into<RagRetrievalConfig>,

Sets or clears the value of rag_retrieval_config.

Example

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

Trait Implementations

impl Clone for VertexRagStore

fn clone(&self) -> VertexRagStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VertexRagStore

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

Formats the value using the given formatter.

impl Default for VertexRagStore

fn default() -> VertexRagStore

Returns the “default value” for a type.

impl Message for VertexRagStore

fn typename() -> &'static str

The typename of this message.

impl PartialEq for VertexRagStore

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