Mnemosyne.Embedding behaviour (mnemosyne v0.1.6)

Behaviour for text embedding generation.

Implementations must convert text into vector representations suitable for similarity search.

Summary

Callbacks

embed(text, opts)

@callback embed(text :: String.t(), opts :: keyword()) ::
  {:ok, Mnemosyne.Embedding.Response.t()}
  | {:error, Mnemosyne.Errors.Framework.AdapterError.t()}

embed_batch(texts, opts)

@callback embed_batch(texts :: [String.t()], opts :: keyword()) ::
  {:ok, Mnemosyne.Embedding.Response.t()}
  | {:error, Mnemosyne.Errors.Framework.AdapterError.t()}