settings

package
v1.34.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License: BSD-3-Clause Imports: 9 Imported by: 1

Documentation

Index

Constants

View Source
const (
	ImageFieldsProperty   = "imageFields"
	TextFieldsProperty    = "textFields"
	AudioFieldsProperty   = "audioFields"
	VideoFieldsProperty   = "videoFields"
	ImuFieldsProperty     = "imuFields"
	ThermalFieldsProperty = "thermalFields"
	DepthFieldsProperty   = "depthFields"
)
View Source
const (
	DefaultPropertyIndexed       = true
	DefaultVectorizeClassName    = true
	DefaultVectorizePropertyName = false
)

Variables

This section is empty.

Functions

func ValidateSetting added in v1.25.0

func ValidateSetting[T string | int64](value T, availableValues []T) bool

Types

type BaseClassMultiModalSettings added in v1.31.21

type BaseClassMultiModalSettings struct {
	*BaseClassSettings
}

func NewBaseClassMultiModalSettingsWithAltNames added in v1.31.21

func NewBaseClassMultiModalSettingsWithAltNames(cfg moduletools.ClassConfig,
	lowerCaseInput bool, moduleName string, altNames []string, customModelParameterName []string,
) *BaseClassMultiModalSettings

func (*BaseClassMultiModalSettings) AudioField added in v1.31.21

func (s *BaseClassMultiModalSettings) AudioField(property string) bool

func (*BaseClassMultiModalSettings) AudioFieldsWeights added in v1.31.21

func (s *BaseClassMultiModalSettings) AudioFieldsWeights() ([]float32, error)

func (*BaseClassMultiModalSettings) DepthField added in v1.31.21

func (s *BaseClassMultiModalSettings) DepthField(property string) bool

func (*BaseClassMultiModalSettings) DepthFieldsWeights added in v1.31.21

func (s *BaseClassMultiModalSettings) DepthFieldsWeights() ([]float32, error)

func (*BaseClassMultiModalSettings) IMUField added in v1.31.21

func (s *BaseClassMultiModalSettings) IMUField(property string) bool

func (*BaseClassMultiModalSettings) IMUFieldsWeights added in v1.31.21

func (s *BaseClassMultiModalSettings) IMUFieldsWeights() ([]float32, error)

func (*BaseClassMultiModalSettings) ImageField added in v1.31.21

func (s *BaseClassMultiModalSettings) ImageField(property string) bool

func (*BaseClassMultiModalSettings) ImageFieldsWeights added in v1.31.21

func (s *BaseClassMultiModalSettings) ImageFieldsWeights() ([]float32, error)

func (*BaseClassMultiModalSettings) TextField added in v1.31.21

func (s *BaseClassMultiModalSettings) TextField(property string) bool

func (*BaseClassMultiModalSettings) TextFieldsWeights added in v1.31.21

func (s *BaseClassMultiModalSettings) TextFieldsWeights() ([]float32, error)

func (*BaseClassMultiModalSettings) ThermalField added in v1.31.21

func (s *BaseClassMultiModalSettings) ThermalField(property string) bool

func (*BaseClassMultiModalSettings) ThermalFieldsWeights added in v1.31.21

func (s *BaseClassMultiModalSettings) ThermalFieldsWeights() ([]float32, error)

func (*BaseClassMultiModalSettings) ValidateMultiModal added in v1.31.21

func (s *BaseClassMultiModalSettings) ValidateMultiModal(fields []string) error

func (*BaseClassMultiModalSettings) VectorizableProperties added in v1.31.21

func (s *BaseClassMultiModalSettings) VectorizableProperties(fields []string) ([]string, error)

func (*BaseClassMultiModalSettings) VideoField added in v1.31.21

func (s *BaseClassMultiModalSettings) VideoField(property string) bool

func (*BaseClassMultiModalSettings) VideoFieldsWeights added in v1.31.21

func (s *BaseClassMultiModalSettings) VideoFieldsWeights() ([]float32, error)

type BaseClassSettings

type BaseClassSettings struct {
	// contains filtered or unexported fields
}

func NewBaseClassSettings

func NewBaseClassSettings(cfg moduletools.ClassConfig, lowerCaseInput bool) *BaseClassSettings

func NewBaseClassSettingsWithAltNames added in v1.25.21

func NewBaseClassSettingsWithAltNames(cfg moduletools.ClassConfig,
	lowerCaseInput bool, moduleName string, altNames []string, customModelParameterName []string,
) *BaseClassSettings

func NewBaseClassSettingsWithCustomModel added in v1.25.25

func NewBaseClassSettingsWithCustomModel(cfg moduletools.ClassConfig, lowerCaseInput bool, customModelParameterName string) *BaseClassSettings

func (BaseClassSettings) GetNumber added in v1.24.5

func (s BaseClassSettings) GetNumber(in any) (float32, error)

func (BaseClassSettings) GetPropertyAsBool added in v1.24.5

func (s BaseClassSettings) GetPropertyAsBool(name string, defaultValue bool) bool

func (BaseClassSettings) GetPropertyAsInt64 added in v1.24.5

func (s BaseClassSettings) GetPropertyAsInt64(name string, defaultValue *int64) *int64

func (BaseClassSettings) GetPropertyAsString added in v1.24.5

func (s BaseClassSettings) GetPropertyAsString(name, defaultValue string) string

func (BaseClassSettings) GetSettings added in v1.25.21

func (s BaseClassSettings) GetSettings() map[string]any

func (BaseClassSettings) LowerCaseInput added in v1.27.0

func (s BaseClassSettings) LowerCaseInput() bool

func (BaseClassSettings) Model added in v1.25.25

func (s BaseClassSettings) Model() string

func (BaseClassSettings) Properties

func (s BaseClassSettings) Properties() []string

func (BaseClassSettings) PropertyIndexed

func (s BaseClassSettings) PropertyIndexed(propName string) bool

func (BaseClassSettings) Validate

func (s BaseClassSettings) Validate(class *models.Class) error

func (BaseClassSettings) ValidateClassSettings added in v1.25.0

func (s BaseClassSettings) ValidateClassSettings() error

func (BaseClassSettings) ValidateIndexState added in v1.25.0

func (s BaseClassSettings) ValidateIndexState(class *models.Class) error

func (BaseClassSettings) VectorizeClassName

func (s BaseClassSettings) VectorizeClassName() bool

func (BaseClassSettings) VectorizePropertyName

func (s BaseClassSettings) VectorizePropertyName(propName string) bool

type PropertyValuesHelper added in v1.24.5

type PropertyValuesHelper interface {
	GetPropertyAsInt(cfg moduletools.ClassConfig, name string, defaultValue *int) *int
	GetPropertyAsIntWithNotExists(cfg moduletools.ClassConfig, name string, defaultValue, notExistsValue *int) *int
	GetPropertyAsInt64(cfg moduletools.ClassConfig, name string, defaultValue *int64) *int64
	GetPropertyAsInt64WithNotExists(cfg moduletools.ClassConfig, name string, defaultValue, notExistsValue *int64) *int64
	GetPropertyAsFloat64(cfg moduletools.ClassConfig, name string, defaultValue *float64) *float64
	GetPropertyAsFloat64WithNotExists(cfg moduletools.ClassConfig, name string, defaultValue, notExistsValue *float64) *float64
	GetPropertyAsString(cfg moduletools.ClassConfig, name, defaultValue string) string
	GetPropertyAsStringWithNotExists(cfg moduletools.ClassConfig, name, defaultValue, notExistsValue string) string
	GetPropertyAsBool(cfg moduletools.ClassConfig, name string, defaultValue bool) bool
	GetPropertyAsBoolWithNotExists(cfg moduletools.ClassConfig, name string, defaultValue, notExistsValue bool) bool
	GetNumber(in any) (float32, error)
	GetPropertyAsListOfStrings(cfg moduletools.ClassConfig, name string, defaultValue []string) []string
}

func NewPropertyValuesHelper added in v1.24.5

func NewPropertyValuesHelper(moduleName string) PropertyValuesHelper

func NewPropertyValuesHelperWithAltNames added in v1.25.21

func NewPropertyValuesHelperWithAltNames(moduleName string, altNames []string) PropertyValuesHelper

Jump to

Keyboard shortcuts

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