embed

Documentation

Index

• Constants
• func IsRateLimitError(err error) bool
• type CheckResult
  • func CheckProvider(ctx context.Context, cfg Config) CheckResult
• type Config
• type EmbeddingBatch
• type HTTPError
  • func (e *HTTPError) Error() string
• type Option
  • func WithAPIKey(apiKey string) Option
  • func WithHTTPClient(client *http.Client) Option
  • func WithRequestTimeout(timeout time.Duration) Option
  • func WithUserAgent(userAgent string) Option
• type Provider
  • func NewProvider(cfg Config, opts ...Option) (Provider, error)

Constants

const (
	ProviderOpenAI           = "openai"
	ProviderOllama           = "ollama"
	ProviderLlamaCpp         = "llamacpp"
	ProviderOpenAICompatible = "openai_compatible"

	DefaultOpenAIBaseURL       = "https://api.openai.com/v1"
	DefaultOllamaBaseURL       = "http://127.0.0.1:11434"
	DefaultLlamaCppBaseURL     = "http://127.0.0.1:8080/v1"
	DefaultOpenAIModel         = "text-embedding-3-small"
	DefaultLocalEmbeddingModel = "nomic-embed-text"
	DefaultBatchSize           = 64
	DefaultMaxInputChars       = 12000
	DefaultRequestTimeout      = 2 * time.Minute
	DefaultProbeTimeout        = 2 * time.Second
)

Functions

func IsRateLimitError

func IsRateLimitError(err error) bool

Types

type CheckResult

type CheckResult struct {
	Provider string
	Model    string
	BaseURL  string
	Status   string
	Warning  string
	Probed   bool
}

func CheckProvider

func CheckProvider(ctx context.Context, cfg Config) CheckResult

type Config

type Config struct {
	Provider       string
	Model          string
	BaseURL        string
	APIKeyEnv      string
	RequestTimeout string
	MaxInputChars  int
	Dimensions     int
	UserAgent      string
}

type EmbeddingBatch

type EmbeddingBatch struct {
	Model      string
	Dimensions int
	Vectors    [][]float32
	Vectors64  [][]float64
}

type HTTPError

type HTTPError struct {
	StatusCode int
	Body       string
	Header     http.Header
}

func (*HTTPError) Error

func (e *HTTPError) Error() string

type Option

type Option func(*providerOptions)

func WithAPIKey

func WithAPIKey(apiKey string) Option

func WithHTTPClient

func WithHTTPClient(client *http.Client) Option

func WithRequestTimeout

func WithRequestTimeout(timeout time.Duration) Option

func WithUserAgent

func WithUserAgent(userAgent string) Option

type Provider

type Provider interface {
	Embed(ctx context.Context, inputs []string) (EmbeddingBatch, error)
}

func NewProvider

func NewProvider(cfg Config, opts ...Option) (Provider, error)