Share via


VectorFilterMode Class

public final class VectorFilterMode
extends ExpandableStringEnum<VectorFilterMode>

Determines whether or not filters are applied before or after the vector search is performed.

Field Summary

Modifier and Type Field and Description
static final VectorFilterMode POST_FILTER

The filter will be applied after the candidate set of vector results is returned.

static final VectorFilterMode PRE_FILTER

The filter will be applied before the search query.

Constructor Summary

Constructor Description
VectorFilterMode()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of VectorFilterMode value.

Method Summary

Modifier and Type Method and Description
static VectorFilterMode fromString(String name)

Creates or finds a VectorFilterMode from its string representation.

static Collection<VectorFilterMode> values()

Gets known VectorFilterMode values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

POST_FILTER

public static final VectorFilterMode POST_FILTER

The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'.

PRE_FILTER

public static final VectorFilterMode PRE_FILTER

The filter will be applied before the search query.

Constructor Details

VectorFilterMode

@Deprecated
public VectorFilterMode()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of VectorFilterMode value.

Method Details

fromString

public static VectorFilterMode fromString(String name)

Creates or finds a VectorFilterMode from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding VectorFilterMode.

values

public static Collection values()

Gets known VectorFilterMode values.

Returns:

known VectorFilterMode values.

Applies to