Class RagVectorDbConfig.RagManagedDb.ANN

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.RagVectorDbConfig.RagManagedDb.ANN
All Implemented Interfaces:
RagVectorDbConfig.RagManagedDb.ANNOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
RagVectorDbConfig.RagManagedDb

public static final class RagVectorDbConfig.RagManagedDb.ANN extends com.google.protobuf.GeneratedMessage implements RagVectorDbConfig.RagManagedDb.ANNOrBuilder
 Config for ANN search.

 RagManagedDb uses a tree-based structure to partition data and
 facilitate faster searches. As a tradeoff, it requires longer indexing
 time and manual triggering of index rebuild via the ImportRagFiles and
 UpdateRagCorpus API.
 
Protobuf type google.cloud.aiplatform.v1.RagVectorDbConfig.RagManagedDb.ANN
See Also:
  • Field Details

    • TREE_DEPTH_FIELD_NUMBER

      public static final int TREE_DEPTH_FIELD_NUMBER
      See Also:
    • LEAF_COUNT_FIELD_NUMBER

      public static final int LEAF_COUNT_FIELD_NUMBER
      See Also:
  • 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
    • getTreeDepth

      public int getTreeDepth()
       The depth of the tree-based structure. Only depth values of 2 and 3 are
       supported.
      
       Recommended value is 2 if you have if you have O(10K) files in the
       RagCorpus and set this to 3 if more than that.
      
       Default value is 2.
       
      int32 tree_depth = 1;
      Specified by:
      getTreeDepth in interface RagVectorDbConfig.RagManagedDb.ANNOrBuilder
      Returns:
      The treeDepth.
    • getLeafCount

      public int getLeafCount()
       Number of leaf nodes in the tree-based structure. Each leaf node
       contains groups of closely related vectors along with their
       corresponding centroid.
      
       Recommended value is 10 * sqrt(num of RagFiles in your RagCorpus).
      
       Default value is 500.
       
      int32 leaf_count = 2;
      Specified by:
      getLeafCount in interface RagVectorDbConfig.RagManagedDb.ANNOrBuilder
      Returns:
      The leafCount.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static RagVectorDbConfig.RagManagedDb.ANN parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static RagVectorDbConfig.RagManagedDb.ANN parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public RagVectorDbConfig.RagManagedDb.ANN.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static RagVectorDbConfig.RagManagedDb.ANN.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected RagVectorDbConfig.RagManagedDb.ANN.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static RagVectorDbConfig.RagManagedDb.ANN getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<RagVectorDbConfig.RagManagedDb.ANN> parser()
    • getParserForType

      public com.google.protobuf.Parser<RagVectorDbConfig.RagManagedDb.ANN> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public RagVectorDbConfig.RagManagedDb.ANN getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder