Skip to main content

Item

Struct Item 

Source
#[non_exhaustive]
pub struct Item {
Show 77 fields pub item_id: String, pub kind: ItemKind, pub turn_id: Option<String>, pub revision: u64, pub status: ItemStatus, pub recorded_at: Option<String>, pub fallback_text: Option<String>, pub text: Option<String>, pub display_text: Option<String>, pub command_id: Option<String>, pub by_client: Option<ClientInfo>, pub steered: Option<bool>, pub retracted: Option<bool>, pub attachments: Option<Vec<MessageAttachment>>, pub truncated: Option<bool>, pub message_phase: Option<MessagePhase>, pub wake_source_descriptions: Option<Vec<String>>, pub cut_off: Option<bool>, pub summary: Option<Vec<String>>, pub provider_item_id: Option<String>, pub tool_call: ToolCallMembers, pub command_text: Option<String>, pub exit_code: Option<i64>, pub exit_signal: Option<i64>, pub duration_ms: Option<u64>, pub subagent_id: Option<String>, pub agent_path: Option<String>, pub depth: Option<u32>, pub role: Option<String>, pub subagent: SubagentMembers, pub objective: Option<String>, pub child_session_id: Option<String>, pub parent_subagent_id: Option<String>, pub control_status: Option<SubagentControlStatus>, pub workflow_run_id: Option<String>, pub usage: Option<TokenUsage>, pub result: Option<SubagentResult>, pub history_unreadable: Option<bool>, pub workflow: WorkflowMembers, pub reminder_agent_id: Option<String>, pub generation_id: Option<u64>, pub task_id: Option<String>, pub child_session_log_path: Option<String>, pub blocking: Option<bool>, pub side_session_id: Option<String>, pub selector: Option<String>, pub source: Option<String>, pub outcome: Option<CompactionOutcome>, pub trigger: Option<CompactionTrigger>, pub strategy_id: Option<String>, pub summarized_through: Option<String>, pub tokens_before: Option<u64>, pub tokens_after: Option<u64>, pub reason: Option<String>, pub hook_key: Option<String>, pub event: Option<HookEventName>, pub run_status: Option<HookRunStatus>, pub label: Option<String>, pub notice_severity: Option<NoticeSeverity>, pub notice_kind: Option<String>, pub notice_origin: Option<NoticeOrigin>, pub notice_subject: Option<NoticeSubject>, pub web_search: WebSearchMembers, pub monitor_id: Option<String>, pub monitor_description: Option<String>, pub damaged_range: Option<DamagedRange>, pub background_terminal_completion: Option<BackgroundTerminalCompletion>, pub body_completion: Option<BodyCompletionMembers>, pub earlier_history: Option<EarlierHistory>, pub peer_message: Option<PeerMessage>, pub scheduled_fire: ScheduledFireMembers, pub terminal_row_before_item_id: Option<String>, pub terminal_row_after_item_id: Option<String>, pub replay_hint: Option<ReplayHint>, pub input_phase: Option<SubagentInputPhase>, pub delivered_before_turn_end: Option<bool>, pub result_status: Option<SubagentResultStatus>,
}
Expand description

One transcript item at one revision. item/started, item/updated, and item/completed carry the full object; item/delta appends to it by field path.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§item_id: String

Bare UUIDv7; the item’s identity across its whole lifecycle. Identity rule: the task id for task-backed kinds (toolCall, subagent), the pre-minted commit message_id for delta-streamed kinds (agentMessage, reasoning), EventId::derive over the session id and the range’s starting sequence number for damagedRange, the same over the boundary checkpoint’s sequence number for earlierHistory, and the opening durable record’s event id for everything else. Opaque to clients.

§kind: ItemKind

The item kind (open enum): clients MUST render unknown kinds generically — kind name plus status plus fallbackText.

§turn_id: Option<String>

The owning turn. null for the kinds outside a turn: userShell always, hookRun for session-boundary runs, monitorFeed always, sideChat always, damagedRange always, earlierHistory always, systemNotice when produced outside a turn.

§revision: u64

Integer >= 1, strictly monotonic per item; apply rule is replace-iff-higher. item/delta never bumps it.

§status: ItemStatus

Open enum; terminal = anything other than "inProgress". Unknown values MUST be treated as terminal-unknown and rendered generically.

§recorded_at: Option<String>

RFC3339 timestamp of the item’s driving durable record. Absent on ephemeral-opened items until first durable re-emission.

§fallback_text: Option<String>

Server-provided one-line human summary any kind MAY carry, for generic rendering of kinds a client does not recognize; new kinds SHOULD carry it during their first release cycle.

§text: Option<String>

userMessage: the prompt text as submitted. agentMessage: the accumulated reply, streamed via item/delta field "text". reasoning: raw committed reasoning text where the provider exposes it.

§display_text: Option<String>

