VectorSearchOptions Class

Options for vector search, builds on TextSearchOptions.

Note: This class is marked as 'experimental' and may change in the future.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Constructor

VectorSearchOptions(*, filter: VectorSearchFilter = None, include_total_count: bool = False, vector_field_name: str | None = None, top: Annotated[int, Gt(gt=0)] = 3, skip: Annotated[int, Ge(ge=0)] = 0, include_vectors: bool = False)

Keyword-Only Parameters

Name	Description
filter Required
include_total_count Required
vector_field_name Required
top	Default value: 3
skip Required
include_vectors Required

Attributes

filter

filter: VectorSearchFilter

include_vectors

include_vectors: bool

is_experimental

is_experimental = True

skip

skip: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0)])]

stage_status

stage_status = 'experimental'

top

top: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]

vector_field_name

vector_field_name: str | None