Expand description
Deprecated compatibility shim for the canonical core module in the Everruns ecosystem.
This is the final forwarding release. Enable the matching everruns-core
feature and migrate imports to its module before the next platform release.
use everruns_core::ag_ui::{Event, RunStartedEvent};
let event = Event::RunStarted(RunStartedEvent::new("thread", "run"));
let _ = event;Modules§
- consumer
- The consumer side of AG-UI 1.0: turning a producer’s event stream into
a checked, assembled
RunResult.
Structs§
- Activity
Delta Event - Activity
Message - Structured progress, as a message whose content is an object.
- Activity
Snapshot Event - Structured progress: an activity message whose content is an object.
- Agent
Capabilities - What an agent declares it can do. Omitted means undeclared; the stream is authoritative. How a consumer obtains a declaration is left to the implementation.
- Assistant
Message - Base
Event - Fields every event may carry.
- Context
- A piece of context the consumer supplies to the run.
- Custom
Event - Execution
Capabilities - Function
Call - Human
InThe Loop Capabilities - Identity
Capabilities - Interrupt
- Something a run stopped to ask for, carried by the interrupt outcome.
- Media
Part - An image, audio, video or document part.
- Messages
Snapshot Event - Multi
Agent Capabilities - Multimodal
Capabilities - Multimodal
Input Capabilities - Multimodal
Output Capabilities - Output
Capabilities - RawEvent
- Reasoning
Capabilities - Reasoning
Encrypted Value Event - A provider reasoning artefact a consumer stores and returns without reading.
- Reasoning
Message - Reasoning
Message Chunk Event - Reasoning
Message Content Event - Reasoning
Message EndEvent - Reasoning
Message Start Event - Reasoning
Span Event REASONING_STARTandREASONING_END: a reasoning span. Spans and reasoning messages are separate namespaces.- Resume
Builder - Builds the
resumelist for a run that continues an interrupted one. - Resume
Entry - The answer to one
Interrupton a resuming run. - RunAgent
Input - The request body that starts a run.
- RunError
Event - RunFinished
Event - RunStarted
Event - State
Capabilities - State
Delta Event - State
Snapshot Event - Step
Event STEP_STARTEDandSTEP_FINISHED.- Subagent
Error Event - Subagent
Finished Event - Subagent
Info - Subagent
Started Event - Announces a subagent invocation before any event attributed to it.
- Text
Message Chunk Event - The chunked form: the first chunk must carry
messageId; later chunks may omit it. - Text
Message Content Event - Text
Message EndEvent - Text
Message Start Event - Text
Only Message - A
developerorsystemmessage: text only. - Text
Part - Token
Usage - Token usage of one provider and model. Input and output counts are totals; cached and reasoning tokens are parts of them.
- Tool
- A frontend tool definition.
- Tool
Call - A tool call on an assistant message.
- Tool
Call Args Event - Tool
Call Chunk Event - The chunked form: the first chunk must carry
toolCallIdandtoolCallName; later chunks may omit them. - Tool
Call EndEvent - Tool
Call Result Event - A tool result. It is a message in its own right (
messageId) and does not reopen the call it answers. - Tool
Call Start Event - Tool
Message - The result of a tool call, as a message in the thread.
- Tools
Capabilities - Transport
Capabilities - User
Message
Enums§
- Content
- Message content: a string, or an ordered list of parts.
- Content
Part - One part of multimodal content, tagged by
type. - Event
- One AG-UI event, tagged by
type. - Json
Patch Operation - One JSON Patch operation, tagged by
op. Paths are JSON Pointers. - Message
- A message in a thread, tagged by
role. - Part
Source - Where a media part’s bytes are, tagged by
type. - Reasoning
Encrypted Value Subtype - Reasoning
Role - The only role a reasoning message may carry.
- Resume
Error - A resume list that breaks the coverage rule.
- Resume
Status - RunFinished
Outcome - How a run ended, tagged by
type. - Subagent
Finished Outcome - Text
Message Role - Roles a
TEXT_MESSAGE_STARTmay open. - Tool
Call Type - Tool
Role - The only role a tool result may carry.
Constants§
- PROTOCOL_
VERSION - The AG-UI protocol version these types implement.
- SCHEMA_
JSON - The upstream JSON Schema these types implement, verbatim.
Functions§
- check_
resume_ coverage - Checks an already-built resume list against the open interrupts.