Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class RagRetrievalConfig.Builder (3.77.0)

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

Specifies the context retrieval config.

Protobuf type google.cloud.aiplatform.v1.RagRetrievalConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.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)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

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

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RagRetrievalConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`RagRetrievalConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public RagRetrievalConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`RagRetrievalConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public RagRetrievalConfig.Builder clearFilter()

Optional. Config for filters.

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

Returns
Type	Description
`RagRetrievalConfig.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public RagRetrievalConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`RagRetrievalConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRanking()

public RagRetrievalConfig.Builder clearRanking()

Optional. Config for ranking and reranking.

.google.cloud.aiplatform.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.

clone()

public RagRetrievalConfig.Builder clone()

Returns
Type	Description
`RagRetrievalConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public RagRetrievalConfig getDefaultInstanceForType()

Returns
Type	Description
`RagRetrievalConfig`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public RagRetrievalConfig.Filter getFilter()

Optional. Config for filters.

.google.cloud.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the ranking field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFilter(RagRetrievalConfig.Filter value)

public RagRetrievalConfig.Builder mergeFilter(RagRetrievalConfig.Filter value)

Optional. Config for filters.

.google.cloud.aiplatform.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.aiplatform.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`RagRetrievalConfig.Ranking`

Returns
Type	Description
`RagRetrievalConfig.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RagRetrievalConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RagRetrievalConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public RagRetrievalConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`RagRetrievalConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(RagRetrievalConfig.Filter value)

public RagRetrievalConfig.Builder setFilter(RagRetrievalConfig.Filter value)

Optional. Config for filters.

.google.cloud.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`RagRetrievalConfig.Ranking.Builder`

Returns
Type	Description
`RagRetrievalConfig.Builder`

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`RagRetrievalConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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.

setUnknownFields(UnknownFieldSet unknownFields)

public final RagRetrievalConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RagRetrievalConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)