Class VertexRagStore.Builder (3.44.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.v1beta1.VertexRagStore

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllRagCorpora(Iterable<String> values) (deprecated)

public VertexRagStore.Builder addAllRagCorpora(Iterable<String> values)

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) = { ... }

Parameter
Name Description
values Iterable<String>

The ragCorpora to add.

Returns
Type Description
VertexRagStore.Builder

This builder for chaining.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1beta1.VertexRagStore.RagResource>
Returns
Type Description
VertexRagStore.Builder

addRagCorpora(String value) (deprecated)

public VertexRagStore.Builder addRagCorpora(String value)

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) = { ... }

Parameter
Name Description
value String

The ragCorpora to add.

Returns
Type Description
VertexRagStore.Builder

This builder for chaining.

addRagCorporaBytes(ByteString value) (deprecated)

public VertexRagStore.Builder addRagCorporaBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes of the ragCorpora to add.

Returns
Type Description
VertexRagStore.Builder

This builder for chaining.

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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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
Overrides

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
Overrides

clearField(Descriptors.FieldDescriptor field)

public VertexRagStore.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
VertexRagStore.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public VertexRagStore.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
VertexRagStore.Builder
Overrides

clearRagCorpora() (deprecated)

public VertexRagStore.Builder clearRagCorpora()

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
Type Description
VertexRagStore.Builder

This builder for chaining.

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

Returns
Type Description
VertexRagStore.Builder

clearSimilarityTopK()

public VertexRagStore.Builder clearSimilarityTopK()

Optional. Number of top k results to return from the selected corpora.

optional int32 similarity_top_k = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VertexRagStore.Builder

This builder for chaining.

clearVectorDistanceThreshold()

public VertexRagStore.Builder clearVectorDistanceThreshold()

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

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

Returns
Type Description
VertexRagStore.Builder

This builder for chaining.

clone()

public VertexRagStore.Builder clone()
Returns
Type Description
VertexRagStore.Builder
Overrides

getDefaultInstanceForType()

public VertexRagStore getDefaultInstanceForType()
Returns
Type Description
VertexRagStore

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getRagCorpora(int index) (deprecated)

public 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) = { ... }

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 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) = { ... }

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 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
Type Description
int

The count of ragCorpora.

getRagCorporaList() (deprecated)

public ProtocolStringList 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
Type Description
ProtocolStringList

A list containing the ragCorpora.

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

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

getSimilarityTopK()

public 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
Type Description
int

The similarityTopK.

getVectorDistanceThreshold()

public 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
Type Description
double

The vectorDistanceThreshold.

hasSimilarityTopK()

public 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
Type Description
boolean

Whether the similarityTopK field is set.

hasVectorDistanceThreshold()

public 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
Type Description
boolean

Whether the vectorDistanceThreshold field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public VertexRagStore.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
VertexRagStore.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VertexRagStore.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VertexRagStore.Builder
Overrides

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.v1beta1.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
Overrides

setRagCorpora(int index, String value) (deprecated)

public VertexRagStore.Builder setRagCorpora(int index, String value)

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
Name Description
index int

The index to set the value at.

value String

The ragCorpora to set.

Returns
Type Description
VertexRagStore.Builder

This builder for chaining.

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

Parameters
Name Description
index int
builderForValue VertexRagStore.RagResource.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
Overrides

setSimilarityTopK(int value)

public VertexRagStore.Builder setSimilarityTopK(int value)

Optional. Number of top k results to return from the selected corpora.

optional int32 similarity_top_k = 2 [(.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
Overrides

setVectorDistanceThreshold(double value)

public VertexRagStore.Builder setVectorDistanceThreshold(double value)

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

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

Parameter
Name Description
value double

The vectorDistanceThreshold to set.

Returns
Type Description
VertexRagStore.Builder

This builder for chaining.