This plugin provides React Native developers with access to Apple's on-device Foundation Models, enabling privacy-focused AI features within mobile applications. It allows for text generation, structured JSON output, and custom tool integration, all processed locally on supported Apple devices.

How It Works

The plugin leverages Apple's native Foundation Model framework, ensuring all LLM processing occurs on-device. This approach enhances user privacy by preventing data from being sent to external servers. It supports structured data generation via JSON schemas and allows developers to define custom tools that the LLM can utilize to perform specific actions, such as fetching real-time data.

Quick Start & Requirements

• Installation: npm install react-native-apple-llm (or yarn add, pnpm add).
• Native Linking: npx pod-install (or cd ios && pod install).
• Prerequisites: iOS 17.0+, Xcode 16+, an Apple Intelligence-enabled device (iPhone 15 Pro, iPhone 16 series, M1+ iPad/Mac) or simulator (macOS 14+ required).
• Documentation: Apple's Foundation Models Documentation, React Native Documentation.

Highlighted Details

• On-device Apple Intelligence access for privacy and offline capabilities.
• Structured JSON output generation based on defined schemas.
• Support for custom tools, enabling LLMs to interact with external functions.
• TypeScript support for enhanced developer experience.

Maintenance & Community

• Contributors: Ahmed Kasem, Erik, and future contributors.
• Community: Contributions are welcome via Pull Requests; open an issue for major changes.
• Related Projects: Links to Apple's Foundation Models Documentation and React Native Documentation.

Licensing & Compatibility

• License: MIT License.
• Compatibility: Suitable for commercial use.

Limitations & Caveats

This is a beta feature, and users may encounter bugs or compatibility issues. Streaming support and advanced function calling capabilities are listed as future TODO items.