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

Class RetrievalSearchFilter

java.lang.Object

com.sap.ai.sdk.grounding.model.RetrievalSearchFilter

public class RetrievalSearchFilter
extends Object

Limit scope of search to certain DataRepositories, Documents or Chunks.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrievalSearchFilter.Builder	Builder helper class.
static interface	RetrievalSearchFilter.Builder1	Builder helper class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RetrievalSearchFilter()	Default constructor for RetrievalSearchFilter.

Method Summary

Modifier and Type	Method	Description
RetrievalSearchFilter	addChunkMetadataItem(RetrievalKeyValueListPair chunkMetadataItem)	Add one chunkMetadata instance to this RetrievalSearchFilter.
RetrievalSearchFilter	addDataRepositoriesItem(String dataRepositoriesItem)	Add one dataRepositories instance to this RetrievalSearchFilter.
RetrievalSearchFilter	addDataRepositoryMetadataItem(RetrievalKeyValueListPair dataRepositoryMetadataItem)	Add one dataRepositoryMetadata instance to this RetrievalSearchFilter.
RetrievalSearchFilter	addDocumentMetadataItem(RetrievalSearchDocumentKeyValueListPair documentMetadataItem)	Add one documentMetadata instance to this RetrievalSearchFilter.
RetrievalSearchFilter	chunkMetadata(List<RetrievalKeyValueListPair> chunkMetadata)	Set the chunkMetadata of this RetrievalSearchFilter instance and return the same instance.
static RetrievalSearchFilter.Builder	create()	Create a type-safe, fluent-api builder object to construct a new RetrievalSearchFilter instance with all required arguments.
RetrievalSearchFilter	dataRepositories(List<String> dataRepositories)	Set the dataRepositories of this RetrievalSearchFilter instance and return the same instance.
RetrievalSearchFilter	dataRepositoryMetadata(List<RetrievalKeyValueListPair> dataRepositoryMetadata)	Set the dataRepositoryMetadata of this RetrievalSearchFilter instance and return the same instance.
RetrievalSearchFilter	dataRepositoryType(DataRepositoryType dataRepositoryType)	Set the dataRepositoryType of this RetrievalSearchFilter instance and return the same instance.
RetrievalSearchFilter	documentMetadata(List<RetrievalSearchDocumentKeyValueListPair> documentMetadata)	Set the documentMetadata of this RetrievalSearchFilter instance and return the same instance.
boolean	equals(Object o)
List<RetrievalKeyValueListPair>	getChunkMetadata()	Restrict chunks considered during search to those with the given metadata.
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the RetrievalSearchFilter.
List<String>	getDataRepositories()	Specify ['*'] to search across all DataRepositories or give a specific list of DataRepository ids.
List<RetrievalKeyValueListPair>	getDataRepositoryMetadata()	Restrict DataRepositories considered during search to those annotated with the given metadata.
DataRepositoryType	getDataRepositoryType()	Get dataRepositoryType
List<RetrievalSearchDocumentKeyValueListPair>	getDocumentMetadata()	Restrict documents considered during search to those annotated with the given metadata.
String	getId()	Identifier of this RetrievalSearchFilter - unique per request.
String	getRemoteName()	Destination Name of remote instance.
RetrievalSearchConfiguration	getSearchConfiguration()	Get searchConfiguration
int	hashCode()
RetrievalSearchFilter	id(String id)	Set the id of this RetrievalSearchFilter instance and return the same instance.
RetrievalSearchFilter	remoteName(String remoteName)	Set the remoteName of this RetrievalSearchFilter instance and return the same instance.
RetrievalSearchFilter	searchConfiguration(RetrievalSearchConfiguration searchConfiguration)	Set the searchConfiguration of this RetrievalSearchFilter instance and return the same instance.
void	setChunkMetadata(List<RetrievalKeyValueListPair> chunkMetadata)	Set the chunkMetadata of this RetrievalSearchFilter instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this RetrievalSearchFilter instance.
void	setDataRepositories(List<String> dataRepositories)	Set the dataRepositories of this RetrievalSearchFilter instance.
void	setDataRepositoryMetadata(List<RetrievalKeyValueListPair> dataRepositoryMetadata)	Set the dataRepositoryMetadata of this RetrievalSearchFilter instance.
void	setDataRepositoryType(DataRepositoryType dataRepositoryType)	Set the dataRepositoryType of this RetrievalSearchFilter instance.
void	setDocumentMetadata(List<RetrievalSearchDocumentKeyValueListPair> documentMetadata)	Set the documentMetadata of this RetrievalSearchFilter instance.
void	setId(String id)	Set the id of this RetrievalSearchFilter instance.
void	setRemoteName(String remoteName)	Set the remoteName of this RetrievalSearchFilter instance.
void	setSearchConfiguration(RetrievalSearchConfiguration searchConfiguration)	Set the searchConfiguration of this RetrievalSearchFilter instance.
Map<String,Object>	toMap()	Get the value of all properties of this RetrievalSearchFilter instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RetrievalSearchFilter

