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

Class VectorSearchResults

java.lang.Object

com.sap.ai.sdk.grounding.model.VectorSearchResults

public class VectorSearchResults
extends Object

VectorSearchResults

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VectorSearchResults.Builder	Builder helper class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
VectorSearchResults	addResultsItem(VectorPerFilterSearchResult resultsItem)	Add one results instance to this VectorSearchResults.
static VectorSearchResults.Builder	create()	Create a type-safe, fluent-api builder object to construct a new VectorSearchResults 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 VectorSearchResults.
List<VectorPerFilterSearchResult>	getResults()	List of returned results.
int	hashCode()
VectorSearchResults	results(List<VectorPerFilterSearchResult> results)	Set the results of this VectorSearchResults instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this VectorSearchResults instance.
void	setResults(List<VectorPerFilterSearchResult> results)	Set the results of this VectorSearchResults instance.
Map<String,Object>	toMap()	Get the value of all properties of this VectorSearchResults instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

VectorSearchResults

protected VectorSearchResults()

Default constructor for VectorSearchResults.

Method Details

results

@Nonnull
public VectorSearchResults results(@Nonnull
 List<VectorPerFilterSearchResult> results)

Set the results of this VectorSearchResults instance and return the same instance.

Parameters:

results - List of returned results.

Returns:

The same instance of this VectorSearchResults class

addResultsItem

@Nonnull
public VectorSearchResults addResultsItem(@Nonnull
 VectorPerFilterSearchResult resultsItem)

Add one results instance to this VectorSearchResults.

Parameters:

resultsItem - The results that should be added

Returns:

The same instance of type VectorSearchResults

getResults

@Nonnull
public List<VectorPerFilterSearchResult> getResults()

List of returned results.

Returns:

results The results of this VectorSearchResults instance.

setResults

public void setResults(@Nonnull
 List<VectorPerFilterSearchResult> results)

Set the results of this VectorSearchResults instance.

Parameters:

results - List of returned results.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the VectorSearchResults.

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

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