Class RetrieveContextsRequest.VertexRagStore (3.59.0) 

public static final class RetrieveContextsRequest.VertexRagStore extends GeneratedMessageV3 implements RetrieveContextsRequest.VertexRagStoreOrBuilder

The data source for Vertex RagStore.

Protobuf type google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore

Inheritance

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

Static Fields

RAG_CORPORA_FIELD_NUMBER

public static final int RAG_CORPORA_FIELD_NUMBER
Field Value
Type Description
int

RAG_RESOURCES_FIELD_NUMBER

public static final int RAG_RESOURCES_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 RetrieveContextsRequest.VertexRagStore getDefaultInstance()
Returns
Type Description
RetrieveContextsRequest.VertexRagStore

getDescriptor()

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

newBuilder()

public static RetrieveContextsRequest.VertexRagStore.Builder newBuilder()
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

newBuilder(RetrieveContextsRequest.VertexRagStore prototype)

public static RetrieveContextsRequest.VertexRagStore.Builder newBuilder(RetrieveContextsRequest.VertexRagStore prototype)
Parameter
Name Description
prototype RetrieveContextsRequest.VertexRagStore
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

parseDelimitedFrom(InputStream input)

public static RetrieveContextsRequest.VertexRagStore parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetrieveContextsRequest.VertexRagStore
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveContextsRequest.VertexRagStore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest.VertexRagStore
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RetrieveContextsRequest.VertexRagStore parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RetrieveContextsRequest.VertexRagStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RetrieveContextsRequest.VertexRagStore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest.VertexRagStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RetrieveContextsRequest.VertexRagStore parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RetrieveContextsRequest.VertexRagStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RetrieveContextsRequest.VertexRagStore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest.VertexRagStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RetrieveContextsRequest.VertexRagStore parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RetrieveContextsRequest.VertexRagStore
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveContextsRequest.VertexRagStore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest.VertexRagStore
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RetrieveContextsRequest.VertexRagStore parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetrieveContextsRequest.VertexRagStore
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetrieveContextsRequest.VertexRagStore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest.VertexRagStore
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RetrieveContextsRequest.VertexRagStore parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RetrieveContextsRequest.VertexRagStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RetrieveContextsRequest.VertexRagStore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest.VertexRagStore
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RetrieveContextsRequest.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

getDefaultInstanceForType()

public RetrieveContextsRequest.VertexRagStore getDefaultInstanceForType()
Returns
Type Description
RetrieveContextsRequest.VertexRagStore

getParserForType()

public Parser<RetrieveContextsRequest.VertexRagStore> getParserForType()
Returns
Type Description
Parser<VertexRagStore>
Overrides

getRagCorpora(int index) (deprecated)

public String getRagCorpora(int index)

Deprecated. google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=127

Optional. Deprecated. Please use rag_resources to specify the data source.

repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The ragCorpora at the given index.

getRagCorporaBytes(int index) (deprecated)

public ByteString getRagCorporaBytes(int index)

Deprecated. google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=127

Optional. Deprecated. Please use rag_resources to specify the data source.

repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the ragCorpora at the given index.

getRagCorporaCount() (deprecated)

public int getRagCorporaCount()

Deprecated. google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=127

Optional. Deprecated. Please use rag_resources to specify the data source.

repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of ragCorpora.

getRagCorporaList() (deprecated)

public ProtocolStringList getRagCorporaList()

Deprecated. google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=127

Optional. Deprecated. Please use rag_resources to specify the data source.

repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the ragCorpora.

getRagResources(int index)

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

Parameter
Name Description
index int
Returns
Type Description
RetrieveContextsRequest.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.v1beta1.RetrieveContextsRequest.VertexRagStore.RagResource rag_resources = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getRagResourcesList()

public List<RetrieveContextsRequest.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.RetrieveContextsRequest.VertexRagStore.RagResource rag_resources = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<RagResource>

getRagResourcesOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.RagResourceOrBuilder

getRagResourcesOrBuilderList()

public List<? extends RetrieveContextsRequest.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.RetrieveContextsRequest.VertexRagStore.RagResource rag_resources = 3 [(.google.api.field_behavior) = OPTIONAL];

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getVectorDistanceThreshold() (deprecated)

public double getVectorDistanceThreshold()

Deprecated. google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=139

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

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

Returns
Type Description
double

The vectorDistanceThreshold.

hasVectorDistanceThreshold() (deprecated)

public boolean hasVectorDistanceThreshold()

Deprecated. google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=139

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

optional double vector_distance_threshold = 2 [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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RetrieveContextsRequest.VertexRagStore.Builder newBuilderForType()
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RetrieveContextsRequest.VertexRagStore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RetrieveContextsRequest.VertexRagStore.Builder toBuilder()
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException