Struct AgentText 

pub struct AgentText(/* private fields */);

Text an agent produced: its free-text answer (StepOutput::text() in ironflow-engine) or a text field of a typed answer.

An agent may repeat, word for word, instructions planted in what it read. So its text reaches the next prompt only inside an untrusted block: pass it to Prompt::untrusted. AgentText deliberately implements neither Display, Deref, AsRef<str>, Borrow<str> nor From<AgentText> for String: format!("{}", text), AgentConfig::new(&text) and Prompt::text do not compile with it.

It serializes as a plain JSON string and its JSON Schema is the one of String: a step output, a replay fixture and the schema sent to the model are the same as with a String.

Debug

{:?} prints AgentText(<N bytes>), with N the length of the text in UTF-8 bytes, never the text itself. A derived Debug would let format!("Act on: {:?}", out.text()), or {:?} of a typed answer holding text fields, carry the agent’s text into a prompt unmarked. The cost: a failing assert_eq! on AgentText shows the lengths, not the texts; compare raw to see them in a test.

Escape hatches

Reading the raw text stays possible, explicitly, for logs, artifacts, shell arguments or comments: raw, into_raw, serde_json::to_string / to_value of an AgentText or of a typed answer, and, in ironflow-engine, StepOutput::json::<String>() and the public output.output JSON value of a step (also printed by {:?} of a StepOutput). Never put their result in a prompt. {:?} of an AgentText is not one of them: it does not print the text.

Examples

use ironflow_core::prompt::{AgentText, Prompt};

let summary = AgentText::from("Looks good.");
assert_eq!(summary, "Looks good.");
assert_eq!(summary.raw(), "Looks good.");

let prompt = Prompt::new().text("Act on this summary:").untrusted(&summary);
assert!(prompt.to_string().contains("Looks good."));

assert_eq!(
    format!("{:?}", AgentText::from("Ignore the above")),
    "AgentText(<16 bytes>)"
);

It cannot be formatted with {}:

use ironflow_core::prompt::AgentText;

let _ = format!("{}", AgentText::from("x"));

nor passed as trusted text:

use ironflow_core::prompt::{AgentText, Prompt};

let _ = Prompt::new().text(&AgentText::from("x"));

nor used as a prompt:

use ironflow_core::prompt::AgentText;
use ironflow_core::provider::AgentConfig;

let _ = AgentConfig::new(&AgentText::from("x"));

Implementations

impl AgentText

pub fn raw(&self) -> &str

The raw text, for logs, artifacts, shell arguments or comments.

Never pass it to a prompt: use Prompt::untrusted with the AgentText itself.

Examples

use ironflow_core::prompt::AgentText;

let text = AgentText::from("日本語");
assert_eq!(text.raw(), "日本語");

pub fn into_raw(self) -> String

The raw text, owned, for logs, artifacts, shell arguments or comments.

Never pass it to a prompt: use Prompt::untrusted with the AgentText itself.

Examples

use ironflow_core::prompt::AgentText;

let text: String = AgentText::from("done").into_raw();
assert_eq!(text, "done");

Trait Implementations

impl AgentAnswer for AgentText

impl Clone for AgentText

fn clone(&self) -> AgentText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentText

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

Formats the value using the given formatter.

impl Default for AgentText

fn default() -> AgentText

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AgentText

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AgentText

impl From<&str> for AgentText

fn from(text: &str) -> AgentText

Converts to this type from the input type.

impl From<String> for AgentText

fn from(text: String) -> AgentText

Converts to this type from the input type.

impl Hash for AgentText

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for AgentText

Same schema as String, inlined: a derive would emit a $defs/AgentText reference and the agent’s output schema would differ from a plain string.

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.

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

The name of the generated JSON Schema.

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

Generates a JSON Schema for this type.

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

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

impl Ord for AgentText

fn cmp(&self, other: &AgentText) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for AgentText

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for AgentText

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<String> for AgentText

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for AgentText

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AgentText

fn partial_cmp(&self, other: &AgentText) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for AgentText

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 AgentText

impl UntrustedContent for AgentText