Class VertexRagStore (3.56.0)

Version latest

• 3.56.0 (latest)
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public final class VertexRagStore extends GeneratedMessageV3 implements VertexRagStoreOrBuilder

Retrieve from Vertex RAG Store for grounding.

Protobuf type google.cloud.aiplatform.v1.VertexRagStore

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > VertexRagStore

Implements

VertexRagStoreOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

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

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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

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

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

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

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

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

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

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

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

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

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

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

RAG_RESOURCES_FIELD_NUMBER

public static final int RAG_RESOURCES_FIELD_NUMBER

Field Value
Type	Description
int

RAG_RETRIEVAL_CONFIG_FIELD_NUMBER

public static final int RAG_RETRIEVAL_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

SIMILARITY_TOP_K_FIELD_NUMBER

public static final int SIMILARITY_TOP_K_FIELD_NUMBER

Field Value
Type	Description
int

VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER

public static final int VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static VertexRagStore getDefaultInstance()

Returns
Type	Description
VertexRagStore

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static VertexRagStore.Builder newBuilder()

Returns
Type	Description
VertexRagStore.Builder

newBuilder(VertexRagStore prototype)

public static VertexRagStore.Builder newBuilder(VertexRagStore prototype)

Parameter
Name	Description
prototype	VertexRagStore

Returns
Type	Description
VertexRagStore.Builder

parseDelimitedFrom(InputStream input)

public static VertexRagStore parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
VertexRagStore

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VertexRagStore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRagStore

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static VertexRagStore parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
VertexRagStore

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VertexRagStore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRagStore

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VertexRagStore parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
VertexRagStore

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VertexRagStore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRagStore

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VertexRagStore parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
VertexRagStore

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VertexRagStore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRagStore

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static VertexRagStore parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
VertexRagStore

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VertexRagStore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRagStore

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static VertexRagStore parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
VertexRagStore

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VertexRagStore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRagStore

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<VertexRagStore> parser()

Returns
Type	Description
Parser<VertexRagStore>

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 VertexRagStore getDefaultInstanceForType()

Returns
Type	Description
VertexRagStore

getParserForType()

public Parser<VertexRagStore> getParserForType()

Returns
Type	Description
Parser<VertexRagStore>

Overrides

GeneratedMessageV3.getParserForType()

getRagResources(int index)

public VertexRagStore.RagResource getRagResources(int index)

Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.

repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
VertexRagStore.RagResource

getRagResourcesCount()

public int getRagResourcesCount()

Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.

repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getRagResourcesList()

public List<VertexRagStore.RagResource> getRagResourcesList()

Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.

repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<RagResource>

getRagResourcesOrBuilder(int index)

public VertexRagStore.RagResourceOrBuilder getRagResourcesOrBuilder(int index)

Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.

repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
VertexRagStore.RagResourceOrBuilder

getRagResourcesOrBuilderList()

public List<? extends VertexRagStore.RagResourceOrBuilder> getRagResourcesOrBuilderList()

Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.

repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1.VertexRagStore.RagResourceOrBuilder>

getRagRetrievalConfig()

public RagRetrievalConfig getRagRetrievalConfig()

Optional. The retrieval config for the Rag query.

.google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig	The ragRetrievalConfig.

getRagRetrievalConfigOrBuilder()

public RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder()

Optional. The retrieval config for the Rag query.

.google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfigOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSimilarityTopK() (deprecated)

public int getSimilarityTopK()

Deprecated. google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=173

Optional. Number of top k results to return from the selected corpora.

optional int32 similarity_top_k = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The similarityTopK.

getVectorDistanceThreshold() (deprecated)

public double getVectorDistanceThreshold()

Deprecated. google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=178

Optional. Only return results with vector distance smaller than the threshold.

optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
double	The vectorDistanceThreshold.

hasRagRetrievalConfig()

public boolean hasRagRetrievalConfig()

Optional. The retrieval config for the Rag query.

.google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the ragRetrievalConfig field is set.

hasSimilarityTopK() (deprecated)

public boolean hasSimilarityTopK()

Deprecated. google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=173

Optional. Number of top k results to return from the selected corpora.

optional int32 similarity_top_k = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the similarityTopK field is set.

hasVectorDistanceThreshold() (deprecated)

public boolean hasVectorDistanceThreshold()

Deprecated. google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=178

Optional. Only return results with vector distance smaller than the threshold.

optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the vectorDistanceThreshold field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public VertexRagStore.Builder newBuilderForType()

Returns
Type	Description
VertexRagStore.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VertexRagStore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
VertexRagStore.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public VertexRagStore.Builder toBuilder()

Returns
Type	Description
VertexRagStore.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException