Struct SystemLanguageModel 

pub struct SystemLanguageModel { /* private fields */ }

The system language model provided by Apple Intelligence.

This is the main entry point for using on-device AI capabilities. Use SystemLanguageModel::new() to get the default model.

Example

use fm_rs::SystemLanguageModel;

let model = SystemLanguageModel::new()?;
if model.is_available() {
    println!("Model is ready to use!");
}

Implementations

impl SystemLanguageModel

pub fn new() -> Result<Self>

Creates the default system language model.

Errors

Returns an error if the model cannot be created or if FoundationModels is not available on the device.

pub fn is_available(&self) -> bool

Checks if the model is available for use.

Returns true if the model is available and ready to generate responses.

pub fn availability(&self) -> ModelAvailability

Gets the current availability status of the model.

This provides more detailed information about why the model might not be available.

pub fn ensure_available(&self) -> Result<()>

Returns a reason-specific error if the model is unavailable.

pub fn token_usage_for(&self, prompt: &str) -> Result<TokenUsage>

Returns token usage for a prompt.

Uses platform token-usage APIs when available in both the build SDK and runtime. Otherwise returns a heuristic estimate.

pub fn token_usage_for_tools( &self, instructions: &str, tools: &[Arc<dyn Tool>], ) -> Result<TokenUsage>

Returns token usage for session instructions and tool definitions.

Tool definitions are serialized from the Rust Tool trait objects. Uses platform token-usage APIs when available in both the build SDK and runtime. Otherwise returns a heuristic estimate.

Trait Implementations

impl Debug for SystemLanguageModel

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

Formats the value using the given formatter.

impl Drop for SystemLanguageModel

fn drop(&mut self)

Executes the destructor for this type.

impl Send for SystemLanguageModel

impl Sync for SystemLanguageModel