userMessage: presentation form; absent when the client sent none.

§command_id: Option<String>

userMessage/userShell: the submitting command — multi-client UIs de-duplicate their local echo on it.

§by_client: Option<ClientInfo>

userMessage: the client that sent the message or steer; absent when unrecorded and on older logs.

§steered: Option<bool>

userMessage: true when injected mid-turn via turn/steer or ifBusy: "steer"; absent otherwise.

§retracted: Option<bool>

userMessage: true after an accepted retract; re-emitted via item/updated.

§attachments: Option<Vec<MessageAttachment>>

userMessage: image attachment metadata only — base64 payloads are not echoed back on the view.

§truncated: Option<bool>

true when the server’s per-surface text budget saturated a streamed surface (agentMessage.text, reasoning.summary[*], toolCall.visibleOutput, userShell.visibleOutput), cut a subagent surface (objective, fallbackText, result.summary, result.text), or cut a monitorFeed surface (text, fallbackText, monitorDescription), or cut a systemNotice surface. On a subagent item the flag is item-level and never cleared: once any of those four is cut, every later update keeps it, even when result.text arrives whole. The durable full text remains in the log.

§message_phase: Option<MessagePhase>

agentMessage: the phase the model declared; see MessagePhase.

§wake_source_descriptions: Option<Vec<String>>

agentMessage: the Monitor source descriptions for the wake turn’s first answer — stripped, bounded, one entry per arming drain in drain order. Absent (or empty) means untagged: the row renders the ordinary untagged shape. The client scrubs per part before joining.

§cut_off: Option<bool>

agentMessage: true when the provider stream died mid-reply and the run failed with this partial text committed — the wire mark for the gate-off “incomplete response” rule. Absent otherwise; never cleared once set.

§summary: Option<Vec<String>>

reasoning: one entry per summary part; part n streams via item/delta field "summary.n" (part boundary = index change).

§provider_item_id: Option<String>

reasoning: provider reasoning item id (e.g. rs_...), for provider-side correlation.

§tool_call: ToolCallMembers

toolCall members, flattened beside the other optional members.

§command_text: Option<String>

userShell: the command text as submitted.

§exit_code: Option<i64>

userShell: the process exit code, when it exited by code.

§exit_signal: Option<i64>

userShell: the terminating signal NUMBER, when signalled (e.g. 9) — the durable payload verbatim; nothing maps numbers to names, and the fold never invents one.

§duration_ms: Option<u64>

userShell/subagent: observed wall-clock duration. workflow: the run’s wall time from launch to reconciliation, set only on the settling item/completed — never a sum of child durations. toolCall: the Backgrounded row’s duration — the open→update record delta in whole ms, served on the backgroundStatus re-emission and frozen there; absent otherwise.

§subagent_id: Option<String>

subagent: durable child identity (subagent_id).

§agent_path: Option<String>

subagent: agent definition path.

§depth: Option<u32>

subagent: nesting depth.

§role: Option<String>

subagent: role as spawned.

§subagent: SubagentMembers

subagent members, flattened beside the other optional members.

§objective: Option<String>

subagent: objective as spawned, bounded on the wire at the 64 KiB retained-text budget; a cut sets truncated. The durable record stays verbatim.

§child_session_id: Option<String>

subagent/reminderChild: the child’s own session id, readable via session/read/view/page — child transcript drill-down without a second protocol.

§parent_subagent_id: Option<String>

subagent: the subagentId of the subagent whose own session spawned this child, by subagent/list’s parentSubagentId rule. Additive-optional: absent for a child of the view’s own session, or when no open subagent item in this view owns the spawning session; never guessed, never derived from agentPath.

§control_status: Option<SubagentControlStatus>

subagent: camelCased SubagentControlStatus (open enum); status stays the generic item vocabulary.

§workflow_run_id: Option<String>

subagent/workflow: the owning durable workflow run id (opaque string — not a UUID family).

§usage: Option<TokenUsage>

subagent: transitive observed usage — the child and its own descendants; updated in place, absent until first observation; never folded into session/tokenUsage.cumulative.

§result: Option<SubagentResult>

subagent: the result envelope from ResultReady.

§history_unreadable: Option<bool>

subagent: the host could not read this live child’s run records when the parent resumed; a client says so once. A resume-time observation: present only as true, absent otherwise, never false, and never carried by a live notification.

§workflow: WorkflowMembers

workflow members, flattened into the item row.

§reminder_agent_id: Option<String>

reminderChild: the reminder agent’s id.

§generation_id: Option<u64>

reminderChild: the reminder generation.

§task_id: Option<String>

reminderChild: the linked task id. Unresolved bodyCompletion items also set it.

§child_session_log_path: Option<String>

reminderChild: parent-session-dir-relative child log path; absent when no filesystem log.

§blocking: Option<bool>

