- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class VertexRagStore.Builder extends GeneratedMessageV3.Builder<VertexRagStore.Builder> implements VertexRagStoreOrBuilder
Retrieve from Vertex RAG Store for grounding.
Protobuf type google.cloud.aiplatform.v1.VertexRagStore
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > VertexRagStore.BuilderImplements
VertexRagStoreOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllRagResources(Iterable<? extends VertexRagStore.RagResource> values)
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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.aiplatform.v1.VertexRagStore.RagResource> |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
addRagResources(VertexRagStore.RagResource value)
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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
VertexRagStore.RagResource |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
addRagResources(VertexRagStore.RagResource.Builder builderForValue)
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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
VertexRagStore.RagResource.Builder |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
addRagResources(int index, VertexRagStore.RagResource value)
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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
VertexRagStore.RagResource |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
addRagResources(int index, VertexRagStore.RagResource.Builder builderForValue)
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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
VertexRagStore.RagResource.Builder |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
addRagResourcesBuilder()
public 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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
VertexRagStore.RagResource.Builder |
addRagResourcesBuilder(int index)
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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
VertexRagStore.RagResource.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public VertexRagStore.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
build()
public VertexRagStore build()
Returns | |
---|---|
Type | Description |
VertexRagStore |
buildPartial()
public VertexRagStore buildPartial()
Returns | |
---|---|
Type | Description |
VertexRagStore |
clear()
public VertexRagStore.Builder clear()
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
clearField(Descriptors.FieldDescriptor field)
public VertexRagStore.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public VertexRagStore.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
clearRagResources()
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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
clearRagRetrievalConfig()
public VertexRagStore.Builder clearRagRetrievalConfig()
Optional. The retrieval config for the Rag query.
.google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
clearSimilarityTopK() (deprecated)
public VertexRagStore.Builder clearSimilarityTopK()
Deprecated. google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=173
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 |
VertexRagStore.Builder |
This builder for chaining. |
clearVectorDistanceThreshold() (deprecated)
public VertexRagStore.Builder clearVectorDistanceThreshold()
Deprecated. google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=178
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 |
VertexRagStore.Builder |
This builder for chaining. |
clone()
public VertexRagStore.Builder clone()
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
getDefaultInstanceForType()
public VertexRagStore getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
VertexRagStore |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getRagResources(int index)
public 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];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
VertexRagStore.RagResource |
getRagResourcesBuilder(int index)
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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
VertexRagStore.RagResource.Builder |
getRagResourcesBuilderList()
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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Builder> |
getRagResourcesCount()
public 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];
Returns | |
---|---|
Type | Description |
int |
getRagResourcesList()
public 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];
Returns | |
---|---|
Type | Description |
List<RagResource> |
getRagResourcesOrBuilder(int index)
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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
VertexRagStore.RagResourceOrBuilder |
getRagResourcesOrBuilderList()
public 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];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.aiplatform.v1.VertexRagStore.RagResourceOrBuilder> |
getRagRetrievalConfig()
public 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 | |
---|---|
Type | Description |
RagRetrievalConfig |
The ragRetrievalConfig. |
getRagRetrievalConfigBuilder()
public RagRetrievalConfig.Builder getRagRetrievalConfigBuilder()
Optional. The retrieval config for the Rag query.
.google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
RagRetrievalConfig.Builder |
getRagRetrievalConfigOrBuilder()
public RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder()
Optional. The retrieval config for the Rag query.
.google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
RagRetrievalConfigOrBuilder |
getSimilarityTopK() (deprecated)
public int getSimilarityTopK()
Deprecated. google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=173
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 double getVectorDistanceThreshold()
Deprecated. google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=178
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 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 | |
---|---|
Type | Description |
boolean |
Whether the ragRetrievalConfig field is set. |
hasSimilarityTopK() (deprecated)
public boolean hasSimilarityTopK()
Deprecated. google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=173
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 boolean hasVectorDistanceThreshold()
Deprecated. google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=178
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(VertexRagStore other)
public VertexRagStore.Builder mergeFrom(VertexRagStore other)
Parameter | |
---|---|
Name | Description |
other |
VertexRagStore |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public VertexRagStore.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public VertexRagStore.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
mergeRagRetrievalConfig(RagRetrievalConfig value)
public VertexRagStore.Builder mergeRagRetrievalConfig(RagRetrievalConfig value)
Optional. The retrieval config for the Rag query.
.google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
RagRetrievalConfig |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final VertexRagStore.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
removeRagResources(int index)
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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public VertexRagStore.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
setRagResources(int index, VertexRagStore.RagResource value)
public 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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
VertexRagStore.RagResource |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
setRagResources(int index, VertexRagStore.RagResource.Builder builderForValue)
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.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
VertexRagStore.RagResource.Builder |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
setRagRetrievalConfig(RagRetrievalConfig value)
public VertexRagStore.Builder setRagRetrievalConfig(RagRetrievalConfig value)
Optional. The retrieval config for the Rag query.
.google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
RagRetrievalConfig |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
setRagRetrievalConfig(RagRetrievalConfig.Builder builderForValue)
public VertexRagStore.Builder setRagRetrievalConfig(RagRetrievalConfig.Builder builderForValue)
Optional. The retrieval config for the Rag query.
.google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
RagRetrievalConfig.Builder |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public VertexRagStore.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
setSimilarityTopK(int value) (deprecated)
public VertexRagStore.Builder setSimilarityTopK(int value)
Deprecated. google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=173
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];
Parameter | |
---|---|
Name | Description |
value |
int The similarityTopK to set. |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final VertexRagStore.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
setVectorDistanceThreshold(double value) (deprecated)
public VertexRagStore.Builder setVectorDistanceThreshold(double value)
Deprecated. google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=178
Optional. Only return results with vector distance smaller than the threshold.
optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
double The vectorDistanceThreshold to set. |
Returns | |
---|---|
Type | Description |
VertexRagStore.Builder |
This builder for chaining. |