Class RagVectorDbConfig.RagManagedDb.ANN (3.64.0)

public static final class RagVectorDbConfig.RagManagedDb.ANN extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RagVectorDbConfig.RagManagedDb.ANN

Static Fields

LEAF_COUNT_FIELD_NUMBER

public static final int LEAF_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TREE_DEPTH_FIELD_NUMBER

public static final int TREE_DEPTH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RagVectorDbConfig.RagManagedDb.ANN getDefaultInstance()
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN

getDescriptor()

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

newBuilder()

public static RagVectorDbConfig.RagManagedDb.ANN.Builder newBuilder()
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder

newBuilder(RagVectorDbConfig.RagManagedDb.ANN prototype)

public static RagVectorDbConfig.RagManagedDb.ANN.Builder newBuilder(RagVectorDbConfig.RagManagedDb.ANN prototype)
Parameter
Name Description
prototype RagVectorDbConfig.RagManagedDb.ANN
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder

parseDelimitedFrom(InputStream input)

public static RagVectorDbConfig.RagManagedDb.ANN parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagVectorDbConfig.RagManagedDb.ANN parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RagVectorDbConfig.RagManagedDb.ANN parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RagVectorDbConfig.RagManagedDb.ANN> parser()
Returns
Type Description
Parser<ANN>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public RagVectorDbConfig.RagManagedDb.ANN getDefaultInstanceForType()
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN

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;

Returns
Type Description
int

The leafCount.

getParserForType()

public Parser<RagVectorDbConfig.RagManagedDb.ANN> getParserForType()
Returns
Type Description
Parser<ANN>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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;

Returns
Type Description
int

The treeDepth.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RagVectorDbConfig.RagManagedDb.ANN.Builder newBuilderForType()
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RagVectorDbConfig.RagManagedDb.ANN.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RagVectorDbConfig.RagManagedDb.ANN.Builder toBuilder()
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException