public static final class VertexRagStore.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder> implements VertexRagStoreOrBuilder
Retrieve from Vertex RAG Store for grounding.Protobuf type
google.cloud.vertexai.v1.VertexRagStore| Modifier and Type | Method and Description |
|---|---|
VertexRagStore.Builder |
addAllRagResources(Iterable<? extends VertexRagStore.RagResource> values)
Optional.
|
VertexRagStore.Builder |
addRagResources(int index,
VertexRagStore.RagResource.Builder builderForValue)
Optional.
|
VertexRagStore.Builder |
addRagResources(int index,
VertexRagStore.RagResource value)
Optional.
|
VertexRagStore.Builder |
addRagResources(VertexRagStore.RagResource.Builder builderForValue)
Optional.
|
VertexRagStore.Builder |
addRagResources(VertexRagStore.RagResource value)
Optional.
|
VertexRagStore.RagResource.Builder |
addRagResourcesBuilder()
Optional.
|
VertexRagStore.RagResource.Builder |
addRagResourcesBuilder(int index)
Optional.
|
VertexRagStore.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
VertexRagStore |
build() |
VertexRagStore |
buildPartial() |
VertexRagStore.Builder |
clear() |
VertexRagStore.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
VertexRagStore.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
VertexRagStore.Builder |
clearRagResources()
Optional.
|
VertexRagStore.Builder |
clearRagRetrievalConfig()
Optional.
|
VertexRagStore.Builder |
clearSimilarityTopK()
Deprecated.
google.cloud.vertexai.v1.VertexRagStore.similarity_top_k is deprecated. See
google/cloud/vertexai/v1/tool.proto;l=250
|
VertexRagStore.Builder |
clearVectorDistanceThreshold()
Deprecated.
google.cloud.vertexai.v1.VertexRagStore.vector_distance_threshold is deprecated.
See google/cloud/vertexai/v1/tool.proto;l=255
|
VertexRagStore.Builder |
clone() |
VertexRagStore |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
VertexRagStore.RagResource |
getRagResources(int index)
Optional.
|
VertexRagStore.RagResource.Builder |
getRagResourcesBuilder(int index)
Optional.
|
List<VertexRagStore.RagResource.Builder> |
getRagResourcesBuilderList()
Optional.
|
int |
getRagResourcesCount()
Optional.
|
List<VertexRagStore.RagResource> |
getRagResourcesList()
Optional.
|
VertexRagStore.RagResourceOrBuilder |
getRagResourcesOrBuilder(int index)
Optional.
|
List<? extends VertexRagStore.RagResourceOrBuilder> |
getRagResourcesOrBuilderList()
Optional.
|
RagRetrievalConfig |
getRagRetrievalConfig()
Optional.
|
RagRetrievalConfig.Builder |
getRagRetrievalConfigBuilder()
Optional.
|
RagRetrievalConfigOrBuilder |
getRagRetrievalConfigOrBuilder()
Optional.
|
int |
getSimilarityTopK()
Deprecated.
google.cloud.vertexai.v1.VertexRagStore.similarity_top_k is deprecated. See
google/cloud/vertexai/v1/tool.proto;l=250
|
double |
getVectorDistanceThreshold()
Deprecated.
google.cloud.vertexai.v1.VertexRagStore.vector_distance_threshold is deprecated.
See google/cloud/vertexai/v1/tool.proto;l=255
|
boolean |
hasRagRetrievalConfig()
Optional.
|
boolean |
hasSimilarityTopK()
Deprecated.
google.cloud.vertexai.v1.VertexRagStore.similarity_top_k is deprecated. See
google/cloud/vertexai/v1/tool.proto;l=250
|
boolean |
hasVectorDistanceThreshold()
Deprecated.
google.cloud.vertexai.v1.VertexRagStore.vector_distance_threshold is deprecated.
See google/cloud/vertexai/v1/tool.proto;l=255
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
VertexRagStore.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
VertexRagStore.Builder |
mergeFrom(com.google.protobuf.Message other) |
VertexRagStore.Builder |
mergeFrom(VertexRagStore other) |
VertexRagStore.Builder |
mergeRagRetrievalConfig(RagRetrievalConfig value)
Optional.
|
VertexRagStore.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
VertexRagStore.Builder |
removeRagResources(int index)
Optional.
|
VertexRagStore.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
VertexRagStore.Builder |
setRagResources(int index,
VertexRagStore.RagResource.Builder builderForValue)
Optional.
|
VertexRagStore.Builder |
setRagResources(int index,
VertexRagStore.RagResource value)
Optional.
|
VertexRagStore.Builder |
setRagRetrievalConfig(RagRetrievalConfig.Builder builderForValue)
Optional.
|
VertexRagStore.Builder |
setRagRetrievalConfig(RagRetrievalConfig value)
Optional.
|
VertexRagStore.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
VertexRagStore.Builder |
setSimilarityTopK(int value)
Deprecated.
google.cloud.vertexai.v1.VertexRagStore.similarity_top_k is deprecated. See
google/cloud/vertexai/v1/tool.proto;l=250
|
VertexRagStore.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
VertexRagStore.Builder |
setVectorDistanceThreshold(double value)
Deprecated.
google.cloud.vertexai.v1.VertexRagStore.vector_distance_threshold is deprecated.
See google/cloud/vertexai/v1/tool.proto;l=255
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder>public VertexRagStore.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder>public VertexRagStore getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic VertexRagStore build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic VertexRagStore buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic VertexRagStore.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder>public VertexRagStore.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder>public VertexRagStore.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder>public VertexRagStore.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder>public VertexRagStore.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder>public VertexRagStore.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder>public VertexRagStore.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<VertexRagStore.Builder>public VertexRagStore.Builder mergeFrom(VertexRagStore other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder>public VertexRagStore.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<VertexRagStore.Builder>IOExceptionpublic 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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
getRagResourcesList in interface VertexRagStoreOrBuilderpublic 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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
getRagResourcesCount in interface VertexRagStoreOrBuilderpublic 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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
getRagResources in interface VertexRagStoreOrBuilderpublic VertexRagStore.Builder setRagResources(int index, VertexRagStore.RagResource value)
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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.Builder setRagResources(int index, VertexRagStore.RagResource.Builder builderForValue)
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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.Builder addRagResources(VertexRagStore.RagResource value)
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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.Builder addRagResources(int index, VertexRagStore.RagResource value)
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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.Builder addRagResources(VertexRagStore.RagResource.Builder builderForValue)
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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.Builder addRagResources(int index, VertexRagStore.RagResource.Builder builderForValue)
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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.Builder addAllRagResources(Iterable<? extends VertexRagStore.RagResource> values)
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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.Builder clearRagResources()
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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.Builder removeRagResources(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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.RagResource.Builder getRagResourcesBuilder(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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public 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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
getRagResourcesOrBuilder in interface VertexRagStoreOrBuilderpublic 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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
getRagResourcesOrBuilderList in interface VertexRagStoreOrBuilderpublic VertexRagStore.RagResource.Builder addRagResourcesBuilder()
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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.RagResource.Builder addRagResourcesBuilder(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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public List<VertexRagStore.RagResource.Builder> getRagResourcesBuilderList()
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.vertexai.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
@Deprecated public boolean hasSimilarityTopK()
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];
hasSimilarityTopK in interface VertexRagStoreOrBuilder@Deprecated public int getSimilarityTopK()
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];
getSimilarityTopK in interface VertexRagStoreOrBuilder@Deprecated public VertexRagStore.Builder setSimilarityTopK(int value)
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];
value - The similarityTopK to set.@Deprecated public VertexRagStore.Builder clearSimilarityTopK()
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];
@Deprecated public boolean hasVectorDistanceThreshold()
Optional. Only return results with vector distance smaller than the threshold.
optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
hasVectorDistanceThreshold in interface VertexRagStoreOrBuilder@Deprecated public double getVectorDistanceThreshold()
Optional. Only return results with vector distance smaller than the threshold.
optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
getVectorDistanceThreshold in interface VertexRagStoreOrBuilder@Deprecated public VertexRagStore.Builder setVectorDistanceThreshold(double value)
Optional. Only return results with vector distance smaller than the threshold.
optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
value - The vectorDistanceThreshold to set.@Deprecated public VertexRagStore.Builder clearVectorDistanceThreshold()
Optional. Only return results with vector distance smaller than the threshold.
optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
public boolean hasRagRetrievalConfig()
Optional. The retrieval config for the Rag query.
.google.cloud.vertexai.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
hasRagRetrievalConfig in interface VertexRagStoreOrBuilderpublic RagRetrievalConfig getRagRetrievalConfig()
Optional. The retrieval config for the Rag query.
.google.cloud.vertexai.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
getRagRetrievalConfig in interface VertexRagStoreOrBuilderpublic VertexRagStore.Builder setRagRetrievalConfig(RagRetrievalConfig value)
Optional. The retrieval config for the Rag query.
.google.cloud.vertexai.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.Builder setRagRetrievalConfig(RagRetrievalConfig.Builder builderForValue)
Optional. The retrieval config for the Rag query.
.google.cloud.vertexai.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.Builder mergeRagRetrievalConfig(RagRetrievalConfig value)
Optional. The retrieval config for the Rag query.
.google.cloud.vertexai.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore.Builder clearRagRetrievalConfig()
Optional. The retrieval config for the Rag query.
.google.cloud.vertexai.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
public RagRetrievalConfig.Builder getRagRetrievalConfigBuilder()
Optional. The retrieval config for the Rag query.
.google.cloud.vertexai.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
public RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder()
Optional. The retrieval config for the Rag query.
.google.cloud.vertexai.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
getRagRetrievalConfigOrBuilder in interface VertexRagStoreOrBuilderpublic final VertexRagStore.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder>public final VertexRagStore.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<VertexRagStore.Builder>Copyright © 2025 Google LLC. All rights reserved.