zvec

package module

Go to main page

Versions in this module

v0

v0.6.0

Jul 20, 2026

Changes in this version

+ type DiskANNQueryParams struct

+ func NewDiskANNQueryParams(listSize int) *DiskANNQueryParams

+ func (p *DiskANNQueryParams) Destroy()

+ func (p *DiskANNQueryParams) GetIsLinear() bool

+ func (p *DiskANNQueryParams) GetIsUsingRefiner() bool

+ func (p *DiskANNQueryParams) GetListSize() int

+ func (p *DiskANNQueryParams) GetRadius() float32

+ func (p *DiskANNQueryParams) SetIsLinear(isLinear bool) error

+ func (p *DiskANNQueryParams) SetIsUsingRefiner(isUsingRefiner bool) error

+ func (p *DiskANNQueryParams) SetListSize(listSize int) error

+ func (p *DiskANNQueryParams) SetRadius(radius float32) error

type GroupBySearchQuery

+ func (q *GroupBySearchQuery) SetDiskANNParams(params *DiskANNQueryParams) error

+ func (q *GroupBySearchQuery) SetTopkPerGroup(topk uint32) error

type IndexParams

+ func NewDiskANNIndexParams(metric MetricType, maxDegree, listSize, pqChunkNum int) (*IndexParams, error)

+ func (p *IndexParams) GetDiskANNListSize() int

+ func (p *IndexParams) GetDiskANNMaxDegree() int

+ func (p *IndexParams) GetDiskANNPQChunkNum() int

+ func (p *IndexParams) SetDiskANNParams(maxDegree, listSize, pqChunkNum int) error

type IndexType

+ const IndexTypeDiskANN

type SearchQuery

+ func (q *SearchQuery) SetDiskANNParams(params *DiskANNQueryParams) error

type SubQuery

+ func (q *SubQuery) SetDiskANNParams(params *DiskANNQueryParams) error

v0.5.1

Jul 8, 2026

Changes in this version

type SubQuery

+ func (q *SubQuery) SetFTS(fts *FTS) error

+ func (q *SubQuery) SetFTSParams(params *FTSQueryParams) error

v0.5.0

Jun 10, 2026

Changes in this version

+ func GetDefaultJiebaDictDir() string

+ func SetDefaultJiebaDictDir(dir string)

type Collection

+ func (c *Collection) MultiQuery(query *MultiQuery) ([]*Doc, error)

type ConfigData

+ func (c *ConfigData) GetFTSBruteForceByKeysRatio() float32

+ func (c *ConfigData) GetJiebaDictDir() string

+ func (c *ConfigData) SetFTSBruteForceByKeysRatio(ratio float32) error

+ func (c *ConfigData) SetJiebaDictDir(dir string) error

type DataType

+ func (d DataType) String() string

type DocOperator

+ func (d DocOperator) String() string

type ErrorCode

+ const AlreadyExists

+ const FailedPrecondition

+ const InternalError

+ const InvalidArgument

+ const NotFound

+ const NotSupported

+ const OK

+ const PermissionDenied

+ const ResourceExhausted

+ const Unavailable

+ const Unknown

+ func (c ErrorCode) String() string

+ type FTS struct

+ func NewFTS() *FTS

+ func (f *FTS) Destroy()

+ func (f *FTS) GetMatchString() string

+ func (f *FTS) GetQueryString() string

+ func (f *FTS) SetMatchString(match string) error

+ func (f *FTS) SetQueryString(query string) error

+ type FTSQueryParams struct

+ func NewFTSQueryParams(defaultOperator string) *FTSQueryParams

+ func (p *FTSQueryParams) Destroy()

+ func (p *FTSQueryParams) GetDefaultOperator() string

+ func (p *FTSQueryParams) SetDefaultOperator(op string) error

+ type FetchOptions struct

+ IncludeVector bool

+ OutputFields []string

+ type GroupBySearchQuery struct

+ func NewGroupBySearchQuery() *GroupBySearchQuery