protected RetrievalSearchFilter()

Default constructor for RetrievalSearchFilter.

Method Details

id

@Nonnull
public RetrievalSearchFilter id(@Nonnull
 String id)

Set the id of this RetrievalSearchFilter instance and return the same instance.

Parameters:

id - Identifier of this RetrievalSearchFilter - unique per request.

Returns:

The same instance of this RetrievalSearchFilter class

getId

@Nonnull
public String getId()

Identifier of this RetrievalSearchFilter - unique per request.

Returns:

id The id of this RetrievalSearchFilter instance.

setId

public void setId(@Nonnull
 String id)

Set the id of this RetrievalSearchFilter instance.

Parameters:

id - Identifier of this RetrievalSearchFilter - unique per request.

searchConfiguration

@Nonnull
public RetrievalSearchFilter searchConfiguration(@Nullable
 RetrievalSearchConfiguration searchConfiguration)

Set the searchConfiguration of this RetrievalSearchFilter instance and return the same instance.

Parameters:

searchConfiguration - The searchConfiguration of this RetrievalSearchFilter

Returns:

The same instance of this RetrievalSearchFilter class

getSearchConfiguration

@Nullable
public RetrievalSearchConfiguration getSearchConfiguration()

Get searchConfiguration

Returns:

searchConfiguration The searchConfiguration of this RetrievalSearchFilter instance.

setSearchConfiguration

public void setSearchConfiguration(@Nullable
 RetrievalSearchConfiguration searchConfiguration)

Set the searchConfiguration of this RetrievalSearchFilter instance.

Parameters:

searchConfiguration - The searchConfiguration of this RetrievalSearchFilter

dataRepositories

@Nonnull
public RetrievalSearchFilter dataRepositories(@Nullable
 List<String> dataRepositories)

Set the dataRepositories of this RetrievalSearchFilter 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 RetrievalSearchFilter class

addDataRepositoriesItem

@Nonnull
public RetrievalSearchFilter addDataRepositoriesItem(@Nonnull
 String dataRepositoriesItem)

Add one dataRepositories instance to this RetrievalSearchFilter.

Parameters:

dataRepositoriesItem - The dataRepositories that should be added

Returns:

The same instance of type RetrievalSearchFilter

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 RetrievalSearchFilter instance.

setDataRepositories

public void setDataRepositories(@Nullable
 List<String> dataRepositories)

Set the dataRepositories of this RetrievalSearchFilter instance.

Parameters:

dataRepositories - Specify ['*'] to search across all DataRepositories or give a specific list of DataRepository ids.

dataRepositoryType

@Nonnull
public RetrievalSearchFilter dataRepositoryType(@Nonnull
 DataRepositoryType dataRepositoryType)

Set the dataRepositoryType of this RetrievalSearchFilter instance and return the same instance.

Parameters:

dataRepositoryType - The dataRepositoryType of this RetrievalSearchFilter

Returns:

The same instance of this RetrievalSearchFilter class

getDataRepositoryType

@Nonnull
public DataRepositoryType getDataRepositoryType()

Get dataRepositoryType

Returns:

dataRepositoryType The dataRepositoryType of this RetrievalSearchFilter instance.

setDataRepositoryType

public void setDataRepositoryType(@Nonnull
 DataRepositoryType dataRepositoryType)

Set the dataRepositoryType of this RetrievalSearchFilter instance.

Parameters:

dataRepositoryType - The dataRepositoryType of this RetrievalSearchFilter

remoteName

@Nonnull
public RetrievalSearchFilter remoteName(@Nullable
 String remoteName)

Set the remoteName of this RetrievalSearchFilter instance and return the same instance.

Parameters:

remoteName - Destination Name of remote instance.

