Class RagRetrievalConfig.Builder (1.43.0)

Version latest

• 1.43.0 (latest)
• 1.42.0
• 1.40.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.30.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class RagRetrievalConfig.Builder extends GeneratedMessage.Builder<RagRetrievalConfig.Builder> implements RagRetrievalConfigOrBuilder

Specifies the context retrieval config.

Protobuf type google.cloud.vertexai.v1.RagRetrievalConfig

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > RagRetrievalConfig.Builder

Implements

RagRetrievalConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public RagRetrievalConfig build()

Returns
Type	Description
RagRetrievalConfig

buildPartial()

public RagRetrievalConfig buildPartial()

Returns
Type	Description
RagRetrievalConfig

clear()

public RagRetrievalConfig.Builder clear()

Returns
Type	Description
RagRetrievalConfig.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearFilter()

public RagRetrievalConfig.Builder clearFilter()

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig.Builder

clearRanking()

public RagRetrievalConfig.Builder clearRanking()

Optional. Config for ranking and reranking.

.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig.Builder

clearTopK()

public RagRetrievalConfig.Builder clearTopK()

Optional. The number of contexts to retrieve.

int32 top_k = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig.Builder	This builder for chaining.

getDefaultInstanceForType()

public RagRetrievalConfig getDefaultInstanceForType()

Returns
Type	Description
RagRetrievalConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getFilter()

public RagRetrievalConfig.Filter getFilter()

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig.Filter	The filter.

getFilterBuilder()

public RagRetrievalConfig.Filter.Builder getFilterBuilder()

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig.Filter.Builder

getFilterOrBuilder()

public RagRetrievalConfig.FilterOrBuilder getFilterOrBuilder()

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig.FilterOrBuilder

getRanking()

public RagRetrievalConfig.Ranking getRanking()

Optional. Config for ranking and reranking.

.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig.Ranking	The ranking.

getRankingBuilder()

public RagRetrievalConfig.Ranking.Builder getRankingBuilder()

Optional. Config for ranking and reranking.

.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig.Ranking.Builder

getRankingOrBuilder()

public RagRetrievalConfig.RankingOrBuilder getRankingOrBuilder()

Optional. Config for ranking and reranking.

.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig.RankingOrBuilder

getTopK()

public int getTopK()

Optional. The number of contexts to retrieve.

int32 top_k = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The topK.

hasFilter()

public boolean hasFilter()

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the filter field is set.

hasRanking()

public boolean hasRanking()

Optional. Config for ranking and reranking.

.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the ranking field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFilter(RagRetrievalConfig.Filter value)

public RagRetrievalConfig.Builder mergeFilter(RagRetrievalConfig.Filter value)

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	RagRetrievalConfig.Filter

Returns
Type	Description
RagRetrievalConfig.Builder

mergeFrom(RagRetrievalConfig other)

public RagRetrievalConfig.Builder mergeFrom(RagRetrievalConfig other)

Parameter
Name	Description
other	RagRetrievalConfig

Returns
Type	Description
RagRetrievalConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagRetrievalConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RagRetrievalConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public RagRetrievalConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
RagRetrievalConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeRanking(RagRetrievalConfig.Ranking value)

public RagRetrievalConfig.Builder mergeRanking(RagRetrievalConfig.Ranking value)

Optional. Config for ranking and reranking.

.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	RagRetrievalConfig.Ranking

Returns
Type	Description
RagRetrievalConfig.Builder

setFilter(RagRetrievalConfig.Filter value)

public RagRetrievalConfig.Builder setFilter(RagRetrievalConfig.Filter value)

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	RagRetrievalConfig.Filter

Returns
Type	Description
RagRetrievalConfig.Builder

setFilter(RagRetrievalConfig.Filter.Builder builderForValue)

public RagRetrievalConfig.Builder setFilter(RagRetrievalConfig.Filter.Builder builderForValue)

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	RagRetrievalConfig.Filter.Builder

Returns
Type	Description
RagRetrievalConfig.Builder

setRanking(RagRetrievalConfig.Ranking value)

public RagRetrievalConfig.Builder setRanking(RagRetrievalConfig.Ranking value)

Optional. Config for ranking and reranking.

.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	RagRetrievalConfig.Ranking

Returns
Type	Description
RagRetrievalConfig.Builder

setRanking(RagRetrievalConfig.Ranking.Builder builderForValue)

public RagRetrievalConfig.Builder setRanking(RagRetrievalConfig.Ranking.Builder builderForValue)

Optional. Config for ranking and reranking.

.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	RagRetrievalConfig.Ranking.Builder

Returns
Type	Description
RagRetrievalConfig.Builder

setTopK(int value)

public RagRetrievalConfig.Builder setTopK(int value)

Optional. The number of contexts to retrieve.

int32 top_k = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The topK to set.

Returns
Type	Description
RagRetrievalConfig.Builder	This builder for chaining.