File size: 5,023 Bytes
59bb539 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | // _ _
// __ _____ __ ___ ___ __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
// \ V V / __/ (_| |\ V /| | (_| | || __/
// \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
// Copyright © 2016 - 2025 Weaviate B.V. All rights reserved.
//
// CONTACT: hello@weaviate.io
//
package modcohere
import (
"context"
"os"
"time"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/weaviate/weaviate/entities/models"
"github.com/weaviate/weaviate/entities/modulecapabilities"
"github.com/weaviate/weaviate/entities/moduletools"
"github.com/weaviate/weaviate/modules/text2vec-cohere/clients"
"github.com/weaviate/weaviate/modules/text2vec-cohere/ent"
"github.com/weaviate/weaviate/usecases/modulecomponents/additional"
"github.com/weaviate/weaviate/usecases/modulecomponents/batch"
"github.com/weaviate/weaviate/usecases/modulecomponents/text2vecbase"
)
const Name = "text2vec-cohere"
var batchSettings = batch.Settings{
TokenMultiplier: 0, // no token limit
MaxTimePerBatch: float64(10),
MaxObjectsPerBatch: 96, // https://docs.cohere.com/reference/embed
MaxTokensPerBatch: func(cfg moduletools.ClassConfig) int { return 500000 }, // there does not seem to be a limit
HasTokenLimit: false,
ReturnsRateLimit: false,
}
func New() *CohereModule {
return &CohereModule{}
}
type CohereModule struct {
vectorizer text2vecbase.TextVectorizerBatch[[]float32]
metaProvider text2vecbase.MetaProvider
graphqlProvider modulecapabilities.GraphQLArguments
searcher modulecapabilities.Searcher[[]float32]
nearTextTransformer modulecapabilities.TextTransform
logger logrus.FieldLogger
additionalPropertiesProvider modulecapabilities.AdditionalProperties
}
func (m *CohereModule) Name() string {
return Name
}
func (m *CohereModule) Type() modulecapabilities.ModuleType {
return modulecapabilities.Text2ManyVec
}
func (m *CohereModule) Init(ctx context.Context,
params moduletools.ModuleInitParams,
) error {
m.logger = params.GetLogger()
if err := m.initVectorizer(ctx, params.GetConfig().ModuleHttpClientTimeout, m.logger); err != nil {
return errors.Wrap(err, "init vectorizer")
}
if err := m.initAdditionalPropertiesProvider(); err != nil {
return errors.Wrap(err, "init additional properties provider")
}
return nil
}
func (m *CohereModule) InitExtension(modules []modulecapabilities.Module) error {
for _, module := range modules {
if module.Name() == m.Name() {
continue
}
if arg, ok := module.(modulecapabilities.TextTransformers); ok {
if arg != nil && arg.TextTransformers() != nil {
m.nearTextTransformer = arg.TextTransformers()["nearText"]
}
}
}
if err := m.initNearText(); err != nil {
return errors.Wrap(err, "init graphql provider")
}
return nil
}
func (m *CohereModule) initVectorizer(ctx context.Context, timeout time.Duration,
logger logrus.FieldLogger,
) error {
apiKey := os.Getenv("COHERE_APIKEY")
client := clients.New(apiKey, timeout, logger)
m.vectorizer = text2vecbase.New(client,
batch.NewBatchVectorizer(client, 50*time.Second, batchSettings, logger, m.Name()),
batch.ReturnBatchTokenizer(batchSettings.TokenMultiplier, m.Name(), ent.LowerCaseInput),
)
m.metaProvider = client
return nil
}
func (m *CohereModule) initAdditionalPropertiesProvider() error {
m.additionalPropertiesProvider = additional.NewText2VecProvider()
return nil
}
func (m *CohereModule) VectorizeObject(ctx context.Context,
obj *models.Object, cfg moduletools.ClassConfig,
) ([]float32, models.AdditionalProperties, error) {
return m.vectorizer.Object(ctx, obj, cfg, ent.NewClassSettings(cfg))
}
func (m *CohereModule) VectorizeBatch(ctx context.Context, objs []*models.Object, skipObject []bool, cfg moduletools.ClassConfig) ([][]float32, []models.AdditionalProperties, map[int]error) {
vecs, errs := m.vectorizer.ObjectBatch(ctx, objs, skipObject, cfg)
return vecs, nil, errs
}
func (m *CohereModule) MetaInfo() (map[string]interface{}, error) {
return m.metaProvider.MetaInfo()
}
func (m *CohereModule) VectorizableProperties(cfg moduletools.ClassConfig) (bool, []string, error) {
return true, nil, nil
}
func (m *CohereModule) VectorizeInput(ctx context.Context,
input string, cfg moduletools.ClassConfig,
) ([]float32, error) {
return m.vectorizer.Texts(ctx, []string{input}, cfg)
}
func (m *CohereModule) AdditionalProperties() map[string]modulecapabilities.AdditionalProperty {
return m.additionalPropertiesProvider.AdditionalProperties()
}
// verify we implement the modules.Module interface
var (
_ = modulecapabilities.Module(New())
_ = modulecapabilities.Vectorizer[[]float32](New())
_ = modulecapabilities.MetaProvider(New())
_ = modulecapabilities.Searcher[[]float32](New())
_ = modulecapabilities.GraphQLArguments(New())
_ = modulecapabilities.InputVectorizer[[]float32](New())
)
|