Codex.Session behaviour (Codex SDK v0.16.1)

Behaviour for persisting conversation state across runs.

Summary

t()

clear(state)

load(state)

clear(arg)

Clears stored history.

load(arg)

Loads session history.

save(arg, entry)

Persists a session entry.

valid?(arg1)

Validates a session reference.

@type t() :: {module(), term()}

@callback clear(state :: term()) :: :ok | {:error, term()}

@callback load(state :: term()) :: {:ok, term()} | {:error, term()}

@callback save(state :: term(), entry :: term()) :: :ok | {:error, term()}

@spec clear(t()) :: :ok | {:error, term()}

Clears stored history.

@spec load(t()) :: {:ok, term()} | {:error, term()}

Loads session history.

@spec save(t(), term()) :: :ok | {:error, term()}

Persists a session entry.

@spec valid?(term()) :: boolean()

Validates a session reference.