+ func (q *GroupBySearchQuery) Destroy()

+ func (q *GroupBySearchQuery) SetFieldName(name string) error

+ func (q *GroupBySearchQuery) SetFilter(filter string) error

+ func (q *GroupBySearchQuery) SetFlatParams(params *FlatQueryParams) error

+ func (q *GroupBySearchQuery) SetGroupByFieldName(name string) error

+ func (q *GroupBySearchQuery) SetGroupCount(count uint32) error

+ func (q *GroupBySearchQuery) SetGroupTopK(topk uint32) error

+ func (q *GroupBySearchQuery) SetHNSWParams(params *HNSWQueryParams) error

+ func (q *GroupBySearchQuery) SetIVFParams(params *IVFQueryParams) error

+ func (q *GroupBySearchQuery) SetIncludeVector(include bool) error

+ func (q *GroupBySearchQuery) SetOutputFields(fields []string) error

+ func (q *GroupBySearchQuery) SetQueryVector(data []float32) error

type IndexParams

+ func NewFTSIndexParams(tokenizerName string, filters []string, extraParams string) (*IndexParams, error)

+ func (p *IndexParams) GetFTSParams() (tokenizerName string, filters []string, extraParams string, err error)

+ func (p *IndexParams) SetFTSParams(tokenizerName string, filters []string, extraParams string) error

type IndexType

+ const IndexTypeFTS

+ func (i IndexType) String() string

type LogLevel

+ func (l LogLevel) String() string

type MetricType

+ func (m MetricType) String() string

+ type MultiQuery struct

+ func NewMultiQuery() *MultiQuery

+ func (q *MultiQuery) AddSubQuery(sub *SubQuery) error

+ func (q *MultiQuery) Destroy()

+ func (q *MultiQuery) GetFilter() string

+ func (q *MultiQuery) GetIncludeVector() bool

+ func (q *MultiQuery) GetSubQueryCount() int

+ func (q *MultiQuery) GetTopK() int

+ func (q *MultiQuery) SetFilter(filter string) error

+ func (q *MultiQuery) SetIncludeVector(include bool) error

+ func (q *MultiQuery) SetOutputFields(fields []string) error

+ func (q *MultiQuery) SetRerankRRF(rankConstant int) error

+ func (q *MultiQuery) SetRerankWeighted(weights []float64) error

+ func (q *MultiQuery) SetTopK(topk int) error

type QuantizeType

+ func (q QuantizeType) String() string

+ type SearchQuery struct

+ func NewSearchQuery() *SearchQuery

+ func (q *SearchQuery) Destroy()

+ func (q *SearchQuery) GetFTS() *FTS

+ func (q *SearchQuery) GetFieldName() string

+ func (q *SearchQuery) GetFilter() string

+ func (q *SearchQuery) GetIncludeDocID() bool

+ func (q *SearchQuery) GetIncludeVector() bool

+ func (q *SearchQuery) GetTopK() int

+ func (q *SearchQuery) SetFTS(fts *FTS) error

+ func (q *SearchQuery) SetFTSParams(params *FTSQueryParams) error

+ func (q *SearchQuery) SetFieldName(name string) error

+ func (q *SearchQuery) SetFilter(filter string) error

+ func (q *SearchQuery) SetFlatParams(params *FlatQueryParams) error

+ func (q *SearchQuery) SetHNSWParams(params *HNSWQueryParams) error

+ func (q *SearchQuery) SetIVFParams(params *IVFQueryParams) error

+ func (q *SearchQuery) SetIncludeDocID(include bool) error

+ func (q *SearchQuery) SetIncludeVector(include bool) error

+ func (q *SearchQuery) SetOutputFields(fields []string) error

+ func (q *SearchQuery) SetQueryVector(data []float32) error

+ func (q *SearchQuery) SetTopK(topk int) error

+ type SubQuery struct

+ func NewSubQuery() *SubQuery

+ func (q *SubQuery) Destroy()

