modcontextionary

Documentation

Overview

modcontextionary concentrates some of the code that relates to the contextionary module, this must be extracted when Weaviate becomes modular.

For now it's just used to concentrate any new contextionary specific code, so it's already in one place to make the modularization easier later on

Index

• Constants
• type ContextionaryModule
  • func New() *ContextionaryModule
  • func (m *ContextionaryModule) AdditionalProperties() map[string]modulecapabilities.AdditionalProperty
  • func (m *ContextionaryModule) Arguments() map[string]modulecapabilities.GraphQLArgument
  • func (m *ContextionaryModule) ClassConfigDefaults() map[string]interface{}
  • func (m *ContextionaryModule) Classifiers() []modulecapabilities.Classifier
  • func (m *ContextionaryModule) Init(ctx context.Context, params moduletools.ModuleInitParams) error
  • func (m *ContextionaryModule) InitExtension(modules []modulecapabilities.Module) error
  • func (m *ContextionaryModule) MetaInfo() (map[string]interface{}, error)
  • func (m *ContextionaryModule) Name() string
  • func (m *ContextionaryModule) PropertyConfigDefaults(dt *schema.DataType) map[string]interface{}
  • func (m *ContextionaryModule) RootHandler() http.Handler
  • func (m *ContextionaryModule) Type() modulecapabilities.ModuleType
  • func (m *ContextionaryModule) ValidateClass(ctx context.Context, class *models.Class, cfg moduletools.ClassConfig) error
  • func (m *ContextionaryModule) VectorSearches() map[string]modulecapabilities.VectorForParams
  • func (m *ContextionaryModule) VectorizableProperties(cfg moduletools.ClassConfig) (bool, []string, error)
  • func (m *ContextionaryModule) VectorizeBatch(ctx context.Context, objs []*models.Object, skipObject []bool, ...) ([][]float32, []models.AdditionalProperties, map[int]error)
  • func (m *ContextionaryModule) VectorizeInput(ctx context.Context, input string, cfg moduletools.ClassConfig) ([]float32, error)
  • func (m *ContextionaryModule) VectorizeObject(ctx context.Context, obj *models.Object, cfg moduletools.ClassConfig) ([]float32, models.AdditionalProperties, error)

Constants

const (
	MinimumRequiredRemoteVersion = "1.0.0"
	Name                         = "text2vec-contextionary"
)

MinimumRequiredRemoteVersion describes the minimal semver version (independent of the model version) of the remote model inference API

Types

type ContextionaryModule

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

ContextionaryModule for now only handles storage and retrieval of extensions, but with making Weaviate more modular, this should contain anything related to the module

func New

func New() *ContextionaryModule

func (*ContextionaryModule) AdditionalProperties

func (m *ContextionaryModule) AdditionalProperties() map[string]modulecapabilities.AdditionalProperty

func (*ContextionaryModule) Arguments

func (m *ContextionaryModule) Arguments() map[string]modulecapabilities.GraphQLArgument

func (*ContextionaryModule) ClassConfigDefaults

func (m *ContextionaryModule) ClassConfigDefaults() map[string]interface{}

func (*ContextionaryModule) Classifiers

func (m *ContextionaryModule) Classifiers() []modulecapabilities.Classifier

func (*ContextionaryModule) Init

func (m *ContextionaryModule) Init(ctx context.Context,
	params moduletools.ModuleInitParams,
) error

func (*ContextionaryModule) InitExtension

func (m *ContextionaryModule) InitExtension(modules []modulecapabilities.Module) error

func (*ContextionaryModule) MetaInfo

func (m *ContextionaryModule) MetaInfo() (map[string]interface{}, error)

func (*ContextionaryModule) Name

func (m *ContextionaryModule) Name() string

func (*ContextionaryModule) PropertyConfigDefaults

func (m *ContextionaryModule) PropertyConfigDefaults(
	dt *schema.DataType,
) map[string]interface{}

func (*ContextionaryModule) RootHandler

func (m *ContextionaryModule) RootHandler() http.Handler

func (*ContextionaryModule) Type

func (m *ContextionaryModule) Type() modulecapabilities.ModuleType

func (*ContextionaryModule) ValidateClass

func (m *ContextionaryModule) ValidateClass(ctx context.Context,
	class *models.Class, cfg moduletools.ClassConfig,
) error

func (*ContextionaryModule) VectorSearches

func (m *ContextionaryModule) VectorSearches() map[string]modulecapabilities.VectorForParams

func (*ContextionaryModule) VectorizableProperties

func (m *ContextionaryModule) VectorizableProperties(cfg moduletools.ClassConfig) (bool, []string, error)

func (*ContextionaryModule) VectorizeBatch

func (m *ContextionaryModule) VectorizeBatch(ctx context.Context, objs []*models.Object, skipObject []bool, cfg moduletools.ClassConfig) ([][]float32, []models.AdditionalProperties, map[int]error)

VectorizeBatch is _slower_ if many requests are done in parallel. So do all objects sequentially

func (*ContextionaryModule) VectorizeInput

func (m *ContextionaryModule) VectorizeInput(ctx context.Context,
	input string, cfg moduletools.ClassConfig,
) ([]float32, error)

func (*ContextionaryModule) VectorizeObject

func (m *ContextionaryModule) VectorizeObject(ctx context.Context,
	obj *models.Object, cfg moduletools.ClassConfig,
) ([]float32, models.AdditionalProperties, error)