vectorizer

Documentation

Index

• Constants
• Variables
• func NewClassSettings(cfg moduletools.ClassConfig) *classSettings
• type ClassSettings
• type Client
• type Vectorizer
  • func New(client Client) *Vectorizer
  • func (v *Vectorizer) Object(ctx context.Context, object *models.Object, ...) ([]float32, models.AdditionalProperties, error)
  • func (v *Vectorizer) Texts(ctx context.Context, inputs []string, cfg moduletools.ClassConfig) ([]float32, error)

Constants

const (
	DefaultJinaAIDocumentType    = "text"
	DefaultJinaAIModel           = "jina-embeddings-v2-base-en"
	DefaultVectorizeClassName    = true
	DefaultPropertyIndexed       = true
	DefaultVectorizePropertyName = false
	DefaultBaseURL               = "https://api.jina.ai"
)

Variables

var DefaultDimensions int64 = 1024

Functions

func NewClassSettings

func NewClassSettings(cfg moduletools.ClassConfig) *classSettings

Types

type ClassSettings

type ClassSettings interface {
	PropertyIndexed(property string) bool
	VectorizePropertyName(propertyName string) bool
	VectorizeClassName() bool
	Model() string
	BaseURL() string
}

IndexCheck returns whether a property of a class should be indexed

type Client

type Client interface {
	Vectorize(ctx context.Context, input string,
		config ent.VectorizationConfig) (*ent.VectorizationResult, error)
	VectorizeQuery(ctx context.Context, input []string,
		config ent.VectorizationConfig) (*ent.VectorizationResult, error)
}

type Vectorizer

type Vectorizer struct {
	// contains filtered or unexported fields
}

func New

func New(client Client) *Vectorizer

func (*Vectorizer) Object

func (v *Vectorizer) Object(ctx context.Context, object *models.Object,
	comp moduletools.VectorizablePropsComparator, cfg moduletools.ClassConfig,
) ([]float32, models.AdditionalProperties, error)

func (*Vectorizer) Texts

func (v *Vectorizer) Texts(ctx context.Context, inputs []string,
	cfg moduletools.ClassConfig,
) ([]float32, error)