Interface RetrieveContextsRequest.VertexRagStoreOrBuilder (3.54.0)

public static interface RetrieveContextsRequest.VertexRagStoreOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getRagCorpora(int index) (deprecated)

public abstract 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=97

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 abstract 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=97

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

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

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 abstract List<String> getRagCorporaList()

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

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
List<String>

A list containing the ragCorpora.

getRagResources(int index)

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

Returns
Type Description
int

getRagResourcesList()

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

getVectorDistanceThreshold()

public abstract double getVectorDistanceThreshold()

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

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

Returns
Type Description
double

The vectorDistanceThreshold.

hasVectorDistanceThreshold()

public abstract boolean hasVectorDistanceThreshold()

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

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

Returns
Type Description
boolean

Whether the vectorDistanceThreshold field is set.