Filter

All Implemented Interfaces:
```
public interface Filter

                    
```
This class represents a filter that can be applied during search in an EmbeddingStore. Many EmbeddingStores support a feature called metadata filtering. A Filter can be used for this. A Filter object can represent simple (e.g. type = 'documentation') and composite (e.g. type = 'documentation' AND year > 2020) filter expressions in an EmbeddingStore-agnostic way. Each EmbeddingStore implementation that supports metadata filtering is mapping Filter into it's native filter expression.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract boolean`	`test(Object object)`	Tests if a given object satisfies this Filter.
`Filter`	`and(Filter filter)`
`static Filter`	`and(Filter left, Filter right)`
`Filter`	`or(Filter filter)`
`static Filter`	`or(Filter left, Filter right)`
`static Filter`	`not(Filter expression)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Method Detail

test
```
 abstract boolean test(Object object)
```
Tests if a given object satisfies this Filter.

Parameters:

object - An object to test.

Returns:

true if a given object satisfies this Filter, false otherwise.

and
```
 Filter and(Filter filter)
```

and

 static Filter and(Filter left, Filter right)

or
```
 Filter or(Filter filter)
```

or

 static Filter or(Filter left, Filter right)

not
```
 static Filter not(Filter expression)
```