Skip to main content

PiMessage

Enum PiMessage 

Source
pub enum PiMessage {
    System {
        content: Value,
        sections: Map<String, Value>,
        tools_added: Vec<Value>,
        tools_removed: Vec<Value>,
        timestamp: f64,
        extra: Map<String, Value>,
    },
    User {
        content: Value,
        timestamp: f64,
        attachments: Vec<Value>,
        extra: Map<String, Value>,
    },
    Assistant {
        content: Vec<ContentBlock>,
        api: String,
        provider: String,
        model: String,
        usage: Option<Usage>,
        stop_reason: String,
        thinking_level: Option<String>,
        timestamp: f64,
        extra: Map<String, Value>,
    },
    ToolResult {
        tool_call_id: String,
        tool_name: String,
        content: Value,
        usage: Option<Usage>,
        is_error: bool,
        timestamp: f64,
        extra: Map<String, Value>,
    },
    BashExecution {
        command: String,
        output: String,
        exit_code: Option<i64>,
        cancelled: bool,
        truncated: bool,
        full_output_path: Option<String>,
        timestamp: f64,
        extra: Map<String, Value>,
    },
}
Expand description

A conversation message, discriminated on role. This is pi’s AgentMessage union plus the RPC-only bashExecution role.

Variants§

§

System

The prompt and tool loadout (pi ≥ 0.86.0). The first request of a session emits one carrying every prompt section and tool declaration; later changes emit further system messages that patch sections by name (null removes one) and list toolsAdded / toolsRemoved. Replaying them in order yields the current prompt and tools. Streams as message_start / message_end ahead of the user message and leads agent_end’s messages.

Fields

§content: Value

A plain string or an array of text blocks; empty when the prompt lives entirely in sections.

§sections: Map<String, Value>

Named prompt sections (preamble, tools, rules, cwd, docs, project_context, …) — string bodies, or null to remove a section declared earlier.

§tools_added: Vec<Value>

Full tool declarations (name, description, parameters) now available to the model.

§tools_removed: Vec<Value>

{ "name": ... } references for tools withdrawn.

§timestamp: f64
§extra: Map<String, Value>
§

User

Fields

§content: Value

A plain string or an array of content blocks — both are legal.

§timestamp: f64
§attachments: Vec<Value>
§extra: Map<String, Value>
§

Assistant

Fields

§provider: String
§model: String
§usage: Option<Usage>
§stop_reason: String

stop, length, toolUse, error, aborted, or (harness-v2) deferred. Left open for forward compat.

§thinking_level: Option<String>

The pi thinking level the agent loop requested for this response (pi ≥ 0.99.0). Absent outside the agent loop and on messages from older sessions.

§timestamp: f64
§extra: Map<String, Value>
§

ToolResult

Fields

§tool_call_id: String
§tool_name: String
§content: Value
§usage: Option<Usage>

Nested LLM work performed by the tool; contributes to session totals when present.

§is_error: bool
§timestamp: f64
§extra: Map<String, Value>
§

BashExecution

Created by the RPC bash command, never by LLM tool calls. On the next prompt it is rewritten into a user message for the model.

Fields

§command: String
§output: String
§exit_code: Option<i64>
§cancelled: bool
§truncated: bool
§full_output_path: Option<String>
§timestamp: f64
§extra: Map<String, Value>

Trait Implementations§

Source§

impl Clone for PiMessage

Source§

fn clone(&self) -> Self

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 PiMessage

Source§

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

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

impl<'de> Deserialize<'de> for PiMessage

Source§

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

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

impl PartialEq for PiMessage

Source§

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

Source§

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

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

impl StructuralPartialEq for PiMessage

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> 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, !>

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.