embedding

Documentation

Index

• Variables
• type Config
• type Model
• type TaskType
  • func (i TaskType) String() string

Variables

var (
	ErrUnsupported       = errors.New("unsupported")         // This Error occurs whem the model does not support the content type provided.
	ErrMaxLengthExceeded = errors.New("max length exceeded") // This Error occurs when the content exceeds the maximum length.
	ErrNoResult          = errors.New("no result")           // This Error occurs when the model does not return any result.
)

Types

type Config

type Config struct {
	Dimension int
}

type Model

type Model interface {
	TextEmbedding(ctx context.Context, text string, task TaskType) ([]float64, error) // Returns the embedding of the text.
}

type TaskType

type TaskType uint16

const (
	TaskTypeGeneral TaskType = iota
	TaskTypeSearchQuery
	TaskTypeSearchDocument
	TaskTypeSemanticSimilarity
	TaskTypeClassification
	TaskTypeClustering
	TaskTypeFactVerification
	TaskTypeQA
)

func (TaskType) String

func (i TaskType) String() string