Interface VertexRagStoreOrBuilder (3.56.0) 

public interface VertexRagStoreOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getRagCorpora(int index) (deprecated)

public abstract String getRagCorpora(int index)

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

Optional. Deprecated. Please use rag_resources instead.

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

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 abstract ByteString getRagCorporaBytes(int index)

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

Optional. Deprecated. Please use rag_resources instead.

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

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 abstract int getRagCorporaCount()

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

Optional. Deprecated. Please use rag_resources instead.

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

Returns
Type Description
int

The count of ragCorpora.

getRagCorporaList() (deprecated)

public abstract List<String> getRagCorporaList()

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

Optional. Deprecated. Please use rag_resources instead.

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

Returns
Type Description
List<String>

A list containing the ragCorpora.

getRagResources(int index)

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

Parameter
Name Description
index int
Returns
Type Description
VertexRagStore.RagResource

getRagResourcesCount()

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

Returns
Type Description
int

getRagResourcesList()

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

Returns
Type Description
List<RagResource>

getRagResourcesOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
VertexRagStore.RagResourceOrBuilder

getRagResourcesOrBuilderList()

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

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

getRagRetrievalConfig()

public abstract RagRetrievalConfig getRagRetrievalConfig()

Optional. The retrieval config for the Rag query.

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

Returns
Type Description
RagRetrievalConfig

The ragRetrievalConfig.

getRagRetrievalConfigOrBuilder()

public abstract RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder()

Optional. The retrieval config for the Rag query.

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

Returns
Type Description
RagRetrievalConfigOrBuilder

getSimilarityTopK() (deprecated)

public abstract int getSimilarityTopK()

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

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 abstract double getVectorDistanceThreshold()

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

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 abstract boolean hasRagRetrievalConfig()

Optional. The retrieval config for the Rag query.

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

Returns
Type Description
boolean

Whether the ragRetrievalConfig field is set.

hasSimilarityTopK() (deprecated)

public abstract boolean hasSimilarityTopK()

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

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 abstract boolean hasVectorDistanceThreshold()

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

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.