Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::RagVectorDbConfig (v1.27.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::RagVectorDbConfig.

Config for the Vector DB to use for RAG.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#api_auth

def api_auth() -> ::Google::Cloud::AIPlatform::V1::ApiAuth

Returns

• (::Google::Cloud::AIPlatform::V1::ApiAuth) — Authentication config for the chosen Vector DB.

#api_auth=

def api_auth=(value) -> ::Google::Cloud::AIPlatform::V1::ApiAuth

Parameter

• value (::Google::Cloud::AIPlatform::V1::ApiAuth) — Authentication config for the chosen Vector DB.

Returns

• (::Google::Cloud::AIPlatform::V1::ApiAuth) — Authentication config for the chosen Vector DB.

#pinecone

def pinecone() -> ::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::Pinecone

Returns

• (::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::Pinecone) — The config for the Pinecone.

  Note: The following fields are mutually exclusive: pinecone, rag_managed_db, vertex_vector_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

#pinecone=

def pinecone=(value) -> ::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::Pinecone

Parameter

• value (::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::Pinecone) — The config for the Pinecone.

  Note: The following fields are mutually exclusive: pinecone, rag_managed_db, vertex_vector_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::Pinecone) — The config for the Pinecone.

  Note: The following fields are mutually exclusive: pinecone, rag_managed_db, vertex_vector_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

#rag_embedding_model_config

def rag_embedding_model_config() -> ::Google::Cloud::AIPlatform::V1::RagEmbeddingModelConfig

Returns

• (::Google::Cloud::AIPlatform::V1::RagEmbeddingModelConfig) — Optional. Immutable. The embedding model config of the Vector DB.

#rag_embedding_model_config=

def rag_embedding_model_config=(value) -> ::Google::Cloud::AIPlatform::V1::RagEmbeddingModelConfig

Parameter

• value (::Google::Cloud::AIPlatform::V1::RagEmbeddingModelConfig) — Optional. Immutable. The embedding model config of the Vector DB.

Returns

• (::Google::Cloud::AIPlatform::V1::RagEmbeddingModelConfig) — Optional. Immutable. The embedding model config of the Vector DB.

#rag_managed_db

def rag_managed_db() -> ::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::RagManagedDb

Returns

• (::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::RagManagedDb) — The config for the RAG-managed Vector DB.

  Note: The following fields are mutually exclusive: rag_managed_db, pinecone, vertex_vector_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

#rag_managed_db=

def rag_managed_db=(value) -> ::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::RagManagedDb

Parameter

• value (::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::RagManagedDb) — The config for the RAG-managed Vector DB.

  Note: The following fields are mutually exclusive: rag_managed_db, pinecone, vertex_vector_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::RagManagedDb) — The config for the RAG-managed Vector DB.

  Note: The following fields are mutually exclusive: rag_managed_db, pinecone, vertex_vector_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

#vertex_vector_search

def vertex_vector_search() -> ::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::VertexVectorSearch

Returns

• (::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::VertexVectorSearch) — The config for the Vertex Vector Search.

  Note: The following fields are mutually exclusive: vertex_vector_search, rag_managed_db, pinecone. If a field in that set is populated, all other fields in the set will automatically be cleared.

#vertex_vector_search=

def vertex_vector_search=(value) -> ::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::VertexVectorSearch

Parameter

• value (::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::VertexVectorSearch) — The config for the Vertex Vector Search.

  Note: The following fields are mutually exclusive: vertex_vector_search, rag_managed_db, pinecone. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::RagVectorDbConfig::VertexVectorSearch) — The config for the Vertex Vector Search.

  Note: The following fields are mutually exclusive: vertex_vector_search, rag_managed_db, pinecone. If a field in that set is populated, all other fields in the set will automatically be cleared.