Skip to main content

AgentOutcome

Struct AgentOutcome 

Source
pub struct AgentOutcome {
    pub text: String,
    pub final_message: String,
    pub stop_reason: String,
    pub session_id: String,
}
Expand description

The canonical agent-outcome record: what a completed agent activity’s result payload carries, from every harness.

Four fields, all snake_case, all mandatory, all AWL-expressible — the AWL checker demands an agent action’s declared return type be a record of exactly this shape (text: String, final_message: String, stop_reason: String, session_id: String), so a workflow reads those values as ordinary record fields.

Empty text and final_message values on a completed run are honest, not a bug: an agent that finished its turn having emitted only tool calls said nothing, and the harness reports that truth rather than inventing words (the work is on the transcript). When the run produced exactly one completed answer, final_message == text; that duplication is the honest degenerate case. stop_reason is one of the canonical strings produced by StopKind::canonical_stop_reason: end_turn | tool_use | limit_reached | cancelled | error | other.

Fields§

§text: String

The whole run output: every completed agent answer, accumulated by the harness.

§final_message: String

The run’s LAST completed agent answer message, alone and exactly as the agent said it.

Reasoning, tool output, and user turns never enter this field. It exists separately from Self::text so an exact-token judge reads the actual final verdict rather than falsely failing a successful run because narration from earlier answers precedes it. It is empty when the agent produced no answer text at all, and equals text when there was exactly one answer.

§stop_reason: String

The canonical snake_case stop reason (StopKind::canonical_stop_reason).

§session_id: String

The handle of the conversation that produced this outcome.

A FACT, not a promise: the id names the session the harness actually ran — minted, loaded, or derived by that harness — and says nothing about whether it can be resumed. Resumability is the per-agent question a harness’s own handshake answers (for ACP, the initialize response’s loadSession capability), never something this field asserts.

The id is meaningful only to the harness that minted it; resume routing pairs the id with the harness identity the workflow record already carries. It is never empty — a harness with a vacant handle is refused at AgentOutcome::into_payload, not shipped.

Implementations§

Source§

impl AgentOutcome

Source

pub fn new( text: impl Into<String>, final_message: impl Into<String>, stop: &StopKind, session_id: impl Into<String>, ) -> AgentOutcome

Builds the record from the whole accumulated answer text, the last completed answer alone, the neutral stop kind, and the conversation handle, spelling stop_reason through the one canonical mapping.

Source

pub fn into_payload(self) -> Result<Payload, AgentOutcomeError>

Serializes the record as the activity’s JSON result Payload.

§Errors

AgentOutcomeError::EmptySessionId when the mandatory session_id is the empty string — the vacancy is refused by name rather than shipped. AgentOutcomeError::Encode when the record cannot be encoded — unreachable for four plain strings, but never swallowed.

Trait Implementations§

Source§

impl Clone for AgentOutcome

Source§

fn clone(&self) -> AgentOutcome

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 AgentOutcome

Source§

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

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

impl<'de> Deserialize<'de> for AgentOutcome

Source§

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

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

impl Eq for AgentOutcome

Source§

impl PartialEq for AgentOutcome

Source§

fn eq(&self, other: &AgentOutcome) -> 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 AgentOutcome

Source§

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

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

impl StructuralPartialEq for AgentOutcome

Source§

impl TS for AgentOutcome

Source§

type WithoutGenerics = AgentOutcome

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None. Read more
Source§

type OptionInnerType = AgentOutcome

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.
Source§

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.
Source§

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes
Source§

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters
Source§

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().
Source§

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration. Read more
Source§

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.
Source§

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.
Source§

fn visit_generics(v: &mut impl TypeVisitor)
where AgentOutcome: 'static,

Iterates over all type parameters of this type.
Source§

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory. Read more
Source§

fn visit_dependencies(v: &mut impl TypeVisitor)
where AgentOutcome: 'static,

Iterates over all dependency of this type.
Source§

fn dependencies(cfg: &Config) -> Vec<Dependency>
where Self: 'static,

Resolves all dependencies of this type recursively.
Source§

fn export(cfg: &Config) -> Result<(), ExportError>
where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all. Read more
Source§

fn export_all(cfg: &Config) -> Result<(), ExportError>
where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export. Read more
Source§

fn export_to_string(cfg: &Config) -> Result<String, ExportError>
where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled. Read more

Auto Trait Implementations§

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> Same for T

Source§

type Output = T

Should always be Self
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, <T as TryFrom<U>>::Error>

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.