# `Mnemosyne.Embedding`
[🔗](https://github.com/edlontech/mnemosyne/blob/main/lib/mnemosyne/embedding.ex#L1)

Behaviour for text embedding generation.

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

# `embed`

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

# `embed_batch`

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*