PromptRunner.LLM behaviour (PromptRunnerSDK v0.12.1)

Copy Markdown View Source

Behaviour and types for LLM integrations.

Summary

Types

close_fun()
provider()
sdk()
stream()
stream_event()

Callbacks

normalize_provider(term)
normalize_sdk(term)
resume_stream(map, map, t)
start_stream(map, t)
steer(map, map, t)

Says something to a session that is already running.

Types

close_fun()

@type close_fun() :: (-> any())

provider()

@type provider() :: sdk()

sdk()

@type sdk() :: :claude | :codex | :amp | :cursor | :antigravity | :simulated

stream()

@type stream() :: Enumerable.t()

stream_event()

@type stream_event() :: map()

Callbacks

normalize_provider(term)

@callback normalize_provider(term()) :: provider() | {:error, term()}

normalize_sdk(term)

@callback normalize_sdk(term()) :: sdk() | {:error, term()}

resume_stream(map, map, t)

@callback resume_stream(map(), map(), String.t()) ::
  {:ok, stream(), close_fun(), map()} | {:error, term()}

start_stream(map, t)

@callback start_stream(map(), String.t()) ::
  {:ok, stream(), close_fun(), map()} | {:error, term()}

steer(map, map, t)

@callback steer(map(), map(), String.t()) ::
  {:ok, :delivered | :interrupted} | {:error, term()}

Says something to a session that is already running.

{:ok, :delivered} means the text reached the running turn and it continues. {:ok, :interrupted} means the turn was ended and the caller has to resume the provider thread with this text — which lane applies is the provider's transport fact, not the caller's choice.