IVectorIndex | Unreal Engine 5.8 Documentation

Abstract interface for vector similarity search indices.


Name	IVectorIndex
Type	class
Header File	/Engine/Plugins/Experimental/SemanticSearch/Source/SemanticSearch/Public/Interfaces/IVectorIndex.h
Include Path	#include "Interfaces/IVectorIndex.h"

Syntax

class IVectorIndex

Name	Remarks	Include Path	Unreal Specifiers
virtual ~IVectorIndex()		Interfaces/IVectorIndex.h

Name	Remarks	Include Path
void Add ( TConstArrayView< int64 > IDs, TConstArrayView< float > Vectors )	Add multiple vectors with corresponding IDs. Index must be trained first.	Interfaces/IVectorIndex.h
void Add ( int64 ID, TConstArrayView< float > Vector )		Interfaces/IVectorIndex.h
int64 GetCount()	Number of vectors currently in the index.	Interfaces/IVectorIndex.h
int32 GetDimension()	Embedding dimension.	Interfaces/IVectorIndex.h
bool IsTrained()	Whether the index has been trained and is ready for Add/Search.	Interfaces/IVectorIndex.h
void Remove ( TConstArrayView< int64 > IDs )	Remove vectors by IDs.	Interfaces/IVectorIndex.h
bool Remove ( int64 ID )		Interfaces/IVectorIndex.h
void Search ( TConstArrayView< float > QueryVector, int32 K, const TSharedRef< const TArray< int64 > >& IDFilter, float DistanceCutoff, TArray< uint32 >& Scratch, FGraphEventRef IndexReadCompleteEvent, TFunction< void(TArray< FSearchResult >&&)> Continuation ) const	Search for K nearest neighbors.	Interfaces/IVectorIndex.h
TArray< uint8 > Serialize()	Serialize the full index to a byte array.	Interfaces/IVectorIndex.h
void Train ( TConstArrayView< float > Vectors, int64 NumVectors )	Train the index on representative vectors. No-op for flat indices.	Interfaces/IVectorIndex.h

Name	Remarks	Include Path
virtual bool Contains ( int64 ID ) const	Returns true if a vector with the given ID exists in the index.	Interfaces/IVectorIndex.h
virtual int64 EstimateMemoryBytes()	Estimated memory usage in bytes. Returns 0 if not implemented.	Interfaces/IVectorIndex.h
virtual bool SupportsQuantization ()	Whether this index supports quantization.	Interfaces/IVectorIndex.h
virtual bool TryGetEmbedding ( int64 ID, TArray< float >& OutEmbedding ) const	Retrieve the embedding for a given ID. Returns false if not supported or ID not found.	Interfaces/IVectorIndex.h
virtual bool Update ( int64 OldID, int64 NewID )	Re-key a vector from OldID to NewID, preserving the embedding data.	Interfaces/IVectorIndex.h