RagRetrievalConfig.Builder (proto-google-cloud-vertexai-v1 1.22.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Builder>
    - - com.google.cloud.vertexai.api.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.GeneratedMessageV3.Builder<RagRetrievalConfig.Builder>
implements RagRetrievalConfigOrBuilder
```
```
 Specifies the context retrieval config.
 
```
Protobuf type google.cloud.vertexai.v1.RagRetrievalConfig

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RagRetrievalConfig.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`RagRetrievalConfig`	`build()`
`RagRetrievalConfig`	`buildPartial()`
`RagRetrievalConfig.Builder`	`clear()`
`RagRetrievalConfig.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`RagRetrievalConfig.Builder`	`clearFilter()` Optional.
`RagRetrievalConfig.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`RagRetrievalConfig.Builder`	`clearRanking()` Optional.
`RagRetrievalConfig.Builder`	`clearTopK()` Optional.
`RagRetrievalConfig.Builder`	`clone()`
`RagRetrievalConfig`	`getDefaultInstanceForType()`
`static 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.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`RagRetrievalConfig.Builder`	`mergeFilter(RagRetrievalConfig.Filter value)` Optional.
`RagRetrievalConfig.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`RagRetrievalConfig.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`RagRetrievalConfig.Builder`	`mergeFrom(RagRetrievalConfig other)`
`RagRetrievalConfig.Builder`	`mergeRanking(RagRetrievalConfig.Ranking value)` Optional.
`RagRetrievalConfig.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`RagRetrievalConfig.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`RagRetrievalConfig.Builder`	`setFilter(RagRetrievalConfig.Filter.Builder builderForValue)` Optional.
`RagRetrievalConfig.Builder`	`setFilter(RagRetrievalConfig.Filter value)` Optional.
`RagRetrievalConfig.Builder`	`setRanking(RagRetrievalConfig.Ranking.Builder builderForValue)` Optional.
`RagRetrievalConfig.Builder`	`setRanking(RagRetrievalConfig.Ranking value)` Optional.
`RagRetrievalConfig.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`RagRetrievalConfig.Builder`	`setTopK(int value)` Optional.
`RagRetrievalConfig.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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
  - clone
```
public RagRetrievalConfig.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Builder>
  - setField
```
public RagRetrievalConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Builder>
  - clearField
```
public RagRetrievalConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Builder>
  - clearOneof
```
public RagRetrievalConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Builder>
  - setRepeatedField
```
public RagRetrievalConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   int index,
                                                   Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Builder>
  - addRepeatedField
```
public RagRetrievalConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.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.GeneratedMessageV3.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.vertexai.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.vertexai.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.vertexai.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.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];
  - mergeFilter
```
public RagRetrievalConfig.Builder mergeFilter(RagRetrievalConfig.Filter value)
```
```
 Optional. Config for filters.
 
```
    .google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];
  - clearFilter
```
public RagRetrievalConfig.Builder clearFilter()
```
```
 Optional. Config for filters.
 
```
    .google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];
  - getFilterBuilder
```
public RagRetrievalConfig.Filter.Builder getFilterBuilder()
```
```
 Optional. Config for filters.
 
```
    .google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];
  - getFilterOrBuilder
```
public RagRetrievalConfig.FilterOrBuilder getFilterOrBuilder()
```
```
 Optional. Config for filters.
 
```
    .google.cloud.vertexai.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.vertexai.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.vertexai.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.vertexai.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.vertexai.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.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];
  - clearRanking
```
public RagRetrievalConfig.Builder clearRanking()
```
```
 Optional. Config for ranking and reranking.
 
```
    .google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];
  - 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];
  - getRankingOrBuilder
```
public RagRetrievalConfig.RankingOrBuilder getRankingOrBuilder()
```
```
 Optional. Config for ranking and reranking.
 
```
    .google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getRankingOrBuilder in interface RagRetrievalConfigOrBuilder
  - setUnknownFields
```
public final RagRetrievalConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Builder>
  - mergeUnknownFields
```
public final RagRetrievalConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Builder>

Class RagRetrievalConfig.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getTopK

setTopK

clearTopK

hasFilter

getFilter

setFilter

setFilter

mergeFilter

clearFilter

getFilterBuilder

getFilterOrBuilder

hasRanking

getRanking

setRanking

setRanking

mergeRanking

clearRanking

getRankingBuilder

getRankingOrBuilder

setUnknownFields

mergeUnknownFields