Struct FoundryLocalChatClient 

pub struct FoundryLocalChatClient { /* private fields */ }

A Microsoft Foundry Local chat client (POST {base_url}/chat/completions).

Implementations

impl FoundryLocalChatClient

pub fn new(model: impl Into<String>) -> Self

Create a client for the given default model, targeting http://localhost:5273/v1.

pub fn from_env(model: impl Into<String>) -> Result<Self>

Build a client from the environment. Foundry Local has no required credential env var (a stock instance is unauthenticated), so this never fails on missing configuration; it only reads the optional FOUNDRY_LOCAL_ENDPOINT_ENV (FOUNDRY_LOCAL_ENDPOINT) to override the default base URL and FOUNDRY_LOCAL_API_KEY_ENV (FOUNDRY_LOCAL_API_KEY) to set a bearer token, if present.

pub fn with_base_url(self, base_url: impl Into<String>) -> Self

Override the base URL (for a non-default port, or a remote Foundry Local host). Must be the OpenAI-compatible root (i.e. include the /v1 suffix), matching FoundryLocalChatClient::new’s default.

pub fn with_api_key(self, api_key: impl Into<String>) -> Self

Set a bearer token sent as Authorization: Bearer <key>. Not needed for a stock local Foundry Local instance; useful when one sits behind an authenticating proxy.

pub fn model(&self) -> &str

The default model id.

pub fn base_url(&self) -> &str

The configured base URL.

Trait Implementations

impl ChatClient for FoundryLocalChatClient

fn get_response<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, options: ChatOptions, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse>> + Send + 'async_trait>>

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

Get a complete (non-streaming) response.

fn get_streaming_response<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, options: ChatOptions, ) -> Pin<Box<dyn Future<Output = Result<ChatStream>> + Send + 'async_trait>>

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

Get a streaming response as a sequence of updates.

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

The default model id for this client, if any.

impl Clone for FoundryLocalChatClient

fn clone(&self) -> FoundryLocalChatClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FoundryLocalChatClient

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

Formats the value using the given formatter.