Enum ScriptOutput 

pub enum ScriptOutput {
    Observation {
        value: Value,
    },
    Error {
        message: String,
    },
    FinalResult {
        value: Value,
    },
    TransferToAgent {
        agent_name: String,
    },
}

Available on crate features agents and codeact only.

The typed value a CodeAct script must return.

Encoded as an internally tagged object keyed on type, e.g. {"type": "final_result", "value": ...}. This wire shape is language-agnostic; how a script constructs it is described to the model by the runtime (see RuntimeCapabilities::prompt).

Variants

Observation

Intermediate information the model wants to inspect before continuing.

Fields

value: Value

Arbitrary JSON payload surfaced back to the model.

Error

An error the model should react to. Just a message string.

Fields

message: String

The error text, in whatever form the model expects.

FinalResult

The terminal answer. Ends the CodeAct loop.

Fields

value: Value

Arbitrary JSON payload returned to the caller.

TransferToAgent

Hand control to another agent (a sub-agent, or a target the Runner supplied via RunConfig::transfer_targets). Ends this agent’s loop; the named agent takes over, exactly as a LlmAgent transfer_to_agent call would.

This variant is only described to the model when transfer targets are available. If the model emits it with an unknown target, the host feeds the error back instead of transferring.

Fields

agent_name: String

The name of the agent to transfer control to.

Implementations

impl ScriptOutput

pub fn decode(value: Value) -> ScriptOutput

Decode a completed script’s returned value into a ScriptOutput.

A value that does not conform to the tagged contract becomes an ScriptOutput::Error telling the model to return a proper value next turn, rather than crashing the run.

Example

use adk_agent::codeact::ScriptOutput;
use serde_json::json;

let out = ScriptOutput::decode(json!({"type": "final_result", "value": 42}));
assert!(matches!(out, ScriptOutput::FinalResult { .. }));

Trait Implementations

impl Clone for ScriptOutput

fn clone(&self) -> ScriptOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScriptOutput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScriptOutput

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ScriptOutput

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.

impl StructuralPartialEq for ScriptOutput