foundation-models-on-device

name	foundation-models-on-device
description	苹果FoundationModels框架用于设备上的LLM——文本生成、使用@Generable进行引导生成、工具调用，以及在iOS 26+中的快照流。
source_path	skills/foundation-models-on-device/SKILL.md

FoundationModels：设备端 LLM（iOS 26）

使用 FoundationModels 框架将苹果的设备端语言模型集成到应用中的模式。涵盖文本生成、使用 @Generable 的结构化输出、自定义工具调用以及快照流式传输——全部在设备端运行，以保护隐私并支持离线使用。

何时启用

• 使用 Apple Intelligence 在设备端构建 AI 功能
• 无需依赖云端即可生成或总结文本
• 从自然语言输入中提取结构化数据
• 为特定领域的 AI 操作实现自定义工具调用
• 流式传输结构化响应以实现实时 UI 更新
• 需要保护隐私的 AI（数据不离开设备）

核心模式 — 可用性检查

在创建会话之前，始终检查模型可用性：

struct GenerativeView: View {
    private var model = SystemLanguageModel.default

    var body: some View {
        switch model.availability {
        case .available:
            ContentView()
        case .unavailable(.deviceNotEligible):
            Text("Device not eligible for Apple Intelligence")
        case .unavailable(.appleIntelligenceNotEnabled):
            Text("Please enable Apple Intelligence in Settings")
        case .unavailable(.modelNotReady):
            Text("Model is downloading or not ready")
        case .unavailable(let other):
            Text("Model unavailable: \(other)")
        }
    }
}

核心模式 — 基础会话

// Single-turn: create a new session each time
let session = LanguageModelSession()
let response = try await session.respond(to: "What's a good month to visit Paris?")
print(response.content)

// Multi-turn: reuse session for conversation context
let session = LanguageModelSession(instructions: """
    You are a cooking assistant.
    Provide recipe suggestions based on ingredients.
    Keep suggestions brief and practical.
    """)

let first = try await session.respond(to: "I have chicken and rice")
let followUp = try await session.respond(to: "What about a vegetarian option?")

指令的关键点：

• 定义模型的角色（"你是一位导师"）
• 指定要做什么（"帮助提取日历事件"）
• 设置风格偏好（"尽可能简短地回答"）
• 添加安全措施（"对于危险请求，回复'我无法提供帮助'"）

核心模式 — 使用 @Generable 进行引导式生成

生成结构化的 Swift 类型，而不是原始字符串：

1. 定义可生成类型

@Generable(description: "Basic profile information about a cat")
struct CatProfile {
    var name: String

    @Guide(description: "The age of the cat", .range(0...20))
    var age: Int

    @Guide(description: "A one sentence profile about the cat's personality")
    var profile: String
}

2. 请求结构化输出

let response = try await session.respond(
    to: "Generate a cute rescue cat",
    generating: CatProfile.self
)

// Access structured fields directly
print("Name: \(response.content.name)")
print("Age: \(response.content.age)")
print("Profile: \(response.content.profile)")

支持的 @Guide 约束

• .range(0...20) — 数值范围
• .count(3) — 数组元素数量
• description: — 生成的语义引导

核心模式 — 工具调用

让模型调用自定义代码以执行特定领域的任务：

1. 定义工具

struct RecipeSearchTool: Tool {
    let name = "recipe_search"
    let description = "Search for recipes matching a given term and return a list of results."

    @Generable
    struct Arguments {
        var searchTerm: String
        var numberOfResults: Int
    }

    func call(arguments: Arguments) async throws -> ToolOutput {
        let recipes = await searchRecipes(
            term: arguments.searchTerm,
            limit: arguments.numberOfResults
        )
        return .string(recipes.map { "- \($0.name): \($0.description)" }.joined(separator: "\n"))
    }
}

2. 创建带工具的会话

let session = LanguageModelSession(tools: [RecipeSearchTool()])
let response = try await session.respond(to: "Find me some pasta recipes")

3. 处理工具错误

do {
    let answer = try await session.respond(to: "Find a recipe for tomato soup.")
} catch let error as LanguageModelSession.ToolCallError {
    print(error.tool.name)
    if case .databaseIsEmpty = error.underlyingError as? RecipeSearchToolError {
        // Handle specific tool error
    }
}

核心模式 — 快照流式传输

使用 PartiallyGenerated 类型为实时 UI 流式传输结构化响应：

@Generable
struct TripIdeas {
    @Guide(description: "Ideas for upcoming trips")
    var ideas: [String]
}

let stream = session.streamResponse(
    to: "What are some exciting trip ideas?",
    generating: TripIdeas.self
)

for try await partial in stream {
    // partial: TripIdeas.PartiallyGenerated (all properties Optional)
    print(partial)
}

SwiftUI 集成

@State private var partialResult: TripIdeas.PartiallyGenerated?
@State private var errorMessage: String?

var body: some View {
    List {
        ForEach(partialResult?.ideas ?? [], id: \.self) { idea in
            Text(idea)
        }
    }
    .overlay {
        if let errorMessage { Text(errorMessage).foregroundStyle(.red) }
    }
    .task {
        do {
            let stream = session.streamResponse(to: prompt, generating: TripIdeas.self)
            for try await partial in stream {
                partialResult = partial
            }
        } catch {
            errorMessage = error.localizedDescription
        }
    }
}

关键设计决策

决策	理由
设备端执行	隐私性——数据不离开设备；支持离线工作
4,096 个令牌限制	设备端模型约束；跨会话分块处理大数据
快照流式传输（非增量）	对结构化输出友好；每个快照都是一个完整的部分状态
@Generable 宏	为结构化生成提供编译时安全性；自动生成 PartiallyGenerated 类型
每个会话单次请求	isResponding 防止并发请求；如有需要，创建多个会话
response.content（而非 .output）	正确的 API——始终通过 .content 属性访问结果

最佳实践

• 在创建会话之前始终检查 model.availability——处理所有不可用的情况
• 使用 instructions 来引导模型行为——它们的优先级高于提示词
• 在发送新请求之前检查 isResponding——会话一次处理一个请求
• 通过 response.content 访问结果——而不是 .output
• 将大型输入分块处理——4,096 个令牌的限制适用于指令、提示词和输出的总和
• 对于结构化输出使用 @Generable——比解析原始字符串提供更强的保证
• 使用 GenerationOptions(temperature:) 来调整创造力（值越高越有创意）
• 使用 Instruments 进行监控——使用 Xcode Instruments 来分析请求性能

应避免的反模式

• 未先检查 model.availability 就创建会话
• 发送超过 4,096 个令牌上下文窗口的输入
• 尝试在单个会话上进行并发请求
• 使用 .output 而不是 .content 来访问响应数据
• 当 @Generable 结构化输出可行时，却去解析原始字符串响应
• 在单个提示词中构建复杂的多步逻辑——将其拆分为多个聚焦的提示词
• 假设模型始终可用——设备的资格和设置各不相同

何时使用

• 为注重隐私的应用进行设备端文本生成
• 从用户输入（表单、自然语言命令）中提取结构化数据
• 必须离线工作的 AI 辅助功能
• 逐步显示生成内容的流式 UI
• 通过工具调用（搜索、计算、查找）执行特定领域的 AI 操作

原文

• 英文原文

导航

• 中文文档导航
• 贡献指南