Class RagRetrievalConfig.HybridSearch.Builder (3.56.0)

public static final class RagRetrievalConfig.HybridSearch.Builder extends GeneratedMessageV3.Builder<RagRetrievalConfig.HybridSearch.Builder> implements RagRetrievalConfig.HybridSearchOrBuilder

Config for Hybrid Search.

Protobuf type google.cloud.aiplatform.v1beta1.RagRetrievalConfig.HybridSearch

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RagRetrievalConfig.HybridSearch.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder
Overrides

build()

public RagRetrievalConfig.HybridSearch build()
Returns
Type Description
RagRetrievalConfig.HybridSearch

buildPartial()

public RagRetrievalConfig.HybridSearch buildPartial()
Returns
Type Description
RagRetrievalConfig.HybridSearch

clear()

public RagRetrievalConfig.HybridSearch.Builder clear()
Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder
Overrides

clearAlpha()

public RagRetrievalConfig.HybridSearch.Builder clearAlpha()

Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.

optional float alpha = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RagRetrievalConfig.HybridSearch.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RagRetrievalConfig.HybridSearch.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder
Overrides

clone()

public RagRetrievalConfig.HybridSearch.Builder clone()
Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder
Overrides

getAlpha()

public float getAlpha()

Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.

optional float alpha = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
float

The alpha.

getDefaultInstanceForType()

public RagRetrievalConfig.HybridSearch getDefaultInstanceForType()
Returns
Type Description
RagRetrievalConfig.HybridSearch

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

hasAlpha()

public boolean hasAlpha()

Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.

optional float alpha = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the alpha field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RagRetrievalConfig.HybridSearch other)

public RagRetrievalConfig.HybridSearch.Builder mergeFrom(RagRetrievalConfig.HybridSearch other)
Parameter
Name Description
other RagRetrievalConfig.HybridSearch
Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagRetrievalConfig.HybridSearch.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RagRetrievalConfig.HybridSearch.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RagRetrievalConfig.HybridSearch.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder
Overrides

setAlpha(float value)

public RagRetrievalConfig.HybridSearch.Builder setAlpha(float value)

Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.

optional float alpha = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value float

The alpha to set.

Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RagRetrievalConfig.HybridSearch.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RagRetrievalConfig.HybridSearch.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RagRetrievalConfig.HybridSearch.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RagRetrievalConfig.HybridSearch.Builder
Overrides