Struct FoundryAgent 

pub struct FoundryAgent { /* private fields */ }

A SupportsAgentRun that runs a Foundry Prompt Agent over the Responses API.

Built from a FoundryChatClient plus a PromptAgentDefinition (name/instructions/model/tools): internally it constructs a core Agent over that client with the definition applied, and every SupportsAgentRun method delegates straight through to it. to_prompt_agent hands back the definition the agent was built from, so it round-trips through FoundryAgent::from_definition.

This realizes a Prompt Agent client-side, entirely through the stateless Responses API — it does not create, fetch, or bind to a server-hosted agent by id/name on the Foundry Agents control plane (AIProjectClient.agents.*). Wiring up that control plane, so FoundryAgent could target a Prompt Agent or Hosted Agent that already exists on the service (e.g. a future agent_id/with_existing_agent constructor), is a documented extension point, not implemented here.

Implementations

impl FoundryAgent

pub fn builder(client: FoundryChatClient) -> FoundryAgentBuilder

Start building a FoundryAgent over client.

pub fn from_definition( client: FoundryChatClient, definition: PromptAgentDefinition, ) -> Self

Build a FoundryAgent directly from a PromptAgentDefinition.

The inner Agent’s id and name are both set to definition.name (the core AgentBuilder otherwise defaults id to a random UUID).

pub fn to_prompt_agent(&self) -> PromptAgentDefinition

The PromptAgentDefinition this agent was built from — round-trips through FoundryAgent::from_definition.

pub fn inner(&self) -> &Agent

The wrapped core Agent, for functionality (e.g. Agent::as_tool) not exposed directly on FoundryAgent.

Trait Implementations

impl Clone for FoundryAgent

fn clone(&self) -> FoundryAgent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FoundryAgent

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

Formats the value using the given formatter.

impl SupportsAgentRun for FoundryAgent

fn run<'life0, 'life1, 'async_trait>( &'life0 self, messages: Vec<Message>, session: Option<&'life1 mut AgentSession>, ) -> Pin<Box<dyn Future<Output = Result<AgentResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Run the agent to completion.

fn run_with_options<'life0, 'life1, 'async_trait>( &'life0 self, messages: Vec<Message>, session: Option<&'life1 mut AgentSession>, options: AgentRunOptions, ) -> Pin<Box<dyn Future<Output = Result<AgentResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Run the agent to completion, applying per-run AgentRunOptions over the agent’s build-time defaults.

fn run_stream<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, session: Option<AgentSession>, options: Option<AgentRunOptions>, ) -> Pin<Box<dyn Future<Output = Result<AgentRunStream>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Run the agent and stream incremental AgentResponseUpdates.

fn id(&self) -> &str

A stable identifier for this agent.

fn name(&self) -> Option<&str>

The optional human-readable name.

fn display_name(&self) -> String

The display name: name if set, else id.

fn create_session(&self) -> AgentSession

A fresh session for a new conversation.