com.google.cloud.aiplatform.v1beta1

Class RagQuery.Ranking.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>

com.google.cloud.aiplatform.v1beta1.RagQuery.Ranking.Builder

All Implemented Interfaces:

RagQuery.RankingOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

RagQuery.Ranking

public static final class RagQuery.Ranking.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>
implements RagQuery.RankingOrBuilder

 Configurations for hybrid search results ranking.
 

Protobuf type google.cloud.aiplatform.v1beta1.RagQuery.Ranking

Method Summary

Modifier and Type	Method and Description
RagQuery.Ranking.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RagQuery.Ranking	build()
RagQuery.Ranking	buildPartial()
RagQuery.Ranking.Builder	clear()
RagQuery.Ranking.Builder	clearAlpha() Optional.
RagQuery.Ranking.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RagQuery.Ranking.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RagQuery.Ranking.Builder	clone()
float	getAlpha() Optional.
RagQuery.Ranking	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	hasAlpha() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RagQuery.Ranking.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RagQuery.Ranking.Builder	mergeFrom(com.google.protobuf.Message other)
RagQuery.Ranking.Builder	mergeFrom(RagQuery.Ranking other)
RagQuery.Ranking.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RagQuery.Ranking.Builder	setAlpha(float value) Optional.
RagQuery.Ranking.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RagQuery.Ranking.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RagQuery.Ranking.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>

clear

public RagQuery.Ranking.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>

getDefaultInstanceForType

public RagQuery.Ranking getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RagQuery.Ranking build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RagQuery.Ranking buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public RagQuery.Ranking.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>

setField

public RagQuery.Ranking.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>

clearField

public RagQuery.Ranking.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>

clearOneof

public RagQuery.Ranking.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>

setRepeatedField

public RagQuery.Ranking.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>

addRepeatedField

public RagQuery.Ranking.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>

mergeFrom

public RagQuery.Ranking.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RagQuery.Ranking.Builder>

mergeFrom

public RagQuery.Ranking.Builder mergeFrom(RagQuery.Ranking other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>

mergeFrom

public RagQuery.Ranking.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RagQuery.Ranking.Builder>

Throws:

IOException

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];

Specified by:

hasAlpha in interface RagQuery.RankingOrBuilder

Returns:

Whether the alpha field is set.

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];

Specified by:

getAlpha in interface RagQuery.RankingOrBuilder

Returns:

The alpha.

setAlpha

public RagQuery.Ranking.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];

Parameters:

value - The alpha to set.

Returns:

This builder for chaining.

clearAlpha

public RagQuery.Ranking.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:

This builder for chaining.

setUnknownFields

public final RagQuery.Ranking.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>

mergeUnknownFields

public final RagQuery.Ranking.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Ranking.Builder>