Package com.sap.ai.sdk.grounding.model
Class RetrievalPerFilterSearchResult
java.lang.Object
com.sap.ai.sdk.grounding.model.RetrievalPerFilterSearchResult
RetrievalPerFilterSearchResult
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceBuilder helper class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDefault constructor for RetrievalPerFilterSearchResult. -
Method Summary
Modifier and TypeMethodDescriptionaddResultsItem(RetrievalDataRepositorySearchResult resultsItem) Add one results instance to thisRetrievalPerFilterSearchResult.create()Create a type-safe, fluent-api builder object to construct a newRetrievalPerFilterSearchResultinstance with all required arguments.booleanSet the filterId of thisRetrievalPerFilterSearchResultinstance and return the same instance.getCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theRetrievalPerFilterSearchResult.Get filterIdFriendly Destination Name of remote instance (grounding.name).List of returned results.inthashCode()remoteGroundingName(String remoteGroundingName) Set the remoteGroundingName of thisRetrievalPerFilterSearchResultinstance and return the same instance.results(List<RetrievalDataRepositorySearchResult> results) Set the results of thisRetrievalPerFilterSearchResultinstance and return the same instance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisRetrievalPerFilterSearchResultinstance.voidsetFilterId(String filterId) Set the filterId of thisRetrievalPerFilterSearchResultinstance.voidsetRemoteGroundingName(String remoteGroundingName) Set the remoteGroundingName of thisRetrievalPerFilterSearchResultinstance.voidSet the results of thisRetrievalPerFilterSearchResultinstance.toMap()Get the value of all properties of thisRetrievalPerFilterSearchResultinstance including unrecognized properties.toString()
-
Constructor Details
-
RetrievalPerFilterSearchResult
protected RetrievalPerFilterSearchResult()Default constructor for RetrievalPerFilterSearchResult.
-
-
Method Details
-
filterId
Set the filterId of thisRetrievalPerFilterSearchResultinstance and return the same instance.- Parameters:
filterId- The filterId of thisRetrievalPerFilterSearchResult- Returns:
- The same instance of this
RetrievalPerFilterSearchResultclass
-
getFilterId
Get filterId- Returns:
- filterId The filterId of this
RetrievalPerFilterSearchResultinstance.
-
setFilterId
Set the filterId of thisRetrievalPerFilterSearchResultinstance.- Parameters:
filterId- The filterId of thisRetrievalPerFilterSearchResult
-
results
@Nonnull public RetrievalPerFilterSearchResult results(@Nullable List<RetrievalDataRepositorySearchResult> results) Set the results of thisRetrievalPerFilterSearchResultinstance and return the same instance.- Parameters:
results- List of returned results.- Returns:
- The same instance of this
RetrievalPerFilterSearchResultclass
-
addResultsItem
@Nonnull public RetrievalPerFilterSearchResult addResultsItem(@Nonnull RetrievalDataRepositorySearchResult resultsItem) Add one results instance to thisRetrievalPerFilterSearchResult.- Parameters:
resultsItem- The results that should be added- Returns:
- The same instance of type
RetrievalPerFilterSearchResult
-
getResults
List of returned results.- Returns:
- results The results of this
RetrievalPerFilterSearchResultinstance.
-
setResults
Set the results of thisRetrievalPerFilterSearchResultinstance.- Parameters:
results- List of returned results.
-
remoteGroundingName
@Nonnull public RetrievalPerFilterSearchResult remoteGroundingName(@Nullable String remoteGroundingName) Set the remoteGroundingName of thisRetrievalPerFilterSearchResultinstance 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
RetrievalPerFilterSearchResultclass
-
getRemoteGroundingName
Friendly Destination Name of remote instance (grounding.name). Only present if dataRepositoryType = remote:dg.- Returns:
- remoteGroundingName The remoteGroundingName of this
RetrievalPerFilterSearchResultinstance.
-
setRemoteGroundingName
Set the remoteGroundingName of thisRetrievalPerFilterSearchResultinstance.- Parameters:
remoteGroundingName- Friendly Destination Name of remote instance (grounding.name). Only present if dataRepositoryType = remote:dg.
-
getCustomFieldNames
Get the names of the unrecognizable properties of theRetrievalPerFilterSearchResult.- 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 thisRetrievalPerFilterSearchResultinstance.- 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 thisRetrievalPerFilterSearchResultinstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisRetrievalPerFilterSearchResultinstance. 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 newRetrievalPerFilterSearchResultinstance with all required arguments.
-
toMap()instead.