base

type Client ¶

type Client struct {
	Embedder
	UsageListener
}

func (c *Client) CreateEmbedding(ctx context.Context, data []string) ([][]float32, error)

type ClientOption ¶

type ClientOption func(*Config)

ClientOption mutates Config. Each provider may alias this type so that its constructor accepts a consistent set of generic options alongside any provider-specific ones.

func WithBaseURL(baseURL string) ClientOption

func WithHTTPClient(httpClient *http.Client) ClientOption

func WithModel(model string) ClientOption

type Config ¶

type Config struct {
	// BaseURL is the root URL of the remote embedding service (e.g. https://api.openai.com).
	BaseURL string

	// HTTPClient performs the underlying HTTP calls.  When nil the provider
	// should fall back to *http.DefaultClient* or create its own with sensible
	// timeout.
	HTTPClient *http.Client

	// Model identifies the embedding model (e.g. "text-embedding-3-small") to
	// be used by the provider.  The concrete provider may fall back to its own
	// default if Model is left empty.
	Model string
}

Config groups the fields that are common to every embedder provider Client.

Several provider implementations (OpenAI, Ollama, VertexAI, …) were declaring the same set of fields (BaseURL, HTTPClient, Model) independently in their dedicated client structs and duplicating functional-option helpers to mutate them. Config centralises those shared attributes so that every provider can embed *base.Config* and inherit the fields automatically. Generic functional-options defined in this package operate on Config and therefore can be reused by all providers, eliminating the previous boiler-plate.

type Embedder ¶

type Embedder interface {
	Embed(ctx context.Context, data []string) (vector [][]float32, totalTokens int, err error)
}

type UsageListener ¶

type UsageListener func(data []string, tokens int)