Spaces:
Running
Running
File size: 4,486 Bytes
b110593 |
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 |
// _ _
// __ _____ __ ___ ___ __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
// \ V V / __/ (_| |\ V /| | (_| | || __/
// \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
// Copyright © 2016 - 2024 Weaviate B.V. All rights reserved.
//
// CONTACT: [email protected]
//
package vectorizer
import (
"fmt"
"strings"
"github.com/pkg/errors"
"github.com/weaviate/weaviate/entities/models"
"github.com/weaviate/weaviate/entities/moduletools"
"github.com/weaviate/weaviate/entities/schema"
)
const (
DefaultJinaAIDocumentType = "text"
DefaultJinaAIModel = "jina-embeddings-v2-base-en"
DefaultVectorizeClassName = true
DefaultPropertyIndexed = true
DefaultVectorizePropertyName = false
DefaultBaseURL = "https://api.jina.ai"
)
type classSettings struct {
cfg moduletools.ClassConfig
}
func NewClassSettings(cfg moduletools.ClassConfig) *classSettings {
return &classSettings{cfg: cfg}
}
func (cs *classSettings) PropertyIndexed(propName string) bool {
if cs.cfg == nil {
// we would receive a nil-config on cross-class requests, such as Explore{}
return DefaultPropertyIndexed
}
vcn, ok := cs.cfg.Property(propName)["skip"]
if !ok {
return DefaultPropertyIndexed
}
asBool, ok := vcn.(bool)
if !ok {
return DefaultPropertyIndexed
}
return !asBool
}
func (cs *classSettings) VectorizePropertyName(propName string) bool {
if cs.cfg == nil {
// we would receive a nil-config on cross-class requests, such as Explore{}
return DefaultVectorizePropertyName
}
vcn, ok := cs.cfg.Property(propName)["vectorizePropertyName"]
if !ok {
return DefaultVectorizePropertyName
}
asBool, ok := vcn.(bool)
if !ok {
return DefaultVectorizePropertyName
}
return asBool
}
func (cs *classSettings) Model() string {
return cs.getProperty("model", DefaultJinaAIModel)
}
func (cs *classSettings) BaseURL() string {
return cs.getProperty("baseURL", DefaultBaseURL)
}
func (cs *classSettings) VectorizeClassName() bool {
if cs.cfg == nil {
// we would receive a nil-config on cross-class requests, such as Explore{}
return DefaultVectorizeClassName
}
vcn, ok := cs.cfg.Class()["vectorizeClassName"]
if !ok {
return DefaultVectorizeClassName
}
asBool, ok := vcn.(bool)
if !ok {
return DefaultVectorizeClassName
}
return asBool
}
func (cs *classSettings) Validate(class *models.Class) error {
if cs.cfg == nil {
// we would receive a nil-config on cross-class requests, such as Explore{}
return errors.New("empty config")
}
err := cs.validateIndexState(class, cs)
if err != nil {
return err
}
return nil
}
func (cs *classSettings) getProperty(name, defaultValue string) string {
if cs.cfg == nil {
// we would receive a nil-config on cross-class requests, such as Explore{}
return defaultValue
}
model, ok := cs.cfg.Class()[name]
if ok {
asString, ok := model.(string)
if ok {
return strings.ToLower(asString)
}
}
return defaultValue
}
func (cs *classSettings) validateIndexState(class *models.Class, settings ClassSettings) error {
if settings.VectorizeClassName() {
// if the user chooses to vectorize the classname, vector-building will
// always be possible, no need to investigate further
return nil
}
// search if there is at least one indexed, string/text prop. If found pass
// validation
for _, prop := range class.Properties {
if len(prop.DataType) < 1 {
return errors.Errorf("property %s must have at least one datatype: "+
"got %v", prop.Name, prop.DataType)
}
if prop.DataType[0] != string(schema.DataTypeText) {
// we can only vectorize text-like props
continue
}
if settings.PropertyIndexed(prop.Name) {
// found at least one, this is a valid schema
return nil
}
}
return fmt.Errorf("invalid properties: didn't find a single property which is " +
"of type string or text and is not excluded from indexing. In addition the " +
"class name is excluded from vectorization as well, meaning that it cannot be " +
"used to determine the vector position. To fix this, set 'vectorizeClassName' " +
"to true if the class name is contextionary-valid. Alternatively add at least " +
"contextionary-valid text/string property which is not excluded from " +
"indexing.")
}
|