vecindexmgr

Documentation

Index

• Constants
• type IndexType
• type VecIndexMgr
  • func GetVecIndexMgrInstance() VecIndexMgr

Constants

const (
	BinaryFlag        uint64 = 1 << 0
	Float32Flag       uint64 = 1 << 1
	Float16Flag       uint64 = 1 << 2
	BFloat16Flag      uint64 = 1 << 3
	SparseFloat32Flag uint64 = 1 << 4

	// NOTrainFlag This flag indicates that there is no need to create any index structure
	NOTrainFlag uint64 = 1 << 16
	// KNNFlag This flag indicates that the index defaults to KNN search, meaning the recall rate is 100%
	KNNFlag uint64 = 1 << 17
	// GpuFlag This flag indicates that the index is deployed on GPU (need GPU devices)
	GpuFlag uint64 = 1 << 18
	// MmapFlag This flag indicates that the index support using mmap manage its mainly memory, which can significant improve the capacity
	MmapFlag uint64 = 1 << 19
	// MvFlag This flag indicates that the index support using materialized view to accelerate filtering search
	MvFlag uint64 = 1 << 20
	// DiskFlag This flag indicates that the index need disk
	DiskFlag uint64 = 1 << 21
)

Types

type IndexType

type IndexType = string

type VecIndexMgr

type VecIndexMgr interface {
	GetFeature(indexType IndexType) (uint64, bool)

	IsBinarySupport(indexType IndexType) bool
	IsFlat32Support(indexType IndexType) bool
	IsFlat16Support(indexType IndexType) bool
	IsBFlat16Support(indexType IndexType) bool
	IsSparseFloat32Support(indexType IndexType) bool
	IsDataTypeSupport(indexType IndexType, dataType schemapb.DataType) bool

	IsFlatVecIndex(indexType IndexType) bool
	IsNoTrainIndex(indexType IndexType) bool
	IsVecIndex(indexType IndexType) bool
	IsDiskANN(indexType IndexType) bool
	IsGPUVecIndex(indexType IndexType) bool
	IsDiskVecIndex(indexType IndexType) bool
	IsMMapSupported(indexType IndexType) bool
	IsMvSupported(indexType IndexType) bool
	// contains filtered or unexported methods
}

func GetVecIndexMgrInstance

func GetVecIndexMgrInstance() VecIndexMgr

GetVecIndexMgrInstance gets the instance of VecIndexMgrInstance.