Class RagEmbeddingModelConfig (3.56.0)

public final class RagEmbeddingModelConfig extends GeneratedMessageV3 implements RagEmbeddingModelConfigOrBuilder

Config for the embedding model to use for RAG.

Protobuf type google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig

Static Fields

HYBRID_SEARCH_CONFIG_FIELD_NUMBER

public static final int HYBRID_SEARCH_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

VERTEX_PREDICTION_ENDPOINT_FIELD_NUMBER

public static final int VERTEX_PREDICTION_ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RagEmbeddingModelConfig getDefaultInstance()
Returns
Type Description
RagEmbeddingModelConfig

getDescriptor()

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

newBuilder()

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

newBuilder(RagEmbeddingModelConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public RagEmbeddingModelConfig getDefaultInstanceForType()
Returns
Type Description
RagEmbeddingModelConfig

getHybridSearchConfig()

public RagEmbeddingModelConfig.HybridSearchConfig getHybridSearchConfig()

Configuration for hybrid search.

.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig.HybridSearchConfig hybrid_search_config = 2;

Returns
Type Description
RagEmbeddingModelConfig.HybridSearchConfig

The hybridSearchConfig.

getHybridSearchConfigOrBuilder()

public RagEmbeddingModelConfig.HybridSearchConfigOrBuilder getHybridSearchConfigOrBuilder()

Configuration for hybrid search.

.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig.HybridSearchConfig hybrid_search_config = 2;

Returns
Type Description
RagEmbeddingModelConfig.HybridSearchConfigOrBuilder

getModelConfigCase()

public RagEmbeddingModelConfig.ModelConfigCase getModelConfigCase()
Returns
Type Description
RagEmbeddingModelConfig.ModelConfigCase

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getVertexPredictionEndpoint()

public RagEmbeddingModelConfig.VertexPredictionEndpoint getVertexPredictionEndpoint()

The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. This is used for dense vector search.

.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig.VertexPredictionEndpoint vertex_prediction_endpoint = 1;

Returns
Type Description
RagEmbeddingModelConfig.VertexPredictionEndpoint

The vertexPredictionEndpoint.

getVertexPredictionEndpointOrBuilder()

public RagEmbeddingModelConfig.VertexPredictionEndpointOrBuilder getVertexPredictionEndpointOrBuilder()

The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. This is used for dense vector search.

.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig.VertexPredictionEndpoint vertex_prediction_endpoint = 1;

Returns
Type Description
RagEmbeddingModelConfig.VertexPredictionEndpointOrBuilder

hasHybridSearchConfig()

public boolean hasHybridSearchConfig()

Configuration for hybrid search.

.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig.HybridSearchConfig hybrid_search_config = 2;

Returns
Type Description
boolean

Whether the hybridSearchConfig field is set.

hasVertexPredictionEndpoint()

public boolean hasVertexPredictionEndpoint()

The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. This is used for dense vector search.

.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig.VertexPredictionEndpoint vertex_prediction_endpoint = 1;

Returns
Type Description
boolean

Whether the vertexPredictionEndpoint 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 RagEmbeddingModelConfig.Builder newBuilderForType()
Returns
Type Description
RagEmbeddingModelConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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