Backplane.AgentRuntime.Codex.Extensions (backplane_agent_runtime v1.10.6)

Copy Markdown

Scoped, ephemeral reference backends for Codex stateful extensions.

This module intentionally does not claim restart durability. A host can replace the state with a durable adapter later without changing the scope, revision, or digest contracts exposed here.

Summary

Functions

ack(state, scope, subscription_id, key)

@spec ack(map(), map(), String.t(), {String.t(), String.t()}) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

capabilities()

@spec capabilities() :: map()

descriptors()

@spec descriptors() :: [map()]

goal_create(state, scope, attrs)

@spec goal_create(map(), map(), map()) ::
  {:ok, map(), map()} | {:error, Backplane.AgentRuntime.Error.t()}

history_append(state, scope, attrs)

@spec history_append(map(), map(), map()) ::
  {:ok, map(), map()} | {:error, Backplane.AgentRuntime.Error.t()}

list(state, collection, scope, opts \\ [])

@spec list(map(), atom(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

memory_create(state, scope, attrs)

@spec memory_create(map(), map(), map()) ::
  {:ok, map(), map()} | {:error, Backplane.AgentRuntime.Error.t()}

new(opts \\ [])

@spec new(keyword()) :: map()

note_create(state, scope, attrs)

@spec note_create(map(), map(), map()) ::
  {:ok, map(), map()} | {:error, Backplane.AgentRuntime.Error.t()}

poll(state, scope, subscription_id, limit \\ 50)

@spec poll(map(), map(), String.t(), non_neg_integer()) ::
  {:ok, [map()]} | {:error, Backplane.AgentRuntime.Error.t()}

publish(state, scope, board, payload, message_id)

@spec publish(map(), map(), String.t(), map(), String.t()) ::
  {:ok, map(), map()} | {:error, Backplane.AgentRuntime.Error.t()}

read(state, collection, scope, id)

@spec read(map(), atom(), map(), String.t()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

search(state, collection, scope, query, opts \\ [])

@spec search(map(), atom(), map(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

skill_publish(state, scope, attrs)

@spec skill_publish(map(), map(), map()) ::
  {:ok, map(), map()} | {:error, Backplane.AgentRuntime.Error.t()}

skill_read(state, scope, name, revision, expected_digest)

@spec skill_read(map(), map(), String.t(), non_neg_integer(), String.t()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

subscribe(state, scope, board)

@spec subscribe(map(), map(), String.t()) ::
  {:ok, map(), map()} | {:error, Backplane.AgentRuntime.Error.t()}

unsubscribe(state, scope, id)

@spec unsubscribe(map(), map(), String.t()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

update(state, collection, scope, id, expected_revision, attrs)

@spec update(map(), atom(), map(), String.t(), non_neg_integer(), map()) ::
  {:ok, map(), map()} | {:error, Backplane.AgentRuntime.Error.t()}