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

Class RetrievalSearchResults

java.lang.Object

com.sap.ai.sdk.grounding.model.RetrievalSearchResults

public class RetrievalSearchResults
extends Object

RetrievalSearchResults

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievalSearchResults

protected RetrievalSearchResults()

Default constructor for RetrievalSearchResults.

Method Details

results

@Nonnull
public RetrievalSearchResults results(@Nonnull
 List<ResultsInner1> results)

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

Parameters:

results - List of returned results.

Returns:

The same instance of this RetrievalSearchResults class

addResultsItem

@Nonnull
public RetrievalSearchResults addResultsItem(@Nonnull
 ResultsInner1 resultsItem)

Add one results instance to this RetrievalSearchResults.

Parameters:

resultsItem - The results that should be added

Returns:

The same instance of type RetrievalSearchResults

getResults

@Nonnull
public List<ResultsInner1> getResults()

List of returned results.

Returns:

results The results of this RetrievalSearchResults instance.

setResults

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

Set the results of this RetrievalSearchResults instance.

Parameters:

results - List of returned results.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RetrievalSearchResults.

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

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