reminderChild: true when this child is a blocking reminder (it holds the turn open until it settles); absent otherwise, never false. The status word stays off the wire; clients name the reminder from reminderAgentId.

§side_session_id: Option<String>

sideChat: the side’s own session id, readable via session/read/view/page — drill-down without a second protocol.

§selector: Option<String>

skillRead: the read skill’s catalog selector (matches the skill/list row; the raw observed id when the read resolved to no catalog row). Set on every skillRead item; old clients render it beside the kind name.

§source: Option<String>

skillRead: the catalog source (matches the skill/list row); empty when the host could not resolve the read to a catalog row (replay without the tool result, context-only evidence). Set on every skillRead item; each client composes the notice line from selector + source.

§outcome: Option<CompactionOutcome>

compaction: terminal only — folds installed/fallback status.

§trigger: Option<CompactionTrigger>

compaction: what initiated the compaction.

§strategy_id: Option<String>

compaction: summarizer strategy (installed only).

§summarized_through: Option<String>

compaction: opaque provenance string naming the compaction boundary. Also a compaction-anchored read anchor, accepted by session/resume and view/page. Still opaque — clients relay it, never parse it.

§tokens_before: Option<u64>

compaction: token budget snapshot before, when measured.

§tokens_after: Option<u64>

compaction: token budget snapshot after, when measured.

§reason: Option<String>

compaction: noop/failure reason, verbatim (snake_case durable vocabulary, e.g. "no_compactable_history"). hookRun: terminal-only capped terminal reason.

§hook_key: Option<String>

hookRun: the durable hook_key.

§event: Option<HookEventName>

hookRun: the hook event in Q2 camelCase vocabulary.

§run_status: Option<HookRunStatus>

hookRun: terminal-only durable outcome; stays blocked when the item settles rejected.

§label: Option<String>

hookRun: capped display label.

§notice_severity: Option<NoticeSeverity>

systemNotice: the notice’s level — info | warning | error, open. Absent means the server classified no level.

§notice_kind: Option<String>

systemNotice: an optional open machine code for what happened, minted per origin by the slice that adds its producer; omitted for monitor and for hook.

§notice_origin: Option<NoticeOrigin>

systemNotice: the producing family, so a client routes a notice without parsing its text. Absent means the server named no origin: render generically, never infer one.

§notice_subject: Option<NoticeSubject>

systemNotice: the durable thing the notice is about — for hook, the hook run’s item id and its bounded label.

§web_search: WebSearchMembers

webSearch members, flattened into the item row.

§monitor_id: Option<String>

monitorFeed: the monitor task id — the same value as that monitor’s toolCall itemId.

§monitor_description: Option<String>

monitorFeed: the monitor’s arm-time description with the durable "Monitor event: " summary prefix stripped; model- controlled tool input under the 64 KiB per-surface budget — sanitize before render.

§damaged_range: Option<DamagedRange>

damagedRange: what the damaged range cost.

§background_terminal_completion: Option<BackgroundTerminalCompletion>

backgroundTerminalCompletion: the five facts the Finished cell renders.

§body_completion: Option<BodyCompletionMembers>

bodyCompletion: the facts one receipt row renders.

§earlier_history: Option<EarlierHistory>

earlierHistory: the boundary checkpoint’s transcript tail.

§peer_message: Option<PeerMessage>

peerMessage: the four facts the consumed card renders.

§scheduled_fire: ScheduledFireMembers

scheduledFire members, flattened beside the other optional members.

§terminal_row_before_item_id: Option<String>

backgroundTerminalCompletion, or a terminal toolCall that already shows a Finished row: render before the target’s whole coalesced region.

§terminal_row_after_item_id: Option<String>

Terminal monitor toolCall, drained subagent, backgroundTerminalCompletion, or Finished-row toolCall: render after the target’s logical rows.

§replay_hint: Option<ReplayHint>

Monitor toolCall: the hint verdict plus anchor (ReplayHint); absent means no hint.

§input_phase: Option<SubagentInputPhase>

subagentInput: the record the item stands for; see SubagentInputPhase.

§delivered_before_turn_end: Option<bool>

subagentInput (delivered): true when the drain landed on its turn before that turn’s terminal, which ends the turn’s final answer as gate-off’s drain record does; absent otherwise.

§result_status: Option<SubagentResultStatus>

subagentResult: the consumed attempt’s outcome; absent if unseen at the drain.

Trait Implementations§

Source§

impl Clone for Item

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Item

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Item

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Item

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for Item

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Item

Auto Trait Implementations§

§

impl Forget for Item

§

impl Freeze for Item

§

impl Move for Item

§

impl RefUnwindSafe for Item

§

impl Send for Item

§

impl Sync for Item

§

impl Unpin for Item

§

impl UnsafeUnpin for Item

§

impl UnwindSafe for Item

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.