Class RagVectorDbConfig.RagManagedDb.ANN.Builder (3.64.0)

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RagVectorDbConfig.RagManagedDb.ANN.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder
Overrides

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

clearField(Descriptors.FieldDescriptor field)

public RagVectorDbConfig.RagManagedDb.ANN.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
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.

clearOneof(Descriptors.OneofDescriptor oneof)

public RagVectorDbConfig.RagManagedDb.ANN.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder
Overrides

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.

clone()

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

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 GeneratedMessageV3.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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RagVectorDbConfig.RagManagedDb.ANN.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RagVectorDbConfig.RagManagedDb.ANN.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
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.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RagVectorDbConfig.RagManagedDb.ANN.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder
Overrides

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.

setUnknownFields(UnknownFieldSet unknownFields)

public final RagVectorDbConfig.RagManagedDb.ANN.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RagVectorDbConfig.RagManagedDb.ANN.Builder
Overrides