+ func (q *SubQuery) GetFieldName() string

+ func (q *SubQuery) GetNumCandidates() int

+ func (q *SubQuery) SetFieldName(name string) error

+ func (q *SubQuery) SetFlatParams(params *FlatQueryParams) error

+ func (q *SubQuery) SetHNSWParams(params *HNSWQueryParams) error

+ func (q *SubQuery) SetIVFParams(params *IVFQueryParams) error

+ func (q *SubQuery) SetNumCandidates(n int) error

+ func (q *SubQuery) SetQueryVector(data []float32) error

+ func (q *SubQuery) SetSparseVector(indices []uint32, values []float32) error

v0.3.1

Apr 25, 2026

Changes in this version

+ var ErrAlreadyExistsError = &Error

+ var ErrFailedPreconditionError = &Error

+ var ErrInternalErrorError = &Error

+ var ErrInvalidArgumentError = &Error

+ var ErrNotFoundError = &Error

+ var ErrNotSupportedError = &Error

+ var ErrPermissionDeniedError = &Error

+ var ErrResourceExhaustedError = &Error

+ var ErrUnavailableError = &Error

+ var ErrUnknownError = &Error

+ func CheckVersion(major, minor, patch int) bool

+ func ClearError()

+ func FreeDocs(docs []*Doc)

+ func GetVersion() string

+ func GetVersionMajor() int

+ func GetVersionMinor() int

+ func GetVersionPatch() int

+ func Initialize(config *ConfigData) error

+ func IsAlreadyExists(err error) bool

+ func IsInitialized() bool

+ func IsInvalidArgument(err error) bool

+ func IsNotFound(err error) bool

+ func Shutdown() error

+ type Collection struct

+ func CreateAndOpen(path string, schema *CollectionSchema, options *CollectionOptions) (*Collection, error)

+ func Open(path string, options *CollectionOptions) (*Collection, error)

+ func (c *Collection) AddColumn(fieldSchema *FieldSchema, defaultExpr string) error

+ func (c *Collection) AlterColumn(columnName, newName string, newSchema *FieldSchema) error

+ func (c *Collection) Close() error

+ func (c *Collection) CreateIndex(fieldName string, params *IndexParams) error

+ func (c *Collection) Delete(pks []string) (*WriteResult, error)

+ func (c *Collection) DeleteByFilter(filter string) error

+ func (c *Collection) Destroy() error

+ func (c *Collection) DropColumn(columnName string) error

+ func (c *Collection) DropIndex(fieldName string) error

+ func (c *Collection) Fetch(primaryKeys []string) ([]*Doc, error)

+ func (c *Collection) Flush() error

+ func (c *Collection) GetOptions() (*CollectionOptions, error)

+ func (c *Collection) GetSchema() (*CollectionSchema, error)

+ func (c *Collection) GetStats() (*CollectionStats, error)

+ func (c *Collection) Insert(docs []*Doc) (*WriteResult, error)

+ func (c *Collection) Optimize() error

+ func (c *Collection) Query(query *VectorQuery) ([]*Doc, error)

+ func (c *Collection) Update(docs []*Doc) (*WriteResult, error)

+ func (c *Collection) Upsert(docs []*Doc) (*WriteResult, error)

+ type CollectionOptions struct

+ func NewCollectionOptions() *CollectionOptions

+ func (o *CollectionOptions) Destroy()

+ func (o *CollectionOptions) GetEnableMmap() bool

+ func (o *CollectionOptions) GetMaxBufferSize() uint64

+ func (o *CollectionOptions) GetReadOnly() bool

+ func (o *CollectionOptions) SetEnableMmap(enable bool) error

+ func (o *CollectionOptions) SetMaxBufferSize(size uint64) error

+ func (o *CollectionOptions) SetReadOnly(readOnly bool) error

+ type CollectionSchema struct

+ func NewCollectionSchema(name string) *CollectionSchema

+ func (s *CollectionSchema) AddField(field *FieldSchema) error

+ func (s *CollectionSchema) AddIndex(fieldName string, params *IndexParams) error

+ func (s *CollectionSchema) Destroy()

+ func (s *CollectionSchema) DropField(name string) error

+ func (s *CollectionSchema) DropIndex(fieldName string) error

+ func (s *CollectionSchema) GetField(name string) *FieldSchema

+ func (s *CollectionSchema) GetMaxDocCountPerSegment() uint64

+ func (s *CollectionSchema) GetName() string

+ func (s *CollectionSchema) HasField(name string) bool

+ func (s *CollectionSchema) HasIndex(fieldName string) bool

+ func (s *CollectionSchema) SetMaxDocCountPerSegment(count uint64) error

+ func (s *CollectionSchema) SetName(name string) error

+ type CollectionStats struct

+ DocCount uint64

+ IndexCompleteness []float32

+ IndexCount int

+ IndexNames []string

+ type ConfigData struct

+ func NewConfigData() *ConfigData

+ func (c *ConfigData) Destroy()

+ func (c *ConfigData) GetMemoryLimit() uint64

+ func (c *ConfigData) GetOptimizeThreadCount() uint32

+ func (c *ConfigData) GetQueryThreadCount() uint32

+ func (c *ConfigData) SetConsoleLog(level LogLevel) error

+ func (c *ConfigData) SetFileLog(level LogLevel, dir, basename string, fileSizeMB, overdueDays uint32) error

+ func (c *ConfigData) SetMemoryLimit(bytes uint64) error

+ func (c *ConfigData) SetOptimizeThreadCount(count uint32) error

+ func (c *ConfigData) SetQueryThreadCount(count uint32) error

+ type DataType uint32

+ const DataTypeArrayBinary

+ const DataTypeArrayBool

+ const DataTypeArrayDouble

+ const DataTypeArrayFloat

+ const DataTypeArrayInt32

+ const DataTypeArrayInt64

+ const DataTypeArrayString

+ const DataTypeArrayUint32

+ const DataTypeArrayUint64

+ const DataTypeBinary

+ const DataTypeBool

+ const DataTypeDouble

+ const DataTypeFloat

+ const DataTypeInt32

+ const DataTypeInt64

+ const DataTypeSparseVectorFP16

+ const DataTypeSparseVectorFP32

+ const DataTypeString

+ const DataTypeUint32

+ const DataTypeUint64

+ const DataTypeUndefined

+ const DataTypeVectorBinary32

+ const DataTypeVectorBinary64

+ const DataTypeVectorFP16

+ const DataTypeVectorFP32

+ const DataTypeVectorFP64

+ const DataTypeVectorInt16

+ const DataTypeVectorInt4

+ const DataTypeVectorInt8

+ type Doc struct

+ func NewDoc() *Doc

+ func (d *Doc) AddBinaryField(name string, data []byte) error

+ func (d *Doc) AddBoolField(name string, value bool) error

+ func (d *Doc) AddDoubleField(name string, value float64) error

+ func (d *Doc) AddFloatField(name string, value float32) error

+ func (d *Doc) AddInt32Field(name string, value int32) error

+ func (d *Doc) AddInt64Field(name string, value int64) error

+ func (d *Doc) AddStringField(name, value string) error

+ func (d *Doc) AddUint32Field(name string, value uint32) error

+ func (d *Doc) AddUint64Field(name string, value uint64) error

+ func (d *Doc) AddVectorFP32Field(name string, vector []float32) error

+ func (d *Doc) Clear()

+ func (d *Doc) Destroy()

+ func (d *Doc) GetBoolField(name string) (bool, error)

+ func (d *Doc) GetDocID() uint64

+ func (d *Doc) GetDoubleField(name string) (float64, error)

+ func (d *Doc) GetFieldCount() int

+ func (d *Doc) GetFieldNames() ([]string, error)

+ func (d *Doc) GetFloatField(name string) (float32, error)

