com.google.cloud.aiplatform.v1

Interface VertexRagStoreOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

VertexRagStore, VertexRagStore.Builder

public interface VertexRagStoreOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
RagRetrievalConfig	getRagRetrievalConfig() Optional.
RagRetrievalConfigOrBuilder	getRagRetrievalConfigOrBuilder() Optional.
int	getSimilarityTopK() Deprecated. google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=250
double	getVectorDistanceThreshold() Deprecated. google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=255
boolean	hasRagRetrievalConfig() Optional.
boolean	hasSimilarityTopK() Deprecated. google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=250
boolean	hasVectorDistanceThreshold() Deprecated. google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=255

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getRagResourcesList

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];

getRagResources

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];

getRagResourcesCount

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];

getRagResourcesOrBuilderList

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];

getRagResourcesOrBuilder

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];

hasSimilarityTopK

@Deprecated
boolean hasSimilarityTopK()

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

 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:

Whether the similarityTopK field is set.

getSimilarityTopK

@Deprecated
int getSimilarityTopK()

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

 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:

The similarityTopK.

hasVectorDistanceThreshold

@Deprecated
boolean hasVectorDistanceThreshold()

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

 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:

Whether the vectorDistanceThreshold field is set.

getVectorDistanceThreshold

@Deprecated
double getVectorDistanceThreshold()

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

 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:

The vectorDistanceThreshold.

hasRagRetrievalConfig

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:

Whether the ragRetrievalConfig field is set.

getRagRetrievalConfig

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:

The ragRetrievalConfig.

getRagRetrievalConfigOrBuilder

RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder()

 Optional. The retrieval config for the Rag query.
 

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