Class RagVectorDbConfig (3.56.0)

public final class RagVectorDbConfig extends GeneratedMessageV3 implements RagVectorDbConfigOrBuilder

Config for the Vector DB to use for RAG.

Protobuf type google.cloud.aiplatform.v1beta1.RagVectorDbConfig

Static Fields

API_AUTH_FIELD_NUMBER

public static final int API_AUTH_FIELD_NUMBER
Field Value
Type Description
int

PINECONE_FIELD_NUMBER

public static final int PINECONE_FIELD_NUMBER
Field Value
Type Description
int

RAG_EMBEDDING_MODEL_CONFIG_FIELD_NUMBER

public static final int RAG_EMBEDDING_MODEL_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

RAG_MANAGED_DB_FIELD_NUMBER

public static final int RAG_MANAGED_DB_FIELD_NUMBER
Field Value
Type Description
int

VERTEX_FEATURE_STORE_FIELD_NUMBER

public static final int VERTEX_FEATURE_STORE_FIELD_NUMBER
Field Value
Type Description
int

VERTEX_VECTOR_SEARCH_FIELD_NUMBER

public static final int VERTEX_VECTOR_SEARCH_FIELD_NUMBER
Field Value
Type Description
int

WEAVIATE_FIELD_NUMBER

public static final int WEAVIATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RagVectorDbConfig getDefaultInstance()
Returns
Type Description
RagVectorDbConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RagVectorDbConfig.Builder newBuilder()
Returns
Type Description
RagVectorDbConfig.Builder

newBuilder(RagVectorDbConfig prototype)

public static RagVectorDbConfig.Builder newBuilder(RagVectorDbConfig prototype)
Parameter
Name Description
prototype RagVectorDbConfig
Returns
Type Description
RagVectorDbConfig.Builder

parseDelimitedFrom(InputStream input)

public static RagVectorDbConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RagVectorDbConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagVectorDbConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RagVectorDbConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RagVectorDbConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RagVectorDbConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RagVectorDbConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RagVectorDbConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RagVectorDbConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RagVectorDbConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RagVectorDbConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RagVectorDbConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RagVectorDbConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RagVectorDbConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagVectorDbConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RagVectorDbConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RagVectorDbConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RagVectorDbConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RagVectorDbConfig> parser()
Returns
Type Description
Parser<RagVectorDbConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getApiAuth()

public ApiAuth getApiAuth()

Authentication config for the chosen Vector DB.

.google.cloud.aiplatform.v1beta1.ApiAuth api_auth = 5;

Returns
Type Description
ApiAuth

The apiAuth.

getApiAuthOrBuilder()

public ApiAuthOrBuilder getApiAuthOrBuilder()

Authentication config for the chosen Vector DB.

.google.cloud.aiplatform.v1beta1.ApiAuth api_auth = 5;

Returns
Type Description
ApiAuthOrBuilder

getDefaultInstanceForType()

public RagVectorDbConfig getDefaultInstanceForType()
Returns
Type Description
RagVectorDbConfig

getParserForType()

public Parser<RagVectorDbConfig> getParserForType()
Returns
Type Description
Parser<RagVectorDbConfig>
Overrides

getPinecone()

public RagVectorDbConfig.Pinecone getPinecone()

The config for the Pinecone.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.Pinecone pinecone = 3;

Returns
Type Description
RagVectorDbConfig.Pinecone

The pinecone.

getPineconeOrBuilder()

public RagVectorDbConfig.PineconeOrBuilder getPineconeOrBuilder()

The config for the Pinecone.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.Pinecone pinecone = 3;

Returns
Type Description
RagVectorDbConfig.PineconeOrBuilder

getRagEmbeddingModelConfig()

public RagEmbeddingModelConfig getRagEmbeddingModelConfig()

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

.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig rag_embedding_model_config = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
RagEmbeddingModelConfig

The ragEmbeddingModelConfig.

getRagEmbeddingModelConfigOrBuilder()

public RagEmbeddingModelConfigOrBuilder getRagEmbeddingModelConfigOrBuilder()

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

.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig rag_embedding_model_config = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
RagEmbeddingModelConfigOrBuilder

getRagManagedDb()

public RagVectorDbConfig.RagManagedDb getRagManagedDb()