+ func (d *Doc) GetInt32Field(name string) (int32, error)

+ func (d *Doc) GetInt64Field(name string) (int64, error)

+ func (d *Doc) GetOperator() DocOperator

+ func (d *Doc) GetPK() string

+ func (d *Doc) GetScore() float32

+ func (d *Doc) GetStringField(name string) (string, error)

+ func (d *Doc) GetUint32Field(name string) (uint32, error)

+ func (d *Doc) GetUint64Field(name string) (uint64, error)

+ func (d *Doc) GetVectorFP32Field(name string) ([]float32, error)

+ func (d *Doc) HasField(name string) bool

+ func (d *Doc) HasFieldValue(name string) bool

+ func (d *Doc) IsEmpty() bool

+ func (d *Doc) IsFieldNull(name string) bool

+ func (d *Doc) RemoveField(name string) error

+ func (d *Doc) SetDocID(docID uint64)

+ func (d *Doc) SetFieldNull(name string) error

+ func (d *Doc) SetOperator(op DocOperator)

+ func (d *Doc) SetPK(pk string)

+ func (d *Doc) SetScore(score float32)

+ type DocOperator int

+ const DocOpDelete

+ const DocOpInsert

+ const DocOpUpdate

+ const DocOpUpsert

+ type Error struct

+ Code ErrorCode

+ Message string

+ func (e *Error) Error() string

+ type ErrorCode int

+ const ErrAlreadyExists

+ const ErrFailedPrecondition

+ const ErrInternalError

+ const ErrInvalidArgument

+ const ErrNotFound

+ const ErrNotSupported

+ const ErrOK

+ const ErrPermissionDenied

+ const ErrResourceExhausted

+ const ErrUnavailable

+ const ErrUnknown

+ type FieldSchema struct

+ func NewFieldSchema(name string, dataType DataType, nullable bool, dimension uint32) *FieldSchema

+ func (f *FieldSchema) Destroy()

+ func (f *FieldSchema) GetDataType() DataType

+ func (f *FieldSchema) GetDimension() uint32

+ func (f *FieldSchema) GetIndexType() IndexType

+ func (f *FieldSchema) GetName() string

+ func (f *FieldSchema) HasIndex() bool

+ func (f *FieldSchema) IsDenseVector() bool

+ func (f *FieldSchema) IsNullable() bool

+ func (f *FieldSchema) IsSparseVector() bool

+ func (f *FieldSchema) IsVectorField() bool

+ func (f *FieldSchema) SetDataType(dataType DataType) error

+ func (f *FieldSchema) SetDimension(dimension uint32) error

+ func (f *FieldSchema) SetIndexParams(params *IndexParams) error

+ func (f *FieldSchema) SetName(name string) error

+ func (f *FieldSchema) SetNullable(nullable bool) error

+ type FlatQueryParams struct

+ func NewFlatQueryParams(isUsingRefiner bool, scaleFactor float32) *FlatQueryParams

+ func (p *FlatQueryParams) Destroy()

+ type GroupByVectorQuery struct

+ func NewGroupByVectorQuery() *GroupByVectorQuery

+ func (q *GroupByVectorQuery) Destroy()

+ func (q *GroupByVectorQuery) SetFieldName(name string) error

+ func (q *GroupByVectorQuery) SetFilter(filter string) error

+ func (q *GroupByVectorQuery) SetFlatParams(params *FlatQueryParams) error

+ func (q *GroupByVectorQuery) SetGroupByFieldName(name string) error

+ func (q *GroupByVectorQuery) SetGroupCount(count uint32) error

+ func (q *GroupByVectorQuery) SetGroupTopK(topk uint32) error

+ func (q *GroupByVectorQuery) SetHNSWParams(params *HNSWQueryParams) error

+ func (q *GroupByVectorQuery) SetIVFParams(params *IVFQueryParams) error

+ func (q *GroupByVectorQuery) SetIncludeVector(include bool) error

