Class FindNeighborsRequest.Query.RRF.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<FindNeighborsRequest.Query.RRF.Builder>
com.google.cloud.aiplatform.v1.FindNeighborsRequest.Query.RRF.Builder
All Implemented Interfaces:
FindNeighborsRequest.Query.RRFOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
FindNeighborsRequest.Query.RRF

public static final class FindNeighborsRequest.Query.RRF.Builder extends com.google.protobuf.GeneratedMessage.Builder<FindNeighborsRequest.Query.RRF.Builder> implements FindNeighborsRequest.Query.RRFOrBuilder
 Parameters for RRF algorithm that combines search results.
 
Protobuf type google.cloud.aiplatform.v1.FindNeighborsRequest.Query.RRF
  • 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<FindNeighborsRequest.Query.RRF.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<FindNeighborsRequest.Query.RRF.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<FindNeighborsRequest.Query.RRF.Builder>
    • getDefaultInstanceForType

      public FindNeighborsRequest.Query.RRF getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public FindNeighborsRequest.Query.RRF buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public FindNeighborsRequest.Query.RRF.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<FindNeighborsRequest.Query.RRF.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<FindNeighborsRequest.Query.RRF.Builder>
    • mergeFrom

      public FindNeighborsRequest.Query.RRF.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<FindNeighborsRequest.Query.RRF.Builder>
      Throws:
      IOException
    • getAlpha

      public float getAlpha()
       Required. Users can provide an alpha value to give more weight to dense
       vs sparse results. For example, if the alpha is 0, we only return
       sparse and if the alpha is 1, we only return dense.
       
      float alpha = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAlpha in interface FindNeighborsRequest.Query.RRFOrBuilder
      Returns:
      The alpha.
    • setAlpha

      public FindNeighborsRequest.Query.RRF.Builder setAlpha(float value)
       Required. Users can provide an alpha value to give more weight to dense
       vs sparse results. For example, if the alpha is 0, we only return
       sparse and if the alpha is 1, we only return dense.
       
      float alpha = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The alpha to set.
      Returns:
      This builder for chaining.
    • clearAlpha

       Required. Users can provide an alpha value to give more weight to dense
       vs sparse results. For example, if the alpha is 0, we only return
       sparse and if the alpha is 1, we only return dense.
       
      float alpha = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.