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

Class DenseRetrievalScoringConfiguration

java.lang.Object

com.sap.ai.sdk.grounding.model.DenseRetrievalScoringConfiguration

public class DenseRetrievalScoringConfiguration
extends Object

DenseRetrievalScoringConfiguration

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static DenseRetrievalScoringConfiguration	create()	Create a new DenseRetrievalScoringConfiguration instance.
DenseRetrievalScoringConfiguration	enabled(Boolean enabled)	Set the enabled of this DenseRetrievalScoringConfiguration 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 DenseRetrievalScoringConfiguration.
Integer	getWeight()	Contribution to final score.
int	hashCode()
Boolean	isEnabled()	Enable dense retrieval.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this DenseRetrievalScoringConfiguration instance.
void	setEnabled(Boolean enabled)	Set the enabled of this DenseRetrievalScoringConfiguration instance.
void	setWeight(Integer weight)	Set the weight of this DenseRetrievalScoringConfiguration instance.
Map<String,Object>	toMap()	Get the value of all properties of this DenseRetrievalScoringConfiguration instance including unrecognized properties.
String	toString()
DenseRetrievalScoringConfiguration	weight(Integer weight)	Set the weight of this DenseRetrievalScoringConfiguration instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

DenseRetrievalScoringConfiguration

protected DenseRetrievalScoringConfiguration()

Default constructor for DenseRetrievalScoringConfiguration.

Method Details

enabled

@Nonnull
public DenseRetrievalScoringConfiguration enabled(@Nullable
 Boolean enabled)

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

Parameters:

enabled - Enable dense retrieval.

Returns:

The same instance of this DenseRetrievalScoringConfiguration class

isEnabled

@Nullable
public Boolean isEnabled()

Enable dense retrieval.

Returns:

enabled The enabled of this DenseRetrievalScoringConfiguration instance.

setEnabled

public void setEnabled(@Nullable
 Boolean enabled)

Set the enabled of this DenseRetrievalScoringConfiguration instance.

Parameters:

enabled - Enable dense retrieval.

weight

@Nonnull
public DenseRetrievalScoringConfiguration weight(@Nullable
 Integer weight)

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

Parameters:

weight - Contribution to final score.

Returns:

The same instance of this DenseRetrievalScoringConfiguration class

getWeight

@Nullable
public Integer getWeight()

Contribution to final score.

Returns:

weight The weight of this DenseRetrievalScoringConfiguration instance.

setWeight

public void setWeight(@Nullable
 Integer weight)

Set the weight of this DenseRetrievalScoringConfiguration instance.

Parameters:

weight - Contribution to final score.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DenseRetrievalScoringConfiguration.

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 DenseRetrievalScoringConfiguration 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 DenseRetrievalScoringConfiguration 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 DenseRetrievalScoringConfiguration 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 DenseRetrievalScoringConfiguration create()

Create a new DenseRetrievalScoringConfiguration instance. No arguments are required.