The config for the RAG-managed Vector DB.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.RagManagedDb rag_managed_db = 1;

Returns
Type Description
RagVectorDbConfig.RagManagedDb

The ragManagedDb.

getRagManagedDbOrBuilder()

public RagVectorDbConfig.RagManagedDbOrBuilder getRagManagedDbOrBuilder()

The config for the RAG-managed Vector DB.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.RagManagedDb rag_managed_db = 1;

Returns
Type Description
RagVectorDbConfig.RagManagedDbOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getVectorDbCase()

public RagVectorDbConfig.VectorDbCase getVectorDbCase()
Returns
Type Description
RagVectorDbConfig.VectorDbCase

getVertexFeatureStore()

public RagVectorDbConfig.VertexFeatureStore getVertexFeatureStore()

The config for the Vertex Feature Store.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.VertexFeatureStore vertex_feature_store = 4;

Returns
Type Description
RagVectorDbConfig.VertexFeatureStore

The vertexFeatureStore.

getVertexFeatureStoreOrBuilder()

public RagVectorDbConfig.VertexFeatureStoreOrBuilder getVertexFeatureStoreOrBuilder()

The config for the Vertex Feature Store.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.VertexFeatureStore vertex_feature_store = 4;

Returns
Type Description
RagVectorDbConfig.VertexFeatureStoreOrBuilder

getVertexVectorSearch()

public RagVectorDbConfig.VertexVectorSearch getVertexVectorSearch()

The config for the Vertex Vector Search.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.VertexVectorSearch vertex_vector_search = 6;

Returns
Type Description
RagVectorDbConfig.VertexVectorSearch

The vertexVectorSearch.

getVertexVectorSearchOrBuilder()

public RagVectorDbConfig.VertexVectorSearchOrBuilder getVertexVectorSearchOrBuilder()

The config for the Vertex Vector Search.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.VertexVectorSearch vertex_vector_search = 6;

Returns
Type Description
RagVectorDbConfig.VertexVectorSearchOrBuilder

getWeaviate()

public RagVectorDbConfig.Weaviate getWeaviate()

The config for the Weaviate.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.Weaviate weaviate = 2;

Returns
Type Description
RagVectorDbConfig.Weaviate

The weaviate.

getWeaviateOrBuilder()

public RagVectorDbConfig.WeaviateOrBuilder getWeaviateOrBuilder()

The config for the Weaviate.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.Weaviate weaviate = 2;

Returns
Type Description
RagVectorDbConfig.WeaviateOrBuilder

hasApiAuth()

public boolean hasApiAuth()

Authentication config for the chosen Vector DB.

.google.cloud.aiplatform.v1beta1.ApiAuth api_auth = 5;

Returns
Type Description
boolean

Whether the apiAuth field is set.

hasPinecone()

public boolean hasPinecone()

The config for the Pinecone.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.Pinecone pinecone = 3;

Returns
Type Description
boolean

Whether the pinecone field is set.

hasRagEmbeddingModelConfig()

public boolean hasRagEmbeddingModelConfig()

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

.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig rag_embedding_model_config = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the ragEmbeddingModelConfig field is set.

hasRagManagedDb()

public boolean hasRagManagedDb()

The config for the RAG-managed Vector DB.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.RagManagedDb rag_managed_db = 1;

Returns
Type Description
boolean

Whether the ragManagedDb field is set.

hasVertexFeatureStore()

public boolean hasVertexFeatureStore()

The config for the Vertex Feature Store.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.VertexFeatureStore vertex_feature_store = 4;

Returns
Type Description
boolean

Whether the vertexFeatureStore field is set.

hasVertexVectorSearch()

public boolean hasVertexVectorSearch()

The config for the Vertex Vector Search.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.VertexVectorSearch vertex_vector_search = 6;

Returns
Type Description
boolean

Whether the vertexVectorSearch field is set.

hasWeaviate()

public boolean hasWeaviate()

The config for the Weaviate.

.google.cloud.aiplatform.v1beta1.RagVectorDbConfig.Weaviate weaviate = 2;

Returns
Type Description
boolean

Whether the weaviate field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RagVectorDbConfig.Builder newBuilderForType()
Returns
Type Description
RagVectorDbConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RagVectorDbConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RagVectorDbConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RagVectorDbConfig.Builder toBuilder()
Returns
Type Description
RagVectorDbConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException