Documentation
¶
Overview ¶
Package embed defines the Embedder interface and concrete implementations in subpackages. See DESIGN.md §9.2.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EmbedTask ¶
type EmbedTask uint8
EmbedTask classifies how the embedded text will be used. Different embedding models tune outputs differently for retrieval vs. classification vs. similarity, so the caller passes intent and the embedder maps it to whatever wire format the underlying model wants (a `task_type` API parameter on gemini-embedding-001; an in-band prompt prefix on gemini-embedding-2; ignored entirely on the fake embedder used in tests).
memmy itself only emits Unspecified, RetrievalDocument, and RetrievalQuery today — the other values are reserved for future use and listed here so the embedder layer doesn't need to grow when a future feature wants them.
const ( EmbedTaskUnspecified EmbedTask = iota // EmbedTaskRetrievalDocument is used when persisting a chunk for // later retrieval (Service.Write). Tunes the embedding for the // "document being searched against" side of an asymmetric pair. EmbedTaskRetrievalDocument // EmbedTaskRetrievalQuery is used when embedding a recall query // (Service.Recall). Tunes the embedding for the "search input" side. EmbedTaskRetrievalQuery EmbedTaskSemanticSimilarity EmbedTaskClassification EmbedTaskClustering EmbedTaskCodeRetrievalQuery EmbedTaskQuestionAnswering EmbedTaskFactVerification )
Directories
¶
| Path | Synopsis |
|---|---|
|
Package fake provides a deterministic Embedder for tests.
|
Package fake provides a deterministic Embedder for tests. |
|
Package gemini implements the Embedder interface against Google's Gemini embeddings API via go-genai (google.golang.org/genai).
|
Package gemini implements the Embedder interface against Google's Gemini embeddings API via go-genai (google.golang.org/genai). |