Class RetrieveContextsRequest.VertexRagStore.Builder (3.53.0)

public static final class RetrieveContextsRequest.VertexRagStore.Builder extends GeneratedMessageV3.Builder<RetrieveContextsRequest.VertexRagStore.Builder> implements RetrieveContextsRequest.VertexRagStoreOrBuilder

The data source for Vertex RagStore.

Protobuf type google.cloud.aiplatform.v1beta1.RetrieveContextsRequest.VertexRagStore

Static Methods

getDescriptor()

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

Methods

addAllRagCorpora(Iterable<String> values) (deprecated)

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

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
values Iterable<String>

The ragCorpora to add.

Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

This builder for chaining.

addAllRagResources(Iterable<? extends RetrieveContextsRequest.VertexRagStore.RagResource> values)

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

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

addRagCorpora(String value) (deprecated)

public RetrieveContextsRequest.VertexRagStore.Builder addRagCorpora(String value)

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

The ragCorpora to add.

Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

This builder for chaining.

addRagCorporaBytes(ByteString value) (deprecated)

public RetrieveContextsRequest.VertexRagStore.Builder addRagCorporaBytes(ByteString value)

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
value ByteString

The bytes of the ragCorpora to add.

Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

This builder for chaining.

addRagResources(RetrieveContextsRequest.VertexRagStore.RagResource value)

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

Parameter
Name Description
value RetrieveContextsRequest.VertexRagStore.RagResource
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

addRagResources(RetrieveContextsRequest.VertexRagStore.RagResource.Builder builderForValue)

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

Parameter
Name Description
builderForValue RetrieveContextsRequest.VertexRagStore.RagResource.Builder
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

addRagResources(int index, RetrieveContextsRequest.VertexRagStore.RagResource value)

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

Parameters
Name Description
index int
value RetrieveContextsRequest.VertexRagStore.RagResource
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

addRagResources(int index, RetrieveContextsRequest.VertexRagStore.RagResource.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue RetrieveContextsRequest.VertexRagStore.RagResource.Builder
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

addRagResourcesBuilder()

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

Returns
Type Description
RetrieveContextsRequest.VertexRagStore.RagResource.Builder

addRagResourcesBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.RagResource.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RetrieveContextsRequest.VertexRagStore.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder
Overrides

build()

public RetrieveContextsRequest.VertexRagStore build()
Returns
Type Description
RetrieveContextsRequest.VertexRagStore

buildPartial()

public RetrieveContextsRequest.VertexRagStore buildPartial()
Returns
Type Description
RetrieveContextsRequest.VertexRagStore

clear()

public RetrieveContextsRequest.VertexRagStore.Builder clear()
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRagCorpora() (deprecated)

public RetrieveContextsRequest.VertexRagStore.Builder clearRagCorpora()

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
RetrieveContextsRequest.VertexRagStore.Builder

This builder for chaining.

clearRagResources()

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

Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

clearVectorDistanceThreshold()

public RetrieveContextsRequest.VertexRagStore.Builder clearVectorDistanceThreshold()

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
RetrieveContextsRequest.VertexRagStore.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public RetrieveContextsRequest.VertexRagStore getDefaultInstanceForType()
Returns
Type Description
RetrieveContextsRequest.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.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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the ragCorpora.

getRagResources(int index)

public 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

getRagResourcesBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.RagResource.Builder

getRagResourcesBuilderList()

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

Returns
Type Description
int

getRagResourcesList()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RetrieveContextsRequest.VertexRagStore other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RetrieveContextsRequest.VertexRagStore.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeRagResources(int index)

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

Parameter
Name Description
index int
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RetrieveContextsRequest.VertexRagStore.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder
Overrides

setRagCorpora(int index, String value) (deprecated)

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

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

Parameters
Name Description
index int

The index to set the value at.

value String

The ragCorpora to set.

Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

This builder for chaining.

setRagResources(int index, RetrieveContextsRequest.VertexRagStore.RagResource value)

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

Parameters
Name Description
index int
value RetrieveContextsRequest.VertexRagStore.RagResource
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

setRagResources(int index, RetrieveContextsRequest.VertexRagStore.RagResource.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue RetrieveContextsRequest.VertexRagStore.RagResource.Builder
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RetrieveContextsRequest.VertexRagStore.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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

setVectorDistanceThreshold(double value)

public RetrieveContextsRequest.VertexRagStore.Builder setVectorDistanceThreshold(double value)

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

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

Parameter
Name Description
value double

The vectorDistanceThreshold to set.

Returns
Type Description
RetrieveContextsRequest.VertexRagStore.Builder

This builder for chaining.