Package 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.GeneratedMessage.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.GeneratedMessage.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
    Description
    RagQuery.Ranking
    build()
     
    RagQuery.Ranking
    buildPartial()
     
    RagQuery.Ranking.Builder
    clear()
     
    RagQuery.Ranking.Builder
    clearAlpha()
    Optional.
    float
    getAlpha()
    Optional.
    RagQuery.Ranking
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    boolean
    hasAlpha()
    Optional.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    RagQuery.Ranking.Builder
    mergeFrom(RagQuery.Ranking other)
     
    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
    setAlpha(float value)
    Optional.

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

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

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

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

    mergeDelimitedFrom, mergeDelimitedFrom

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

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

    • 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.GeneratedMessage.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.