Package com.google.cloud.aiplatform.v1

Class RagRetrievalConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<RagRetrievalConfig.Builder>

com.google.cloud.aiplatform.v1.RagRetrievalConfig.Builder

All Implemented Interfaces:

RagRetrievalConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

RagRetrievalConfig

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

 Specifies the context retrieval config.
 

Protobuf type google.cloud.aiplatform.v1.RagRetrievalConfig

Method Summary

Modifier and Type	Method	Description
RagRetrievalConfig	build()
RagRetrievalConfig	buildPartial()
RagRetrievalConfig.Builder	clear()
RagRetrievalConfig.Builder	clearFilter()	Optional.
RagRetrievalConfig.Builder	clearRanking()	Optional.
RagRetrievalConfig.Builder	clearTopK()	Optional.
RagRetrievalConfig	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
RagRetrievalConfig.Filter	getFilter()	Optional.
RagRetrievalConfig.Filter.Builder	getFilterBuilder()	Optional.
RagRetrievalConfig.FilterOrBuilder	getFilterOrBuilder()	Optional.
RagRetrievalConfig.Ranking	getRanking()	Optional.
RagRetrievalConfig.Ranking.Builder	getRankingBuilder()	Optional.
RagRetrievalConfig.RankingOrBuilder	getRankingOrBuilder()	Optional.
int	getTopK()	Optional.
boolean	hasFilter()	Optional.
boolean	hasRanking()	Optional.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
RagRetrievalConfig.Builder	mergeFilter(RagRetrievalConfig.Filter value)	Optional.
RagRetrievalConfig.Builder	mergeFrom(RagRetrievalConfig other)
RagRetrievalConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RagRetrievalConfig.Builder	mergeFrom(com.google.protobuf.Message other)
RagRetrievalConfig.Builder	mergeRanking(RagRetrievalConfig.Ranking value)	Optional.
RagRetrievalConfig.Builder	setFilter(RagRetrievalConfig.Filter value)	Optional.
RagRetrievalConfig.Builder	setFilter(RagRetrievalConfig.Filter.Builder builderForValue)	Optional.
RagRetrievalConfig.Builder	setRanking(RagRetrievalConfig.Ranking value)	Optional.
RagRetrievalConfig.Builder	setRanking(RagRetrievalConfig.Ranking.Builder builderForValue)	Optional.
RagRetrievalConfig.Builder	setTopK(int value)	Optional.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RagRetrievalConfig.Builder>

clear

public RagRetrievalConfig.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<RagRetrievalConfig.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<RagRetrievalConfig.Builder>

getDefaultInstanceForType

public RagRetrievalConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RagRetrievalConfig build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RagRetrievalConfig buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public RagRetrievalConfig.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RagRetrievalConfig.Builder>

mergeFrom

public RagRetrievalConfig.Builder mergeFrom(RagRetrievalConfig other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RagRetrievalConfig.Builder>

mergeFrom

public RagRetrievalConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RagRetrievalConfig.Builder>

Throws:

IOException

getTopK

public int getTopK()

 Optional. The number of contexts to retrieve.
 

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

Specified by:

getTopK in interface RagRetrievalConfigOrBuilder

Returns:

The topK.

setTopK

public RagRetrievalConfig.Builder setTopK(int value)

 Optional. The number of contexts to retrieve.
 

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

Parameters:

value - The topK to set.

Returns:

This builder for chaining.

clearTopK

public RagRetrievalConfig.Builder clearTopK()

 Optional. The number of contexts to retrieve.
 

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

Returns:

This builder for chaining.

hasFilter

public boolean hasFilter()

 Optional. Config for filters.
 

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

Specified by:

hasFilter in interface RagRetrievalConfigOrBuilder

Returns:

Whether the filter field is set.

getFilter

public RagRetrievalConfig.Filter getFilter()

 Optional. Config for filters.
 

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

Specified by:

getFilter in interface RagRetrievalConfigOrBuilder

Returns:

The filter.

setFilter

public RagRetrievalConfig.Builder setFilter(RagRetrievalConfig.Filter value)

 Optional. Config for filters.
 

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

setFilter

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

mergeFilter

public RagRetrievalConfig.Builder mergeFilter(RagRetrievalConfig.Filter value)

 Optional. Config for filters.
 

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

clearFilter

public RagRetrievalConfig.Builder clearFilter()

 Optional. Config for filters.
 

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

getFilterBuilder

public RagRetrievalConfig.Filter.Builder getFilterBuilder()

 Optional. Config for filters.
 

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

getFilterOrBuilder

public RagRetrievalConfig.FilterOrBuilder getFilterOrBuilder()

 Optional. Config for filters.
 

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

Specified by:

getFilterOrBuilder in interface RagRetrievalConfigOrBuilder

hasRanking

public boolean hasRanking()

 Optional. Config for ranking and reranking.
 

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

Specified by:

hasRanking in interface RagRetrievalConfigOrBuilder

Returns:

Whether the ranking field is set.

getRanking

public RagRetrievalConfig.Ranking getRanking()

 Optional. Config for ranking and reranking.
 

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

Specified by:

getRanking in interface RagRetrievalConfigOrBuilder

Returns:

The ranking.

setRanking

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

setRanking

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

mergeRanking

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

clearRanking

public RagRetrievalConfig.Builder clearRanking()

 Optional. Config for ranking and reranking.
 

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

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

getRankingOrBuilder

public RagRetrievalConfig.RankingOrBuilder getRankingOrBuilder()

 Optional. Config for ranking and reranking.
 

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

Specified by:

getRankingOrBuilder in interface RagRetrievalConfigOrBuilder