+ func (q *GroupByVectorQuery) SetOutputFields(fields []string) error

+ func (q *GroupByVectorQuery) SetQueryVector(data []float32) error

+ type HNSWQueryParams struct

+ func NewHNSWQueryParams(ef int, radius float32, isLinear, isUsingRefiner bool) *HNSWQueryParams

+ func (p *HNSWQueryParams) Destroy()

+ func (p *HNSWQueryParams) GetEf() int

+ func (p *HNSWQueryParams) SetEf(ef int) error

+ type IVFQueryParams struct

+ func NewIVFQueryParams(nprobe int, isUsingRefiner bool, scaleFactor float32) *IVFQueryParams

+ func (p *IVFQueryParams) Destroy()

+ func (p *IVFQueryParams) SetNprobe(nprobe int) error

+ type IndexParams struct

+ func NewFlatIndexParams(metric MetricType) *IndexParams

+ func NewHNSWIndexParams(metric MetricType, m, efConstruction int) *IndexParams

+ func NewIVFIndexParams(metric MetricType, nList, nIters int, useSoar bool) *IndexParams

+ func NewIndexParams(indexType IndexType) *IndexParams

+ func NewInvertIndexParams(enableRangeOpt, enableWildcard bool) *IndexParams

+ func (p *IndexParams) Destroy()

+ func (p *IndexParams) GetHNSWEfConstruction() int

+ func (p *IndexParams) GetHNSWM() int

+ func (p *IndexParams) GetMetricType() MetricType

+ func (p *IndexParams) GetQuantizeType() QuantizeType

+ func (p *IndexParams) GetType() IndexType

+ func (p *IndexParams) SetHNSWParams(m, efConstruction int) error

+ func (p *IndexParams) SetIVFParams(nList, nIters int, useSoar bool) error

+ func (p *IndexParams) SetInvertParams(enableRangeOpt, enableWildcard bool) error

+ func (p *IndexParams) SetMetricType(metric MetricType) error

+ func (p *IndexParams) SetQuantizeType(quantize QuantizeType) error

+ type IndexType uint32

+ const IndexTypeFlat

+ const IndexTypeHNSW

+ const IndexTypeIVF

+ const IndexTypeInvert

+ const IndexTypeUndefined

+ type LogLevel int

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelFatal

+ const LogLevelInfo

+ const LogLevelWarn

+ type MetricType uint32

+ const MetricTypeCosine

+ const MetricTypeIP

+ const MetricTypeL2

+ const MetricTypeMIPSL2

+ const MetricTypeUndefined

+ type QuantizeType uint32

+ const QuantizeTypeFP16

+ const QuantizeTypeInt4

+ const QuantizeTypeInt8

+ const QuantizeTypeUndefined

+ type VectorQuery struct

+ func NewVectorQuery() *VectorQuery

+ func (q *VectorQuery) Destroy()

+ func (q *VectorQuery) GetFieldName() string

+ func (q *VectorQuery) GetFilter() string

+ func (q *VectorQuery) GetIncludeDocID() bool

+ func (q *VectorQuery) GetIncludeVector() bool

+ func (q *VectorQuery) GetTopK() int

+ func (q *VectorQuery) SetFieldName(name string) error

+ func (q *VectorQuery) SetFilter(filter string) error

+ func (q *VectorQuery) SetFlatParams(params *FlatQueryParams) error

+ func (q *VectorQuery) SetHNSWParams(params *HNSWQueryParams) error

+ func (q *VectorQuery) SetIVFParams(params *IVFQueryParams) error

+ func (q *VectorQuery) SetIncludeDocID(include bool) error

+ func (q *VectorQuery) SetIncludeVector(include bool) error

+ func (q *VectorQuery) SetOutputFields(fields []string) error

+ func (q *VectorQuery) SetQueryVector(data []float32) error

+ func (q *VectorQuery) SetTopK(topk int) error

+ type WriteResult struct

+ ErrorCount uint64

+ SuccessCount uint64

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL