|
| 1 | +# Glossary (Universal Schema) |
| 2 | + |
| 3 | +This glossary defines the universal schema terms used across the daemon, SDK, and tests. |
| 4 | + |
| 5 | +Session terms |
| 6 | +- session_id: daemon-generated identifier for a universal session. |
| 7 | +- native_session_id: provider-native thread/session/run identifier (thread_id merged here). |
| 8 | +- session.started: event emitted at session start (native or synthetic). |
| 9 | +- session.ended: event emitted at session end (native or synthetic); includes reason and terminated_by. |
| 10 | +- terminated_by: who ended the session: agent or daemon. |
| 11 | +- reason: why the session ended: completed, error, or terminated. |
| 12 | + |
| 13 | +Event terms |
| 14 | +- UniversalEvent: envelope that wraps all events; includes source, type, data, raw. |
| 15 | +- event_id: unique identifier for the event. |
| 16 | +- sequence: monotonic event sequence number within a session. |
| 17 | +- time: RFC3339 timestamp for the event. |
| 18 | +- source: event origin: agent (native) or daemon (synthetic). |
| 19 | +- raw: original provider payload for native events; optional for synthetic events. |
| 20 | + |
| 21 | +Item terms |
| 22 | +- item_id: daemon-generated identifier for a universal item. |
| 23 | +- native_item_id: provider-native item/message identifier when available; null otherwise. |
| 24 | +- parent_id: item_id of the parent item (e.g., tool call/result parented to a message). |
| 25 | +- kind: item category: message, tool_call, tool_result, system, status, unknown. |
| 26 | +- role: actor role for message items: user, assistant, system, tool (or null). |
| 27 | +- status: item lifecycle status: in_progress, completed, failed (or null). |
| 28 | + |
| 29 | +Item event terms |
| 30 | +- item.started: item creation event (may be synthetic). |
| 31 | +- item.delta: streaming delta event (native where supported; synthetic otherwise). |
| 32 | +- item.completed: final item event with complete content. |
| 33 | + |
| 34 | +Content terms |
| 35 | +- content: ordered list of parts that make up an item payload. |
| 36 | +- content part: a typed element inside content (text, json, tool_call, tool_result, file_ref, image, status, reasoning). |
| 37 | +- text: plain text content part. |
| 38 | +- json: structured JSON content part. |
| 39 | +- tool_call: tool invocation content part (name, arguments, call_id). |
| 40 | +- tool_result: tool result content part (call_id, output). |
| 41 | +- file_ref: file reference content part (path, action, diff). |
| 42 | +- image: image content part (path, mime). |
| 43 | +- status: status content part (label, detail). |
| 44 | +- reasoning: reasoning content part (text, visibility). |
| 45 | +- visibility: reasoning visibility: public or private. |
| 46 | + |
| 47 | +HITL terms |
| 48 | +- permission.requested / permission.resolved: human-in-the-loop permission flow events. |
| 49 | +- permission_id: identifier for the permission request. |
| 50 | +- question.requested / question.resolved: human-in-the-loop question flow events. |
| 51 | +- question_id: identifier for the question request. |
| 52 | +- options: question answer options. |
| 53 | +- response: selected answer for a question. |
| 54 | + |
| 55 | +Synthetic terms |
| 56 | +- synthetic event: a daemon-emitted event used to fill gaps in provider-native schemas. |
| 57 | +- source=daemon: marks synthetic events. |
| 58 | +- synthetic delta: a single full-content delta emitted for providers without native deltas. |
| 59 | + |
| 60 | +Provider terms |
| 61 | +- agent: the native provider (claude, codex, opencode, amp). |
| 62 | +- native payload: the provider’s original event/message object stored in raw. |
0 commit comments