com.google.cloud.aiplatform.v1

Class RagVectorDbConfig.RagManagedDb.ANN.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<RagVectorDbConfig.RagManagedDb.ANN.Builder>

com.google.cloud.aiplatform.v1.RagVectorDbConfig.RagManagedDb.ANN.Builder

All Implemented Interfaces:

RagVectorDbConfig.RagManagedDb.ANNOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

RagVectorDbConfig.RagManagedDb.ANN

public static final class RagVectorDbConfig.RagManagedDb.ANN.Builder
extends com.google.protobuf.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

Method Summary

Modifier and Type	Method and Description
RagVectorDbConfig.RagManagedDb.ANN.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RagVectorDbConfig.RagManagedDb.ANN	build()
RagVectorDbConfig.RagManagedDb.ANN	buildPartial()
RagVectorDbConfig.RagManagedDb.ANN.Builder	clear()
RagVectorDbConfig.RagManagedDb.ANN.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RagVectorDbConfig.RagManagedDb.ANN.Builder	clearLeafCount() Number of leaf nodes in the tree-based structure.
RagVectorDbConfig.RagManagedDb.ANN.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RagVectorDbConfig.RagManagedDb.ANN.Builder	clearTreeDepth() The depth of the tree-based structure.
RagVectorDbConfig.RagManagedDb.ANN.Builder	clone()
RagVectorDbConfig.RagManagedDb.ANN	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
int	getLeafCount() Number of leaf nodes in the tree-based structure.
int	getTreeDepth() The depth of the tree-based structure.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RagVectorDbConfig.RagManagedDb.ANN.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RagVectorDbConfig.RagManagedDb.ANN.Builder	mergeFrom(com.google.protobuf.Message other)
RagVectorDbConfig.RagManagedDb.ANN.Builder	mergeFrom(RagVectorDbConfig.RagManagedDb.ANN other)
RagVectorDbConfig.RagManagedDb.ANN.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RagVectorDbConfig.RagManagedDb.ANN.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RagVectorDbConfig.RagManagedDb.ANN.Builder	setLeafCount(int value) Number of leaf nodes in the tree-based structure.
RagVectorDbConfig.RagManagedDb.ANN.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RagVectorDbConfig.RagManagedDb.ANN.Builder	setTreeDepth(int value) The depth of the tree-based structure.
RagVectorDbConfig.RagManagedDb.ANN.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RagVectorDbConfig.RagManagedDb.ANN.Builder>

clear

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

getDefaultInstanceForType

public RagVectorDbConfig.RagManagedDb.ANN getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RagVectorDbConfig.RagManagedDb.ANN build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RagVectorDbConfig.RagManagedDb.ANN buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public RagVectorDbConfig.RagManagedDb.ANN.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RagVectorDbConfig.RagManagedDb.ANN.Builder>

setField

public RagVectorDbConfig.RagManagedDb.ANN.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                           Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RagVectorDbConfig.RagManagedDb.ANN.Builder>

clearField

public RagVectorDbConfig.RagManagedDb.ANN.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RagVectorDbConfig.RagManagedDb.ANN.Builder>

clearOneof

public RagVectorDbConfig.RagManagedDb.ANN.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RagVectorDbConfig.RagManagedDb.ANN.Builder>

setRepeatedField

public RagVectorDbConfig.RagManagedDb.ANN.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                   int index,
                                                                   Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RagVectorDbConfig.RagManagedDb.ANN.Builder>

addRepeatedField

public RagVectorDbConfig.RagManagedDb.ANN.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                   Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RagVectorDbConfig.RagManagedDb.ANN.Builder>

mergeFrom

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

mergeFrom

public RagVectorDbConfig.RagManagedDb.ANN.Builder mergeFrom(RagVectorDbConfig.RagManagedDb.ANN other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RagVectorDbConfig.RagManagedDb.ANN.Builder>

mergeFrom

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

Throws:

IOException

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.

setTreeDepth

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;

Parameters:

value - The treeDepth to set.

Returns:

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:

This builder for chaining.

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.

setLeafCount

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;

Parameters:

value - The leafCount to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setUnknownFields

public final RagVectorDbConfig.RagManagedDb.ANN.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RagVectorDbConfig.RagManagedDb.ANN.Builder>

mergeUnknownFields

public final RagVectorDbConfig.RagManagedDb.ANN.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RagVectorDbConfig.RagManagedDb.ANN.Builder>