%SQL.VectorIndex.KNNIndexer

class %SQL.VectorIndex.KNNIndexer extends %Library.RegisteredObject

Property Inventory

ClassName
Data
DataLocation
Dim
Distance
GraphLocation
IndexGlobalLocation
IndexName
K
OffSet
Point
Property
PropertyGlb
PropertyGlbListIdx

Method Inventory

%OnNew()
ComputeDistance()
Delete()
Insert()
Purge()
TopK()
Update()
getNext()

Properties

property ClassName as %String;

Property methods: ClassNameDisplayToLogical(), ClassNameGet(), ClassNameIsValid(), ClassNameLogicalToDisplay(), ClassNameLogicalToOdbc(), ClassNameNormalize(), ClassNameSet()

property Data as %String;

Property methods: DataDisplayToLogical(), DataGet(), DataIsValid(), DataLogicalToDisplay(), DataLogicalToOdbc(), DataNormalize(), DataSet()

property DataLocation as %String;

Property methods: DataLocationDisplayToLogical(), DataLocationGet(), DataLocationIsValid(), DataLocationLogicalToDisplay(), DataLocationLogicalToOdbc(), DataLocationNormalize(), DataLocationSet()

property Dim as %Integer (MINVAL = 1);

Property methods: DimDisplayToLogical(), DimGet(), DimIsValid(), DimLogicalToDisplay(), DimNormalize(), DimSet()

property Distance as %String [ InitialExpression = "COSINE" ];

Property methods: DistanceDisplayToLogical(), DistanceGet(), DistanceIsValid(), DistanceLogicalToDisplay(), DistanceLogicalToOdbc(), DistanceNormalize(), DistanceSet()

property GraphLocation as %String;

Property methods: GraphLocationDisplayToLogical(), GraphLocationGet(), GraphLocationIsValid(), GraphLocationLogicalToDisplay(), GraphLocationLogicalToOdbc(), GraphLocationNormalize(), GraphLocationSet()

property IndexGlobalLocation as %String;

Property methods: IndexGlobalLocationDisplayToLogical(), IndexGlobalLocationGet(), IndexGlobalLocationIsValid(), IndexGlobalLocationLogicalToDisplay(), IndexGlobalLocationLogicalToOdbc(), IndexGlobalLocationNormalize(), IndexGlobalLocationSet()

property IndexName as %String;

Property methods: IndexNameDisplayToLogical(), IndexNameGet(), IndexNameIsValid(), IndexNameLogicalToDisplay(), IndexNameLogicalToOdbc(), IndexNameNormalize(), IndexNameSet()

property K as %Integer (MINVAL = 1) [ InitialExpression = 5 ];

Property methods: KDisplayToLogical(), KGet(), KIsValid(), KLogicalToDisplay(), KNormalize(), KSet()

property OffSet as %Integer [ InitialExpression = 0 ];

Property methods: OffSetDisplayToLogical(), OffSetGet(), OffSetIsValid(), OffSetLogicalToDisplay(), OffSetNormalize(), OffSetSet()

property Point as %Vector;

Property methods: PointCalculateODBCLength(), PointDisplayToLogical(), PointGet(), PointHandleConversionError(), PointIsValid(), PointLogicalToDisplay(), PointLogicalToOdbc(), PointNormalize(), PointOdbcToLogical(), PointSet()

property Property as %String;

Property methods: PropertyDisplayToLogical(), PropertyGet(), PropertyIsValid(), PropertyLogicalToDisplay(), PropertyLogicalToOdbc(), PropertyNormalize(), PropertySet()

property PropertyGlb as %String;

Property methods: PropertyGlbDisplayToLogical(), PropertyGlbGet(), PropertyGlbIsValid(), PropertyGlbLogicalToDisplay(), PropertyGlbLogicalToOdbc(), PropertyGlbNormalize(), PropertyGlbSet()

property PropertyGlbListIdx as %Integer [ InitialExpression = 0 ];

Property methods: PropertyGlbListIdxDisplayToLogical(), PropertyGlbListIdxGet(), PropertyGlbListIdxIsValid(), PropertyGlbListIdxLogicalToDisplay(), PropertyGlbListIdxNormalize(), PropertyGlbListIdxSet()

Methods

method %OnNew(ClassName, IndexName, Distance, IndexProperty, DIM, IndexData) as %Status

Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method ComputeDistance(vec1 As %Vector, vec2 As %Vector, ByRef status As %Status) as %Library.Decimal

Compute the distance between vec1 and vec2, using the distance function specified in i%Distance Supported distance functions: "COSINE" and "DOTPRODUCT"

method Delete(pID, ByRef pArg, lock)

Removes row with id pID from the KNN index lock indicates if locking is in effect (lock=1) or not (lock =0).

method Insert(pID, ByRef pArg, lock)

Inserts row with id pID into the KNN index lock indicates if locking is in effect (lock=1) or not (lock =0).

method Purge(lock=1)

Purge the KNN index lock indicates if locking is in effect (lock=1) or not (lock =0). Default value is 1.

method TopK(point, k, additionalParameters...)

Find the top K nearest neighbor of point and store the results as a local array in i%TopK

method Update(pID, ByRef pArg, lock)

Update row with id pID in the KNN index lock indicates if locking is in effect (lock=1) or not (lock =0). Default value is 1.

method getNext(ByRef distance, ByRef id) as %Boolean

Returns by reference the next nearest neighbor to i%Point and the distance between this neighbor to i%Point

Subclasses

%SQL.VectorIndex.HNSWIndexer