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

Class RetrievalDataRepositorySearchResult

java.lang.Object

com.sap.ai.sdk.grounding.model.RetrievalDataRepositorySearchResult

public class RetrievalDataRepositorySearchResult
extends Object

RetrievalDataRepositorySearchResult

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static RetrievalDataRepositorySearchResult.Builder	create()	Create a type-safe, fluent-api builder object to construct a new RetrievalDataRepositorySearchResult instance with all required arguments.
RetrievalDataRepositorySearchResult	dataRepository(DataRepositoryWithDocuments dataRepository)	Set the dataRepository of this RetrievalDataRepositorySearchResult instance and return the same instance.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the RetrievalDataRepositorySearchResult.
DataRepositoryWithDocuments	getDataRepository()	Get dataRepository
int	hashCode()
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this RetrievalDataRepositorySearchResult instance.
void	setDataRepository(DataRepositoryWithDocuments dataRepository)	Set the dataRepository of this RetrievalDataRepositorySearchResult instance.
Map<String,Object>	toMap()	Get the value of all properties of this RetrievalDataRepositorySearchResult instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievalDataRepositorySearchResult

protected RetrievalDataRepositorySearchResult()

Default constructor for RetrievalDataRepositorySearchResult.

Method Details

dataRepository

@Nonnull
public RetrievalDataRepositorySearchResult dataRepository(@Nonnull
 DataRepositoryWithDocuments dataRepository)

Set the dataRepository of this RetrievalDataRepositorySearchResult instance and return the same instance.

Parameters:

dataRepository - The dataRepository of this RetrievalDataRepositorySearchResult

Returns:

The same instance of this RetrievalDataRepositorySearchResult class

getDataRepository

@Nonnull
public DataRepositoryWithDocuments getDataRepository()

Get dataRepository

Returns:

dataRepository The dataRepository of this RetrievalDataRepositorySearchResult instance.

setDataRepository

public void setDataRepository(@Nonnull
 DataRepositoryWithDocuments dataRepository)

Set the dataRepository of this RetrievalDataRepositorySearchResult instance.

Parameters:

dataRepository - The dataRepository of this RetrievalDataRepositorySearchResult

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RetrievalDataRepositorySearchResult.

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

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