Skip to content

README.md

Latest commit

 

History

History
81 lines (62 loc) · 2.58 KB

README.md

File metadata and controls

81 lines (62 loc) · 2.58 KB
Raw

AgentUE Python SDK

The Python SDK is split into optional capabilities.

UI events

python -m pip install "agentue[ui]"

agentue.ui provides Pydantic models, an ordered patch emitter, a deterministic reducer, and the SSE binding.

from agentue.ui import BaseBlock, ModelMeta, PatchEmitter, UIModel, apply_patches

model = UIModel(biz="chat", meta=ModelMeta())
emitter = PatchEmitter()
events = [
    emitter.start(model),
    emitter.block_append(BaseBlock(id="answer", type="text", content="Hello")),
    emitter.end(),
]
snapshot = apply_patches({}, events)

Use PatchEmitter(stream_id="message-123") to optionally tag one logical timeline. The default emitter omits the field. For multiplexed delivery, route events by stream_id before applying them to separate snapshots; the reducer still handles one model at a time. See logical stream addressing.

Runner

python -m pip install "agentue[runner]"

Runner users provide exactly four lifecycle callbacks: pre_start, prepare, stream, and complete. Runner owns task spawning, Redis delivery, terminal control events, event-loop heartbeat observation, and timeout recovery.

from agentue.runner import Runner, RunnerCallbacks

runner = Runner(
    redis,
    RunnerCallbacks(
        pre_start=pre_start,
        prepare=prepare,
        stream=stream,
        complete=complete,
    ),
)
await runner.start()

async for event in runner.run(task_id=task_id, data=request, model=model):
    yield event.data

Runner yields JSON without transport framing. For SSE, pass event.data and event.cursor to agentue.ui.encode_sse.

See the Runner design for lifecycle and recovery requirements.

Reference blocks

Protocol 1.1 accepts a mixed ordered list of inline {id, type, ...} blocks and reference {id, ref} blocks. Existing 1.0 inline snapshots remain readable. ref is an opaque key interpreted by the application selected by biz; reference blocks carry no type or body. Whole-block set creates or replaces either form. The application must load and check the referenced block's ID before field-level set or append; the pure reducer rejects unresolved targets without loading. See the protocol for the full contract.

from agentue.ui import ModelMeta, ReferenceBlock, UIModel

model = UIModel(
    biz="chat",
    meta=ModelMeta(),
    blocks=[
        ReferenceBlock(id="b2", ref="opaque-reference"),
    ],
)