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

Class SearchResults

java.lang.Object
com.sap.ai.sdk.grounding.model.SearchResults
public class SearchResults extends Object
SearchResults

  • Constructor Details

    • SearchResults

      protected SearchResults()
      Default constructor for SearchResults.

  • Method Details

    • results

      @Nonnull public SearchResults results(@Nonnull List<ResultsInner> results)
      Set the results of this SearchResults instance and return the same instance.
      Parameters:
      results - List of returned results.
      Returns:
      The same instance of this SearchResults class

    • addResultsItem

      @Nonnull public SearchResults addResultsItem(@Nonnull ResultsInner resultsItem)
      Add one results instance to this SearchResults.
      Parameters:
      resultsItem - The results that should be added
      Returns:
      The same instance of type SearchResults

    • getResults

      @Nonnull public List<ResultsInner> getResults()
      List of returned results.
      Returns:
      results The results of this SearchResults instance.

    • setResults

      public void setResults(@Nonnull List<ResultsInner> results)
      Set the results of this SearchResults instance.
      Parameters:
      results - List of returned results.

    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Get the names of the unrecognizable properties of the SearchResults.
      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 SearchResults 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 SearchResults 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 SearchResults 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 SearchResults.Builder create()
      Create a type-safe, fluent-api builder object to construct a new SearchResults instance with all required arguments.