Jido.Memory.Capability.ExplainableRetrieval behaviour (Jido Memory v1.0.0)

View Source

Optional provider capability for retrieval explanations.

Summary

Callbacks

explain_retrieval(arg1, arg2, keyword)

@callback explain_retrieval(
  map() | struct(),
  Jido.Memory.Query.t() | map() | keyword(),
  keyword()
) ::
  {:ok, Jido.Memory.Explanation.t()} | {:error, term()}