Class RagVectorDbConfig.RagManagedDb.ANN (1.43.0)

Version latest

• 1.43.0 (latest)
• 1.42.0
• 1.40.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.30.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

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

Inheritance

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

Implements

RagVectorDbConfig.RagManagedDb.ANNOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public RagVectorDbConfig.RagManagedDb.ANN.Builder newBuilderForType()

Returns
Type	Description
RagVectorDbConfig.RagManagedDb.ANN.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RagVectorDbConfig.RagManagedDb.ANN.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
RagVectorDbConfig.RagManagedDb.ANN.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

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

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException