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

Class RetrievalSearchInput

java.lang.Object

com.sap.ai.sdk.grounding.model.RetrievalSearchInput

public class RetrievalSearchInput
extends Object

RetrievalSearchInput

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RetrievalSearchInput	addFiltersItem(FiltersInner filtersItem)	Add one filters instance to this RetrievalSearchInput.
RetrievalSearchInput	addPostProcessingItem(RetrievalSearchInputPostProcessingInner postProcessingItem)	Add one postProcessing instance to this RetrievalSearchInput.
static RetrievalSearchInput.Builder	create()	Create a type-safe, fluent-api builder object to construct a new RetrievalSearchInput instance with all required arguments.
boolean	equals(Object o)
RetrievalSearchInput	filters(List<FiltersInner> filters)	Set the filters of this RetrievalSearchInput 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 RetrievalSearchInput.
List<FiltersInner>	getFilters()	Get filters
List<RetrievalSearchInputPostProcessingInner>	getPostProcessing()	List of operations to be performed across PerFilterSearchResults.
String	getQuery()	Query string
int	hashCode()
RetrievalSearchInput	postProcessing(List<RetrievalSearchInputPostProcessingInner> postProcessing)	Set the postProcessing of this RetrievalSearchInput instance and return the same instance.
RetrievalSearchInput	query(String query)	Set the query of this RetrievalSearchInput instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this RetrievalSearchInput instance.
void	setFilters(List<FiltersInner> filters)	Set the filters of this RetrievalSearchInput instance.
void	setPostProcessing(List<RetrievalSearchInputPostProcessingInner> postProcessing)	Set the postProcessing of this RetrievalSearchInput instance.
void	setQuery(String query)	Set the query of this RetrievalSearchInput instance.
Map<String,Object>	toMap()	Get the value of all properties of this RetrievalSearchInput instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievalSearchInput

protected RetrievalSearchInput()

Default constructor for RetrievalSearchInput.

Method Details

query

@Nonnull
public RetrievalSearchInput query(@Nullable
 String query)

Set the query of this RetrievalSearchInput instance and return the same instance.

Parameters:

query - Query string

Returns:

The same instance of this RetrievalSearchInput class

getQuery

@Nullable
public String getQuery()

Query string

Returns:

query The query of this RetrievalSearchInput instance.

setQuery

public void setQuery(@Nullable
 String query)

Set the query of this RetrievalSearchInput instance.

Parameters:

query - Query string

filters

@Nonnull
public RetrievalSearchInput filters(@Nonnull
 List<FiltersInner> filters)

Set the filters of this RetrievalSearchInput instance and return the same instance.

Parameters:

filters - The filters of this RetrievalSearchInput

Returns:

The same instance of this RetrievalSearchInput class

addFiltersItem

@Nonnull
public RetrievalSearchInput addFiltersItem(@Nonnull
 FiltersInner filtersItem)

Add one filters instance to this RetrievalSearchInput.

Parameters:

filtersItem - The filters that should be added

Returns:

The same instance of type RetrievalSearchInput

getFilters

@Nonnull
public List<FiltersInner> getFilters()

Get filters

Returns:

filters The filters of this RetrievalSearchInput instance.

setFilters

public void setFilters(@Nonnull
 List<FiltersInner> filters)

Set the filters of this RetrievalSearchInput instance.

Parameters:

filters - The filters of this RetrievalSearchInput

postProcessing

@Nonnull
public RetrievalSearchInput postProcessing(@Nullable
 List<RetrievalSearchInputPostProcessingInner> postProcessing)

Set the postProcessing of this RetrievalSearchInput instance and return the same instance.

Parameters:

postProcessing - List of operations to be performed across PerFilterSearchResults.

Returns:

The same instance of this RetrievalSearchInput class

addPostProcessingItem

@Nonnull
public RetrievalSearchInput addPostProcessingItem(@Nonnull
 RetrievalSearchInputPostProcessingInner postProcessingItem)

Add one postProcessing instance to this RetrievalSearchInput.

Parameters:

postProcessingItem - The postProcessing that should be added

Returns:

The same instance of type RetrievalSearchInput

getPostProcessing

@Nonnull
public List<RetrievalSearchInputPostProcessingInner> getPostProcessing()

List of operations to be performed across PerFilterSearchResults.

Returns:

postProcessing The postProcessing of this RetrievalSearchInput instance.

setPostProcessing

public void setPostProcessing(@Nullable
 List<RetrievalSearchInputPostProcessingInner> postProcessing)

Set the postProcessing of this RetrievalSearchInput instance.

Parameters:

postProcessing - List of operations to be performed across PerFilterSearchResults.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RetrievalSearchInput.

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

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