Skip to main content

Class: HNSWVectorField

Defined in: schema/fields.ts:322

HNSWVectorField for HNSW algorithm

Extends​

Constructors​

Constructor​

new HNSWVectorField(name, attrs): HNSWVectorField

Defined in: schema/fields.ts:323

Parameters​

name​

string

attrs​

HNSWVectorFieldAttrs

Returns​

HNSWVectorField

Overrides​

BaseField.constructor

Methods​

toRedisField()​

toRedisField(isJson): any

Defined in: schema/fields.ts:335

Convert this field to Redis schema field format. Each subclass must implement this method to return the appropriate Redis field type.

Parameters​

isJson​

boolean

Whether the index uses JSON storage (affects field naming with $.prefix)

Returns​

any

Overrides​

BaseField.toRedisField

Properties​

attrs​

readonly attrs: HNSWVectorFieldAttrs

Defined in: schema/fields.ts:325

Inherited from​

BaseField.attrs


name​

readonly name: string

Defined in: schema/fields.ts:30

Inherited from​

BaseField.name


path?​

optional path?: string | null

Defined in: schema/fields.ts:33

Inherited from​

BaseField.path


type​

readonly type: string

Defined in: schema/fields.ts:31

Inherited from​

BaseField.type