Package com.sap.ai.sdk.grounding.model
Class RetrievalSearchInput
java.lang.Object
com.sap.ai.sdk.grounding.model.RetrievalSearchInput
RetrievalSearchInput
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceBuilder helper class.static interfaceBuilder helper class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDefault constructor for RetrievalSearchInput. -
Method Summary
Modifier and TypeMethodDescriptionaddFiltersItem(FiltersInner filtersItem) Add one filters instance to thisRetrievalSearchInput.addPostProcessingItem(RetrievalSearchInputPostProcessingInner postProcessingItem) Add one postProcessing instance to thisRetrievalSearchInput.static RetrievalSearchInput.Buildercreate()Create a type-safe, fluent-api builder object to construct a newRetrievalSearchInputinstance with all required arguments.booleanfilters(List<FiltersInner> filters) Set the filters of thisRetrievalSearchInputinstance and return the same instance.getCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theRetrievalSearchInput.Get filtersList of operations to be performed across PerFilterSearchResults.getQuery()Query stringinthashCode()postProcessing(List<RetrievalSearchInputPostProcessingInner> postProcessing) Set the postProcessing of thisRetrievalSearchInputinstance and return the same instance.Set the query of thisRetrievalSearchInputinstance and return the same instance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisRetrievalSearchInputinstance.voidsetFilters(List<FiltersInner> filters) Set the filters of thisRetrievalSearchInputinstance.voidsetPostProcessing(List<RetrievalSearchInputPostProcessingInner> postProcessing) Set the postProcessing of thisRetrievalSearchInputinstance.voidSet the query of thisRetrievalSearchInputinstance.toMap()Get the value of all properties of thisRetrievalSearchInputinstance including unrecognized properties.toString()
-
Constructor Details
-
RetrievalSearchInput
protected RetrievalSearchInput()Default constructor for RetrievalSearchInput.
-
-
Method Details
-
query
Set the query of thisRetrievalSearchInputinstance and return the same instance.- Parameters:
query- Query string- Returns:
- The same instance of this
RetrievalSearchInputclass
-
getQuery
Query string- Returns:
- query The query of this
RetrievalSearchInputinstance.
-
setQuery
Set the query of thisRetrievalSearchInputinstance.- Parameters:
query- Query string
-
filters
Set the filters of thisRetrievalSearchInputinstance and return the same instance.- Parameters:
filters- The filters of thisRetrievalSearchInput- Returns:
- The same instance of this
RetrievalSearchInputclass
-
addFiltersItem
Add one filters instance to thisRetrievalSearchInput.- Parameters:
filtersItem- The filters that should be added- Returns:
- The same instance of type
RetrievalSearchInput
-
getFilters
Get filters- Returns:
- filters The filters of this
RetrievalSearchInputinstance.
-
setFilters
Set the filters of thisRetrievalSearchInputinstance.- Parameters:
filters- The filters of thisRetrievalSearchInput
-
postProcessing
@Nonnull public RetrievalSearchInput postProcessing(@Nullable List<RetrievalSearchInputPostProcessingInner> postProcessing) Set the postProcessing of thisRetrievalSearchInputinstance and return the same instance.- Parameters:
postProcessing- List of operations to be performed across PerFilterSearchResults.- Returns:
- The same instance of this
RetrievalSearchInputclass
-
addPostProcessingItem
@Nonnull public RetrievalSearchInput addPostProcessingItem(@Nonnull RetrievalSearchInputPostProcessingInner postProcessingItem) Add one postProcessing instance to thisRetrievalSearchInput.- Parameters:
postProcessingItem- The postProcessing that should be added- Returns:
- The same instance of type
RetrievalSearchInput
-
getPostProcessing
List of operations to be performed across PerFilterSearchResults.- Returns:
- postProcessing The postProcessing of this
RetrievalSearchInputinstance.
-
setPostProcessing
public void setPostProcessing(@Nullable List<RetrievalSearchInputPostProcessingInner> postProcessing) Set the postProcessing of thisRetrievalSearchInputinstance.- Parameters:
postProcessing- List of operations to be performed across PerFilterSearchResults.
-
getCustomFieldNames
Get the names of the unrecognizable properties of theRetrievalSearchInput.- Returns:
- The set of properties names
-
getCustomField
@Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException Deprecated.UsetoMap()instead.Get the value of an unrecognizable property of thisRetrievalSearchInputinstance.- 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
Get the value of all properties of thisRetrievalSearchInputinstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisRetrievalSearchInputinstance. 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 propertycustomFieldValue- The value of the property
-
equals
-
hashCode
public int hashCode() -
toString
-
create
Create a type-safe, fluent-api builder object to construct a newRetrievalSearchInputinstance with all required arguments.
-
toMap()instead.