Class RagVectorDbConfig.RagManagedDb.ANN.Builder (1.43.0)

public static final class RagVectorDbConfig.RagManagedDb.ANN.Builder extends GeneratedMessage.Builder<RagVectorDbConfig.RagManagedDb.ANN.Builder> 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.vertexai.v1.RagVectorDbConfig.RagManagedDb.ANN

Static Methods

getDescriptor()

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

Methods

build()

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

buildPartial()

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

clear()

public RagVectorDbConfig.RagManagedDb.ANN.Builder clear()
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder
Overrides

clearLeafCount()

public RagVectorDbConfig.RagManagedDb.ANN.Builder clearLeafCount()

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
RagVectorDbConfig.RagManagedDb.ANN.Builder

This builder for chaining.

clearTreeDepth()

public RagVectorDbConfig.RagManagedDb.ANN.Builder clearTreeDepth()

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
RagVectorDbConfig.RagManagedDb.ANN.Builder

This builder for chaining.

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RagVectorDbConfig.RagManagedDb.ANN other)

public RagVectorDbConfig.RagManagedDb.ANN.Builder mergeFrom(RagVectorDbConfig.RagManagedDb.ANN other)
Parameter
Name Description
other RagVectorDbConfig.RagManagedDb.ANN
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagVectorDbConfig.RagManagedDb.ANN.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RagVectorDbConfig.RagManagedDb.ANN.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder
Overrides

setLeafCount(int value)

public RagVectorDbConfig.RagManagedDb.ANN.Builder setLeafCount(int value)

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;

Parameter
Name Description
value int

The leafCount to set.

Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder

This builder for chaining.

setTreeDepth(int value)

public RagVectorDbConfig.RagManagedDb.ANN.Builder setTreeDepth(int value)

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;

Parameter
Name Description
value int

The treeDepth to set.

Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder

This builder for chaining.