Package com.sap.ai.sdk.grounding.model

Class BoostingScoringConfiguration

java.lang.Object

com.sap.ai.sdk.grounding.model.BoostingScoringConfiguration

public class BoostingScoringConfiguration
extends Object

BoostingScoringConfiguration

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BoostingScoringConfiguration()	Default constructor for BoostingScoringConfiguration.

Method Summary

Modifier and Type	Method	Description
BoostingScoringConfiguration	addMetadataItem(BoostingScoringConfigurationMetadataInner metadataItem)	Add one metadata instance to this BoostingScoringConfiguration.
static BoostingScoringConfiguration	create()	Create a new BoostingScoringConfiguration instance.
BoostingScoringConfiguration	enabled(Boolean enabled)	Set the enabled of this BoostingScoringConfiguration instance and return the same instance.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the BoostingScoringConfiguration.
List<BoostingScoringConfigurationMetadataInner>	getMetadata()	Get metadata
BoostingScoreComputationStrategy	getScoreComputationStrategy()	Get scoreComputationStrategy
Integer	getWeight()	Contribution to final score.
int	hashCode()
Boolean	isEnabled()	Enable metadata-based boosting.
BoostingScoringConfiguration	metadata(List<BoostingScoringConfigurationMetadataInner> metadata)	Set the metadata of this BoostingScoringConfiguration instance and return the same instance.
BoostingScoringConfiguration	scoreComputationStrategy(BoostingScoreComputationStrategy scoreComputationStrategy)	Set the scoreComputationStrategy of this BoostingScoringConfiguration instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this BoostingScoringConfiguration instance.
void	setEnabled(Boolean enabled)	Set the enabled of this BoostingScoringConfiguration instance.
void	setMetadata(List<BoostingScoringConfigurationMetadataInner> metadata)	Set the metadata of this BoostingScoringConfiguration instance.
void	setScoreComputationStrategy(BoostingScoreComputationStrategy scoreComputationStrategy)	Set the scoreComputationStrategy of this BoostingScoringConfiguration instance.
void	setWeight(Integer weight)	Set the weight of this BoostingScoringConfiguration instance.
Map<String,Object>	toMap()	Get the value of all properties of this BoostingScoringConfiguration instance including unrecognized properties.
String	toString()
BoostingScoringConfiguration	weight(Integer weight)	Set the weight of this BoostingScoringConfiguration instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

BoostingScoringConfiguration

protected BoostingScoringConfiguration()

Default constructor for BoostingScoringConfiguration.

Method Details

enabled

@Nonnull
public BoostingScoringConfiguration enabled(@Nullable
 Boolean enabled)

Set the enabled of this BoostingScoringConfiguration instance and return the same instance.

Parameters:

enabled - Enable metadata-based boosting.

Returns:

The same instance of this BoostingScoringConfiguration class

isEnabled

@Nullable
public Boolean isEnabled()

Enable metadata-based boosting.

Returns:

enabled The enabled of this BoostingScoringConfiguration instance.

setEnabled

public void setEnabled(@Nullable
 Boolean enabled)

Set the enabled of this BoostingScoringConfiguration instance.

Parameters:

enabled - Enable metadata-based boosting.

metadata

@Nonnull
public BoostingScoringConfiguration metadata(@Nullable
 List<BoostingScoringConfigurationMetadataInner> metadata)

Set the metadata of this BoostingScoringConfiguration instance and return the same instance.

Parameters:

metadata - The metadata of this BoostingScoringConfiguration

Returns:

The same instance of this BoostingScoringConfiguration class

addMetadataItem

@Nonnull
public BoostingScoringConfiguration addMetadataItem(@Nonnull
 BoostingScoringConfigurationMetadataInner metadataItem)

Add one metadata instance to this BoostingScoringConfiguration.

Parameters:

metadataItem - The metadata that should be added

Returns:

The same instance of type BoostingScoringConfiguration

getMetadata

@Nullable
public List<BoostingScoringConfigurationMetadataInner> getMetadata()

Get metadata

Returns:

metadata The metadata of this BoostingScoringConfiguration instance.

setMetadata

public void setMetadata(@Nullable
 List<BoostingScoringConfigurationMetadataInner> metadata)

Set the metadata of this BoostingScoringConfiguration instance.

Parameters:

metadata - The metadata of this BoostingScoringConfiguration

weight

@Nonnull
public BoostingScoringConfiguration weight(@Nullable
 Integer weight)

Set the weight of this BoostingScoringConfiguration instance and return the same instance.

Parameters:

weight - Contribution to final score.

Returns:

The same instance of this BoostingScoringConfiguration class

getWeight

@Nullable
public Integer getWeight()

Contribution to final score.

Returns:

weight The weight of this BoostingScoringConfiguration instance.

setWeight

public void setWeight(@Nullable
 Integer weight)

Set the weight of this BoostingScoringConfiguration instance.

Parameters:

weight - Contribution to final score.

scoreComputationStrategy

@Nonnull
public BoostingScoringConfiguration scoreComputationStrategy(@Nullable
 BoostingScoreComputationStrategy scoreComputationStrategy)

Set the scoreComputationStrategy of this BoostingScoringConfiguration instance and return the same instance.

Parameters:

scoreComputationStrategy - The scoreComputationStrategy of this BoostingScoringConfiguration

Returns:

The same instance of this BoostingScoringConfiguration class

getScoreComputationStrategy

@Nonnull
public BoostingScoreComputationStrategy getScoreComputationStrategy()

Get scoreComputationStrategy

Returns:

scoreComputationStrategy The scoreComputationStrategy of this BoostingScoringConfiguration instance.

setScoreComputationStrategy

public void setScoreComputationStrategy(@Nullable
 BoostingScoreComputationStrategy scoreComputationStrategy)

Set the scoreComputationStrategy of this BoostingScoringConfiguration instance.

Parameters:

scoreComputationStrategy - The scoreComputationStrategy of this BoostingScoringConfiguration

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the BoostingScoringConfiguration.

Returns:

The set of properties names

getCustomField

@Nullable
@Deprecated
public Object getCustomField(@Nonnull
 String name)
                      throws NoSuchElementException

Deprecated.

Use toMap() instead.

Get the value of an unrecognizable property of this BoostingScoringConfiguration instance.

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

NoSuchElementException - If no property with the given name could be found.

toMap

@Nonnull
public Map<String,Object> toMap()

Get the value of all properties of this BoostingScoringConfiguration instance including unrecognized properties.

Returns:

The map of all properties

setCustomField

public void setCustomField(@Nonnull
 String customFieldName,
 @Nullable
 Object customFieldValue)

Set an unrecognizable property of this BoostingScoringConfiguration instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

customFieldName - The name of the property

customFieldValue - The value of the property

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

create

public static BoostingScoringConfiguration create()

Create a new BoostingScoringConfiguration instance. No arguments are required.