Class RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder (3.54.0)

public static final class RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder extends GeneratedMessageV3.Builder<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder> implements RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25OrBuilder

Message for BM25 parameters.

Protobuf type google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder

Implements

RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25OrBuilder

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 RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`

Overrides

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

build()

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 build()

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25`

buildPartial()

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 buildPartial()

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25`

clear()

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder clear()

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`

Overrides

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

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
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	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
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`

Overrides

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

clone()

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder clone()

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

Returns
Type	Description
`float`	The b.

getDefaultInstanceForType()

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 getDefaultInstanceForType()

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Returns
Type	Description
`float`	The k1.

getMultilingual()

public boolean getMultilingual()

Optional. Use multilingual tokenizer if set to true.

bool multilingual = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The multilingual.

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

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

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

Returns
Type	Description
`boolean`	Whether the k1 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()

mergeFrom(RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 other)

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder mergeFrom(RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 other)

Parameter
Name	Description
`other`	`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25`

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`

Overrides

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

setB(float value)

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

Parameter
Name	Description
`value`	`float` The b to set.

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder setField(Descriptors.FieldDescriptor field, Object value)

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

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`

Overrides

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

setK1(float value)

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

Parameter
Name	Description
`value`	`float` The k1 to set.

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	This builder for chaining.

setMultilingual(boolean value)

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder setMultilingual(boolean value)

Optional. Use multilingual tokenizer if set to true.

bool multilingual = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`boolean` The multilingual to set.

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`	This builder for chaining.

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

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder`

Overrides

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