github.com/weaviate/weaviate@v1.24.6/modules/text2vec-gpt4all/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 modtransformers
    13  
    14  import (
    15  	"context"
    16  	"net/http"
    17  	"os"
    18  	"time"
    19  
    20  	"github.com/pkg/errors"
    21  	"github.com/sirupsen/logrus"
    22  	"github.com/weaviate/weaviate/entities/models"
    23  	"github.com/weaviate/weaviate/entities/modulecapabilities"
    24  	"github.com/weaviate/weaviate/entities/moduletools"
    25  	"github.com/weaviate/weaviate/modules/text2vec-gpt4all/clients"
    26  	"github.com/weaviate/weaviate/modules/text2vec-gpt4all/vectorizer"
    27  	"github.com/weaviate/weaviate/usecases/modulecomponents/additional"
    28  )
    29  
    30  const Name = "text2vec-gpt4all"
    31  
    32  func New() *GPT4AllModule {
    33  	return &GPT4AllModule{}
    34  }
    35  
    36  type GPT4AllModule struct {
    37  	vectorizer                   textVectorizer
    38  	metaProvider                 metaProvider
    39  	graphqlProvider              modulecapabilities.GraphQLArguments
    40  	searcher                     modulecapabilities.Searcher
    41  	nearTextTransformer          modulecapabilities.TextTransform
    42  	logger                       logrus.FieldLogger
    43  	additionalPropertiesProvider modulecapabilities.AdditionalProperties
    44  }
    45  
    46  type textVectorizer interface {
    47  	Object(ctx context.Context, obj *models.Object, comp moduletools.VectorizablePropsComparator,
    48  		cfg moduletools.ClassConfig) ([]float32, models.AdditionalProperties, error)
    49  	Texts(ctx context.Context, input []string,
    50  		cfg moduletools.ClassConfig) ([]float32, error)
    51  }
    52  
    53  type metaProvider interface {
    54  	MetaInfo() (map[string]interface{}, error)
    55  }
    56  
    57  func (m *GPT4AllModule) Name() string {
    58  	return Name
    59  }
    60  
    61  func (m *GPT4AllModule) Type() modulecapabilities.ModuleType {
    62  	return modulecapabilities.Text2Vec
    63  }
    64  
    65  func (m *GPT4AllModule) Init(ctx context.Context,
    66  	params moduletools.ModuleInitParams,
    67  ) error {
    68  	m.logger = params.GetLogger()
    69  
    70  	if err := m.initVectorizer(ctx, params.GetConfig().ModuleHttpClientTimeout, m.logger); err != nil {
    71  		return errors.Wrap(err, "init vectorizer")
    72  	}
    73  
    74  	if err := m.initAdditionalPropertiesProvider(); err != nil {
    75  		return errors.Wrap(err, "init additional properties provider")
    76  	}
    77  
    78  	return nil
    79  }
    80  
    81  func (m *GPT4AllModule) InitExtension(modules []modulecapabilities.Module) error {
    82  	for _, module := range modules {
    83  		if module.Name() == m.Name() {
    84  			continue
    85  		}
    86  		if arg, ok := module.(modulecapabilities.TextTransformers); ok {
    87  			if arg != nil && arg.TextTransformers() != nil {
    88  				m.nearTextTransformer = arg.TextTransformers()["nearText"]
    89  			}
    90  		}
    91  	}
    92  
    93  	if err := m.initNearText(); err != nil {
    94  		return errors.Wrap(err, "init graphql provider")
    95  	}
    96  	return nil
    97  }
    98  
    99  func (m *GPT4AllModule) initVectorizer(ctx context.Context, timeout time.Duration,
   100  	logger logrus.FieldLogger,
   101  ) error {
   102  	uri := os.Getenv("GPT4ALL_INFERENCE_API")
   103  	if uri == "" {
   104  		return errors.New("required variable GPT4ALL_INFERENCE_API is not set")
   105  	}
   106  
   107  	client := clients.New(uri, timeout, logger)
   108  	if err := client.WaitForStartup(ctx, 1*time.Second); err != nil {
   109  		return errors.Wrap(err, "init remote vectorizer")
   110  	}
   111  
   112  	m.vectorizer = vectorizer.New(client)
   113  	m.metaProvider = client
   114  
   115  	return nil
   116  }
   117  
   118  func (m *GPT4AllModule) initAdditionalPropertiesProvider() error {
   119  	m.additionalPropertiesProvider = additional.NewText2VecProvider()
   120  	return nil
   121  }
   122  
   123  func (m *GPT4AllModule) RootHandler() http.Handler {
   124  	// TODO: remove once this is a capability interface
   125  	return nil
   126  }
   127  
   128  func (m *GPT4AllModule) VectorizeObject(ctx context.Context,
   129  	obj *models.Object, comp moduletools.VectorizablePropsComparator, cfg moduletools.ClassConfig,
   130  ) ([]float32, models.AdditionalProperties, error) {
   131  	return m.vectorizer.Object(ctx, obj, comp, cfg)
   132  }
   133  
   134  func (m *GPT4AllModule) MetaInfo() (map[string]interface{}, error) {
   135  	return m.metaProvider.MetaInfo()
   136  }
   137  
   138  func (m *GPT4AllModule) AdditionalProperties() map[string]modulecapabilities.AdditionalProperty {
   139  	return m.additionalPropertiesProvider.AdditionalProperties()
   140  }
   141  
   142  func (m *GPT4AllModule) VectorizeInput(ctx context.Context,
   143  	input string, cfg moduletools.ClassConfig,
   144  ) ([]float32, error) {
   145  	return m.vectorizer.Texts(ctx, []string{input}, cfg)
   146  }
   147  
   148  // verify we implement the modules.Module interface
   149  var (
   150  	_ = modulecapabilities.Module(New())
   151  	_ = modulecapabilities.Vectorizer(New())
   152  	_ = modulecapabilities.MetaProvider(New())
   153  )