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

Class RetrievalVectorSearchFilter

java.lang.Object

com.sap.ai.sdk.grounding.model.RetrievalVectorSearchFilter

public class RetrievalVectorSearchFilter
extends Object

RetrievalVectorSearchFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrievalVectorSearchFilter.Builder	Builder helper class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RetrievalVectorSearchFilter	addChunkMetadataItem(RetrievalKeyValueListPair chunkMetadataItem)	Add one chunkMetadata instance to this RetrievalVectorSearchFilter.
RetrievalVectorSearchFilter	addDataRepositoriesItem(String dataRepositoriesItem)	Add one dataRepositories instance to this RetrievalVectorSearchFilter.
RetrievalVectorSearchFilter	addDataRepositoryMetadataItem(RetrievalKeyValueListPair dataRepositoryMetadataItem)	Add one dataRepositoryMetadata instance to this RetrievalVectorSearchFilter.
RetrievalVectorSearchFilter	addDocumentMetadataItem(RetrievalSearchDocumentKeyValueListPair documentMetadataItem)	Add one documentMetadata instance to this RetrievalVectorSearchFilter.
RetrievalVectorSearchFilter	chunkMetadata(List<RetrievalKeyValueListPair> chunkMetadata)	Set the chunkMetadata of this RetrievalVectorSearchFilter instance and return the same instance.
static RetrievalVectorSearchFilter.Builder	create()	Create a type-safe, fluent-api builder object to construct a new RetrievalVectorSearchFilter instance with all required arguments.
RetrievalVectorSearchFilter	dataRepositories(List<String> dataRepositories)	Set the dataRepositories of this RetrievalVectorSearchFilter instance and return the same instance.
RetrievalVectorSearchFilter	dataRepositoryMetadata(List<RetrievalKeyValueListPair> dataRepositoryMetadata)	Set the dataRepositoryMetadata of this RetrievalVectorSearchFilter instance and return the same instance.
RetrievalVectorSearchFilter	dataRepositoryType(DataRepositoryType dataRepositoryType)	Set the dataRepositoryType of this RetrievalVectorSearchFilter instance and return the same instance.
RetrievalVectorSearchFilter	documentMetadata(List<RetrievalSearchDocumentKeyValueListPair> documentMetadata)	Set the documentMetadata of this RetrievalVectorSearchFilter instance and return the same instance.
boolean	equals(Object o)
RetrievalVectorSearchFilter	filter(RetrievalVectorSearchFilterFilter filter)	Set the filter of this RetrievalVectorSearchFilter instance and return the same instance.
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 RetrievalVectorSearchFilter.
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.
RetrievalVectorSearchFilterFilter	getFilter()	Get filter
String	getId()	Identifier of this RetrievalSearchFilter - unique per request.
String	getRemoteName()	Destination Name of remote instance.
VectorScoringConfiguration	getScoringConfiguration()	Get scoringConfiguration
RetrievalSearchConfiguration	getSearchConfiguration()	Get searchConfiguration
int	hashCode()
RetrievalVectorSearchFilter	id(String id)	Set the id of this RetrievalVectorSearchFilter instance and return the same instance.
RetrievalVectorSearchFilter	remoteName(String remoteName)	Set the remoteName of this RetrievalVectorSearchFilter instance and return the same instance.
RetrievalVectorSearchFilter	scoringConfiguration(VectorScoringConfiguration scoringConfiguration)	Set the scoringConfiguration of this RetrievalVectorSearchFilter instance and return the same instance.
RetrievalVectorSearchFilter	searchConfiguration(RetrievalSearchConfiguration searchConfiguration)	Set the searchConfiguration of this RetrievalVectorSearchFilter instance and return the same instance.
void	setChunkMetadata(List<RetrievalKeyValueListPair> chunkMetadata)	Set the chunkMetadata of this RetrievalVectorSearchFilter instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this RetrievalVectorSearchFilter instance.
void	setDataRepositories(List<String> dataRepositories)	Set the dataRepositories of this RetrievalVectorSearchFilter instance.
void	setDataRepositoryMetadata(List<RetrievalKeyValueListPair> dataRepositoryMetadata)	Set the dataRepositoryMetadata of this RetrievalVectorSearchFilter instance.
void	setDataRepositoryType(DataRepositoryType dataRepositoryType)	Set the dataRepositoryType of this RetrievalVectorSearchFilter instance.
void	setDocumentMetadata(List<RetrievalSearchDocumentKeyValueListPair> documentMetadata)	Set the documentMetadata of this RetrievalVectorSearchFilter instance.
void	setFilter(RetrievalVectorSearchFilterFilter filter)	Set the filter of this RetrievalVectorSearchFilter instance.
void	setId(String id)	Set the id of this RetrievalVectorSearchFilter instance.
void	setRemoteName(String remoteName)	Set the remoteName of this RetrievalVectorSearchFilter instance.
void	setScoringConfiguration(VectorScoringConfiguration scoringConfiguration)	Set the scoringConfiguration of this RetrievalVectorSearchFilter instance.
void	setSearchConfiguration(RetrievalSearchConfiguration searchConfiguration)	Set the searchConfiguration of this RetrievalVectorSearchFilter instance.
Map<String,Object>	toMap()	Get the value of all properties of this RetrievalVectorSearchFilter instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievalVectorSearchFilter

protected RetrievalVectorSearchFilter()

Default constructor for RetrievalVectorSearchFilter.

Method Details

id

@Nonnull
public RetrievalVectorSearchFilter id(@Nonnull
 String id)

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

Parameters:

id - Identifier of this RetrievalSearchFilter - unique per request.

Returns:

The same instance of this RetrievalVectorSearchFilter class

getId

@Nonnull
public String getId()

Identifier of this RetrievalSearchFilter - unique per request.

Returns:

id The id of this RetrievalVectorSearchFilter instance.

setId

public void setId(@Nonnull
 String id)

Set the id of this RetrievalVectorSearchFilter instance.

Parameters:

id - Identifier of this RetrievalSearchFilter - unique per request.

searchConfiguration

@Nonnull
public RetrievalVectorSearchFilter searchConfiguration(@Nullable
 RetrievalSearchConfiguration searchConfiguration)

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

Parameters:

searchConfiguration - The searchConfiguration of this RetrievalVectorSearchFilter

Returns:

The same instance of this RetrievalVectorSearchFilter class

getSearchConfiguration

@Nullable
public RetrievalSearchConfiguration getSearchConfiguration()

Get searchConfiguration

Returns:

searchConfiguration The searchConfiguration of this RetrievalVectorSearchFilter instance.

setSearchConfiguration

public void setSearchConfiguration(@Nullable
 RetrievalSearchConfiguration searchConfiguration)

Set the searchConfiguration of this RetrievalVectorSearchFilter instance.

Parameters:

searchConfiguration - The searchConfiguration of this RetrievalVectorSearchFilter

dataRepositories

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

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

addDataRepositoriesItem

@Nonnull
public RetrievalVectorSearchFilter addDataRepositoriesItem(@Nonnull
 String dataRepositoriesItem)

Add one dataRepositories instance to this RetrievalVectorSearchFilter.

Parameters:

dataRepositoriesItem - The dataRepositories that should be added

Returns:

The same instance of type RetrievalVectorSearchFilter

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

setDataRepositories

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

Set the dataRepositories of this RetrievalVectorSearchFilter instance.

Parameters:

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

dataRepositoryType

@Nonnull
public RetrievalVectorSearchFilter dataRepositoryType(@Nullable
 DataRepositoryType dataRepositoryType)

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

Parameters:

dataRepositoryType - The dataRepositoryType of this RetrievalVectorSearchFilter

Returns:

The same instance of this RetrievalVectorSearchFilter class

getDataRepositoryType

@Nonnull
public DataRepositoryType getDataRepositoryType()

Get dataRepositoryType

Returns:

dataRepositoryType The dataRepositoryType of this RetrievalVectorSearchFilter instance.

setDataRepositoryType

public void setDataRepositoryType(@Nullable
 DataRepositoryType dataRepositoryType)

Set the dataRepositoryType of this RetrievalVectorSearchFilter instance.

Parameters:

dataRepositoryType - The dataRepositoryType of this RetrievalVectorSearchFilter

remoteName

@Nonnull
public RetrievalVectorSearchFilter remoteName(@Nullable
 String remoteName)

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

Parameters:

remoteName - Destination Name of remote instance.

Returns:

The same instance of this RetrievalVectorSearchFilter class

getRemoteName

@Nullable
public String getRemoteName()

Destination Name of remote instance.

Returns:

remoteName The remoteName of this RetrievalVectorSearchFilter instance.

setRemoteName

public void setRemoteName(@Nullable
 String remoteName)

Set the remoteName of this RetrievalVectorSearchFilter instance.

Parameters:

remoteName - Destination Name of remote instance.

dataRepositoryMetadata

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

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

addDataRepositoryMetadataItem

@Nonnull
public RetrievalVectorSearchFilter addDataRepositoryMetadataItem(@Nonnull
 RetrievalKeyValueListPair dataRepositoryMetadataItem)

Add one dataRepositoryMetadata instance to this RetrievalVectorSearchFilter.

Parameters:

dataRepositoryMetadataItem - The dataRepositoryMetadata that should be added

Returns:

The same instance of type RetrievalVectorSearchFilter

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

setDataRepositoryMetadata

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

Set the dataRepositoryMetadata of this RetrievalVectorSearchFilter instance.

Parameters:

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

documentMetadata

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

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

addDocumentMetadataItem

@Nonnull
public RetrievalVectorSearchFilter addDocumentMetadataItem(@Nonnull
 RetrievalSearchDocumentKeyValueListPair documentMetadataItem)

Add one documentMetadata instance to this RetrievalVectorSearchFilter.

Parameters:

documentMetadataItem - The documentMetadata that should be added

Returns:

The same instance of type RetrievalVectorSearchFilter

getDocumentMetadata

@Nonnull
public List<RetrievalSearchDocumentKeyValueListPair> getDocumentMetadata()

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

Returns:

documentMetadata The documentMetadata of this RetrievalVectorSearchFilter instance.

setDocumentMetadata

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

Set the documentMetadata of this RetrievalVectorSearchFilter instance.

Parameters:

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

chunkMetadata

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

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

addChunkMetadataItem

@Nonnull
public RetrievalVectorSearchFilter addChunkMetadataItem(@Nonnull
 RetrievalKeyValueListPair chunkMetadataItem)

Add one chunkMetadata instance to this RetrievalVectorSearchFilter.

Parameters:

chunkMetadataItem - The chunkMetadata that should be added

Returns:

The same instance of type RetrievalVectorSearchFilter

getChunkMetadata

@Nonnull
public List<RetrievalKeyValueListPair> getChunkMetadata()

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

Returns:

chunkMetadata The chunkMetadata of this RetrievalVectorSearchFilter instance.

setChunkMetadata

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

Set the chunkMetadata of this RetrievalVectorSearchFilter instance.

Parameters:

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

filter

@Nonnull
public RetrievalVectorSearchFilter filter(@Nullable
 RetrievalVectorSearchFilterFilter filter)

Set the filter of this RetrievalVectorSearchFilter instance and return the same instance.

Parameters:

filter - The filter of this RetrievalVectorSearchFilter

Returns:

The same instance of this RetrievalVectorSearchFilter class

getFilter

@Nullable
public RetrievalVectorSearchFilterFilter getFilter()

Get filter

Returns:

filter The filter of this RetrievalVectorSearchFilter instance.

setFilter

public void setFilter(@Nullable
 RetrievalVectorSearchFilterFilter filter)

Set the filter of this RetrievalVectorSearchFilter instance.

Parameters:

filter - The filter of this RetrievalVectorSearchFilter

scoringConfiguration

@Nonnull
public RetrievalVectorSearchFilter scoringConfiguration(@Nullable
 VectorScoringConfiguration scoringConfiguration)

Set the scoringConfiguration of this RetrievalVectorSearchFilter instance and return the same instance.

Parameters:

scoringConfiguration - The scoringConfiguration of this RetrievalVectorSearchFilter

Returns:

The same instance of this RetrievalVectorSearchFilter class

getScoringConfiguration

@Nonnull
public VectorScoringConfiguration getScoringConfiguration()

Get scoringConfiguration

Returns:

scoringConfiguration The scoringConfiguration of this RetrievalVectorSearchFilter instance.

setScoringConfiguration

public void setScoringConfiguration(@Nullable
 VectorScoringConfiguration scoringConfiguration)

Set the scoringConfiguration of this RetrievalVectorSearchFilter instance.

Parameters:

scoringConfiguration - The scoringConfiguration of this RetrievalVectorSearchFilter

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RetrievalVectorSearchFilter.

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

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