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

Class Documents

java.lang.Object
com.sap.ai.sdk.grounding.model.Documents
public class Documents extends Object
A response containing documents retrieved from the server.

  • Constructor Details

    • Documents

      protected Documents()
      Default constructor for Documents.

  • Method Details

    • count

      @Nonnull public Documents count(@Nullable Integer count)
      Set the count of this Documents instance and return the same instance.
      Parameters:
      count - The count of this Documents
      Returns:
      The same instance of this Documents class

    • getCount

      @Nonnull public Integer getCount()
      Get count
      Returns:
      count The count of this Documents instance.

    • setCount

      public void setCount(@Nullable Integer count)
      Set the count of this Documents instance.
      Parameters:
      count - The count of this Documents

    • resources

      @Nonnull public Documents resources(@Nonnull List<DocumentWithoutChunks> resources)
      Set the resources of this Documents instance and return the same instance.
      Parameters:
      resources - The resources of this Documents
      Returns:
      The same instance of this Documents class

    • addResourcesItem

      @Nonnull public Documents addResourcesItem(@Nonnull DocumentWithoutChunks resourcesItem)
      Add one resources instance to this Documents.
      Parameters:
      resourcesItem - The resources that should be added
      Returns:
      The same instance of type Documents

    • getResources

      @Nonnull public List<DocumentWithoutChunks> getResources()
      Get resources
      Returns:
      resources The resources of this Documents instance.

    • setResources

      public void setResources(@Nonnull List<DocumentWithoutChunks> resources)
      Set the resources of this Documents instance.
      Parameters:
      resources - The resources of this Documents

    • getCustomFieldNames

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