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

Class ResultsInner1

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

  • Constructor Details

    • ResultsInner1

      protected ResultsInner1()
      Default constructor for ResultsInner1.

  • Method Details

    • filterId

      @Nonnull public ResultsInner1 filterId(@Nonnull String filterId)
      Set the filterId of this ResultsInner1 instance and return the same instance.
      Parameters:
      filterId - The filterId of this ResultsInner1
      Returns:
      The same instance of this ResultsInner1 class

    • getFilterId

      @Nonnull public String getFilterId()
      Get filterId
      Returns:
      filterId The filterId of this ResultsInner1 instance.

    • setFilterId

      public void setFilterId(@Nonnull String filterId)
      Set the filterId of this ResultsInner1 instance.
      Parameters:
      filterId - The filterId of this ResultsInner1

    • results

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

    • addResultsItem

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

    • getResults

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

    • setResults

      public void setResults(@Nullable List<RetrievalDataRepositorySearchResult> results)
      Set the results of this ResultsInner1 instance.
      Parameters:
      results - List of returned results.

    • remoteGroundingName

      @Nonnull public ResultsInner1 remoteGroundingName(@Nullable String remoteGroundingName)
      Set the remoteGroundingName of this ResultsInner1 instance 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 ResultsInner1 class

    • getRemoteGroundingName

      @Nullable public String getRemoteGroundingName()
      Friendly Destination Name of remote instance (grounding.name). Only present if dataRepositoryType = remote:dg.
      Returns:
      remoteGroundingName The remoteGroundingName of this ResultsInner1 instance.

    • setRemoteGroundingName

      public void setRemoteGroundingName(@Nullable String remoteGroundingName)
      Set the remoteGroundingName of this ResultsInner1 instance.
      Parameters:
      remoteGroundingName - Friendly Destination Name of remote instance (grounding.name). Only present if dataRepositoryType = remote:dg.

    • error

      @Nonnull public ResultsInner1 error(@Nullable RetrievalPerFilterSearchResultError error)
      Set the error of this ResultsInner1 instance and return the same instance.
      Parameters:
      error - The error of this ResultsInner1
      Returns:
      The same instance of this ResultsInner1 class

    • getError

      @Nonnull public RetrievalPerFilterSearchResultError getError()
      Get error
      Returns:
      error The error of this ResultsInner1 instance.

    • setError

      public void setError(@Nullable RetrievalPerFilterSearchResultError error)
      Set the error of this ResultsInner1 instance.
      Parameters:
      error - The error of this ResultsInner1

    • getCustomFieldNames

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