File size: 5,227 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 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | // _ _
// __ _____ __ ___ ___ __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
// \ V V / __/ (_| |\ V /| | (_| | || __/
// \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
// Copyright © 2016 - 2025 Weaviate B.V. All rights reserved.
//
// CONTACT: hello@weaviate.io
//
package modqna
import (
"context"
"os"
"time"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
entcfg "github.com/weaviate/weaviate/entities/config"
"github.com/weaviate/weaviate/entities/modulecapabilities"
"github.com/weaviate/weaviate/entities/moduletools"
qnaadditional "github.com/weaviate/weaviate/modules/qna-transformers/additional"
qnaadditionalanswer "github.com/weaviate/weaviate/modules/qna-transformers/additional/answer"
qnaask "github.com/weaviate/weaviate/modules/qna-transformers/ask"
"github.com/weaviate/weaviate/modules/qna-transformers/clients"
qnaadependency "github.com/weaviate/weaviate/modules/qna-transformers/dependency"
"github.com/weaviate/weaviate/modules/qna-transformers/ent"
)
const Name = "qna-transformers"
func New() *QnAModule {
return &QnAModule{}
}
type QnAModule struct {
qna qnaClient
graphqlProvider modulecapabilities.GraphQLArguments
searcher modulecapabilities.DependencySearcher[[]float32]
additionalPropertiesProvider modulecapabilities.AdditionalProperties
nearTextDependencies []modulecapabilities.Dependency[[]float32]
askTextTransformer modulecapabilities.TextTransform
}
type qnaClient interface {
Answer(ctx context.Context,
text, question string) (*ent.AnswerResult, error)
MetaInfo() (map[string]interface{}, error)
}
func (m *QnAModule) Name() string {
return Name
}
func (m *QnAModule) Type() modulecapabilities.ModuleType {
return modulecapabilities.Text2TextQnA
}
func (m *QnAModule) Init(ctx context.Context,
params moduletools.ModuleInitParams,
) error {
if err := m.initAdditional(ctx, params.GetConfig().ModuleHttpClientTimeout, params.GetLogger()); err != nil {
return errors.Wrap(err, "init vectorizer")
}
return nil
}
func (m *QnAModule) InitExtension(modules []modulecapabilities.Module) error {
var textTransformer modulecapabilities.TextTransform
for _, module := range modules {
if module.Name() == m.Name() {
continue
}
if arg, ok := module.(modulecapabilities.TextTransformers); ok {
if arg != nil && arg.TextTransformers() != nil {
textTransformer = arg.TextTransformers()["ask"]
}
}
}
m.askTextTransformer = textTransformer
if err := m.initAskProvider(); err != nil {
return errors.Wrap(err, "init ask provider")
}
return nil
}
func (m *QnAModule) InitDependency(modules []modulecapabilities.Module) error {
nearTextDependencies := []modulecapabilities.Dependency[[]float32]{}
for _, module := range modules {
if module.Name() == m.Name() {
continue
}
var argument modulecapabilities.GraphQLArgument
var searcher modulecapabilities.VectorForParams[[]float32]
if arg, ok := module.(modulecapabilities.GraphQLArguments); ok {
if arg != nil && arg.Arguments() != nil {
if nearTextArg, ok := arg.Arguments()["nearText"]; ok {
argument = nearTextArg
}
}
}
if arg, ok := module.(modulecapabilities.Searcher[[]float32]); ok {
if arg != nil && arg.VectorSearches() != nil {
if nearTextSearcher, ok := arg.VectorSearches()["nearText"]; ok {
searcher = nearTextSearcher
}
}
}
if argument.ExtractFunction != nil && searcher != nil {
nearTextDependency := qnaadependency.New(module.Name(), argument, searcher)
nearTextDependencies = append(nearTextDependencies, nearTextDependency)
}
}
if len(nearTextDependencies) == 0 {
return errors.New("nearText dependecy not present")
}
m.nearTextDependencies = nearTextDependencies
if err := m.initAskSearcher(); err != nil {
return errors.Wrap(err, "init ask searcher")
}
return nil
}
func (m *QnAModule) initAdditional(ctx context.Context, timeout time.Duration,
logger logrus.FieldLogger,
) error {
// TODO: proper config management
uri := os.Getenv("QNA_INFERENCE_API")
if uri == "" {
return errors.Errorf("required variable QNA_INFERENCE_API is not set")
}
waitForStartup := true
if envWaitForStartup := os.Getenv("QNA_WAIT_FOR_STARTUP"); envWaitForStartup != "" {
waitForStartup = entcfg.Enabled(envWaitForStartup)
}
client := clients.New(uri, timeout, logger)
if waitForStartup {
if err := client.WaitForStartup(ctx, 1*time.Second); err != nil {
return errors.Wrap(err, "init remote vectorizer")
}
}
m.qna = client
answerProvider := qnaadditionalanswer.New(m.qna, qnaask.NewParamsHelper())
m.additionalPropertiesProvider = qnaadditional.New(answerProvider)
return nil
}
func (m *QnAModule) MetaInfo() (map[string]interface{}, error) {
return m.qna.MetaInfo()
}
func (m *QnAModule) AdditionalProperties() map[string]modulecapabilities.AdditionalProperty {
return m.additionalPropertiesProvider.AdditionalProperties()
}
// verify we implement the modules.Module interface
var (
_ = modulecapabilities.Module(New())
_ = modulecapabilities.AdditionalProperties(New())
_ = modulecapabilities.MetaProvider(New())
)
|