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

Class VectorKeyValueListPair

java.lang.Object

com.sap.ai.sdk.grounding.model.VectorKeyValueListPair

public class VectorKeyValueListPair
extends Object

Collection metadata during ingestion

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

VectorKeyValueListPair

protected VectorKeyValueListPair()

Default constructor for VectorKeyValueListPair.

Method Details

key

@Nonnull
public VectorKeyValueListPair key(@Nonnull
 String key)

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

Parameters:

key - The key of this VectorKeyValueListPair

Returns:

The same instance of this VectorKeyValueListPair class

getKey

@Nonnull
public String getKey()

Get key

Returns:

key The key of this VectorKeyValueListPair instance.

setKey

public void setKey(@Nonnull
 String key)

Set the key of this VectorKeyValueListPair instance.

Parameters:

key - The key of this VectorKeyValueListPair

value

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

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

Parameters:

value - The value of this VectorKeyValueListPair

Returns:

The same instance of this VectorKeyValueListPair class

addValueItem

@Nonnull
public VectorKeyValueListPair addValueItem(@Nonnull
 String valueItem)

Add one value instance to this VectorKeyValueListPair.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type VectorKeyValueListPair

getValue

@Nonnull
public List<String> getValue()

Get value

Returns:

value The value of this VectorKeyValueListPair instance.

setValue

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

Set the value of this VectorKeyValueListPair instance.

Parameters:

value - The value of this VectorKeyValueListPair

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the VectorKeyValueListPair.

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

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