flutter_foundation_models 0.3.0

flutter_foundation_models: ^0.3.0 copied to clipboard

Breaking Changes #

• respondTo() now returns TextResponse instead of String
  • Use response.content to get the text
  • Also provides response.transcriptEntries for entries created during this response
• respondToWithSchema() now returns StructuredResponse instead of GeneratedContent
  • Use response.content to get the generated content
  • Also provides response.rawContent and response.transcriptEntries

New Features #

• Response wrappers - TextResponse and StructuredResponse provide content plus metadata
• List generation - Generate arrays of @Generable types
  • GenerationSchema.array(schema) - Create array schema from item schema
  • content.toList(fromContent) - Convert array content to typed List<T>
  • content.toPartialList(fromPartialContent) - For streaming arrays
• Generation errors - Typed GenerationException matching Swift's GenerationError
  • GenerationErrorType enum with all Swift error types
  • debugDescription for additional debugging info

• Transcript support - Access conversation history and continue sessions
  • session.transcript - Get the current conversation transcript
  • LanguageModelSession.createWithTranscript() - Create a session from a previous transcript
  • Transcript.toJson() / Transcript.fromJson() - Serialize/deserialize transcripts
  • Type-safe transcript entries: TranscriptPrompt, TranscriptResponse, TranscriptToolCalls, TranscriptToolOutput, TranscriptInstructions

• Update documentation

Breaking Changes #

• LanguageModelSession now uses async factory method LanguageModelSession.create() instead of constructor
• Moved isAvailable from LanguageModelSession to SystemLanguageModel.isAvailable

New Features #

• Swift Package Manager support - Plugin now supports both SPM and CocoaPods
• SystemLanguageModel class - Manage language models with configuration options
  • SystemLanguageModel.defaultModel - Access the default system model
  • SystemLanguageModel.create() - Create custom model with adapter, useCase, or guardrails
  • SystemLanguageModel.isAvailable - Check if Foundation Models API is available
  • SystemLanguageModel.availability - Get detailed availability info with unavailability reason
• Adapter support - Load custom adapters
  • Adapter.create(name:) - Create adapter by name
  • Adapter.fromAsset(assetPath) - Create adapter from Flutter asset
• UseCase configuration - UseCase.general and UseCase.contentTagging
• Guardrails configuration - Guardrails.defaultGuardrails and Guardrails.permissiveContentTransformations
• Text streaming - streamResponseTo() for plain text streaming without schema
• Session prewarm - session.prewarm() to reduce latency on first request
• Session state - session.isResponding to check if session is actively generating

• Add runtime availability check with LanguageModelSession.isAvailable()
• Lower minimum iOS version to 16.0 (API requires iOS 26+ at runtime)
• Improve documentation
• Clean up published package (exclude unnecessary example files)

• Initial release
• Text generation with respondTo()
• Structured output with respondToWithSchema()
• Streaming support with streamResponseToWithSchema()
• Tool use support
• Generation options (sampling mode, temperature, max tokens)
• System instructions support
• Availability checking with LanguageModelSession.isAvailable()
• Supports iOS 16+ (Foundation Models API requires iOS 26+ at runtime)