Package com.google.cloud.aiplatform.v1beta1

Class RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.aiplatform.v1beta1.RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25

All Implemented Interfaces:

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

Enclosing class:

RagEmbeddingModelConfig.SparseEmbeddingConfig

public static final class RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25
extends com.google.protobuf.GeneratedMessage
implements RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25OrBuilder

 Message for BM25 parameters.
 

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder	Message for BM25 parameters.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	B_FIELD_NUMBER
static final int	K1_FIELD_NUMBER
static final int	MULTILINGUAL_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
float	getB()	Optional.
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	getDefaultInstance()
RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
float	getK1()	Optional.
boolean	getMultilingual()	Optional.
com.google.protobuf.Parser<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25>	getParserForType()
int	getSerializedSize()
boolean	hasB()	Optional.
int	hashCode()
boolean	hasK1()	Optional.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder	newBuilder()
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder	newBuilder(RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 prototype)
RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder	newBuilderForType()
protected RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	parseDelimitedFrom(InputStream input)
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	parseFrom(byte[] data)
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	parseFrom(com.google.protobuf.ByteString data)
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	parseFrom(com.google.protobuf.CodedInputStream input)
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	parseFrom(InputStream input)
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	parseFrom(ByteBuffer data)
static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25>	parser()
RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

MULTILINGUAL_FIELD_NUMBER

public static final int MULTILINGUAL_FIELD_NUMBER

See Also:

• Constant Field Values

K1_FIELD_NUMBER

public static final int K1_FIELD_NUMBER

See Also:

• Constant Field Values

B_FIELD_NUMBER

public static final int B_FIELD_NUMBER

See Also:

• Constant Field Values

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

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 parseFrom(ByteBuffer data)
                                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 parseFrom(com.google.protobuf.ByteString data)
                                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 parseFrom(byte[] data)
                                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 parseFrom(InputStream input)
                                                                    throws IOException

Throws:

IOException

parseFrom

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 parseDelimitedFrom(InputStream input)
                                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                             throws IOException

Throws:

IOException

parseFrom

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 parseFrom(com.google.protobuf.CodedInputStream input)
                                                                    throws IOException

Throws:

IOException

parseFrom

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                    throws IOException

Throws:

IOException

newBuilderForType

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder newBuilder()

newBuilder

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder newBuilder(RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 prototype)

toBuilder

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 getDefaultInstance()

parser

public static com.google.protobuf.Parser<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25> parser()

getParserForType

public com.google.protobuf.Parser<RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public RagEmbeddingModelConfig.SparseEmbeddingConfig.Bm25 getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder