github.com/weaviate/weaviate@v1.24.6/modules/ref2vec-centroid/module.go (about)

     1  //                           _       _
     2  // __      _____  __ ___   ___  __ _| |_ ___
     3  // \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
     4  //  \ V  V /  __/ (_| |\ V /| | (_| | ||  __/
     5  //   \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
     6  //
     7  //  Copyright © 2016 - 2024 Weaviate B.V. All rights reserved.
     8  //
     9  //  CONTACT: hello@weaviate.io
    10  //
    11  
    12  package modcentroid
    13  
    14  import (
    15  	"context"
    16  	"net/http"
    17  
    18  	"github.com/sirupsen/logrus"
    19  	"github.com/weaviate/weaviate/entities/models"
    20  	"github.com/weaviate/weaviate/entities/modulecapabilities"
    21  	"github.com/weaviate/weaviate/entities/moduletools"
    22  	"github.com/weaviate/weaviate/modules/ref2vec-centroid/vectorizer"
    23  )
    24  
    25  const (
    26  	Name = "ref2vec-centroid"
    27  )
    28  
    29  func New() *CentroidModule {
    30  	return &CentroidModule{}
    31  }
    32  
    33  type CentroidModule struct {
    34  	logger logrus.FieldLogger
    35  }
    36  
    37  func (m *CentroidModule) Name() string {
    38  	return Name
    39  }
    40  
    41  func (m *CentroidModule) Init(ctx context.Context, params moduletools.ModuleInitParams) error {
    42  	m.logger = params.GetLogger()
    43  	return nil
    44  }
    45  
    46  func (m *CentroidModule) RootHandler() http.Handler {
    47  	// TODO: remove from overall module, this is a capability
    48  	return nil
    49  }
    50  
    51  func (m *CentroidModule) Type() modulecapabilities.ModuleType {
    52  	return modulecapabilities.Ref2Vec
    53  }
    54  
    55  func (m *CentroidModule) MetaInfo() (map[string]interface{}, error) {
    56  	return map[string]interface{}{}, nil
    57  }
    58  
    59  func (m *CentroidModule) VectorizeObject(ctx context.Context,
    60  	obj *models.Object, cfg moduletools.ClassConfig,
    61  	findRefVecsFn modulecapabilities.FindObjectFn,
    62  ) ([]float32, error) {
    63  	vzr := vectorizer.New(cfg, findRefVecsFn)
    64  	return vzr.Object(ctx, obj)
    65  }
    66  
    67  // verify we implement the modules.Module interface
    68  var (
    69  	_ = modulecapabilities.Module(New())
    70  	_ = modulecapabilities.ReferenceVectorizer(New())
    71  	_ = modulecapabilities.MetaProvider(New())
    72  )