Jidoka.Memory (Jidoka v0.8.0-beta.1)

Data contracts and runtime helpers for visible agent memory.

Summary

Types

entry()

recall_request()

recall_result()

write_request()

write_result()

Functions

capture_turn(spec, request, result, opts \\ [])

Captures a completed turn into memory when the spec enables conversation capture.

recall(spec, request, opts \\ [])

Recalls visible memory for a spec/request pair.

write(spec, content, opts \\ [])

Writes one visible memory entry using the spec's memory policy.

Types

entry()

@type entry() :: Jidoka.Memory.Entry.t()

recall_request()

@type recall_request() :: Jidoka.Memory.RecallRequest.t()

recall_result()

@type recall_result() :: Jidoka.Memory.RecallResult.t()

write_request()

@type write_request() :: Jidoka.Memory.WriteRequest.t()

write_result()

@type write_result() :: Jidoka.Memory.WriteResult.t()

Functions

capture_turn(spec, request, result, opts \\ [])

@spec capture_turn(
  Jidoka.Agent.Spec.t(),
  Jidoka.Turn.Request.t(),
  Jidoka.Turn.Result.t(),
  keyword()
) ::
  {:ok, write_result() | nil} | {:error, term()}

Captures a completed turn into memory when the spec enables conversation capture.

recall(spec, request, opts \\ [])

@spec recall(Jidoka.Agent.Spec.t(), Jidoka.Turn.Request.t(), keyword()) ::
  {:ok, recall_result() | nil} | {:error, term()}

Recalls visible memory for a spec/request pair.

This is the public facade over the runtime memory policy: it applies the spec's memory scope, namespace, session id, and max-entry settings before calling the configured memory store.

write(spec, content, opts \\ [])

@spec write(Jidoka.Agent.Spec.t(), String.t(), keyword()) ::
  {:ok, write_result()} | {:error, term()}

Writes one visible memory entry using the spec's memory policy.