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

Class RetrievalPerFilterSearchResult

java.lang.Object

com.sap.ai.sdk.grounding.model.RetrievalPerFilterSearchResult

public class RetrievalPerFilterSearchResult
extends Object

RetrievalPerFilterSearchResult

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RetrievalPerFilterSearchResult	addResultsItem(RetrievalDataRepositorySearchResult resultsItem)	Add one results instance to this RetrievalPerFilterSearchResult.
static RetrievalPerFilterSearchResult.Builder	create()	Create a type-safe, fluent-api builder object to construct a new RetrievalPerFilterSearchResult instance with all required arguments.
boolean	equals(Object o)
RetrievalPerFilterSearchResult	filterId(String filterId)	Set the filterId of this RetrievalPerFilterSearchResult instance and return the same instance.
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the RetrievalPerFilterSearchResult.
String	getFilterId()	Get filterId
String	getRemoteGroundingName()	Friendly Destination Name of remote instance (grounding.name).
List<RetrievalDataRepositorySearchResult>	getResults()	List of returned results.
int	hashCode()
RetrievalPerFilterSearchResult	remoteGroundingName(String remoteGroundingName)	Set the remoteGroundingName of this RetrievalPerFilterSearchResult instance and return the same instance.
RetrievalPerFilterSearchResult	results(List<RetrievalDataRepositorySearchResult> results)	Set the results of this RetrievalPerFilterSearchResult instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this RetrievalPerFilterSearchResult instance.
void	setFilterId(String filterId)	Set the filterId of this RetrievalPerFilterSearchResult instance.
void	setRemoteGroundingName(String remoteGroundingName)	Set the remoteGroundingName of this RetrievalPerFilterSearchResult instance.
void	setResults(List<RetrievalDataRepositorySearchResult> results)	Set the results of this RetrievalPerFilterSearchResult instance.
Map<String,Object>	toMap()	Get the value of all properties of this RetrievalPerFilterSearchResult instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievalPerFilterSearchResult

protected RetrievalPerFilterSearchResult()

Default constructor for RetrievalPerFilterSearchResult.

Method Details

filterId

@Nonnull
public RetrievalPerFilterSearchResult filterId(@Nonnull
 String filterId)

Set the filterId of this RetrievalPerFilterSearchResult instance and return the same instance.

Parameters:

filterId - The filterId of this RetrievalPerFilterSearchResult

Returns:

The same instance of this RetrievalPerFilterSearchResult class

getFilterId

@Nonnull
public String getFilterId()

Get filterId

Returns:

filterId The filterId of this RetrievalPerFilterSearchResult instance.

setFilterId

public void setFilterId(@Nonnull
 String filterId)

Set the filterId of this RetrievalPerFilterSearchResult instance.

Parameters:

filterId - The filterId of this RetrievalPerFilterSearchResult

results

@Nonnull
public RetrievalPerFilterSearchResult results(@Nullable
 List<RetrievalDataRepositorySearchResult> results)

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

Parameters:

results - List of returned results.

Returns:

The same instance of this RetrievalPerFilterSearchResult class

addResultsItem

@Nonnull
public RetrievalPerFilterSearchResult addResultsItem(@Nonnull
 RetrievalDataRepositorySearchResult resultsItem)

Add one results instance to this RetrievalPerFilterSearchResult.

Parameters:

resultsItem - The results that should be added

Returns:

The same instance of type RetrievalPerFilterSearchResult

getResults

@Nonnull
public List<RetrievalDataRepositorySearchResult> getResults()

List of returned results.

Returns:

results The results of this RetrievalPerFilterSearchResult instance.

setResults

public void setResults(@Nullable
 List<RetrievalDataRepositorySearchResult> results)

Set the results of this RetrievalPerFilterSearchResult instance.

Parameters:

results - List of returned results.

remoteGroundingName

@Nonnull
public RetrievalPerFilterSearchResult remoteGroundingName(@Nullable
 String remoteGroundingName)

Set the remoteGroundingName of this RetrievalPerFilterSearchResult instance and return the same instance.

Parameters:

remoteGroundingName - Friendly Destination Name of remote instance (grounding.name). Only present if dataRepositoryType = remote:dg.

Returns:

The same instance of this RetrievalPerFilterSearchResult class

getRemoteGroundingName

@Nullable
public String getRemoteGroundingName()

Friendly Destination Name of remote instance (grounding.name). Only present if dataRepositoryType = remote:dg.

Returns:

remoteGroundingName The remoteGroundingName of this RetrievalPerFilterSearchResult instance.

setRemoteGroundingName

public void setRemoteGroundingName(@Nullable
 String remoteGroundingName)

Set the remoteGroundingName of this RetrievalPerFilterSearchResult instance.

Parameters:

remoteGroundingName - Friendly Destination Name of remote instance (grounding.name). Only present if dataRepositoryType = remote:dg.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RetrievalPerFilterSearchResult.

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

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