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

Class RetrievalVectorSearchFilterFilter

java.lang.Object

com.sap.ai.sdk.grounding.model.RetrievalVectorSearchFilterFilter

public class RetrievalVectorSearchFilterFilter
extends Object

Filter to apply on the search results. This cannot be used together with 'documentMetadata'. The depth of the filter must not exceed 5 levels.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrievalVectorSearchFilterFilter.Builder	Builder helper class.
static interface	RetrievalVectorSearchFilterFilter.Builder1	Builder helper class.
static interface	RetrievalVectorSearchFilterFilter.Builder2	Builder helper class.
static interface	RetrievalVectorSearchFilterFilter.Builder3	Builder helper class.
static interface	RetrievalVectorSearchFilterFilter.Builder4	Builder helper class.
static enum	RetrievalVectorSearchFilterFilter.OperatorEnum	Gets or Sets operator
static enum	RetrievalVectorSearchFilterFilter.ScopeEnum	Gets or Sets scope

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RetrievalVectorSearchFilterFilter	addValueItem(String valueItem)	Add one value instance to this RetrievalVectorSearchFilterFilter.
static RetrievalVectorSearchFilterFilter.Builder	create()	Create a type-safe, fluent-api builder object to construct a new RetrievalVectorSearchFilterFilter instance with all required arguments.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the RetrievalVectorSearchFilterFilter.
String	getKey()	Get key
Left	getLeft()	Get left
RetrievalVectorSearchFilterFilter.OperatorEnum	getOperator()	Get operator
Right	getRight()	Get right
RetrievalVectorSearchFilterFilter.ScopeEnum	getScope()	Get scope
List<String>	getValue()	Get value
int	hashCode()
RetrievalVectorSearchFilterFilter	key(String key)	Set the key of this RetrievalVectorSearchFilterFilter instance and return the same instance.
RetrievalVectorSearchFilterFilter	left(Left left)	Set the left of this RetrievalVectorSearchFilterFilter instance and return the same instance.
RetrievalVectorSearchFilterFilter	operator(RetrievalVectorSearchFilterFilter.OperatorEnum operator)	Set the operator of this RetrievalVectorSearchFilterFilter instance and return the same instance.
RetrievalVectorSearchFilterFilter	right(Right right)	Set the right of this RetrievalVectorSearchFilterFilter instance and return the same instance.
RetrievalVectorSearchFilterFilter	scope(RetrievalVectorSearchFilterFilter.ScopeEnum scope)	Set the scope of this RetrievalVectorSearchFilterFilter instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this RetrievalVectorSearchFilterFilter instance.
void	setKey(String key)	Set the key of this RetrievalVectorSearchFilterFilter instance.
void	setLeft(Left left)	Set the left of this RetrievalVectorSearchFilterFilter instance.
void	setOperator(RetrievalVectorSearchFilterFilter.OperatorEnum operator)	Set the operator of this RetrievalVectorSearchFilterFilter instance.
void	setRight(Right right)	Set the right of this RetrievalVectorSearchFilterFilter instance.
void	setScope(RetrievalVectorSearchFilterFilter.ScopeEnum scope)	Set the scope of this RetrievalVectorSearchFilterFilter instance.
void	setValue(List<String> value)	Set the value of this RetrievalVectorSearchFilterFilter instance.
Map<String,Object>	toMap()	Get the value of all properties of this RetrievalVectorSearchFilterFilter instance including unrecognized properties.
String	toString()
RetrievalVectorSearchFilterFilter	value(List<String> value)	Set the value of this RetrievalVectorSearchFilterFilter instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievalVectorSearchFilterFilter

protected RetrievalVectorSearchFilterFilter()

Default constructor for RetrievalVectorSearchFilterFilter.

Method Details

operator

@Nonnull
public RetrievalVectorSearchFilterFilter operator(@Nonnull
 RetrievalVectorSearchFilterFilter.OperatorEnum operator)

Set the operator of this RetrievalVectorSearchFilterFilter instance and return the same instance.

Parameters:

operator - The operator of this RetrievalVectorSearchFilterFilter

Returns:

The same instance of this RetrievalVectorSearchFilterFilter class

getOperator

@Nonnull
public RetrievalVectorSearchFilterFilter.OperatorEnum getOperator()

