Jido.Memory.Runtime (Jido Memory v1.0.0)

Facade API for writing and retrieving memory records.

Works with either:

agent/context inputs that already carry memory plugin state, or
explicit namespace and optional provider options for non-plugin callers.

Summary

Types

target()

Functions

capabilities(target, opts \\ [])

Returns the canonical capability set for the active provider.

consolidate(target, opts \\ [])

Runs canonical lifecycle consolidation when supported by the provider.

explain_retrieval(target, query_attrs, opts \\ [])

Returns a canonical retrieval explanation when supported by the provider.

forget(target, id, opts \\ [])

Deletes a memory record by id and returns whether it existed.

get(target, id, opts \\ [])

Reads a single memory record by id.

info(target, opts \\ [])

Returns canonical provider metadata.

info(target, opts, fields)

Returns provider metadata, optionally filtered to selected fields.

ingest(target, request, opts \\ [])

Runs canonical ingestion when supported by the provider.

plugin_state_key()

Returns the plugin state key used for memory metadata.

prune_expired(target, opts \\ [])

Prunes expired records in the active store.

remember(target, attrs, opts \\ [])

Writes a memory record.

resolve_provider(target, attrs, opts)

Infers provider and provider options for plugin and action code paths.

retrieve(target, query_attrs, opts \\ [])

Canonical retrieval entrypoint that delegates through provider.

Types

target()

@type target() :: map() | struct()

Functions

capabilities(target, opts \\ [])

@spec capabilities(
  target(),
  keyword()
) :: {:ok, Jido.Memory.CapabilitySet.t()} | {:error, term()}

Returns the canonical capability set for the active provider.

consolidate(target, opts \\ [])

@spec consolidate(
  target(),
  keyword()
) :: {:ok, Jido.Memory.ConsolidationResult.t()} | {:error, term()}

Runs canonical lifecycle consolidation when supported by the provider.

explain_retrieval(target, query_attrs, opts \\ [])

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

Returns a canonical retrieval explanation when supported by the provider.

forget(target, id, opts \\ [])

@spec forget(target(), String.t(), keyword()) :: {:ok, boolean()} | {:error, term()}

Deletes a memory record by id and returns whether it existed.

get(target, id, opts \\ [])

@spec get(target(), String.t(), keyword()) ::
  {:ok, Jido.Memory.Record.t()} | {:error, term()}

Reads a single memory record by id.

info(target, opts \\ [])

@spec info(
  target(),
  keyword()
) :: {:ok, Jido.Memory.ProviderInfo.t()} | {:error, term()}

Returns canonical provider metadata.

info(target, opts, fields)

@spec info(target(), keyword(), :all | [atom()]) ::
  {:ok, Jido.Memory.ProviderInfo.t() | map()} | {:error, term()}

Returns provider metadata, optionally filtered to selected fields.

ingest(target, request, opts \\ [])

@spec ingest(target(), map() | keyword(), keyword()) ::
  {:ok, Jido.Memory.IngestResult.t()} | {:error, term()}

Runs canonical ingestion when supported by the provider.

plugin_state_key()

@spec plugin_state_key() :: atom()

Returns the plugin state key used for memory metadata.

prune_expired(target, opts \\ [])

@spec prune_expired(
  target(),
  keyword()
) :: {:ok, non_neg_integer()} | {:error, term()}

Prunes expired records in the active store.

remember(target, attrs, opts \\ [])

@spec remember(target(), map() | keyword(), keyword()) ::
  {:ok, Jido.Memory.Record.t()} | {:error, term()}

Writes a memory record.

resolve_provider(target, attrs, opts)

@spec resolve_provider(target(), map(), keyword()) ::
  {:ok, {module(), keyword()}} | {:error, term()}

Infers provider and provider options for plugin and action code paths.

retrieve(target, query_attrs, opts \\ [])

@spec retrieve(target(), Jido.Memory.Query.t() | map() | keyword(), keyword()) ::
  {:ok, Jido.Memory.RetrieveResult.t()} | {:error, term()}

Canonical retrieval entrypoint that delegates through provider.