Documentation
¶
Overview ¶
Package service manages the main logic of server.
Index ¶
- type Faiss
- type Option
- func WithAutoIndexCheckDuration(dur string) Option
- func WithAutoIndexDurationLimit(dur string) Option
- func WithAutoIndexLength(l int) Option
- func WithAutoSaveIndexDuration(dur string) Option
- func WithCopyOnWrite(enabled bool) Option
- func WithEnableInMemoryMode(enabled bool) Option
- func WithErrGroup(eg errgroup.Group) Option
- func WithIndexPath(path string) Option
- func WithInitialDelayMaxDuration(dur string) Option
- func WithLoadIndexTimeoutFactor(dur string) Option
- func WithMaxLoadIndexTimeout(dur string) Option
- func WithMinLoadIndexTimeout(dur string) Option
- func WithProactiveGC(enabled bool) Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Faiss ¶
type Faiss interface {
Start(ctx context.Context) <-chan error
Search(k, nprobe, nq uint32, xq []float32) (*payload.Search_Response, error)
Insert(uuid string, vec []float32) (err error)
InsertWithTime(uuid string, vec []float32, t int64) (err error)
Update(uuid string, vec []float32) (err error)
UpdateWithTime(uuid string, vec []float32, t int64) (err error)
UpdateTimestamp(uuid string, ts int64, force bool) (err error)
Delete(uuid string) (err error)
DeleteWithTime(uuid string, t int64) (err error)
Exists(uuid string) (uint32, bool)
CreateIndex(ctx context.Context) (err error)
SaveIndex(ctx context.Context) (err error)
CreateAndSaveIndex(ctx context.Context) (err error)
Train(nb int, vec []float32) (err error)
IsIndexing() bool
IsSaving() bool
Len() uint64
NumberOfCreateIndexExecution() uint64
NumberOfProactiveGCExecution() uint64
UUIDs(context.Context) (uuids []string)
InsertVQueueBufferLen() uint64
DeleteVQueueBufferLen() uint64
GetDimensionSize() int
GetTrainSize() int
Close(ctx context.Context) error
}
type Option ¶
type Option func(f *faiss) error
Option represent the functional option for faiss.
func WithAutoIndexCheckDuration ¶
WithAutoIndexCheckDuration returns the functional option to set the index check duration.
func WithAutoIndexDurationLimit ¶
WithAutoIndexDurationLimit returns the functional option to set the auto index duration limit.
func WithAutoIndexLength ¶
WithAutoIndexLength returns the functional option to set the auto index length.
func WithAutoSaveIndexDuration ¶
WithAutoSaveIndexDuration returns the functional option to set the auto save index duration.
func WithCopyOnWrite ¶
WithCopyOnWrite returns the functional option to set the CoW enable flag.
func WithEnableInMemoryMode ¶
WithEnableInMemoryMode returns the functional option to set the in memory mode flag.
func WithErrGroup ¶
WithErrGroup returns the functional option to set the error group.
func WithIndexPath ¶
WithIndexPath returns the functional option to set the index path of the Faiss.
func WithInitialDelayMaxDuration ¶
WithInitialDelayMaxDuration returns the functional option to set the initial delay duration.
func WithLoadIndexTimeoutFactor ¶
WithLoadIndexTimeoutFactor returns the functional option to set the factor of load index timeout.
func WithMaxLoadIndexTimeout ¶
WithMaxLoadIndexTimeout returns the functional option to set the maximum load index timeout.
func WithMinLoadIndexTimeout ¶
WithMinLoadIndexTimeout returns the functional option to set the minimal load index timeout.
func WithProactiveGC ¶
WithProactiveGC returns the functional option to set the proactive GC enable flag.
Source Files