Struct PhiAgent 

pub struct PhiAgent {
    pub config: PhiAgentConfig,
    /* private fields */
}

A built Agent instance.

Wraps AgentRuntime with common operations behind a simpler API.

Example

let agent = PhiAgent::build(builder, config)?;
let session = agent.create_session().await;
agent.run_turn(session, "Hello!", |event| renderer.render(event)).await?;

Fields

config: PhiAgentConfig

The configuration this agent was built with.

Implementations

impl PhiAgent

pub fn builder( llm_client: Arc<dyn LlmClient>, system_prompt: String, ) -> AgentBuilder

Create a pre-configured AgentBuilder.

Equivalent to base_agent_builder(llm_client).system_prompt(system_prompt), after which you register tools, middleware, and approval handlers, then call Self::build.

pub fn build(builder: AgentBuilder, config: PhiAgentConfig) -> Result<Self>

Build from an AgentBuilder.

pub async fn create_session(&self) -> SessionId

Create an agent session.

pub async fn run_turn<F>( &self, session_id: SessionId, query: &str, on_event: F, ) -> AgentResult<RunOutcome>

where F: FnMut(RuntimeEvent) -> AgentResult<()> + Send,

Execute one turn.

pub fn cancel(&self)

Cancel the currently executing turn.

pub fn is_cancelled(&self) -> bool

Check whether the agent has been cancelled.

pub async fn set_reasoning_effort(&self, effort: ReasoningEffort)

Set the reasoning effort.

pub fn runtime(&self) -> &AgentRuntime

Access the underlying runtime (for advanced use like hook registration).

pub async fn list_tools(&self) -> Vec<(String, String)>

List all registered tools with their names and descriptions, sorted by name.

Trait Implementations

impl Clone for PhiAgent

fn clone(&self) -> PhiAgent

Returns a duplicate of the value.

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

Performs copy-assignment from source.