Struct EffectOutput 

pub struct EffectOutput {
    pub observation_for_model: String,
    pub display: Option<DisplayOutput>,
    pub artifacts: Vec<Artifact>,
    pub memory_policy: ToolMemoryPolicy,
    pub metadata: BTreeMap<String, Value>,
}

Output produced by an executed effect.

Fields

observation_for_model: String

Model-visible observation text.

display: Option<DisplayOutput>

Optional host/UI display output.

artifacts: Vec<Artifact>

Artifact handles produced by the effect.

memory_policy: ToolMemoryPolicy

Memory policy for the model-visible observation.

metadata: BTreeMap<String, Value>

Host/application metadata.

Implementations

impl EffectOutput

pub fn text(observation_for_model: impl Into<String>) -> EffectOutput

Constructs a text observation for the model.

pub fn with_display(self, display: DisplayOutput) -> EffectOutput

Sets host/UI display output.

pub fn with_artifacts(self, artifacts: Vec<Artifact>) -> EffectOutput

Sets artifact handles.

pub fn with_memory_policy(self, policy: ToolMemoryPolicy) -> EffectOutput

Sets the memory policy.

pub fn with_metadata(self, metadata: BTreeMap<String, Value>) -> EffectOutput

Sets host/application metadata.

Trait Implementations

impl Clone for EffectOutput

fn clone(&self) -> EffectOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EffectOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EffectOutput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EffectOutput

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EffectOutput

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 EffectOutput