vectorizer

Documentation

Index

• Constants
• Variables
• func NewClassSettings(cfg moduletools.ClassConfig) *classSettings
• func PickDefaultDimensions(model string) *int64
• func PickDefaultModelVersion(model, docType string) string
• 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 (
	DefaultOpenAIDocumentType    = "text"
	DefaultOpenAIModel           = "ada"
	DefaultVectorizeClassName    = true
	DefaultPropertyIndexed       = true
	DefaultVectorizePropertyName = false
	DefaultBaseURL               = "https://api.openai.com"
	DefaultApiVersion            = "2024-02-01"
)

const (
	TextEmbedding3Small = "text-embedding-3-small"
	TextEmbedding3Large = "text-embedding-3-large"
)

Variables

var (
	TextEmbedding3SmallDefaultDimensions int64 = 1536
	TextEmbedding3LargeDefaultDimensions int64 = 3072
)

Functions

func NewClassSettings

func NewClassSettings(cfg moduletools.ClassConfig) *classSettings

func PickDefaultDimensions

func PickDefaultDimensions(model string) *int64

func PickDefaultModelVersion

func PickDefaultModelVersion(model, docType string) string

Types

type ClassSettings

type ClassSettings interface {
	PropertyIndexed(property string) bool
	VectorizePropertyName(propertyName string) bool
	VectorizeClassName() bool
	Model() string
	Type() string
	ModelVersion() string
	ResourceName() string
	DeploymentID() string
	BaseURL() string
	ApiVersion() string
	IsAzure() bool
}

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)