Struct ChunkFilter

pub struct ChunkFilter {
    pub jsonb_prefilter: Option<Option<bool>>,
    pub must: Option<Option<Vec<ConditionType>>>,
    pub must_not: Option<Option<Vec<ConditionType>>>,
    pub should: Option<Option<Vec<ConditionType>>>,
}

ChunkFilter : Filters is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata.

Fields

jsonb_prefilter: Option<Option<bool>>

JOSNB prefilter tells the server to perform a full scan over the metadata JSONB column instead of using the filtered HNSW. Datasets on the enterprise plan with custom metadata indices will perform better with the filtered HNSW instead. When false, the server will use the filtered HNSW index to filter chunks. When true, the server will perform a full scan over the metadata JSONB column to filter chunks. Default is true.

must: Option<Option<Vec<ConditionType>>>

All of these field conditions have to match for the chunk to be included in the result set.

must_not: Option<Option<Vec<ConditionType>>>

None of these field conditions can match for the chunk to be included in the result set.

should: Option<Option<Vec<ConditionType>>>

Only one of these field conditions has to match for the chunk to be included in the result set.

Implementations

impl ChunkFilter

pub fn new() -> ChunkFilter

Filters is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata.

Trait Implementations

impl Clone for ChunkFilter

fn clone(&self) -> ChunkFilter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChunkFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ChunkFilter

fn default() -> ChunkFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChunkFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChunkFilter

fn eq(&self, other: &ChunkFilter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ChunkFilter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChunkFilter