foundation-models 0.4.0

Safe Rust bindings for Apple's FoundationModels framework - on-device LLM on macOS 26+
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

//! [`SystemLanguageModel`] — entry point for querying device capability.

use crate::error::Unavailability;
use crate::ffi;

/// The on-device default language model provided by the operating system.
///
/// `FoundationModels` exposes a single shared `SystemLanguageModel.default`;
/// this type mirrors that singleton and only carries availability queries.
/// To actually generate text, construct a [`crate::LanguageModelSession`].
///
/// # Examples
///
/// ```rust,no_run
/// use foundation_models::SystemLanguageModel;
///
/// if SystemLanguageModel::is_available() {
///     println!("Apple Intelligence model is ready.");
/// } else {
///     eprintln!("Unavailable: {:?}", SystemLanguageModel::availability());
/// }
/// ```
#[derive(Debug, Clone, Copy)]
pub struct SystemLanguageModel;

impl SystemLanguageModel {
    /// Convenience: `availability() == Availability::Available`.
    #[must_use]
    pub fn is_available() -> bool {
        unsafe { ffi::fm_system_model_is_available() }
    }

    /// Detailed availability state of the on-device model.
    #[must_use]
    pub fn availability() -> Availability {
        let code = unsafe { ffi::fm_system_model_availability_code() };
        match code {
            0 => Availability::Available,
            1 => Availability::Unavailable(Unavailability::DeviceNotEligible),
            2 => Availability::Unavailable(Unavailability::AppleIntelligenceNotEnabled),
            3 => Availability::Unavailable(Unavailability::ModelNotReady),
            -1 => Availability::Unavailable(Unavailability::OsTooOld),
            _ => Availability::Unavailable(Unavailability::Unknown),
        }
    }
}

/// Result of [`SystemLanguageModel::availability`].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum Availability {
    /// Model is loaded and ready to generate.
    Available,
    /// Model cannot be used; the inner value explains why.
    Unavailable(Unavailability),
}