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

Class KeyWordRetrievalScoringConfiguration

java.lang.Object

com.sap.ai.sdk.grounding.model.KeyWordRetrievalScoringConfiguration

public class KeyWordRetrievalScoringConfiguration
extends Object

KeyWordRetrievalScoringConfiguration

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static KeyWordRetrievalScoringConfiguration	create()	Create a new KeyWordRetrievalScoringConfiguration instance.
KeyWordRetrievalScoringConfiguration	enabled(Boolean enabled)	Set the enabled of this KeyWordRetrievalScoringConfiguration instance and return the same instance.
boolean	equals(Object o)
KeyWordRetrievalScoringConfiguration	extractKeyWordsFromQuery(Boolean extractKeyWordsFromQuery)	Set the extractKeyWordsFromQuery of this KeyWordRetrievalScoringConfiguration instance and return the same instance.
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the KeyWordRetrievalScoringConfiguration.
Integer	getWeight()	Contribution to final score.
int	hashCode()
Boolean	isEnabled()	Enable dense retrieval.
Boolean	isExtractKeyWordsFromQuery()	Extract Keywords from Query.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this KeyWordRetrievalScoringConfiguration instance.
void	setEnabled(Boolean enabled)	Set the enabled of this KeyWordRetrievalScoringConfiguration instance.
void	setExtractKeyWordsFromQuery(Boolean extractKeyWordsFromQuery)	Set the extractKeyWordsFromQuery of this KeyWordRetrievalScoringConfiguration instance.
void	setWeight(Integer weight)	Set the weight of this KeyWordRetrievalScoringConfiguration instance.
Map<String,Object>	toMap()	Get the value of all properties of this KeyWordRetrievalScoringConfiguration instance including unrecognized properties.
String	toString()
KeyWordRetrievalScoringConfiguration	weight(Integer weight)	Set the weight of this KeyWordRetrievalScoringConfiguration instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

KeyWordRetrievalScoringConfiguration

protected KeyWordRetrievalScoringConfiguration()

Default constructor for KeyWordRetrievalScoringConfiguration.

Method Details

enabled

@Nonnull
public KeyWordRetrievalScoringConfiguration enabled(@Nullable
 Boolean enabled)

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

Parameters:

enabled - Enable dense retrieval.

Returns:

The same instance of this KeyWordRetrievalScoringConfiguration class

isEnabled

@Nullable
public Boolean isEnabled()

Enable dense retrieval.

Returns:

enabled The enabled of this KeyWordRetrievalScoringConfiguration instance.

setEnabled

public void setEnabled(@Nullable
 Boolean enabled)

Set the enabled of this KeyWordRetrievalScoringConfiguration instance.

Parameters:

enabled - Enable dense retrieval.

weight

@Nonnull
public KeyWordRetrievalScoringConfiguration weight(@Nullable
 Integer weight)

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

Parameters:

weight - Contribution to final score.

Returns:

The same instance of this KeyWordRetrievalScoringConfiguration class

getWeight

@Nullable
public Integer getWeight()

Contribution to final score.

Returns:

weight The weight of this KeyWordRetrievalScoringConfiguration instance.

setWeight

public void setWeight(@Nullable
 Integer weight)

Set the weight of this KeyWordRetrievalScoringConfiguration instance.

Parameters:

weight - Contribution to final score.

extractKeyWordsFromQuery

@Nonnull
public KeyWordRetrievalScoringConfiguration extractKeyWordsFromQuery(@Nullable
 Boolean extractKeyWordsFromQuery)

Set the extractKeyWordsFromQuery of this KeyWordRetrievalScoringConfiguration instance and return the same instance.

Parameters:

extractKeyWordsFromQuery - Extract Keywords from Query.

Returns:

The same instance of this KeyWordRetrievalScoringConfiguration class

isExtractKeyWordsFromQuery

@Nullable
public Boolean isExtractKeyWordsFromQuery()

Extract Keywords from Query.

Returns:

extractKeyWordsFromQuery The extractKeyWordsFromQuery of this KeyWordRetrievalScoringConfiguration instance.

setExtractKeyWordsFromQuery

public void setExtractKeyWordsFromQuery(@Nullable
 Boolean extractKeyWordsFromQuery)

Set the extractKeyWordsFromQuery of this KeyWordRetrievalScoringConfiguration instance.

Parameters:

extractKeyWordsFromQuery - Extract Keywords from Query.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the KeyWordRetrievalScoringConfiguration.

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

Create a new KeyWordRetrievalScoringConfiguration instance. No arguments are required.