com.google.cloud.aiplatform.v1beta1

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
String	getRagCorpora(int index) Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=201
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=201
int	getRagCorporaCount() Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=201
List<String>	getRagCorporaList() Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=201
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	getSimilarityTopK() Optional.
double	getVectorDistanceThreshold() Optional.
boolean	hasSimilarityTopK() Optional.
boolean	hasVectorDistanceThreshold() Optional.

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

getRagCorporaList

@Deprecated
List<String> getRagCorporaList()

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

 Optional. Deprecated. Please use rag_resources instead.
 

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

Returns:

A list containing the ragCorpora.

getRagCorporaCount

@Deprecated
int getRagCorporaCount()

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

 Optional. Deprecated. Please use rag_resources instead.
 

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

Returns:

The count of ragCorpora.

getRagCorpora

@Deprecated
String getRagCorpora(int index)

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

 Optional. Deprecated. Please use rag_resources instead.
 

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

Parameters:

index - The index of the element to return.

Returns:

The ragCorpora at the given index.

getRagCorporaBytes

@Deprecated
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=201

 Optional. Deprecated. Please use rag_resources instead.
 

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

Parameters:

index - The index of the value to return.

Returns:

The bytes of the ragCorpora at the given index.

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

hasSimilarityTopK

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

Returns:

Whether the similarityTopK field is set.

getSimilarityTopK

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

Returns:

The similarityTopK.

hasVectorDistanceThreshold

boolean hasVectorDistanceThreshold()

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

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

Returns:

Whether the vectorDistanceThreshold field is set.

getVectorDistanceThreshold

double getVectorDistanceThreshold()

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

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

Returns:

The vectorDistanceThreshold.