README
¶
embedding
model := embedding.ModelRef{Provider: "local", Name: "demo", Dim: 3}
key := embedding.CacheKey(model, "hello")
err := embedding.ValidateDimensions([]embedding.Vector{{1, 2, 3}}, model.Dim)
request := embedding.Request{Model: model, Inputs: []string{"hello"}}
result := embedding.Result{Model: model, Vectors: []embedding.Vector{{1, 2, 3}}}
err = embedding.ValidateResult(request, result)
embedding is the provider-neutral contract for embedding requests and dense
vectors.
The package does not call models, choose providers, or own vector-space policy.
Callers pass an Embedder implementation and keep model identity, dimensions,
fallback behavior, and cache invalidation explicit.
A successful Embed call returns exactly one positive-dimension, finite vector
per input in the same order. ValidateResult checks that cardinality and shape,
including agreement with declared request and result dimensions; zero-magnitude
vectors remain valid. Implementations should run the reusable
embedding/embeddingtest contract suite.
ModelRef.Identity uses versioned byte-length framing. The modelref:v1
format prevents delimiter collisions, including with Unicode fields. Upgrading
to this version intentionally invalidates cache keys produced by the legacy
colon-joined identity; callers should expect cold misses rather than dual-read
old keys.
Documentation
¶
Overview ¶
Package embedding defines provider-neutral embedding model, request, result, vector, cache-key, and dimension-validation contracts. Provider clients and model policy stay in adapters or applications.
Package embedding defines provider-neutral embedding contracts.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidResult = errors.New("embedding: invalid result")
ErrInvalidResult indicates that an embedder returned a malformed result.
Functions ¶
func ValidateDimensions ¶
ValidateDimensions checks that every vector has dims values.
Example ¶
package main
import (
"fmt"
"github.com/dotcommander/reliquary/embedding"
)
func main() {
model := embedding.ModelRef{Provider: "local", Name: "demo", Dim: 3}
err := embedding.ValidateDimensions([]embedding.Vector{{1, 2, 3}}, model.Dim)
fmt.Println(err == nil)
}
Output: true
func ValidateResult ¶ added in v0.9.0
ValidateResult verifies the shape and finite values required of a successful embedding result. A zero ModelRef.Dim means unspecified; when present, request and result dimensions must agree with each other and every vector.
Types ¶
type Embedder ¶
Embedder embeds text into vectors. Successful results contain exactly one vector per input, in the same order as the request inputs.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package embeddingtest provides a reusable contract suite for Embedder implementations.
|
Package embeddingtest provides a reusable contract suite for Embedder implementations. |