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

Class VectorDocumentKeyValueListPair

java.lang.Object

com.sap.ai.sdk.grounding.model.VectorDocumentKeyValueListPair

public class VectorDocumentKeyValueListPair
extends Object

VectorDocumentKeyValueListPair

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
VectorDocumentKeyValueListPair	addValueItem(String valueItem)	Add one value instance to this VectorDocumentKeyValueListPair.
static VectorDocumentKeyValueListPair.Builder	create()	Create a type-safe, fluent-api builder object to construct a new VectorDocumentKeyValueListPair 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 VectorDocumentKeyValueListPair.
String	getKey()	Get key
FilterMatchModeEnum	getMatchMode()	Get matchMode
List<String>	getValue()	Get value
int	hashCode()
VectorDocumentKeyValueListPair	key(String key)	Set the key of this VectorDocumentKeyValueListPair instance and return the same instance.
VectorDocumentKeyValueListPair	matchMode(FilterMatchModeEnum matchMode)	Set the matchMode of this VectorDocumentKeyValueListPair instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this VectorDocumentKeyValueListPair instance.
void	setKey(String key)	Set the key of this VectorDocumentKeyValueListPair instance.
void	setMatchMode(FilterMatchModeEnum matchMode)	Set the matchMode of this VectorDocumentKeyValueListPair instance.
void	setValue(List<String> value)	Set the value of this VectorDocumentKeyValueListPair instance.
Map<String,Object>	toMap()	Get the value of all properties of this VectorDocumentKeyValueListPair instance including unrecognized properties.
String	toString()
VectorDocumentKeyValueListPair	value(List<String> value)	Set the value of this VectorDocumentKeyValueListPair instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

VectorDocumentKeyValueListPair

protected VectorDocumentKeyValueListPair()

Default constructor for VectorDocumentKeyValueListPair.

Method Details

key

@Nonnull
public VectorDocumentKeyValueListPair key(@Nonnull
 String key)

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

Parameters:

key - The key of this VectorDocumentKeyValueListPair

Returns:

The same instance of this VectorDocumentKeyValueListPair class

getKey

@Nonnull
public String getKey()

Get key

Returns:

key The key of this VectorDocumentKeyValueListPair instance.

setKey

public void setKey(@Nonnull
 String key)

Set the key of this VectorDocumentKeyValueListPair instance.

Parameters:

key - The key of this VectorDocumentKeyValueListPair

value

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

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

Parameters:

value - The value of this VectorDocumentKeyValueListPair

Returns:

The same instance of this VectorDocumentKeyValueListPair class

addValueItem

@Nonnull
public VectorDocumentKeyValueListPair addValueItem(@Nonnull
 String valueItem)

Add one value instance to this VectorDocumentKeyValueListPair.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type VectorDocumentKeyValueListPair

getValue

@Nonnull
public List<String> getValue()

Get value

Returns:

value The value of this VectorDocumentKeyValueListPair instance.

setValue

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

Set the value of this VectorDocumentKeyValueListPair instance.

Parameters:

value - The value of this VectorDocumentKeyValueListPair

matchMode

@Nonnull
public VectorDocumentKeyValueListPair matchMode(@Nullable
 FilterMatchModeEnum matchMode)

Set the matchMode of this VectorDocumentKeyValueListPair instance and return the same instance.

Parameters:

matchMode - The matchMode of this VectorDocumentKeyValueListPair

Returns:

The same instance of this VectorDocumentKeyValueListPair class

getMatchMode

@Nonnull
public FilterMatchModeEnum getMatchMode()

Get matchMode

Returns:

matchMode The matchMode of this VectorDocumentKeyValueListPair instance.

setMatchMode

public void setMatchMode(@Nullable
 FilterMatchModeEnum matchMode)

Set the matchMode of this VectorDocumentKeyValueListPair instance.

Parameters:

matchMode - The matchMode of this VectorDocumentKeyValueListPair

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the VectorDocumentKeyValueListPair.

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

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