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

Class FiltersInner

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

  • Constructor Details

    • FiltersInner

      protected FiltersInner()
      Default constructor for FiltersInner.

  • Method Details

    • id

      @Nonnull public FiltersInner id(@Nonnull String id)
      Set the id of this FiltersInner instance and return the same instance.
      Parameters:
      id - Identifier of this RetrievalSearchFilter - unique per request.
      Returns:
      The same instance of this FiltersInner class

    • getId

      @Nonnull public String getId()
      Identifier of this RetrievalSearchFilter - unique per request.
      Returns:
      id The id of this FiltersInner instance.

    • setId

      public void setId(@Nonnull String id)
      Set the id of this FiltersInner instance.
      Parameters:
      id - Identifier of this RetrievalSearchFilter - unique per request.

    • searchConfiguration

      @Nonnull public FiltersInner searchConfiguration(@Nullable RetrievalSearchConfiguration searchConfiguration)
      Set the searchConfiguration of this FiltersInner instance and return the same instance.
      Parameters:
      searchConfiguration - The searchConfiguration of this FiltersInner
      Returns:
      The same instance of this FiltersInner class

    • getSearchConfiguration

      @Nullable public RetrievalSearchConfiguration getSearchConfiguration()
      Get searchConfiguration
      Returns:
      searchConfiguration The searchConfiguration of this FiltersInner instance.

    • setSearchConfiguration

      public void setSearchConfiguration(@Nullable RetrievalSearchConfiguration searchConfiguration)
      Set the searchConfiguration of this FiltersInner instance.
      Parameters:
      searchConfiguration - The searchConfiguration of this FiltersInner

    • dataRepositories

      @Nonnull public FiltersInner dataRepositories(@Nullable List<String> dataRepositories)
      Set the dataRepositories of this FiltersInner instance and return the same instance.
      Parameters:
      dataRepositories - Specify ['*'] to search across all DataRepositories or give a specific list of DataRepository ids.
      Returns:
      The same instance of this FiltersInner class

    • addDataRepositoriesItem

      @Nonnull public FiltersInner addDataRepositoriesItem(@Nonnull String dataRepositoriesItem)
      Add one dataRepositories instance to this FiltersInner.
      Parameters:
      dataRepositoriesItem - The dataRepositories that should be added
      Returns:
      The same instance of type FiltersInner

    • getDataRepositories

      @Nonnull public List<String> getDataRepositories()
      Specify ['*'] to search across all DataRepositories or give a specific list of DataRepository ids.
      Returns:
      dataRepositories The dataRepositories of this FiltersInner instance.

    • setDataRepositories

      public void setDataRepositories(@Nullable List<String> dataRepositories)
      Set the dataRepositories of this FiltersInner instance.
      Parameters:
      dataRepositories - Specify ['*'] to search across all DataRepositories or give a specific list of DataRepository ids.

    • dataRepositoryType

      @Nonnull public FiltersInner dataRepositoryType(@Nonnull DataRepositoryType dataRepositoryType)
      Set the dataRepositoryType of this FiltersInner instance and return the same instance.
      Parameters:
      dataRepositoryType - The dataRepositoryType of this FiltersInner
      Returns:
      The same instance of this FiltersInner class

    • getDataRepositoryType

      @Nonnull public DataRepositoryType getDataRepositoryType()
      Get dataRepositoryType
      Returns:
      dataRepositoryType The dataRepositoryType of this FiltersInner instance.

    • setDataRepositoryType

      public void setDataRepositoryType(@Nonnull DataRepositoryType dataRepositoryType)
      Set the dataRepositoryType of this FiltersInner instance.
      Parameters:
      dataRepositoryType - The dataRepositoryType of this FiltersInner

    • remoteName

      @Nonnull public FiltersInner remoteName(@Nullable String remoteName)
      Set the remoteName of this FiltersInner instance and return the same instance.
      Parameters:
      remoteName - Destination Name of remote instance.
      Returns:
      The same instance of this FiltersInner class

    • getRemoteName

      @Nullable public String getRemoteName()
      Destination Name of remote instance.
      Returns:
      remoteName The remoteName of this FiltersInner instance.

    • setRemoteName

      public void setRemoteName(@Nullable String remoteName)
      Set the remoteName of this FiltersInner instance.
      Parameters:
      remoteName - Destination Name of remote instance.

    • dataRepositoryMetadata

      @Nonnull public FiltersInner dataRepositoryMetadata(@Nullable List<RetrievalKeyValueListPair> dataRepositoryMetadata)
      Set the dataRepositoryMetadata of this FiltersInner instance and return the same instance.
      Parameters:
      dataRepositoryMetadata - Restrict DataRepositories considered during search to those annotated with the given metadata. Useful when combined with dataRepositories=['*']
      Returns:
      The same instance of this FiltersInner class

    • addDataRepositoryMetadataItem

      @Nonnull public FiltersInner addDataRepositoryMetadataItem(@Nonnull RetrievalKeyValueListPair dataRepositoryMetadataItem)
      Add one dataRepositoryMetadata instance to this FiltersInner.
      Parameters:
      dataRepositoryMetadataItem - The dataRepositoryMetadata that should be added
      Returns:
      The same instance of type FiltersInner

    • getDataRepositoryMetadata

      @Nonnull public List<RetrievalKeyValueListPair> getDataRepositoryMetadata()
      Restrict DataRepositories considered during search to those annotated with the given metadata. Useful when combined with dataRepositories=['*']
      Returns:
      dataRepositoryMetadata The dataRepositoryMetadata of this FiltersInner instance.

    • setDataRepositoryMetadata

      public void setDataRepositoryMetadata(@Nullable List<RetrievalKeyValueListPair> dataRepositoryMetadata)
      Set the dataRepositoryMetadata of this FiltersInner instance.
      Parameters:
      dataRepositoryMetadata - Restrict DataRepositories considered during search to those annotated with the given metadata. Useful when combined with dataRepositories=['*']

    • documentMetadata

      @Nonnull public FiltersInner documentMetadata(@Nullable List<RetrievalSearchDocumentKeyValueListPair> documentMetadata)
      Set the documentMetadata of this FiltersInner instance and return the same instance.
      Parameters:
      documentMetadata - Restrict documents considered during search to those annotated with the given metadata.
      Returns:
      The same instance of this FiltersInner class

    • addDocumentMetadataItem

      @Nonnull public FiltersInner addDocumentMetadataItem(@Nonnull RetrievalSearchDocumentKeyValueListPair documentMetadataItem)
      Add one documentMetadata instance to this FiltersInner.
      Parameters:
      documentMetadataItem - The documentMetadata that should be added
      Returns:
      The same instance of type FiltersInner

    • getDocumentMetadata

      @Nonnull public List<RetrievalSearchDocumentKeyValueListPair> getDocumentMetadata()
      Restrict documents considered during search to those annotated with the given metadata.
      Returns:
      documentMetadata The documentMetadata of this FiltersInner instance.

    • setDocumentMetadata

      public void setDocumentMetadata(@Nullable List<RetrievalSearchDocumentKeyValueListPair> documentMetadata)
      Set the documentMetadata of this FiltersInner instance.
      Parameters:
      documentMetadata - Restrict documents considered during search to those annotated with the given metadata.

    • chunkMetadata

      @Nonnull public FiltersInner chunkMetadata(@Nullable List<RetrievalKeyValueListPair> chunkMetadata)
      Set the chunkMetadata of this FiltersInner instance and return the same instance.
      Parameters:
      chunkMetadata - Restrict chunks considered during search to those with the given metadata.
      Returns:
      The same instance of this FiltersInner class

    • addChunkMetadataItem

      @Nonnull public FiltersInner addChunkMetadataItem(@Nonnull RetrievalKeyValueListPair chunkMetadataItem)
      Add one chunkMetadata instance to this FiltersInner.
      Parameters:
      chunkMetadataItem - The chunkMetadata that should be added
      Returns:
      The same instance of type FiltersInner

    • getChunkMetadata

      @Nonnull public List<RetrievalKeyValueListPair> getChunkMetadata()
      Restrict chunks considered during search to those with the given metadata.
      Returns:
      chunkMetadata The chunkMetadata of this FiltersInner instance.

    • setChunkMetadata

      public void setChunkMetadata(@Nullable List<RetrievalKeyValueListPair> chunkMetadata)
      Set the chunkMetadata of this FiltersInner instance.
      Parameters:
      chunkMetadata - Restrict chunks considered during search to those with the given metadata.

    • filter

      @Nonnull public FiltersInner filter(@Nullable RetrievalVectorSearchFilterFilter filter)
      Set the filter of this FiltersInner instance and return the same instance.
      Parameters:
      filter - The filter of this FiltersInner
      Returns:
      The same instance of this FiltersInner class

    • getFilter

      @Nullable public RetrievalVectorSearchFilterFilter getFilter()
      Get filter
      Returns:
      filter The filter of this FiltersInner instance.

    • setFilter

      public void setFilter(@Nullable RetrievalVectorSearchFilterFilter filter)
      Set the filter of this FiltersInner instance.
      Parameters:
      filter - The filter of this FiltersInner

    • scoringConfiguration

      @Nonnull public FiltersInner scoringConfiguration(@Nullable VectorScoringConfiguration scoringConfiguration)
      Set the scoringConfiguration of this FiltersInner instance and return the same instance.
      Parameters:
      scoringConfiguration - The scoringConfiguration of this FiltersInner
      Returns:
      The same instance of this FiltersInner class

    • getScoringConfiguration

      @Nonnull public VectorScoringConfiguration getScoringConfiguration()
      Get scoringConfiguration
      Returns:
      scoringConfiguration The scoringConfiguration of this FiltersInner instance.

    • setScoringConfiguration

      public void setScoringConfiguration(@Nullable VectorScoringConfiguration scoringConfiguration)
      Set the scoringConfiguration of this FiltersInner instance.
      Parameters:
      scoringConfiguration - The scoringConfiguration of this FiltersInner

    • getCustomFieldNames

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