Get operator

Returns:

operator The operator of this RetrievalVectorSearchFilterFilter instance.

setOperator

public void setOperator(@Nonnull
 RetrievalVectorSearchFilterFilter.OperatorEnum operator)

Set the operator of this RetrievalVectorSearchFilterFilter instance.

Parameters:

operator - The operator of this RetrievalVectorSearchFilterFilter

left

@Nonnull
public RetrievalVectorSearchFilterFilter left(@Nonnull
 Left left)

Set the left of this RetrievalVectorSearchFilterFilter instance and return the same instance.

Parameters:

left - The left of this RetrievalVectorSearchFilterFilter

Returns:

The same instance of this RetrievalVectorSearchFilterFilter class

getLeft

@Nonnull
public Left getLeft()

Get left

Returns:

left The left of this RetrievalVectorSearchFilterFilter instance.

setLeft

public void setLeft(@Nonnull
 Left left)

Set the left of this RetrievalVectorSearchFilterFilter instance.

Parameters:

left - The left of this RetrievalVectorSearchFilterFilter

right

@Nonnull
public RetrievalVectorSearchFilterFilter right(@Nonnull
 Right right)

Set the right of this RetrievalVectorSearchFilterFilter instance and return the same instance.

Parameters:

right - The right of this RetrievalVectorSearchFilterFilter

Returns:

The same instance of this RetrievalVectorSearchFilterFilter class

getRight

@Nonnull
public Right getRight()

Get right

Returns:

right The right of this RetrievalVectorSearchFilterFilter instance.

setRight

public void setRight(@Nonnull
 Right right)

Set the right of this RetrievalVectorSearchFilterFilter instance.

Parameters:

right - The right of this RetrievalVectorSearchFilterFilter

key

@Nonnull
public RetrievalVectorSearchFilterFilter key(@Nonnull
 String key)

Set the key of this RetrievalVectorSearchFilterFilter instance and return the same instance.

Parameters:

key - The key of this RetrievalVectorSearchFilterFilter

Returns:

The same instance of this RetrievalVectorSearchFilterFilter class

getKey

@Nonnull
public String getKey()

Get key

Returns:

key The key of this RetrievalVectorSearchFilterFilter instance.

setKey

public void setKey(@Nonnull
 String key)

Set the key of this RetrievalVectorSearchFilterFilter instance.

Parameters:

key - The key of this RetrievalVectorSearchFilterFilter

value

@Nonnull
public RetrievalVectorSearchFilterFilter value(@Nonnull
 List<String> value)

Set the value of this RetrievalVectorSearchFilterFilter instance and return the same instance.

Parameters:

value - The value of this RetrievalVectorSearchFilterFilter

Returns:

The same instance of this RetrievalVectorSearchFilterFilter class

addValueItem

@Nonnull
public RetrievalVectorSearchFilterFilter addValueItem(@Nonnull
 String valueItem)

Add one value instance to this RetrievalVectorSearchFilterFilter.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type RetrievalVectorSearchFilterFilter

getValue

@Nonnull
public List<String> getValue()

Get value

Returns:

value The value of this RetrievalVectorSearchFilterFilter instance.

setValue

public void setValue(@Nonnull
 List<String> value)

Set the value of this RetrievalVectorSearchFilterFilter instance.

Parameters:

value - The value of this RetrievalVectorSearchFilterFilter

scope

@Nonnull
public RetrievalVectorSearchFilterFilter scope(@Nullable
 RetrievalVectorSearchFilterFilter.ScopeEnum scope)

Set the scope of this RetrievalVectorSearchFilterFilter instance and return the same instance.

Parameters:

scope - The scope of this RetrievalVectorSearchFilterFilter

Returns:

The same instance of this RetrievalVectorSearchFilterFilter class

getScope

@Nonnull
public RetrievalVectorSearchFilterFilter.ScopeEnum getScope()

Get scope

Returns:

scope The scope of this RetrievalVectorSearchFilterFilter instance.

setScope

public void setScope(@Nullable
 RetrievalVectorSearchFilterFilter.ScopeEnum scope)

Set the scope of this RetrievalVectorSearchFilterFilter instance.

Parameters:

scope - The scope of this RetrievalVectorSearchFilterFilter

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RetrievalVectorSearchFilterFilter.

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

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