Struct RunFinishedEvent 

pub struct RunFinishedEvent {
    pub base: BaseEvent,
    pub thread_id: ThreadId,
    pub run_id: RunId,
    pub result: Option<Value>,
    pub outcome: Option<RunOutcome>,
    pub usage: Option<Vec<TokenUsage>>,
}

The last event of a run that did not error.

“Finished” includes paused: an RunOutcome::Interrupt outcome means the agent is waiting on human input and the run continues on the next request.

Fields

base: BaseEvent

Timestamp and raw provider event.

thread_id: ThreadId

The conversation this run belongs to.

run_id: RunId

The run that finished.

result: Option<Value>

Agent-defined return value.

outcome: Option<RunOutcome>

How the run ended. Absent from producers that predate the interrupt protocol, which consumers read as success. A JSON null also reads as absent, for producers that serialize None rather than omitting it.

usage: Option<Vec<TokenUsage>>

Token usage, one entry per (provider, model) the run invoked.

Implementations

impl RunFinishedEvent

pub fn new(thread_id: impl Into<ThreadId>, run_id: impl Into<RunId>) -> Self

Finishes a run without declaring an outcome (legacy shape).

pub fn with_outcome(self, outcome: RunOutcome) -> Self

Sets the outcome.

pub fn with_result(self, result: impl Into<Value>) -> Self

Sets the return value.

pub fn with_usage(self, usage: impl Into<Vec<TokenUsage>>) -> Self

Sets the token usage.

Trait Implementations

impl Clone for RunFinishedEvent

fn clone(&self) -> RunFinishedEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for RunFinishedEvent

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for RunFinishedEvent

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

Formats the value using the given formatter.

impl Default for RunFinishedEvent

fn default() -> RunFinishedEvent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunFinishedEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RunFinishedEvent> for Event

fn from(payload: RunFinishedEvent) -> Self

Converts to this type from the input type.

impl JsonSchema for RunFinishedEvent

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for RunFinishedEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RunFinishedEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RunFinishedEvent

impl ToSchema for RunFinishedEvent

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.