Returns:

The same instance of this RetrievalSearchFilter class

getRemoteName

@Nullable
public String getRemoteName()

Destination Name of remote instance.

Returns:

remoteName The remoteName of this RetrievalSearchFilter instance.

setRemoteName

public void setRemoteName(@Nullable
 String remoteName)

Set the remoteName of this RetrievalSearchFilter instance.

Parameters:

remoteName - Destination Name of remote instance.

dataRepositoryMetadata

@Nonnull
public RetrievalSearchFilter dataRepositoryMetadata(@Nullable
 List<RetrievalKeyValueListPair> dataRepositoryMetadata)

Set the dataRepositoryMetadata of this RetrievalSearchFilter 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 RetrievalSearchFilter class

addDataRepositoryMetadataItem

@Nonnull
public RetrievalSearchFilter addDataRepositoryMetadataItem(@Nonnull
 RetrievalKeyValueListPair dataRepositoryMetadataItem)

Add one dataRepositoryMetadata instance to this RetrievalSearchFilter.

Parameters:

dataRepositoryMetadataItem - The dataRepositoryMetadata that should be added

Returns:

The same instance of type RetrievalSearchFilter

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 RetrievalSearchFilter instance.

setDataRepositoryMetadata

public void setDataRepositoryMetadata(@Nullable
 List<RetrievalKeyValueListPair> dataRepositoryMetadata)

Set the dataRepositoryMetadata of this RetrievalSearchFilter instance.

Parameters:

dataRepositoryMetadata - Restrict DataRepositories considered during search to those annotated with the given metadata. Useful when combined with dataRepositories=['*']

documentMetadata

@Nonnull
public RetrievalSearchFilter documentMetadata(@Nullable
 List<RetrievalSearchDocumentKeyValueListPair> documentMetadata)

Set the documentMetadata of this RetrievalSearchFilter 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 RetrievalSearchFilter class

addDocumentMetadataItem

@Nonnull
public RetrievalSearchFilter addDocumentMetadataItem(@Nonnull
 RetrievalSearchDocumentKeyValueListPair documentMetadataItem)

Add one documentMetadata instance to this RetrievalSearchFilter.

Parameters:

documentMetadataItem - The documentMetadata that should be added

Returns:

The same instance of type RetrievalSearchFilter

getDocumentMetadata

@Nonnull
public List<RetrievalSearchDocumentKeyValueListPair> getDocumentMetadata()

Restrict documents considered during search to those annotated with the given metadata.

Returns:

documentMetadata The documentMetadata of this RetrievalSearchFilter instance.

setDocumentMetadata

public void setDocumentMetadata(@Nullable
 List<RetrievalSearchDocumentKeyValueListPair> documentMetadata)

Set the documentMetadata of this RetrievalSearchFilter instance.

Parameters:

documentMetadata - Restrict documents considered during search to those annotated with the given metadata.

chunkMetadata

@Nonnull
public RetrievalSearchFilter chunkMetadata(@Nullable
 List<RetrievalKeyValueListPair> chunkMetadata)

Set the chunkMetadata of this RetrievalSearchFilter 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 RetrievalSearchFilter class

addChunkMetadataItem

@Nonnull
public RetrievalSearchFilter addChunkMetadataItem(@Nonnull
 RetrievalKeyValueListPair chunkMetadataItem)

Add one chunkMetadata instance to this RetrievalSearchFilter.

Parameters:

chunkMetadataItem - The chunkMetadata that should be added

Returns:

The same instance of type RetrievalSearchFilter

getChunkMetadata

@Nonnull
public List<RetrievalKeyValueListPair> getChunkMetadata()

Restrict chunks considered during search to those with the given metadata.

Returns:

chunkMetadata The chunkMetadata of this RetrievalSearchFilter instance.

setChunkMetadata

public void setChunkMetadata(@Nullable
 List<RetrievalKeyValueListPair> chunkMetadata)

Set the chunkMetadata of this RetrievalSearchFilter instance.

Parameters:

chunkMetadata - Restrict chunks considered during search to those with the given metadata.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RetrievalSearchFilter.

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 RetrievalSearchFilter 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 RetrievalSearchFilter 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 RetrievalSearchFilter 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 RetrievalSearchFilter.Builder create()

Create a type-safe, fluent-api builder object to construct a new RetrievalSearchFilter instance with all required arguments.