flat

Documentation

Index

• Constants
• func ParseAndValidateConfig(input interface{}) (schema.VectorIndexConfig, error)
• type CompressionUserConfig
• type UserConfig
  • func NewDefaultUserConfig() UserConfig
  • func (u UserConfig) DistanceName() string
  • func (u UserConfig) IndexType() string
  • func (u *UserConfig) SetDefaults()

Constants

const (
	DefaultVectorCache           = false
	DefaultVectorCacheMaxObjects = 1e12
	DefaultCompressionEnabled    = false
	DefaultCompressionRescore    = -1 // indicates "let Weaviate pick"
)

Functions

func ParseAndValidateConfig

func ParseAndValidateConfig(input interface{}) (schema.VectorIndexConfig, error)

ParseAndValidateConfig from an unknown input value, as this is not further specified in the API to allow of exchanging the index type

Types

type CompressionUserConfig

type CompressionUserConfig struct {
	Enabled      bool `json:"enabled"`
	RescoreLimit int  `json:"rescoreLimit"`
	Cache        bool `json:"cache"`
}

type UserConfig

type UserConfig struct {
	Distance              string                `json:"distance"`
	VectorCacheMaxObjects int                   `json:"vectorCacheMaxObjects"`
	PQ                    CompressionUserConfig `json:"pq"`
	BQ                    CompressionUserConfig `json:"bq"`
}

func NewDefaultUserConfig

func NewDefaultUserConfig() UserConfig

func (UserConfig) DistanceName

func (u UserConfig) DistanceName() string

func (UserConfig) IndexType

func (u UserConfig) IndexType() string

IndexType returns the type of the underlying vector index, thus making sure the schema.VectorIndexConfig interface is implemented

func (*UserConfig) SetDefaults

func (u *UserConfig) SetDefaults()

SetDefaults in the user-specifyable part of the config