Vettore.Index behaviour (Vettore v0.3.3)

Search index behaviour.

Indexes may keep acceleration state, but ETS remains the canonical record store. Implementations must return Vettore.Result structs.

Summary

context()

close(context)

put(context, t)

@type context() :: map()

(optional)

@callback close(context()) :: :ok | {:error, term()}

@callback delete(context(), String.t()) :: :ok | {:error, term()}

@callback new(
  Vettore.Distance.metric(),
  keyword()
) :: {:ok, term()} | {:error, term()}

@callback put(context(), Vettore.Embedding.t()) :: :ok | {:error, term()}

@callback put_many(context(), [Vettore.Embedding.t()]) :: :ok | {:error, term()}

@callback search(context(), [number()], keyword()) ::
  {:ok, [Vettore.Result.t()]} | {:error, term()}