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

Class VectorSearchDocumentKeyValueListPair

java.lang.Object

com.sap.ai.sdk.grounding.model.VectorSearchDocumentKeyValueListPair

public class VectorSearchDocumentKeyValueListPair
extends Object

VectorSearchDocumentKeyValueListPair

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VectorSearchDocumentKeyValueListPair.Builder	Builder helper class.
static interface	VectorSearchDocumentKeyValueListPair.Builder1	Builder helper class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
VectorSearchDocumentKeyValueListPair	addSelectModeItem(VectorSearchSelectOptionEnum selectModeItem)	Add one selectMode instance to this VectorSearchDocumentKeyValueListPair.
VectorSearchDocumentKeyValueListPair	addValueItem(String valueItem)	Add one value instance to this VectorSearchDocumentKeyValueListPair.
static VectorSearchDocumentKeyValueListPair.Builder	create()	Create a type-safe, fluent-api builder object to construct a new VectorSearchDocumentKeyValueListPair instance with all required arguments.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the VectorSearchDocumentKeyValueListPair.
String	getKey()	Get key
List<VectorSearchSelectOptionEnum>	getSelectMode()	Select mode for search filters
List<String>	getValue()	Get value
int	hashCode()
VectorSearchDocumentKeyValueListPair	key(String key)	Set the key of this VectorSearchDocumentKeyValueListPair instance and return the same instance.
VectorSearchDocumentKeyValueListPair	selectMode(List<VectorSearchSelectOptionEnum> selectMode)	Set the selectMode of this VectorSearchDocumentKeyValueListPair instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this VectorSearchDocumentKeyValueListPair instance.
void	setKey(String key)	Set the key of this VectorSearchDocumentKeyValueListPair instance.
void	setSelectMode(List<VectorSearchSelectOptionEnum> selectMode)	Set the selectMode of this VectorSearchDocumentKeyValueListPair instance.
void	setValue(List<String> value)	Set the value of this VectorSearchDocumentKeyValueListPair instance.
Map<String,Object>	toMap()	Get the value of all properties of this VectorSearchDocumentKeyValueListPair instance including unrecognized properties.
String	toString()
VectorSearchDocumentKeyValueListPair	value(List<String> value)	Set the value of this VectorSearchDocumentKeyValueListPair instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

VectorSearchDocumentKeyValueListPair

protected VectorSearchDocumentKeyValueListPair()

Default constructor for VectorSearchDocumentKeyValueListPair.

Method Details

key

@Nonnull
public VectorSearchDocumentKeyValueListPair key(@Nonnull
 String key)

Set the key of this VectorSearchDocumentKeyValueListPair instance and return the same instance.

Parameters:

key - The key of this VectorSearchDocumentKeyValueListPair

Returns:

The same instance of this VectorSearchDocumentKeyValueListPair class

getKey

@Nonnull
public String getKey()

Get key

Returns:

key The key of this VectorSearchDocumentKeyValueListPair instance.

setKey

public void setKey(@Nonnull
 String key)

Set the key of this VectorSearchDocumentKeyValueListPair instance.

Parameters:

key - The key of this VectorSearchDocumentKeyValueListPair

value

@Nonnull
public VectorSearchDocumentKeyValueListPair value(@Nonnull
 List<String> value)

Set the value of this VectorSearchDocumentKeyValueListPair instance and return the same instance.

Parameters:

value - The value of this VectorSearchDocumentKeyValueListPair

Returns:

The same instance of this VectorSearchDocumentKeyValueListPair class

addValueItem

@Nonnull
public VectorSearchDocumentKeyValueListPair addValueItem(@Nonnull
 String valueItem)

Add one value instance to this VectorSearchDocumentKeyValueListPair.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type VectorSearchDocumentKeyValueListPair

getValue

@Nonnull
public List<String> getValue()

Get value

Returns:

value The value of this VectorSearchDocumentKeyValueListPair instance.

setValue

public void setValue(@Nonnull
 List<String> value)

Set the value of this VectorSearchDocumentKeyValueListPair instance.

Parameters:

value - The value of this VectorSearchDocumentKeyValueListPair

selectMode

@Nonnull
public VectorSearchDocumentKeyValueListPair selectMode(@Nullable
 List<VectorSearchSelectOptionEnum> selectMode)

Set the selectMode of this VectorSearchDocumentKeyValueListPair instance and return the same instance.

Parameters:

selectMode - Select mode for search filters

Returns:

The same instance of this VectorSearchDocumentKeyValueListPair class

addSelectModeItem

@Nonnull
public VectorSearchDocumentKeyValueListPair addSelectModeItem(@Nonnull
 VectorSearchSelectOptionEnum selectModeItem)

Add one selectMode instance to this VectorSearchDocumentKeyValueListPair.

Parameters:

selectModeItem - The selectMode that should be added

Returns:

The same instance of type VectorSearchDocumentKeyValueListPair

getSelectMode

@Nullable
public List<VectorSearchSelectOptionEnum> getSelectMode()

Select mode for search filters

Returns:

selectMode The selectMode of this VectorSearchDocumentKeyValueListPair instance.

setSelectMode

public void setSelectMode(@Nullable
 List<VectorSearchSelectOptionEnum> selectMode)

Set the selectMode of this VectorSearchDocumentKeyValueListPair instance.

Parameters:

selectMode - Select mode for search filters

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the VectorSearchDocumentKeyValueListPair.

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 VectorSearchDocumentKeyValueListPair 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 VectorSearchDocumentKeyValueListPair 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 VectorSearchDocumentKeyValueListPair 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 VectorSearchDocumentKeyValueListPair.Builder create()

Create a type-safe, fluent-api builder object to construct a new VectorSearchDocumentKeyValueListPair instance with all required arguments.