Struct AppleIntelligenceModels 

pub struct AppleIntelligenceModels { /* private fields */ }

Handle for Apple’s default on-device system language model.

Implementations

impl AppleIntelligenceModels

pub fn new() -> Self

Creates a handle to the default system language model.

pub fn availability(&self) -> Result<(), AvailabilityError>

Returns Ok(()) when Apple Intelligence is ready for this model.

This mirrors Swift’s SystemLanguageModel.default.availability shape, but maps unavailable states into AvailabilityError.

Errors

Returns AvailabilityError describing why the local model cannot be used on the current machine.

pub fn is_available(&self) -> bool

Returns true when the default system language model is available.

pub fn session(&self) -> LanguageModelSessionBuilder

Starts building a stateful session.

pub fn agent(&self) -> LanguageModelSessionBuilder

Alias for AppleIntelligenceModels::session for users coming from Rig’s agent builders.

pub async fn respond<P>(&self, prompt: P) -> Result<String, Error>

where P: TryInto<Prompt>, P::Error: Into<Error>,

Sends a single prompt in a fresh session and returns plain response text.

Errors

Returns Error::NullByte for prompt text that cannot cross the C FFI boundary, Error::Unavailable when Apple Intelligence is unavailable, or Error::Generation when the model or bridge fails.

pub async fn generate<P>(&self, prompt: P) -> Result<GeneratedText, Error>

where P: TryInto<Prompt>, P::Error: Into<Error>,

MLX-style alias for AppleIntelligenceModels::generate_text.

Errors

Returns the same error variants as AppleIntelligenceModels::generate_text.

pub async fn generate_with_options<P>( &self, prompt: P, options: &GenerationOptions, ) -> Result<GeneratedText, Error>

where P: TryInto<Prompt>, P::Error: Into<Error>,

MLX-style alias for AppleIntelligenceModels::generate_text_with_options.

Errors

Returns the same error variants as AppleIntelligenceModels::generate_text_with_options.

pub async fn complete<P>(&self, prompt: P) -> Result<ResponseText, Error>

where P: TryInto<Prompt>, P::Error: Into<Error>,

Sends a single prompt in a fresh session and returns typed response text.

Errors

Returns the same error variants as AppleIntelligenceModels::respond.

pub async fn generate_text<P>(&self, prompt: P) -> Result<ResponseText, Error>

where P: TryInto<Prompt>, P::Error: Into<Error>,

Generates typed response text in a fresh session.

Errors

Returns the same error variants as AppleIntelligenceModels::respond.

pub async fn generate_text_with_options<P>( &self, prompt: P, options: &GenerationOptions, ) -> Result<ResponseText, Error>

where P: TryInto<Prompt>, P::Error: Into<Error>,

Generates typed response text in a fresh session with explicit options.

Errors

Returns Error::NullByte for invalid prompt text, Error::InvalidTemperature or Error::InvalidMaxTokens for invalid options, Error::Unavailable when Apple Intelligence is unavailable, or Error::Generation when the model or bridge fails.

pub fn stream_text<P>(&self, prompt: P) -> Result<ResponseStream, Error>

where P: TryInto<Prompt>, P::Error: Into<Error>,

Streams response text from a fresh session.

Errors

Returns the same error variants as AppleIntelligenceModels::generate_text.

pub fn stream_text_with_options<P>( &self, prompt: P, options: &GenerationOptions, ) -> Result<ResponseStream, Error>

where P: TryInto<Prompt>, P::Error: Into<Error>,

Streams response text from a fresh session with explicit options.

Errors

Returns the same error variants as AppleIntelligenceModels::generate_text_with_options.

pub fn stream_generate<P>(&self, prompt: P) -> Result<ResponseStream, Error>

where P: TryInto<Prompt>, P::Error: Into<Error>,

MLX-style alias for AppleIntelligenceModels::stream_text.

Errors

Returns the same error variants as AppleIntelligenceModels::stream_text.

pub fn stream_generate_with_options<P>( &self, prompt: P, options: &GenerationOptions, ) -> Result<ResponseStream, Error>

where P: TryInto<Prompt>, P::Error: Into<Error>,

MLX-style alias for AppleIntelligenceModels::stream_text_with_options.

Errors

Returns the same error variants as AppleIntelligenceModels::stream_text_with_options.

Trait Implementations

impl Clone for AppleIntelligenceModels

fn clone(&self) -> AppleIntelligenceModels

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppleIntelligenceModels

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

Formats the value using the given formatter.

impl Default for AppleIntelligenceModels

fn default() -> AppleIntelligenceModels

Returns the “default value” for a type.

impl LanguageModel for AppleIntelligenceModels

fn generate_text_with_options<P>( &self, prompt: P, options: GenerationOptions, ) -> impl Future<Output = Result<ResponseText, Error>> + '_

where P: TryInto<Prompt>, P::Error: Into<Error>,

Generates response text for a prompt with explicit generation options.

fn stream_text_with_options<P>( &self, prompt: P, options: GenerationOptions, ) -> Result<ResponseStream, Error>

where P: TryInto<Prompt>, P::Error: Into<Error>,

Streams response text for a prompt with explicit generation options.

impl Copy for AppleIntelligenceModels