Struct RagVectorDbConfig 

#[non_exhaustive]
pub struct RagVectorDbConfig {
    pub api_auth: Option<ApiAuth>,
    pub rag_embedding_model_config: Option<RagEmbeddingModelConfig>,
    pub vector_db: Option<VectorDb>,
    /* private fields */
}

Available on crate feature vertex-rag-data-service only.

Config for the Vector DB to use for RAG.

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.

api_auth: Option<ApiAuth>

Authentication config for the chosen Vector DB.

rag_embedding_model_config: Option<RagEmbeddingModelConfig>

Optional. Immutable. The embedding model config of the Vector DB.

vector_db: Option<VectorDb>

The config for the Vector DB.

Implementations

impl RagVectorDbConfig

pub fn new() -> Self

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

where T: Into<ApiAuth>,

Sets the value of api_auth.

Example

use google_cloud_aiplatform_v1::model::ApiAuth;
let x = RagVectorDbConfig::new().set_api_auth(ApiAuth::default()/* use setters */);

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

where T: Into<ApiAuth>,

Sets or clears the value of api_auth.

Example

use google_cloud_aiplatform_v1::model::ApiAuth;
let x = RagVectorDbConfig::new().set_or_clear_api_auth(Some(ApiAuth::default()/* use setters */));
let x = RagVectorDbConfig::new().set_or_clear_api_auth(None::<ApiAuth>);

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

where T: Into<RagEmbeddingModelConfig>,

Sets the value of rag_embedding_model_config.

Example

use google_cloud_aiplatform_v1::model::RagEmbeddingModelConfig;
let x = RagVectorDbConfig::new().set_rag_embedding_model_config(RagEmbeddingModelConfig::default()/* use setters */);

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

where T: Into<RagEmbeddingModelConfig>,

Sets or clears the value of rag_embedding_model_config.

Example

use google_cloud_aiplatform_v1::model::RagEmbeddingModelConfig;
let x = RagVectorDbConfig::new().set_or_clear_rag_embedding_model_config(Some(RagEmbeddingModelConfig::default()/* use setters */));
let x = RagVectorDbConfig::new().set_or_clear_rag_embedding_model_config(None::<RagEmbeddingModelConfig>);

pub fn set_vector_db<T: Into<Option<VectorDb>>>(self, v: T) -> Self

Sets the value of vector_db.

Note that all the setters affecting vector_db are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::rag_vector_db_config::RagManagedDb;
let x = RagVectorDbConfig::new().set_vector_db(Some(
    google_cloud_aiplatform_v1::model::rag_vector_db_config::VectorDb::RagManagedDb(RagManagedDb::default().into())));

pub fn rag_managed_db(&self) -> Option<&Box<RagManagedDb>>

The value of vector_db if it holds a RagManagedDb, None if the field is not set or holds a different branch.

pub fn set_rag_managed_db<T: Into<Box<RagManagedDb>>>(self, v: T) -> Self

Sets the value of vector_db to hold a RagManagedDb.

Note that all the setters affecting vector_db are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::rag_vector_db_config::RagManagedDb;
let x = RagVectorDbConfig::new().set_rag_managed_db(RagManagedDb::default()/* use setters */);
assert!(x.rag_managed_db().is_some());
assert!(x.pinecone().is_none());
assert!(x.vertex_vector_search().is_none());

pub fn pinecone(&self) -> Option<&Box<Pinecone>>

The value of vector_db if it holds a Pinecone, None if the field is not set or holds a different branch.

pub fn set_pinecone<T: Into<Box<Pinecone>>>(self, v: T) -> Self

Sets the value of vector_db to hold a Pinecone.

Note that all the setters affecting vector_db are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::rag_vector_db_config::Pinecone;
let x = RagVectorDbConfig::new().set_pinecone(Pinecone::default()/* use setters */);
assert!(x.pinecone().is_some());
assert!(x.rag_managed_db().is_none());
assert!(x.vertex_vector_search().is_none());

pub fn vertex_vector_search(&self) -> Option<&Box<VertexVectorSearch>>

The value of vector_db if it holds a VertexVectorSearch, None if the field is not set or holds a different branch.

pub fn set_vertex_vector_search<T: Into<Box<VertexVectorSearch>>>( self, v: T, ) -> Self

Sets the value of vector_db to hold a VertexVectorSearch.

Note that all the setters affecting vector_db are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::rag_vector_db_config::VertexVectorSearch;
let x = RagVectorDbConfig::new().set_vertex_vector_search(VertexVectorSearch::default()/* use setters */);
assert!(x.vertex_vector_search().is_some());
assert!(x.rag_managed_db().is_none());
assert!(x.pinecone().is_none());

Trait Implementations

impl Clone for RagVectorDbConfig

fn clone(&self) -> RagVectorDbConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RagVectorDbConfig

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

Formats the value using the given formatter.

impl Default for RagVectorDbConfig

fn default() -> RagVectorDbConfig

Returns the “default value” for a type.

impl Message for RagVectorDbConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RagVectorDbConfig

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