RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder (proto-google-cloud-aiplatform-v1beta1 0.102.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder>
    - - com.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder

All Implemented Interfaces:

RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25OrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25
```
public static final class RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder
extends com.google.protobuf.GeneratedMessage.Builder<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder>
implements RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25OrBuilder
```
```
 Message for BM25 parameters.
 
```
Protobuf type google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25`	`build()`
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25`	`buildPartial()`
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	`clear()`
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	`clearB()` Optional.
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	`clearK1()` Optional.
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	`clearMultilingual()` Optional.
`float`	`getB()` Optional.
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`float`	`getK1()` Optional.
`boolean`	`getMultilingual()` Optional.
`boolean`	`hasB()` Optional.
`boolean`	`hasK1()` Optional.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	`mergeFrom(RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 other)`
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	`setB(float value)` Optional.
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	`setK1(float value)` Optional.
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	`setMultilingual(boolean 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.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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

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

- Method Detail
  - 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<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder>
  - clear
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.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<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.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<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder>
  - getDefaultInstanceForType
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.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<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder>
  - mergeFrom
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder mergeFrom(RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder>
  - mergeFrom
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.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<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder>
    
    Throws:
    
    IOException
  - getMultilingual
```
public boolean getMultilingual()
```
```
 Optional. Use multilingual tokenizer if set to true.
 
```
    bool multilingual = 1 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getMultilingual in interface RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25OrBuilder
    
    Returns:
    
    The multilingual.
  - setMultilingual
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder setMultilingual(boolean value)
```
```
 Optional. Use multilingual tokenizer if set to true.
 
```
    bool multilingual = 1 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The multilingual to set.
    
    Returns:
    
    This builder for chaining.
  - clearMultilingual
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder clearMultilingual()
```
```
 Optional. Use multilingual tokenizer if set to true.
 
```
    bool multilingual = 1 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.
  - hasK1
```
public boolean hasK1()
```
```
 Optional. The parameter to control term frequency saturation. It
 determines the scaling between the matching term frequency and final
 score. k1 is in the range of [1.2, 3]. The default value is 1.2.
 
```
    optional float k1 = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    hasK1 in interface RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25OrBuilder
    
    Returns:
    
    Whether the k1 field is set.
  - getK1
```
public float getK1()
```
```
 Optional. The parameter to control term frequency saturation. It
 determines the scaling between the matching term frequency and final
 score. k1 is in the range of [1.2, 3]. The default value is 1.2.
 
```
    optional float k1 = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getK1 in interface RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25OrBuilder
    
    Returns:
    
    The k1.
  - setK1
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder setK1(float value)
```
```
 Optional. The parameter to control term frequency saturation. It
 determines the scaling between the matching term frequency and final
 score. k1 is in the range of [1.2, 3]. The default value is 1.2.
 
```
    optional float k1 = 2 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The k1 to set.
    
    Returns:
    
    This builder for chaining.
  - clearK1
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder clearK1()
```
```
 Optional. The parameter to control term frequency saturation. It
 determines the scaling between the matching term frequency and final
 score. k1 is in the range of [1.2, 3]. The default value is 1.2.
 
```
    optional float k1 = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.
  - hasB
```
public boolean hasB()
```
```
 Optional. The parameter to control document length normalization. It
 determines how much the document length affects the final score. b is
 in the range of [0, 1]. The default value is 0.75.
 
```
    optional float b = 3 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    hasB in interface RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25OrBuilder
    
    Returns:
    
    Whether the b field is set.
  - getB
```
public float getB()
```
```
 Optional. The parameter to control document length normalization. It
 determines how much the document length affects the final score. b is
 in the range of [0, 1]. The default value is 0.75.
 
```
    optional float b = 3 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getB in interface RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25OrBuilder
    
    Returns:
    
    The b.
  - setB
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder setB(float value)
```
```
 Optional. The parameter to control document length normalization. It
 determines how much the document length affects the final score. b is
 in the range of [0, 1]. The default value is 0.75.
 
```
    optional float b = 3 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The b to set.
    
    Returns:
    
    This builder for chaining.
  - clearB
```
public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder clearB()
```
```
 Optional. The parameter to control document length normalization. It
 determines how much the document length affects the final score. b is
 in the range of [0, 1]. The default value is 0.75.
 
```
    optional float b = 3 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.

Class RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.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

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getMultilingual

setMultilingual

clearMultilingual

hasK1

getK1

setK1

clearK1

hasB

getB

setB

clearB