Backplane.AgentRuntime.ToolEffects behaviour (backplane_agent_runtime v1.10.11)

Tool effects and cancellation boundary for Backplane agent runtime.

Summary

adapter()

cancel(map)

execute(map)

Classifies an observed backend result using its admitted descriptor safety.

@type adapter() :: module()

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

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

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

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

@spec settlement(term(), map()) :: :settled | :uncertain

Classifies an observed backend result using its admitted descriptor safety.

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