com.google.cloud.aiplatform.v1beta1

Class VertexRagStore

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.VertexRagStore

All Implemented Interfaces:

VertexRagStoreOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class VertexRagStore
extends com.google.protobuf.GeneratedMessageV3
implements VertexRagStoreOrBuilder

 Retrieve from Vertex RAG Store for grounding.
 

Protobuf type google.cloud.aiplatform.v1beta1.VertexRagStore

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VertexRagStore.Builder Retrieve from Vertex RAG Store for grounding.
static class	VertexRagStore.RagResource The definition of the Rag resource.
static interface	VertexRagStore.RagResourceOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	RAG_CORPORA_FIELD_NUMBER
static int	RAG_RESOURCES_FIELD_NUMBER
static int	SIMILARITY_TOP_K_FIELD_NUMBER
static int	VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static VertexRagStore	getDefaultInstance()
VertexRagStore	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<VertexRagStore>	getParserForType()
String	getRagCorpora(int index) Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=267
com.google.protobuf.ByteString	getRagCorporaBytes(int index) Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=267
int	getRagCorporaCount() Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=267
com.google.protobuf.ProtocolStringList	getRagCorporaList() Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=267
VertexRagStore.RagResource	getRagResources(int index) Optional.
int	getRagResourcesCount() Optional.
List<VertexRagStore.RagResource>	getRagResourcesList() Optional.
VertexRagStore.RagResourceOrBuilder	getRagResourcesOrBuilder(int index) Optional.
List<? extends VertexRagStore.RagResourceOrBuilder>	getRagResourcesOrBuilderList() Optional.
int	getSerializedSize()
int	getSimilarityTopK() Optional.
double	getVectorDistanceThreshold() Optional.
int	hashCode()
boolean	hasSimilarityTopK() Optional.
boolean	hasVectorDistanceThreshold() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static VertexRagStore.Builder	newBuilder()
static VertexRagStore.Builder	newBuilder(VertexRagStore prototype)
VertexRagStore.Builder	newBuilderForType()
protected VertexRagStore.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static VertexRagStore	parseDelimitedFrom(InputStream input)
static VertexRagStore	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static VertexRagStore	parseFrom(byte[] data)
static VertexRagStore	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static VertexRagStore	parseFrom(ByteBuffer data)
static VertexRagStore	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static VertexRagStore	parseFrom(com.google.protobuf.ByteString data)
static VertexRagStore	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static VertexRagStore	parseFrom(com.google.protobuf.CodedInputStream input)
static VertexRagStore	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static VertexRagStore	parseFrom(InputStream input)
static VertexRagStore	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<VertexRagStore>	parser()
VertexRagStore.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

RAG_CORPORA_FIELD_NUMBER

public static final int RAG_CORPORA_FIELD_NUMBER

See Also:

Constant Field Values

RAG_RESOURCES_FIELD_NUMBER

public static final int RAG_RESOURCES_FIELD_NUMBER

See Also:

Constant Field Values

SIMILARITY_TOP_K_FIELD_NUMBER

public static final int SIMILARITY_TOP_K_FIELD_NUMBER

See Also:

Constant Field Values

VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER

public static final int VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

getRagCorporaList

@Deprecated
public com.google.protobuf.ProtocolStringList getRagCorporaList()

Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=267

 Optional. Deprecated. Please use rag_resources instead.
 

repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getRagCorporaList in interface VertexRagStoreOrBuilder

Returns:

A list containing the ragCorpora.

getRagCorporaCount

@Deprecated
public int getRagCorporaCount()

Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=267

 Optional. Deprecated. Please use rag_resources instead.
 

repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getRagCorporaCount in interface VertexRagStoreOrBuilder

Returns:

The count of ragCorpora.

getRagCorpora

@Deprecated
public String getRagCorpora(int index)

Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=267

 Optional. Deprecated. Please use rag_resources instead.
 

repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getRagCorpora in interface VertexRagStoreOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The ragCorpora at the given index.

getRagCorporaBytes

@Deprecated
public com.google.protobuf.ByteString getRagCorporaBytes(int index)

Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=267

 Optional. Deprecated. Please use rag_resources instead.
 

repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getRagCorporaBytes in interface VertexRagStoreOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the ragCorpora at the given index.

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.v1beta1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRagResourcesList in interface VertexRagStoreOrBuilder

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.v1beta1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRagResourcesOrBuilderList in interface VertexRagStoreOrBuilder

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.v1beta1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRagResourcesCount in interface VertexRagStoreOrBuilder

getRagResources

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.v1beta1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRagResources in interface VertexRagStoreOrBuilder

getRagResourcesOrBuilder

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.v1beta1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRagResourcesOrBuilder in interface VertexRagStoreOrBuilder

hasSimilarityTopK

public boolean hasSimilarityTopK()

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

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

Specified by:

hasSimilarityTopK in interface VertexRagStoreOrBuilder

Returns:

Whether the similarityTopK field is set.

getSimilarityTopK

public int getSimilarityTopK()

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

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

Specified by:

getSimilarityTopK in interface VertexRagStoreOrBuilder

Returns:

The similarityTopK.

hasVectorDistanceThreshold

public boolean hasVectorDistanceThreshold()

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

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

Specified by:

hasVectorDistanceThreshold in interface VertexRagStoreOrBuilder

Returns:

Whether the vectorDistanceThreshold field is set.

getVectorDistanceThreshold

public double getVectorDistanceThreshold()

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

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

Specified by:

getVectorDistanceThreshold in interface VertexRagStoreOrBuilder

Returns:

The vectorDistanceThreshold.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static VertexRagStore parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static VertexRagStore parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static VertexRagStore parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static VertexRagStore parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static VertexRagStore parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static VertexRagStore parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static VertexRagStore parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static VertexRagStore parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static VertexRagStore parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static VertexRagStore parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static VertexRagStore parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static VertexRagStore parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public VertexRagStore.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static VertexRagStore.Builder newBuilder()

newBuilder

public static VertexRagStore.Builder newBuilder(VertexRagStore prototype)

toBuilder

public VertexRagStore.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected VertexRagStore.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static VertexRagStore getDefaultInstance()

parser

public static com.google.protobuf.Parser<VertexRagStore> parser()

getParserForType

public com.google.protobuf.Parser<VertexRagStore> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public VertexRagStore getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder