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

Class VectorSearchFilter

java.lang.Object

com.sap.ai.sdk.grounding.model.VectorSearchFilter

public class VectorSearchFilter
extends Object

VectorSearchFilter

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
VectorSearchFilter	_configuration(VectorSearchConfiguration _configuration)	Set the _configuration of this VectorSearchFilter instance and return the same instance.
VectorSearchFilter	addChunkMetadataItem(VectorKeyValueListPair chunkMetadataItem)	Add one chunkMetadata instance to this VectorSearchFilter.
VectorSearchFilter	addCollectionIdsItem(String collectionIdsItem)	Add one collectionIds instance to this VectorSearchFilter.
VectorSearchFilter	addCollectionMetadataItem(VectorKeyValueListPair collectionMetadataItem)	Add one collectionMetadata instance to this VectorSearchFilter.
VectorSearchFilter	addDocumentMetadataItem(VectorSearchDocumentKeyValueListPair documentMetadataItem)	Add one documentMetadata instance to this VectorSearchFilter.
VectorSearchFilter	chunkMetadata(List<VectorKeyValueListPair> chunkMetadata)	Set the chunkMetadata of this VectorSearchFilter instance and return the same instance.
VectorSearchFilter	collectionIds(List<String> collectionIds)	Set the collectionIds of this VectorSearchFilter instance and return the same instance.
VectorSearchFilter	collectionMetadata(List<VectorKeyValueListPair> collectionMetadata)	Set the collectionMetadata of this VectorSearchFilter instance and return the same instance.
static VectorSearchFilter.Builder	create()	Create a type-safe, fluent-api builder object to construct a new VectorSearchFilter instance with all required arguments.
VectorSearchFilter	documentMetadata(List<VectorSearchDocumentKeyValueListPair> documentMetadata)	Set the documentMetadata of this VectorSearchFilter instance and return the same instance.
boolean	equals(Object o)
VectorSearchFilter	filter(Filter filter)	Set the filter of this VectorSearchFilter instance and return the same instance.
List<VectorKeyValueListPair>	getChunkMetadata()	Restrict chunks considered during search to those with the given metadata.
List<String>	getCollectionIds()	Get collectionIds
List<VectorKeyValueListPair>	getCollectionMetadata()	Restrict collections considered during search to those annotated with the given metadata.
VectorSearchConfiguration	getConfiguration()	Get _configuration
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the VectorSearchFilter.
List<VectorSearchDocumentKeyValueListPair>	getDocumentMetadata()	Restrict documents considered during search to those annotated with the given metadata.
Filter	getFilter()	Get filter
String	getId()	Identifier of this VectorSearchFilter - unique per request.
int	hashCode()
VectorSearchFilter	id(String id)	Set the id of this VectorSearchFilter instance and return the same instance.
void	setChunkMetadata(List<VectorKeyValueListPair> chunkMetadata)	Set the chunkMetadata of this VectorSearchFilter instance.
void	setCollectionIds(List<String> collectionIds)	Set the collectionIds of this VectorSearchFilter instance.
void	setCollectionMetadata(List<VectorKeyValueListPair> collectionMetadata)	Set the collectionMetadata of this VectorSearchFilter instance.
void	setConfiguration(VectorSearchConfiguration _configuration)	Set the _configuration of this VectorSearchFilter instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this VectorSearchFilter instance.
void	setDocumentMetadata(List<VectorSearchDocumentKeyValueListPair> documentMetadata)	Set the documentMetadata of this VectorSearchFilter instance.
void	setFilter(Filter filter)	Set the filter of this VectorSearchFilter instance.
void	setId(String id)	Set the id of this VectorSearchFilter instance.
Map<String,Object>	toMap()	Get the value of all properties of this VectorSearchFilter instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

VectorSearchFilter

protected VectorSearchFilter()

Default constructor for VectorSearchFilter.

Method Details

id

@Nonnull
public VectorSearchFilter id(@Nonnull
 String id)

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

Parameters:

id - Identifier of this VectorSearchFilter - unique per request.

Returns:

The same instance of this VectorSearchFilter class

getId

@Nonnull
public String getId()

Identifier of this VectorSearchFilter - unique per request.

Returns:

id The id of this VectorSearchFilter instance.

setId

public void setId(@Nonnull
 String id)

Set the id of this VectorSearchFilter instance.

Parameters:

id - Identifier of this VectorSearchFilter - unique per request.

collectionIds

@Nonnull
public VectorSearchFilter collectionIds(@Nonnull
 List<String> collectionIds)

Set the collectionIds of this VectorSearchFilter instance and return the same instance.

Parameters:

collectionIds - The collectionIds of this VectorSearchFilter

Returns:

The same instance of this VectorSearchFilter class

addCollectionIdsItem

@Nonnull
public VectorSearchFilter addCollectionIdsItem(@Nonnull
 String collectionIdsItem)

Add one collectionIds instance to this VectorSearchFilter.

Parameters:

collectionIdsItem - The collectionIds that should be added

Returns:

The same instance of type VectorSearchFilter

getCollectionIds

@Nonnull
public List<String> getCollectionIds()

Get collectionIds

Returns:

collectionIds The collectionIds of this VectorSearchFilter instance.

setCollectionIds

public void setCollectionIds(@Nonnull
 List<String> collectionIds)

Set the collectionIds of this VectorSearchFilter instance.

Parameters:

collectionIds - The collectionIds of this VectorSearchFilter

_configuration

@Nonnull
public VectorSearchFilter _configuration(@Nonnull
 VectorSearchConfiguration _configuration)

Set the _configuration of this VectorSearchFilter instance and return the same instance.

Parameters:

_configuration - The _configuration of this VectorSearchFilter

Returns:

The same instance of this VectorSearchFilter class

getConfiguration

@Nonnull
public VectorSearchConfiguration getConfiguration()

Get _configuration

Returns:

_configuration The _configuration of this VectorSearchFilter instance.

setConfiguration

public void setConfiguration(@Nonnull
 VectorSearchConfiguration _configuration)

Set the _configuration of this VectorSearchFilter instance.

Parameters:

_configuration - The _configuration of this VectorSearchFilter

collectionMetadata

@Nonnull
public VectorSearchFilter collectionMetadata(@Nullable
 List<VectorKeyValueListPair> collectionMetadata)

Set the collectionMetadata of this VectorSearchFilter instance and return the same instance.

Parameters:

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

Returns:

The same instance of this VectorSearchFilter class

addCollectionMetadataItem

@Nonnull
public VectorSearchFilter addCollectionMetadataItem(@Nonnull
 VectorKeyValueListPair collectionMetadataItem)

Add one collectionMetadata instance to this VectorSearchFilter.

Parameters:

collectionMetadataItem - The collectionMetadata that should be added

Returns:

The same instance of type VectorSearchFilter

getCollectionMetadata

@Nullable
public List<VectorKeyValueListPair> getCollectionMetadata()

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

Returns:

collectionMetadata The collectionMetadata of this VectorSearchFilter instance.

setCollectionMetadata

public void setCollectionMetadata(@Nullable
 List<VectorKeyValueListPair> collectionMetadata)

Set the collectionMetadata of this VectorSearchFilter instance.

Parameters:

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

documentMetadata

@Nonnull
public VectorSearchFilter documentMetadata(@Nullable
 List<VectorSearchDocumentKeyValueListPair> documentMetadata)

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

addDocumentMetadataItem

@Nonnull
public VectorSearchFilter addDocumentMetadataItem(@Nonnull
 VectorSearchDocumentKeyValueListPair documentMetadataItem)

Add one documentMetadata instance to this VectorSearchFilter.

Parameters:

documentMetadataItem - The documentMetadata that should be added

Returns:

The same instance of type VectorSearchFilter

getDocumentMetadata

@Nullable
public List<VectorSearchDocumentKeyValueListPair> getDocumentMetadata()

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

Returns:

documentMetadata The documentMetadata of this VectorSearchFilter instance.

setDocumentMetadata

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

Set the documentMetadata of this VectorSearchFilter instance.

Parameters:

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

chunkMetadata

@Nonnull
public VectorSearchFilter chunkMetadata(@Nullable
 List<VectorKeyValueListPair> chunkMetadata)

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

addChunkMetadataItem

@Nonnull
public VectorSearchFilter addChunkMetadataItem(@Nonnull
 VectorKeyValueListPair chunkMetadataItem)

Add one chunkMetadata instance to this VectorSearchFilter.

Parameters:

chunkMetadataItem - The chunkMetadata that should be added

Returns:

The same instance of type VectorSearchFilter

getChunkMetadata

@Nonnull
public List<VectorKeyValueListPair> getChunkMetadata()

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

Returns:

chunkMetadata The chunkMetadata of this VectorSearchFilter instance.

setChunkMetadata

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

Set the chunkMetadata of this VectorSearchFilter instance.

Parameters:

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

filter

@Nonnull
public VectorSearchFilter filter(@Nullable
 Filter filter)

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

Parameters:

filter - The filter of this VectorSearchFilter

Returns:

The same instance of this VectorSearchFilter class

getFilter

@Nullable
public Filter getFilter()

Get filter

Returns:

filter The filter of this VectorSearchFilter instance.

setFilter

public void setFilter(@Nullable
 Filter filter)

Set the filter of this VectorSearchFilter instance.

Parameters:

filter - The filter of this VectorSearchFilter

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the VectorSearchFilter.

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

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