api-surface.md

# SDK public API surface

> Machine-generated by `scripts/dump-public-api.sh` from the built `.swiftinterface`s.
> Do not hand-edit. `sdk-guide.md` §12 is the *narrative* reference; this is the check.
> SDK version: `"2.3.0"` (the published `v2.3.0-GA` xcframeworks, built from 9b45072) · generated 2026-10-27T19:05Z

## LocalLMLabSDKCore

```swift
public enum CSVCodec
public struct CSVError : Error, Equatable
public var message: String
public static func == (a: CSVCodec.CSVError, b: CSVCodec.CSVError) -> Bool
public static func encode(_ rows: [[String]]) -> String
public static func decode(_ text: String) throws -> [[String]]
public struct Table
public var header: [String]
public var rows: [[String]]
public init(header: [String], rows: [[String]])
public func index(of column: String) -> Int?
public func value(_ row: [String], _ column: String) -> String
public func encoded() -> String
public static func decodeTable(_ text: String) throws -> CSVCodec.Table
public enum CalendarAccess
nonisolated(unsafe) public static var store: EKEventStore
public static var authorizationStatus: EKAuthorizationStatus
public static var isAuthorized: Bool
public struct AccessResult
public var granted: Bool
public var error: String?
public var needsSystemSettings: Bool
public static func requestAccess() async -> CalendarAccess.AccessResult
public static func openSystemSettings()
public struct EventSummary : Codable
public var eventIdentifier: String
public var title: String
public var start: String
public var end: String
public var calendar: String
public var location: String?
public var isAllDay: Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public static func upcomingEvents(days: Int) -> [CalendarAccess.EventSummary]
public struct AddEventResult
public var success: Bool
public var error: String?
public static func addEvent(title: String, start: Date, end: Date) -> CalendarAccess.AddEventResult
public struct MutateEventResult
public var success: Bool
public var error: String?
public static func updateEvent(title: String, onDate: DateComponents, newTitle: String?, newDate: DateComponents?, newTime: DateComponents?, durationMinutes: Int?) -> CalendarAccess.MutateEventResult
public static func deleteEvent(title: String, onDate: DateComponents) -> CalendarAccess.MutateEventResult
public struct GetUpcomingEventsTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var days: Int?
public init(days: Int? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var days: Optional<Int>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: GetUpcomingEventsTool.Arguments) async throws -> String
public typealias Output = String
public struct AddCalendarEventTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var title: String
public var date: String
public var time: String
public var durationMinutes: Int?
public init(title: String, date: String, time: String, durationMinutes: Int? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var title: String.PartiallyGenerated?
public var date: String.PartiallyGenerated?
public var time: String.PartiallyGenerated?
public var durationMinutes: Optional<Int>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: AddCalendarEventTool.Arguments) async throws -> String
public typealias Output = String
public struct UpdateCalendarEventTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var title: String
public var currentDate: String
public var newTitle: String?
public var newDate: String?
public var newTime: String?
public var durationMinutes: Int?
public init(title: String, currentDate: String, newTitle: String? = nil, newDate: String? = nil, newTime: String? = nil, durationMinutes: Int? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var title: String.PartiallyGenerated?
public var currentDate: String.PartiallyGenerated?
public var newTitle: Optional<String>.PartiallyGenerated?
public var newDate: Optional<String>.PartiallyGenerated?
public var newTime: Optional<String>.PartiallyGenerated?
public var durationMinutes: Optional<Int>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: UpdateCalendarEventTool.Arguments) async throws -> String
public typealias Output = String
public struct DeleteCalendarEventTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var title: String
public var currentDate: String
public init(title: String, currentDate: String)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var title: String.PartiallyGenerated?
public var currentDate: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: DeleteCalendarEventTool.Arguments) async throws -> String
public typealias Output = String
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
public struct ClockTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public init()
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: ClockTool.Arguments) async throws -> String
public typealias Output = String
nonisolated public init(_ content: GeneratedContent) throws
public enum Connector : String, CaseIterable, Sendable
case calendar
case reminders
case contacts
case location
public init?(rawValue: String)
public typealias AllCases = [Connector]
nonisolated public static var allCases: [Connector]
public var rawValue: String
public struct ConnectorAccessResult : Sendable
public var granted: Bool
public var error: String?
public var needsSystemSettings: Bool
public enum Connectors
public static func isAuthorized(_ connector: Connector) -> Bool
public static func requestAccess(_ connector: Connector) async -> ConnectorAccessResult
public static func openSystemSettings(for connector: Connector)
public enum ContactsAccess
nonisolated(unsafe) public static var store: CNContactStore
public static var authorizationStatus: CNAuthorizationStatus
public static var isAuthorized: Bool
public struct AccessResult
public var granted: Bool
public var error: String?
public var needsSystemSettings: Bool
public static func requestAccess() async -> ContactsAccess.AccessResult
public static func openSystemSettings()
public struct ContactSummary : Codable
public var identifier: String
public var name: String
public var givenName: String
public var familyName: String?
public var organization: String?
public var phoneNumbers: [String]
public var emails: [String]
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public static func search(query: String, limit: Int) -> [ContactsAccess.ContactSummary]
public static func list(limit: Int) -> [ContactsAccess.ContactSummary]
public struct MutateContactResult
public var success: Bool
public var error: String?
public static func addContact(givenName: String, familyName: String, organization: String?, phoneNumbers: [String], emails: [String]) -> ContactsAccess.MutateContactResult
public static func updateContact(givenName: String, familyName: String?, newGivenName: String?, newFamilyName: String?, newOrganization: String?, newPhoneNumbers: [String]?, newEmails: [String]?) -> ContactsAccess.MutateContactResult
public static func deleteContact(givenName: String, familyName: String?) -> ContactsAccess.MutateContactResult
public struct SearchContactsTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var query: String
public var limit: Int?
public init(query: String, limit: Int? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var query: String.PartiallyGenerated?
public var limit: Optional<Int>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: SearchContactsTool.Arguments) async throws -> String
public typealias Output = String
public struct ListContactsTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var limit: Int?
public init(limit: Int? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var limit: Optional<Int>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: ListContactsTool.Arguments) async throws -> String
public typealias Output = String
public struct AddContactTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var givenName: String
public var familyName: String?
public var organization: String?
public var phoneNumbers: [String]?
public var emails: [String]?
public init(givenName: String, familyName: String? = nil, organization: String? = nil, phoneNumbers: [String]? = nil, emails: [String]? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var givenName: String.PartiallyGenerated?
public var familyName: Optional<String>.PartiallyGenerated?
public var organization: Optional<String>.PartiallyGenerated?
public var phoneNumbers: Optional<[String]>.PartiallyGenerated?
public var emails: Optional<[String]>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: AddContactTool.Arguments) async throws -> String
public typealias Output = String
public struct UpdateContactTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var currentGivenName: String
public var currentFamilyName: String?
public var newGivenName: String?
public var newFamilyName: String?
public var newOrganization: String?
public var newPhoneNumbers: [String]?
public var newEmails: [String]?
public init(currentGivenName: String, currentFamilyName: String? = nil, newGivenName: String? = nil, newFamilyName: String? = nil, newOrganization: String? = nil, newPhoneNumbers: [String]? = nil, newEmails: [String]? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var currentGivenName: String.PartiallyGenerated?
public var currentFamilyName: Optional<String>.PartiallyGenerated?
public var newGivenName: Optional<String>.PartiallyGenerated?
public var newFamilyName: Optional<String>.PartiallyGenerated?
public var newOrganization: Optional<String>.PartiallyGenerated?
public var newPhoneNumbers: Optional<[String]>.PartiallyGenerated?
public var newEmails: Optional<[String]>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: UpdateContactTool.Arguments) async throws -> String
public typealias Output = String
public struct DeleteContactTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var currentGivenName: String
public var currentFamilyName: String?
public init(currentGivenName: String, currentFamilyName: String? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var currentGivenName: String.PartiallyGenerated?
public var currentFamilyName: Optional<String>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: DeleteContactTool.Arguments) async throws -> String
public typealias Output = String
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
public struct ContextBudget : Sendable, Equatable
public let windowTokens: Int?
public let lastInputTokens: Int
public let lastOutputTokens: Int
public var fractionUsed: Double?
public static func windowHint(for id: ModelID) -> Int?
public static func == (a: ContextBudget, b: ContextBudget) -> Bool
public struct JSONColumnSpec
public var header: String
public var path: String
public init(header: String, path: String)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var header: String.PartiallyGenerated?
public var path: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
public struct ColumnRenameSpec
public var from: String
public var to: String
public init(from: String, to: String = "")
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var from: String.PartiallyGenerated?
public var to: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
public struct FilterConditionSpec
public var column: String
public var op: String
public var value: String
public init(column: String, op: String, value: String = "")
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var column: String.PartiallyGenerated?
public var op: String.PartiallyGenerated?
public var value: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
public struct AggregateSpec
public var fn: String
public var column: String
public var name: String
public init(fn: String, column: String = "", name: String = "")
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var fn: String.PartiallyGenerated?
public var column: String.PartiallyGenerated?
public var name: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
public struct JSONToCSVTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var inputPath: String
public var outputPath: String
public var rowsAt: String
public var columns: [JSONColumnSpec]?
public init(inputPath: String, outputPath: String, rowsAt: String = "", columns: [JSONColumnSpec]? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var inputPath: String.PartiallyGenerated?
public var outputPath: String.PartiallyGenerated?
public var rowsAt: String.PartiallyGenerated?
public var columns: Optional<[JSONColumnSpec]>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: JSONToCSVTool.Arguments) async throws -> String
public typealias Output = String
public struct SelectColumnsTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var inputPath: String
public var outputPath: String
public var columns: [ColumnRenameSpec]
public init(inputPath: String, outputPath: String, columns: [ColumnRenameSpec])
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var inputPath: String.PartiallyGenerated?
public var outputPath: String.PartiallyGenerated?
public var columns: Array<ColumnRenameSpec>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: SelectColumnsTool.Arguments) async throws -> String
public typealias Output = String
public struct FilterRowsTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var inputPath: String
public var outputPath: String
public var conditions: [FilterConditionSpec]
public var matchAny: Bool?
public init(inputPath: String, outputPath: String, conditions: [FilterConditionSpec], matchAny: Bool? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var inputPath: String.PartiallyGenerated?
public var outputPath: String.PartiallyGenerated?
public var conditions: Array<FilterConditionSpec>.PartiallyGenerated?
public var matchAny: Optional<Bool>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: FilterRowsTool.Arguments) async throws -> String
public typealias Output = String
public struct SortRowsTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var inputPath: String
public var outputPath: String
public var by: String
public var descending: Bool?
public var limit: Int?
public init(inputPath: String, outputPath: String, by: String, descending: Bool? = nil, limit: Int? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var inputPath: String.PartiallyGenerated?
public var outputPath: String.PartiallyGenerated?
public var by: String.PartiallyGenerated?
public var descending: Optional<Bool>.PartiallyGenerated?
public var limit: Optional<Int>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: SortRowsTool.Arguments) async throws -> String
public typealias Output = String
public struct DedupeRowsTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var inputPath: String
public var outputPath: String
public var on: [String]?
public init(inputPath: String, outputPath: String, on: [String]? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var inputPath: String.PartiallyGenerated?
public var outputPath: String.PartiallyGenerated?
public var on: Optional<[String]>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: DedupeRowsTool.Arguments) async throws -> String
public typealias Output = String
public struct ConcatRowsTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var inputPaths: [String]
public var outputPath: String
public init(inputPaths: [String], outputPath: String)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var inputPaths: Array<String>.PartiallyGenerated?
public var outputPath: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: ConcatRowsTool.Arguments) async throws -> String
public typealias Output = String
public struct AggregateRowsTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var inputPath: String
public var outputPath: String
public var groupBy: [String]?
public var aggregates: [AggregateSpec]
public init(inputPath: String, outputPath: String, groupBy: [String]? = nil, aggregates: [AggregateSpec])
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var inputPath: String.PartiallyGenerated?
public var outputPath: String.PartiallyGenerated?
public var groupBy: Optional<[String]>.PartiallyGenerated?
public var aggregates: Array<AggregateSpec>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: AggregateRowsTool.Arguments) async throws -> String
public typealias Output = String
public struct DescribeJSONTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var path: String
public init(path: String)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var path: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: DescribeJSONTool.Arguments) async throws -> String
public typealias Output = String
public struct CSVInfoTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var path: String
public var sampleRows: Int?
public init(path: String, sampleRows: Int? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var path: String.PartiallyGenerated?
public var sampleRows: Optional<Int>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: CSVInfoTool.Arguments) async throws -> String
public typealias Output = String
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
public struct DecisionCalibration : Sendable, Hashable, Codable
public var noulTemperature: Double
public var choiceTemperature: Double
public var scoreTemperature: Double
public init(noulTemperature: Double, choiceTemperature: Double, scoreTemperature: Double)
public static let none: DecisionCalibration
public struct Sample : Sendable, Hashable, Codable
public var kind: DecisionCalibration.Sample.Kind
public var probabilities: [Double]
public var correct: [Int]
public enum Kind : String, Sendable, Hashable, Codable, CaseIterable
case noul, choice, score
public init(_ kind: DecisionQuestion.Kind)
public init?(rawValue: String)
public typealias AllCases = [DecisionCalibration.Sample.Kind]
nonisolated public static var allCases: [DecisionCalibration.Sample.Kind]
public var rawValue: String
public init(kind: DecisionCalibration.Sample.Kind, probabilities: [Double], correct: [Int])
public static func == (a: DecisionCalibration.Sample, b: DecisionCalibration.Sample) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public struct Measurement : Sendable, Hashable
public var count: Int
public var accuracy: Double
public var expectedCalibrationError: Double
public var logLoss: Double
public static func == (a: DecisionCalibration.Measurement, b: DecisionCalibration.Measurement) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public func temperature(for kind: DecisionCalibration.Sample.Kind) -> Double
public func apply(_ probabilities: [Double], kind: DecisionCalibration.Sample.Kind) -> [Double]
public static func apply(_ p: [Double], temperature t: Double) -> [Double]
public static func fit(_ samples: [DecisionCalibration.Sample]) -> DecisionCalibration
public func measure(_ samples: [DecisionCalibration.Sample]) -> DecisionCalibration.Measurement
public static func == (a: DecisionCalibration, b: DecisionCalibration) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public struct DecisionPairing : Sendable, Equatable
public var decider: ModelID
public var generator: ModelID
public var deciderBytes: Int64?
public var generatorBytes: Int64?
public var budgetBytes: Int64?
public var residentModels: Int
public var note: String?
public init(decider: ModelID, generator: ModelID, deciderBytes: Int64? = nil, generatorBytes: Int64? = nil, budgetBytes: Int64? = nil, residentModels: Int, note: String? = nil)
public static func == (a: DecisionPairing, b: DecisionPairing) -> Bool
public protocol PairableDecisionProvider : DecisionProvider
@MainActor func pair(decider: ModelID, generator: ModelID, registry: ModelRegistry) async throws -> DecisionPairing
@MainActor final public func pair(decision: RouteName, generator: RouteName) async throws -> DecisionPairing
public protocol DecisionProvider : Sendable
public func owns(_ id: ModelID) -> Bool
public var limits: DecisionLimits
public func prewarm(_ id: ModelID) async
public struct DecisionQuestionSet : Sendable, Hashable, Codable
public static let currentFormat: Int
public var format: Int
public var name: String
public var questions: [DecisionQuestion]
public var tuning: DecisionQuestionSet.Tuning?
public struct Tuning : Sendable, Hashable, Codable
public var model: ModelID?
public var revision: String?
public var system: String?
public var inputLabel: String?
public var calibration: DecisionCalibration?
public var testedAt: Date?
public init(model: ModelID? = nil, revision: String? = nil, system: String? = nil, inputLabel: String? = nil, calibration: DecisionCalibration? = nil, testedAt: Date? = nil)
public static func == (a: DecisionQuestionSet.Tuning, b: DecisionQuestionSet.Tuning) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public init(name: String, questions: [DecisionQuestion], tuning: DecisionQuestionSet.Tuning? = nil)
public init(contentsOf url: URL) throws
public init(json data: Data) throws
public func jsonData() throws -> Data
public static func == (a: DecisionQuestionSet, b: DecisionQuestionSet) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public struct DecisionAnswerSet : Sendable, Hashable, Codable
public struct Example : Sendable, Hashable, Codable
public var input: String
public var answers: [String : String]
public init(input: String, answers: [String : String])
public static func == (a: DecisionAnswerSet.Example, b: DecisionAnswerSet.Example) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public var examples: [DecisionAnswerSet.Example]
public init(examples: [DecisionAnswerSet.Example])
public init(csv text: String) throws
public func csv(questionIDs: [String]) -> String
public func problems(for questions: [DecisionQuestion]) -> [String]
public static func answerKey(_ raw: String, for q: DecisionQuestion) -> String?
public static func == (a: DecisionAnswerSet, b: DecisionAnswerSet) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public struct DecisionQuestion : Sendable, Hashable, Codable
public enum Kind : Sendable, Hashable, Codable
case noul
case choice(criteria: [DecisionQuestion.Criterion])
case score(levels: [String])
public static func == (a: DecisionQuestion.Kind, b: DecisionQuestion.Kind) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public struct Criterion : Sendable, Hashable, Codable
public var key: String
public var description: String?
public init(_ key: String, _ description: String? = nil)
public static func == (a: DecisionQuestion.Criterion, b: DecisionQuestion.Criterion) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public var id: String
public var instructions: String
public var kind: DecisionQuestion.Kind
public init(id: String, instructions: String, kind: DecisionQuestion.Kind)
public static func noul(_ id: String, _ instructions: String) -> DecisionQuestion
public static func choice(_ id: String, _ instructions: String, criteria: KeyValuePairs<String, String>) -> DecisionQuestion
public static func choice(_ id: String, _ instructions: String, criteria: [String]) -> DecisionQuestion
public static func score(_ id: String, _ instructions: String, criteria: [String]) -> DecisionQuestion
public init(from decoder: any Decoder) throws
public func encode(to encoder: any Encoder) throws
public static func == (a: DecisionQuestion, b: DecisionQuestion) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public enum DecisionState : Sendable, Hashable, Codable
case text(String)
case json(String)
public static func encoding<T>(_ value: T) throws -> DecisionState where T : Encodable
public var rendered: String
public static func == (a: DecisionState, b: DecisionState) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public struct DecisionRequest : Sendable, Hashable
public var state: DecisionState
public var questions: [DecisionQuestion]
public init(state: DecisionState, questions: [DecisionQuestion])
public func validate(against limits: DecisionLimits = .jev) throws
public static func == (a: DecisionRequest, b: DecisionRequest) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public struct DecisionLimits : Sendable, Hashable
public var maxQuestions: Int
public var maxChoiceCriteria: Int
public var maxScoreLevels: Int
public var maxStateCharacters: Int?
public init(maxQuestions: Int, maxChoiceCriteria: Int, maxScoreLevels: Int, maxStateCharacters: Int? = nil)
public static let jev: DecisionLimits
public static func == (a: DecisionLimits, b: DecisionLimits) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public struct ChoiceAnswer : Sendable, Hashable, Codable
public var choice: String
public var confidence: Double
public var probabilities: [String : Double]
public init(choice: String, confidence: Double, probabilities: [String : Double])
public static func == (a: ChoiceAnswer, b: ChoiceAnswer) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public struct ScoreAnswer : Sendable, Hashable, Codable
public var score: Double
public var confidence: Double
public var probabilities: [Double]
public var legend: [String]
public init(score: Double, confidence: Double, probabilities: [Double], legend: [String])
public var level: Int
public static func == (a: ScoreAnswer, b: ScoreAnswer) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public enum DecisionAnswer : Sendable, Hashable, Codable
case noul(Double)
case choice(ChoiceAnswer)
case score(ScoreAnswer)
public static func == (a: DecisionAnswer, b: DecisionAnswer) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public enum DecisionFidelity : Sendable, Hashable, Codable
case native
case tokenScored(calibrated: Bool)
public static func == (a: DecisionFidelity, b: DecisionFidelity) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public struct DecisionUsage : Sendable, Hashable, Codable
public var inputTokens: Int?
public var outputTokens: Int?
public var cost: Double?
public init(inputTokens: Int? = nil, outputTokens: Int? = nil, cost: Double? = nil)
public static func == (a: DecisionUsage, b: DecisionUsage) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public struct Decision : Sendable, Hashable, Codable
public var answers: [String : DecisionAnswer]
public var modelID: ModelID
public var fidelity: DecisionFidelity
public var latency: Duration
public var usage: DecisionUsage?
public var refusals: Set<String>
public init(answers: [String : DecisionAnswer], modelID: ModelID, fidelity: DecisionFidelity, latency: Duration, usage: DecisionUsage? = nil)
public init(answers: [String : DecisionAnswer], modelID: ModelID, fidelity: DecisionFidelity, latency: Duration, usage: DecisionUsage? = nil, refusals: Set<String>)
public func isRefused(_ id: String) -> Bool
public init(from decoder: any Decoder) throws
public func encode(to encoder: any Encoder) throws
public func noul(_ id: String) -> Double?
public func choice(_ id: String) -> ChoiceAnswer?
public func score(_ id: String) -> ScoreAnswer?
public static func == (a: Decision, b: Decision) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public enum DecisionError : Error, LocalizedError, Sendable, Equatable
case invalidRequest(String)
case noRoute(RouteName)
case unavailable(ModelID, ModelAvailability)
case malformedAnswer(String)
case backend(String)
case pairing(String)
public var errorDescription: String?
public static func == (a: DecisionError, b: DecisionError) -> Bool
public protocol DownloadableModelProvider : ModelProvider
public var residencyEventStream: AsyncStream<ResidencyEvent>?
public struct InstalledModel : Sendable, Hashable, Codable, Identifiable
public var id: ModelID
public var repoID: String
public var capabilities: ModelCapabilities
public var sizeBytes: Int64?
public var contextTokens: Int?
public var resolvedRevision: String
public init(id: ModelID, repoID: String, resolvedRevision: String, capabilities: ModelCapabilities = [], sizeBytes: Int64? = nil, contextTokens: Int? = nil)
public static func == (a: InstalledModel, b: InstalledModel) -> Bool
public typealias ID = ModelID
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public enum DownloadEvent : Sendable
case progress(bytesReceived: Int64, totalBytes: Int64, fraction: Double)
case completed(InstalledModel)
public struct PreflightResult : Sendable, Equatable
public enum Stage : String, Sendable, Codable
case trustPolicy
case repoReachable
case mlxFormat
case architectureSupported
case sizeVsMemory
case diskSpace
case cacheQuota
public init?(rawValue: String)
public var rawValue: String
public var failedStage: PreflightResult.Stage?
public var detail: String?
public var weightBytes: Int64?
public var ramBytes: Int64?
public var freeDiskBytes: Int64?
public var passed: Bool
public init(failedStage: PreflightResult.Stage? = nil, detail: String? = nil, weightBytes: Int64? = nil, ramBytes: Int64? = nil, freeDiskBytes: Int64? = nil)
public static let ok: PreflightResult
public static func == (a: PreflightResult, b: PreflightResult) -> Bool
public struct ModelCapabilityReport : Sendable, Equatable
public var id: ModelID
public var capabilities: ModelCapabilities
public var notes: [String]
public var blocked: String?
public var isUsable: Bool
public init(id: ModelID, capabilities: ModelCapabilities = [], notes: [String] = [], blocked: String? = nil)
public static func == (a: ModelCapabilityReport, b: ModelCapabilityReport) -> Bool
public struct SaveAsPolicy : Sendable, Equatable
public var directory: String?
public var allowedExtensions: Set<String>?
public var allowsHiddenPaths: Bool
public init(directory: String? = "raw", allowedExtensions: Set<String>? = SaveAsPolicy.dataExtensions, allowsHiddenPaths: Bool = false)
public static let dataExtensions: Set<String>
public static let `default`: SaveAsPolicy
public static let unrestricted: SaveAsPolicy
public static func == (a: SaveAsPolicy, b: SaveAsPolicy) -> Bool
public struct FileBackedTool : Tool
public typealias Arguments = GeneratedContent
public let name: String
public let description: String
public let parameters: GenerationSchema
public let toolOrigin: ToolOrigin
public init(name: String, description: String, argumentsJSONSchema: Data, root: URL, previewCharacters: Int = 600, inlineCharacterLimit: Int? = nil, origin: ToolOrigin = .host, followUp: String = "read it back a window at a time with readFileRange", saveAsPolicy: SaveAsPolicy = .default, invoke: @escaping @Sendable (GeneratedContent) async -> String) throws
nonisolated public func call(arguments: GeneratedContent) async throws -> String
public typealias Output = String
public enum GenerationErrorDescription
public static func describe(_ error: any Error) async -> String
public static func describeSync(_ error: any Error) -> String
public enum ArchiveError : Error, Equatable
case notEmpty
case unsupportedFormat(String)
public static func == (a: HostTranscript.ArchiveError, b: HostTranscript.ArchiveError) -> Bool
@MainActor final public func archive() throws -> Data
@MainActor final public func restore(from data: Data) throws
@MainActor final public class HostTranscript
public struct Entry : Identifiable, Sendable
public enum Content : Sendable
case user(String)
case assistant(String)
case reasoning(String)
case toolCall(ToolCallRecord)
case appContext(instance: String, text: String)
public let id: String
public var content: HostTranscript.Entry.Content
public let turn: Int
public var appInstance: String?
public typealias ID = String
@MainActor final public var entries: [HostTranscript.Entry]
@MainActor final public var replyInProgress: HostTranscript.ReplyInProgress?
public struct ReplyInProgress : Sendable, Equatable
public var reasoning: String?
public var text: String
public var isReasoning: Bool
public init(reasoning: String?, text: String, isReasoning: Bool)
public static func == (a: HostTranscript.ReplyInProgress, b: HostTranscript.ReplyInProgress) -> Bool
@MainActor final public func appOnlyCallCount(for instance: String) -> Int
@MainActor final public var resultMemoryBudget: Int
@MainActor final public var spillDirectory: URL?
@MainActor final public var toolCalls: [ToolCallRecord]
@MainActor final public func toolCall(id: String) -> ToolCallRecord?
public enum JSONPath
public static func value(at path: String, in root: Any) -> Any?
public static func stringify(_ value: Any?) -> String
public enum JevWire
public struct Request : Sendable, Hashable
public var model: String?
public var request: DecisionRequest
public init(model: String?, request: DecisionRequest)
public static func == (a: JevWire.Request, b: JevWire.Request) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public struct Response : Sendable
public var model: String?
public var answers: [String : DecisionAnswer]
public var usage: DecisionUsage?
public var fidelity: DecisionFidelity?
public var errorMessage: String?
public var refusals: Set<String>
public static func encodeRequest(_ request: DecisionRequest, model: String) throws -> Data
public static func decodeRequest(_ data: Data) throws -> JevWire.Request
public static func encodeResponse(_ decision: Decision, model: String, request: DecisionRequest) throws -> Data
public static func decodeResponse(_ data: Data, request: DecisionRequest) throws -> JevWire.Response
public static func encodeError(message: String, type: String, code: Int) -> Data
public static func errorMessage(in data: Data) -> String?
@MainActor final public func decide(route: RouteName, state: DecisionState, questions: [DecisionQuestion]) async throws -> Decision
public struct DecisionEvaluation : Sendable
public struct QuestionScore : Sendable, Hashable
public var id: String
public var kind: DecisionCalibration.Sample.Kind
public var marked: Int
public var correct: Int
public var refused: Int
public var accuracy: Double
public var meanConfidenceWhenRight: Double?
public var meanConfidenceWhenWrong: Double?
public static func == (a: DecisionEvaluation.QuestionScore, b: DecisionEvaluation.QuestionScore) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public struct Miss : Sendable, Hashable
public var input: String
public var questionID: String
public var expected: String
public var answer: String
public var confidence: Double
public static func == (a: DecisionEvaluation.Miss, b: DecisionEvaluation.Miss) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public var modelID: ModelID
public var fidelity: DecisionFidelity
public var questions: [DecisionEvaluation.QuestionScore]
public var misses: [DecisionEvaluation.Miss]
public var samples: [DecisionCalibration.Sample]
public var decisions: Int
public var totalLatency: Duration
public var accuracy: Double
public var calibration: DecisionCalibration.Measurement
public func score(_ questionID: String) -> DecisionEvaluation.QuestionScore?
@MainActor final public func evaluate(route: RouteName, questions: [DecisionQuestion], answerSet: DecisionAnswerSet, progress: (@MainActor @Sendable (Int, Int) -> Void)? = nil) async throws -> DecisionEvaluation
@MainActor final public func makeSession(route: RouteName, tools: [any Tool] = [], instructions: String? = nil, restoring transcript: Transcript? = nil, includeMCPTools: Bool = true, mcpAppHints: Bool = false, options: SessionOptions = .init(), authorizer: (any ToolCallAuthorizer)? = nil) throws -> LocalLMLabSession
@MainActor final public class LocalLMLab
public struct Configuration
public var providers: [any ModelProvider]
public var state: LocalLMLabState?
public var mcp: MCPSettings
public init(providers: [any ModelProvider] = [], state: LocalLMLabState? = nil, mcp: MCPSettings = MCPSettings())
@MainActor final public let models: ModelRegistry
@MainActor final public let mcp: MCPServerManager
@MainActor final public let connectors: ConnectorsFacade
@MainActor final public let workspace: WorkspaceFacade
@MainActor public init(configuration: LocalLMLab.Configuration = .init())
@MainActor final public func snapshot() -> LocalLMLabState
@MainActor final public func restore(from state: LocalLMLabState)
public struct MCPSettings
public var handlers: MCPClientHandlers
public var responseLimits: MCPResponseLimits
public var versionNegotiation: MCPVersionNegotiation
public var liveUpdates: Bool
public init(handlers: MCPClientHandlers = MCPClientHandlers(), responseLimits: MCPResponseLimits = .default, versionNegotiation: MCPVersionNegotiation = .auto, liveUpdates: Bool = true)
public struct LocalLMLabState : Codable, Sendable, Equatable
public static let currentVersion: Int
public var version: Int
public var routes: [RouteName : ModelID]
public var residency: ModelResidency
public var installedModels: [InstalledModel]
public var decisionRoutes: [RouteName : ModelID]
public init(version: Int = LocalLMLabState.currentVersion, routes: [RouteName : ModelID] = [:], residency: ModelResidency = .lastUsedOnly, installedModels: [InstalledModel] = [], decisionRoutes: [RouteName : ModelID] = [:])
public init(from decoder: any Decoder) throws
public static func == (a: LocalLMLabState, b: LocalLMLabState) -> Bool
public func encode(to encoder: any Encoder) throws
@MainActor public struct ConnectorsFacade
@MainActor public func isAuthorized(_ connector: Connector) -> Bool
@MainActor public func requestAccess(_ connector: Connector) async -> ConnectorAccessResult
@MainActor public func openSystemSettings(for connector: Connector)
@MainActor public struct WorkspaceFacade
@MainActor public var maxReadCharacters: Int
public enum LocalLMLabError : Error, LocalizedError
case modelUnavailable(reason: String)
case download(stage: String, underlying: (any Error)?)
case validation(stage: PreflightResult.Stage, detail: String)
case generation(underlying: any Error)
case context(detail: String)
case mcp(detail: String)
case connector(detail: String)
public var errorDescription: String?
public enum LocalLMLabSDKVersion
public static let current: String
@MainActor public func callMCPTool(server: MCPServerID, tool: String, arguments: [String : MCPValue], initiator: ToolCallInitiator) async -> Result<MCPToolResult, MCPServerError>
@MainActor public func updateModelContext(_ text: String, fromAppInstance instance: String)
public func respond(to prompt: String, options: SessionOptions = SessionOptions(), fromAppInstance instance: String? = nil) async throws -> String
public func streamResponse(to prompt: String, options: SessionOptions = SessionOptions(), fromAppInstance instance: String? = nil) -> AsyncThrowingStream<String, any Error>
public struct LocalLMLabSession : Sendable
public let route: RouteName
public let modelID: ModelID
public var retryOnContextOverflow: RetryPolicy
public var turnContext: (@Sendable () -> String?)?
public var languageModelSession: LanguageModelSession
public var events: AsyncStream<SessionEvent>
public var citations: [Citation]
public var hostTranscript: HostTranscript
public func reconcileServerToolArtifacts()
public var contextBudget: ContextBudget
public func cancel()
final public class LocationAccess : NSObject, CLLocationManagerDelegate, @unchecked Sendable
public static let shared: LocationAccess
final public var lastFetchFailureReason: String?
final public var authorizationStatus: CLAuthorizationStatus
final public var isAuthorized: Bool
public struct AccessResult : Sendable
public var granted: Bool
public var error: String?
public var needsSystemSettings: Bool
@MainActor final public func requestAccess() async -> LocationAccess.AccessResult
public static func openSystemSettings()
public struct LocationSummary : Codable
public var latitude: Double
public var longitude: Double
public var horizontalAccuracyMeters: Double
public var timestamp: String
public var placeName: String?
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
final public func currentLocation() async -> LocationAccess.LocationSummary?
public struct GetCurrentLocationTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public init()
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: GetCurrentLocationTool.Arguments) async throws -> String
public typealias Output = String
nonisolated public init(_ content: GeneratedContent) throws
public enum MCPAppVisibility : String, Sendable, Codable, Hashable, CaseIterable
case model
case app
public init?(rawValue: String)
public typealias AllCases = [MCPAppVisibility]
nonisolated public static var allCases: [MCPAppVisibility]
public var rawValue: String
public struct MCPAppLink : Sendable, Equatable, Hashable
public var resourceURI: String
public var visibility: Set<MCPAppVisibility>
public init(resourceURI: String, visibility: Set<MCPAppVisibility>)
public static func == (a: MCPAppLink, b: MCPAppLink) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public var app: MCPAppLink?
public var appVisibility: Set<MCPAppVisibility>
public var isModelVisible: Bool
public var isMCPAppResource: Bool
public var isMCPAppResource: Bool
public struct MCPElicitationField : Sendable, Equatable
public enum Kind : Sendable, Equatable
case string(format: String?)
case number(minimum: Double?, maximum: Double?)
case integer(minimum: Double?, maximum: Double?)
case boolean
case enumeration(options: [String], optionTitles: [String]?, multiSelect: Bool)
public static func == (a: MCPElicitationField.Kind, b: MCPElicitationField.Kind) -> Bool
public var name: String
public var title: String?
public var description: String?
public var required: Bool
public var defaultValue: MCPValue?
public var kind: MCPElicitationField.Kind
public init(name: String, title: String?, description: String?, required: Bool, defaultValue: MCPValue?, kind: MCPElicitationField.Kind)
public static func == (a: MCPElicitationField, b: MCPElicitationField) -> Bool
public struct MCPElicitationRequest : Sendable, Equatable
public var message: String
public var rawSchema: Data
public var fields: [MCPElicitationField]
public var url: URL?
public var serverName: String?
public var serverURL: URL?
public init(message: String, rawSchema: Data, fields: [MCPElicitationField], url: URL? = nil, serverName: String? = nil, serverURL: URL? = nil)
public static func == (a: MCPElicitationRequest, b: MCPElicitationRequest) -> Bool
public enum MCPElicitationResponse : Sendable, Equatable
case accept([String : MCPValue])
case decline
case cancel
public static func == (a: MCPElicitationResponse, b: MCPElicitationResponse) -> Bool
public protocol MCPElicitationHandler : Sendable
public struct MCPSamplingRequest : Sendable, Equatable
public var rawParams: Data
public static func == (a: MCPSamplingRequest, b: MCPSamplingRequest) -> Bool
public struct MCPSamplingResponse : Sendable, Equatable
public var role: String
public var text: String
public var model: String
public var stopReason: String?
public init(role: String = "assistant", text: String, model: String, stopReason: String? = nil)
public static func == (a: MCPSamplingResponse, b: MCPSamplingResponse) -> Bool
public protocol MCPSamplingHandler : Sendable
public struct MCPRoot : Sendable, Equatable, Codable
public var uri: String
public var name: String?
public init(uri: String, name: String? = nil)
public static func == (a: MCPRoot, b: MCPRoot) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public protocol MCPRootsProvider : Sendable
public struct MCPLogMessage : Sendable, Equatable
public var level: String
public var logger: String?
public var data: MCPValue
public static func == (a: MCPLogMessage, b: MCPLogMessage) -> Bool
public protocol MCPLoggingSink : Sendable
public struct MCPClientHandlers : Sendable
public var elicitation: (any MCPElicitationHandler)?
public var sampling: (any MCPSamplingHandler)?
public var roots: (any MCPRootsProvider)?
public var logging: (any MCPLoggingSink)?
public var extensions: [String : MCPValue]
public init(elicitation: (any MCPElicitationHandler)? = nil, sampling: (any MCPSamplingHandler)? = nil, roots: (any MCPRootsProvider)? = nil, logging: (any MCPLoggingSink)? = nil, extensions: [String : MCPValue] = [:])
public enum MCPStoredCredentialKind : String, Sendable, Equatable
case oauth
case pat
public init?(rawValue: String)
public var rawValue: String
public enum MCPCredentialProbe
public static func storedKind(for server: URL) -> MCPStoredCredentialKind?
public static func requiresAuth(declared authType: MCPAuthType, server: URL) -> Bool
public enum MCPLogLevel : Int, Sendable, Comparable, Codable
case debug, info, notice, error, off
public static func < (l: MCPLogLevel, r: MCPLogLevel) -> Bool
public init?(rawValue: Int)
public var rawValue: Int
public struct MCPDiagnosticEvent : Sendable, Codable
public enum Level : String, Sendable, Codable
case debug, info, notice, error
public init?(rawValue: String)
public var rawValue: String
public var timestamp: Date
public var level: MCPDiagnosticEvent.Level
public var area: String
public var message: String
public var fields: [String : String]
public func line() -> String
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public enum MCPDiagnostics
public static var logLevel: MCPLogLevel
public static func setEnabled(_ enabled: Bool)
public static var isEnabled: Bool
public static var capacity: Int
public static var observer: (@Sendable (MCPDiagnosticEvent) -> Void)?
public static func exportText() -> String
public static func exportJSON() -> Data
public static func snapshot() -> [MCPDiagnosticEvent]
public static func clear()
public enum MCPOAuthFlow
nonisolated(unsafe) public static var redirectURI: String
nonisolated(unsafe) public static var clientMetadataURL: URL?
@MainActor final public class MCPOAuthRedirectListener
@MainActor public static let shared: MCPOAuthRedirectListener
@MainActor final public func handleRedirect(_ url: URL)
@MainActor final public func cancelAll()
public enum MCPProtocolVersion : String, CaseIterable, Comparable, Sendable, Codable
case v2024_11_05
case v2025_03_26
case v2025_06_18
case v2025_11_25
case v2026_07_28
public static let clientPreferred: MCPProtocolVersion
public static let minimumSupported: MCPProtocolVersion
public static var allCases: [MCPProtocolVersion]
public static let statelessPreferred: MCPProtocolVersion
public var isStateless: Bool
public static func < (lhs: MCPProtocolVersion, rhs: MCPProtocolVersion) -> Bool
public var supportsStructuredContent: Bool
public var supportsElicitation: Bool
public var supportsIconsAndRicherElicitation: Bool
public var sendsProtocolVersionHeader: Bool
public var supportsURLElicitation: Bool
public init?(rawValue: String)
public typealias AllCases = [MCPProtocolVersion]
public var rawValue: String
public struct MCPServerCapabilities : Sendable, Codable, Equatable
public var tools: Bool
public var toolsListChanged: Bool
public var resources: Bool
public var resourcesListChanged: Bool
public var resourcesSubscribe: Bool
public var prompts: Bool
public var promptsListChanged: Bool
public var logging: Bool
public var completions: Bool
public var hasExperimental: Bool
public init(tools: Bool = false, toolsListChanged: Bool = false, resources: Bool = false, resourcesListChanged: Bool = false, resourcesSubscribe: Bool = false, prompts: Bool = false, promptsListChanged: Bool = false, logging: Bool = false, completions: Bool = false, hasExperimental: Bool = false)
public var summary: String
public init(from raw: [String : Any])
public static func == (a: MCPServerCapabilities, b: MCPServerCapabilities) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct MCPServerIdentity : Sendable, Codable, Equatable
public var protocolVersion: MCPProtocolVersion
public var serverName: String
public var serverTitle: String
public var serverVersion: String?
public var instructions: String?
public var capabilities: MCPServerCapabilities
public init(protocolVersion: MCPProtocolVersion, serverName: String, serverTitle: String? = nil, serverVersion: String? = nil, instructions: String? = nil, capabilities: MCPServerCapabilities = MCPServerCapabilities())
public static func == (a: MCPServerIdentity, b: MCPServerIdentity) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public enum MCPConnectionMode : Sendable, Equatable
case handshake(MCPProtocolVersion)
case stateless(MCPProtocolVersion)
public var negotiatedVersion: MCPProtocolVersion
public var isStateless: Bool
public static func == (a: MCPConnectionMode, b: MCPConnectionMode) -> Bool
public enum MCPVersionNegotiation : Sendable, Equatable
case auto
case legacy
case pin(MCPProtocolVersion)
public static func == (a: MCPVersionNegotiation, b: MCPVersionNegotiation) -> Bool
@MainActor final public class MCPServerManager
@MainActor final public var servers: [MCPServerID : MCPServerState]
@MainActor final public var serverChanges: AsyncStream<[MCPServerID : MCPServerState]>
@MainActor public init(responseLimits: MCPResponseLimits = .default, handlers: MCPClientHandlers = MCPClientHandlers(), versionNegotiation: MCPVersionNegotiation = .auto, liveUpdates: Bool = true)
@MainActor final public func addServer(url: URL, displayName: String, authType: MCPAuthType = .none, patToken: String? = nil, manualClientID: String? = nil) async -> Result<MCPServerState, MCPServerError>
@MainActor final public func reconnect(_ id: MCPServerID) async -> Result<MCPServerState, MCPServerError>
@MainActor final public func disconnect(_ id: MCPServerID)
@MainActor final public func toolsForSession() -> [MCPToolDescriptor]
@MainActor final public func setTrust(_ trust: MCPServerTrust, server: MCPServerID)
@MainActor final public func setToolApproval(_ approval: ToolApproval?, server: MCPServerID)
@MainActor final public func toolApproval(server: MCPServerID) -> ToolApproval
@MainActor final public func setFileBackedOutput(_ output: MCPFileBackedOutput?, server: MCPServerID)
@MainActor final public func fileBackedOutput(server: MCPServerID) -> MCPFileBackedOutput?
@MainActor final public func setToolEnabled(server: MCPServerID, tool: String, enabled: Bool)
@MainActor final public func callTool(server: MCPServerID, tool: String, arguments: [String : MCPValue], allowElicitation: Bool = true) async -> Result<MCPToolResult, MCPServerError>
@MainActor final public func resourcesForSession() -> [MCPResourceDescriptor]
@MainActor final public func resourceTemplatesForSession() -> [MCPResourceTemplateDescriptor]
@MainActor final public func setResourceEnabled(server: MCPServerID, uri: String, enabled: Bool)
@MainActor final public func readResource(server: MCPServerID, uri: String) async -> Result<MCPResourceContent, MCPServerError>
@MainActor final public func promptsForSession() -> [MCPPromptDescriptor]
@MainActor final public func getPrompt(server: MCPServerID, name: String, arguments: [String : String]) async -> Result<[MCPPromptMessage], MCPServerError>
@MainActor final public func removeServer(_ id: MCPServerID)
@MainActor final public func removeAllKeepingCredentials()
@MainActor final public func restore(from persisted: [(id: MCPServerID, url: URL, displayName: String, tools: [MCPToolDescriptor], estimatedTokens: Int, enabled: Bool, authType: MCPAuthType, manualClientID: String?, resources: [(uri: String, name: String, enabled: Bool)])])
@MainActor final public var estimatedTotalTokens: Int
public struct MCPServerID : Hashable, Codable, Sendable
public let rawValue: String
public init(rawValue: String)
public init(from decoder: any Decoder) throws
public func encode(to encoder: any Encoder) throws
public static func == (a: MCPServerID, b: MCPServerID) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public struct MCPServerState : Codable, Sendable
public var id: MCPServerID
public var url: URL
public var displayName: String
public var connectionStatus: MCPConnectionStatus
public var tools: [MCPToolDescriptor]
public var estimatedTokens: Int
public var enabled: Bool
public var authType: MCPAuthType
public var patTokenLastFour: String?
public var manualClientID: String?
public var resources: [MCPResourceDescriptor]
public var resourceTemplates: [MCPResourceTemplateDescriptor]
public var prompts: [MCPPromptDescriptor]
public var negotiatedProtocolVersion: MCPProtocolVersion?
public var serverInstructions: String?
public var liveUpdates: MCPLiveUpdates?
public var trust: MCPServerTrust
public var toolApproval: ToolApproval?
public var trustedToolsDigest: String?
public var toolsChangedSinceTrusted: Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public func exportSummary() -> String
public enum MCPAuthType : String, Codable, Sendable
case none
case pat
case oauthManual
public init?(rawValue: String)
public var rawValue: String
public enum MCPConnectionStatus : String, Codable, Sendable
case connected
case disconnected
case connecting
case failed
public init?(rawValue: String)
public var rawValue: String
public struct MCPResourceDescriptor : Codable, Sendable
public var serverID: MCPServerID
public var uri: String
public var name: String
public var description: String
public var mimeType: String?
public var enabled: Bool
public var title: String?
public var meta: MCPValue?
public init(serverID: MCPServerID, uri: String, name: String, description: String, mimeType: String? = nil, enabled: Bool = true, title: String? = nil, meta: MCPValue? = nil)
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct MCPResourceTemplateDescriptor : Codable, Sendable
public var serverID: MCPServerID
public var uriTemplate: String
public var name: String
public var description: String
public var mimeType: String?
public var title: String?
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct MCPPromptArgument : Codable, Sendable
public var name: String
public var description: String
public var required: Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct MCPPromptDescriptor : Codable, Sendable
public var serverID: MCPServerID
public var name: String
public var description: String
public var arguments: [MCPPromptArgument]
public var title: String?
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct MCPResourceContent : Codable, Sendable
public var uri: String
public var mimeType: String?
public var text: String?
public var blob: String?
public var meta: MCPValue?
public init(uri: String, mimeType: String? = nil, text: String? = nil, blob: String? = nil, meta: MCPValue? = nil)
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct MCPPromptMessage : Codable, Sendable
public var role: String
public var text: String
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct MCPToolAnnotations : Codable, Sendable, Equatable
public var title: String?
public var readOnlyHint: Bool?
public var destructiveHint: Bool?
public var idempotentHint: Bool?
public var openWorldHint: Bool?
public init(title: String? = nil, readOnlyHint: Bool? = nil, destructiveHint: Bool? = nil, idempotentHint: Bool? = nil, openWorldHint: Bool? = nil)
public var isReadOnly: Bool
public var isDestructive: Bool
public static func == (a: MCPToolAnnotations, b: MCPToolAnnotations) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct MCPToolDescriptor : Codable, Sendable
public var serverID: MCPServerID
public var name: String
public var description: String
public var rawSchema: Data
public var estimatedTokens: Int
public var enabled: Bool
public var title: String?
public var outputSchema: Data?
public var meta: MCPValue?
public var annotations: MCPToolAnnotations?
public init(serverID: MCPServerID, name: String, description: String, rawSchema: Data, estimatedTokens: Int, enabled: Bool = true, title: String? = nil, outputSchema: Data? = nil, meta: MCPValue? = nil, annotations: MCPToolAnnotations? = nil)
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
indirect public enum MCPValue : Codable, Sendable, Equatable
case string(String)
case number(Double)
case bool(Bool)
case array([MCPValue])
case object([String : MCPValue])
case null
public init(from decoder: any Decoder) throws
public func encode(to encoder: any Encoder) throws
public func strippingEmpty() -> MCPValue?
public static func == (a: MCPValue, b: MCPValue) -> Bool
public enum MCPServerError : Error, Codable, Sendable
case unreachable
case malformedResponse
case protocolMismatch
case notConnected
case toolNotFound
case serverError(String)
case authorizationRequired
case credentialRejected
case httpError(Int)
case oauthRegistrationNotSupported
case responseTooLarge(String)
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public protocol MCPConnection : Sendable
public struct MCPSubscriptionFilter : Sendable, Codable, Equatable
public var toolsListChanged: Bool
public var promptsListChanged: Bool
public var resourcesListChanged: Bool
public init(toolsListChanged: Bool = false, promptsListChanged: Bool = false, resourcesListChanged: Bool = false)
public var isEmpty: Bool
public static func == (a: MCPSubscriptionFilter, b: MCPSubscriptionFilter) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public enum MCPChangeEvent : Sendable, Equatable
case acknowledged(MCPSubscriptionFilter)
case toolsChanged
case promptsChanged
case resourcesChanged
case ended(MCPListenEnd)
public static func == (a: MCPChangeEvent, b: MCPChangeEvent) -> Bool
public enum MCPListenEnd : Sendable, Equatable
case closed
case failed(String)
case refused(String)
case unauthorized
public static func == (a: MCPListenEnd, b: MCPListenEnd) -> Bool
public enum MCPLiveUpdates : Sendable, Codable, Equatable
case active(MCPSubscriptionFilter)
case reconnecting
case unavailable(String)
public static func == (a: MCPLiveUpdates, b: MCPLiveUpdates) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public func listen(filter: MCPSubscriptionFilter) -> AsyncStream<MCPChangeEvent>
public func refreshAuthorizationSilently() async -> Bool
public var authorizationGeneration: Int
public enum MCPToolAdapterError : Error, CustomStringConvertible
case invalidRawSchema
case unbuildableSchema(String)
public var description: String
public struct MCPTool : Tool
public let name: String
public let description: String
public let parameters: GenerationSchema
public init(descriptor: MCPToolDescriptor, manager: MCPServerManager) throws
nonisolated public func call(arguments: GeneratedContent) async throws -> String
public typealias Arguments = GeneratedContent
public typealias Output = String
public struct MCPFileBackedOutput : Sendable, Equatable
public var root: URL
public var previewCharacters: Int
public var inlineCharacterLimit: Int?
public var followUp: String
public var saveAsPolicy: SaveAsPolicy
public init(root: URL, previewCharacters: Int = 600, inlineCharacterLimit: Int? = nil, followUp: String = "read it back a window at a time with readFileRange", saveAsPolicy: SaveAsPolicy = .default)
public static func == (a: MCPFileBackedOutput, b: MCPFileBackedOutput) -> Bool
public static func mcp(descriptor: MCPToolDescriptor, manager: MCPServerManager, root: URL, previewCharacters: Int = 600, inlineCharacterLimit: Int? = nil, followUp: String = "read it back a window at a time with readFileRange", saveAsPolicy: SaveAsPolicy = .default) throws -> FileBackedTool
public struct MCPResourceLink : Sendable, Codable, Equatable
public var uri: String
public var name: String?
public var title: String?
public var description: String?
public var mimeType: String?
public init(uri: String, name: String? = nil, title: String? = nil, description: String? = nil, mimeType: String? = nil)
public static func == (a: MCPResourceLink, b: MCPResourceLink) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct MCPToolResult : Sendable, Codable, Equatable
public var text: String
public var structuredContent: MCPValue?
public var resourceLinks: [MCPResourceLink]
public var isError: Bool
public var truncated: Bool
public var meta: MCPValue?
public init(text: String = "", structuredContent: MCPValue? = nil, resourceLinks: [MCPResourceLink] = [], isError: Bool = false, truncated: Bool = false, meta: MCPValue? = nil)
public var renderedForModel: String
public var rawPayload: String
public static func == (a: MCPToolResult, b: MCPToolResult) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct MCPResponseLimits : Sendable, Equatable
public var maxResponseBytes: Int
public var maxDescriptorCount: Int
public var maxSchemaBytes: Int
public var maxTextFieldLength: Int
public var maxInlineContentBytes: Int
public var maxUIResourceBytes: Int
public init(maxResponseBytes: Int = 8 * 1024 * 1024, maxDescriptorCount: Int = 512, maxSchemaBytes: Int = 128 * 1024, maxTextFieldLength: Int = 16 * 1024, maxInlineContentBytes: Int = 1 * 1024 * 1024, maxUIResourceBytes: Int = 4 * 1024 * 1024)
public static let `default`: MCPResponseLimits
public static func == (a: MCPResponseLimits, b: MCPResponseLimits) -> Bool
public enum ModelAvailability : Sendable, Equatable
case available
case notDownloaded
case needsCredential
case unavailable(kind: ModelAvailability.UnavailableKind, detail: String)
public enum UnavailableKind : Sendable, Equatable
case ineligibleHardware
case notEnabled
case modelNotReady
case unsupportedModel
case providerError
case noProvider
case requiresOS(String)
public static func == (a: ModelAvailability.UnavailableKind, b: ModelAvailability.UnavailableKind) -> Bool
public var isAvailable: Bool
public static func == (a: ModelAvailability, b: ModelAvailability) -> Bool
public struct ModelCapabilities : OptionSet, Sendable, Hashable, Codable
public let rawValue: Int
public init(rawValue: Int)
public static let toolCalling: ModelCapabilities
public static let guidedGeneration: ModelCapabilities
public static let reasoningToggle: ModelCapabilities
public struct ModelID : Hashable, Sendable, Codable, CustomStringConvertible, LosslessStringConvertible
public let scheme: String
public let rest: String
public var rawValue: String
public var description: String
public init?(_ raw: String)
public init?(scheme: String, rest: String = "")
public init(from decoder: any Decoder) throws
public func encode(to encoder: any Encoder) throws
public static let system: ModelID
public static let pcc: ModelID
public static func == (a: ModelID, b: ModelID) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public protocol ModelProvider : Sendable
public struct TurnArtifacts : Sendable, Equatable
public var serverToolActivities: [ServerToolActivity]
public var citations: [Citation]
public init(serverToolActivities: [ServerToolActivity] = [], citations: [Citation] = [])
public static let none: TurnArtifacts
public static func == (a: TurnArtifacts, b: TurnArtifacts) -> Bool
public var scheme: String
public func owns(_ id: ModelID) -> Bool
public func prewarm(_ id: ModelID) async
public var advertisedModels: [ModelID]
public func turnArtifacts(in transcript: Transcript) -> TurnArtifacts
public func makeSession(for id: ModelID, tools: [any Tool], instructions: String?, transcript: Transcript?, options: SessionOptions) throws -> LanguageModelSession
@MainActor final public func register(decision provider: any DecisionProvider) throws
@MainActor final public func replace(decision provider: any DecisionProvider)
@MainActor final public func removeDecisionProvider(scheme: String)
@MainActor final public func route(decision route: RouteName, to id: ModelID)
@MainActor final public func modelID(forDecision route: RouteName) -> ModelID?
@MainActor final public func decisionProvider(for id: ModelID) -> (any DecisionProvider)?
@MainActor final public func decisionAvailability(for id: ModelID) -> ModelAvailability
@MainActor final public class ModelRegistry
@MainActor final public var providers: [any ModelProvider]
@MainActor final public var routes: [RouteName : ModelID]
@MainActor final public var decisionProviders: [any DecisionProvider]
@MainActor final public var decisionRoutes: [RouteName : ModelID]
@MainActor final public var residency: ModelResidency
@MainActor final public let events: AsyncStream<ResidencyEvent>
@MainActor public init()
@MainActor final public func applyResidency() async
@MainActor final public func route(_ route: RouteName, to id: ModelID)
@MainActor final public func modelID(for route: RouteName) -> ModelID?
@MainActor final public func register(_ provider: any ModelProvider) throws
@MainActor final public func replace(_ provider: any ModelProvider)
@MainActor final public func removeProvider(scheme: String)
@MainActor final public func provider(for id: ModelID) -> (any ModelProvider)?
@MainActor public static let macOS27OnlySchemes: Set<String>
@MainActor final public func availability(for id: ModelID) -> ModelAvailability
@MainActor final public var schemesRequiringNewerOS: [String]
@MainActor final public var downloadableProviders: [any DownloadableModelProvider]
@MainActor final public var installedModels: [InstalledModel]
@MainActor final public var knownModels: [ModelID]
@MainActor final public var downloads: [ModelID : DownloadProgress]
@MainActor final public func startDownload(_ repoID: String) async throws -> InstalledModel
@MainActor final public func cancelDownload(_ repoID: String)
public struct DownloadProgress : Sendable, Equatable
public var bytesReceived: Int64
public var totalBytes: Int64
public var fraction: Double
public init(bytesReceived: Int64, totalBytes: Int64, fraction: Double)
public static func == (a: DownloadProgress, b: DownloadProgress) -> Bool
public enum ModelRegistryError : Error, Equatable, CustomStringConvertible
case schemeAlreadyRegistered(String)
case noDownloadableProvider
public var description: String
public static func == (a: ModelRegistryError, b: ModelRegistryError) -> Bool
public enum ModelResidency : Sendable, Equatable, Codable
case lastUsedOnly
case keepWarm([RouteName])
public static func == (a: ModelResidency, b: ModelResidency) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public enum DecisionWireFormat : String, Sendable, Hashable, Codable
case jev
case openAIDecisions
public init?(rawValue: String)
public var rawValue: String
public static let openAIDecisions: DecisionLimits
public enum OpenAIDecisionWire
public static let maxTextCharacters: Int
public static let maxJSONDepth: Int
public static let maxJSONValues: Int
public static let maxJSONBytes: Int
public static func encodeRequest(_ request: DecisionRequest, model: String) throws -> Data
public static func decodeRequest(_ data: Data) throws -> JevWire.Request
public static func encodeResponse(_ decision: Decision, model: String, request: DecisionRequest) throws -> Data
public static func decodeResponse(_ data: Data, request: DecisionRequest) throws -> JevWire.Response
public static func errorMessage(in data: Data) -> String?
public struct PCCModelProvider : ModelProvider
public static var scheme: String
public init()
public var advertisedModels: [ModelID]
public func owns(_ id: ModelID) -> Bool
public func makeSession(for id: ModelID, tools: [any Tool], instructions: String?, transcript: Transcript?) throws -> LanguageModelSession
public func availability(for id: ModelID) -> ModelAvailability
public func probe(timeout: Duration = .seconds(8)) async -> ModelAvailability
public enum RemindersAccess
nonisolated(unsafe) public static var store: EKEventStore
public static var authorizationStatus: EKAuthorizationStatus
public static var isAuthorized: Bool
public struct AccessResult
public var granted: Bool
public var error: String?
public var needsSystemSettings: Bool
public static func requestAccess() async -> RemindersAccess.AccessResult
public static func openSystemSettings()
public struct ReminderSummary : Codable, Sendable
public var calendarItemIdentifier: String
public var title: String
public var dueDate: String?
public var list: String
public var isCompleted: Bool
public var priority: Int
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public static func upcomingReminders(days: Int) async -> [RemindersAccess.ReminderSummary]
public struct AddReminderResult
public var success: Bool
public var error: String?
public static func addReminder(title: String, dueDateComponents: DateComponents?) -> RemindersAccess.AddReminderResult
public struct MutateReminderResult
public var success: Bool
public var error: String?
public init(success: Bool, error: String? = nil)
public static func updateReminder(title: String, dueDate: DateComponents?, newTitle: String?, newDate: DateComponents?, newTime: DateComponents?, isCompleted: Bool?) async -> RemindersAccess.MutateReminderResult
public static func deleteReminder(title: String, dueDate: DateComponents?) async -> RemindersAccess.MutateReminderResult
public struct GetUpcomingRemindersTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var days: Int?
public init(days: Int? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var days: Optional<Int>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: GetUpcomingRemindersTool.Arguments) async throws -> String
public typealias Output = String
public struct AddReminderTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var title: String
public var date: String?
public var time: String?
public init(title: String, date: String? = nil, time: String? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var title: String.PartiallyGenerated?
public var date: Optional<String>.PartiallyGenerated?
public var time: Optional<String>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: AddReminderTool.Arguments) async throws -> String
public typealias Output = String
public struct UpdateReminderTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var title: String
public var currentDate: String?
public var newTitle: String?
public var newDate: String?
public var newTime: String?
public var isCompleted: Bool?
public init(title: String, currentDate: String? = nil, newTitle: String? = nil, newDate: String? = nil, newTime: String? = nil, isCompleted: Bool? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var title: String.PartiallyGenerated?
public var currentDate: Optional<String>.PartiallyGenerated?
public var newTitle: Optional<String>.PartiallyGenerated?
public var newDate: Optional<String>.PartiallyGenerated?
public var newTime: Optional<String>.PartiallyGenerated?
public var isCompleted: Optional<Bool>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: UpdateReminderTool.Arguments) async throws -> String
public typealias Output = String
public struct DeleteReminderTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var title: String
public var currentDate: String?
public init(title: String, currentDate: String? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var title: String.PartiallyGenerated?
public var currentDate: Optional<String>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: DeleteReminderTool.Arguments) async throws -> String
public typealias Output = String
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
public enum ResidencyEvent : Sendable
case warmed(ModelID)
case evicted(ModelID, reason: String)
case loadProgress(ModelID, Double)
public struct RetryPolicy : Sendable
public var maxRetries: Int
public var compact: (@Sendable (Transcript) -> Transcript)?
public init(maxRetries: Int = 0, compact: (@Sendable (Transcript) -> Transcript)? = nil)
public static let disabled: RetryPolicy
public struct RouteName : Hashable, Sendable, Codable, CustomStringConvertible, ExpressibleByStringLiteral
public let rawValue: String
public init(_ rawValue: String)
public init(stringLiteral value: String)
public var description: String
public init(from decoder: any Decoder) throws
public func encode(to encoder: any Encoder) throws
public static let heavy: RouteName
public static let light: RouteName
public static let local: RouteName
public static func == (a: RouteName, b: RouteName) -> Bool
public typealias ExtendedGraphemeClusterLiteralType = String
public typealias StringLiteralType = String
public typealias UnicodeScalarLiteralType = String
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public struct LoadTableTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var jsonPath: String
public var tableName: String
public var recordsAt: String
public init(jsonPath: String, tableName: String, recordsAt: String = "")
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var jsonPath: String.PartiallyGenerated?
public var tableName: String.PartiallyGenerated?
public var recordsAt: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments a: LoadTableTool.Arguments) async throws -> String
public typealias Output = String
public struct SQLQueryTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var sql: String
public var outputPath: String
public init(sql: String, outputPath: String)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var sql: String.PartiallyGenerated?
public var outputPath: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments a: SQLQueryTool.Arguments) async throws -> String
public typealias Output = String
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
public enum MCPServerTrust : String, Sendable, Codable, CaseIterable
case untrusted
case trusted
public init?(rawValue: String)
public typealias AllCases = [MCPServerTrust]
nonisolated public static var allCases: [MCPServerTrust]
public var rawValue: String
public enum ToolApprover : String, Sendable, Codable
case user
case policy
public init?(rawValue: String)
public var rawValue: String
public enum ToolApproval : Sendable, Codable, Equatable
case allow
case ask(atOrAbove: ToolImpact, by: ToolApprover)
public static func `default`(for trust: MCPServerTrust) -> ToolApproval
public static func == (a: ToolApproval, b: ToolApproval) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public typealias ToolPolicy = @Sendable (PendingToolCall) async -> ToolPolicyDecision
public enum ToolPolicyDecision : Sendable, Equatable
case allow
case deny(reason: String)
case askUser
public static func == (a: ToolPolicyDecision, b: ToolPolicyDecision) -> Bool
public enum SessionEvent : Sendable
case modelLoadProgress(Double)
case routeSwitched(from: ModelID, to: ModelID)
case contextCompacted(removedEntries: Int)
case toolCallStarted(id: String, name: String, arguments: String)
case toolCallFinished(id: String, name: String, failed: Bool, resultSummary: String?)
case serverToolCall(ServerToolActivity)
public enum SessionOptionsError : Error, LocalizedError, Equatable
case topKAndTopPBothSet
case seedRequiresTopKOrTopP
case invalidValue(field: String, detail: String)
case perCallOptionsUnsupported(model: String)
public var errorDescription: String?
public static func == (a: SessionOptionsError, b: SessionOptionsError) -> Bool
public func appleGenerationOptions() throws -> GenerationOptions
public struct SessionOptions : Sendable, Equatable
public var webSearch: Bool
public var webSearchMaxUses: Int?
public var webSearchAllowedDomains: [String]
public var webSearchBlockedDomains: [String]
public var effort: Effort?
public var temperature: Double?
public var topP: Double?
public var maxOutputTokens: Int?
public var userLocation: UserLocation?
public var seed: UInt64?
public var topK: Int?
public var minP: Double?
public var repetitionPenalty: Double?
public var repetitionContextSize: Int?
public var prefillStepSize: Int?
public var maxModelCallsPerTurn: Int?
public init(webSearch: Bool = false, webSearchMaxUses: Int? = nil, webSearchAllowedDomains: [String] = [], webSearchBlockedDomains: [String] = [], effort: Effort? = nil, temperature: Double? = nil, topP: Double? = nil, maxOutputTokens: Int? = nil, userLocation: UserLocation? = nil, seed: UInt64? = nil, topK: Int? = nil, minP: Double? = nil, repetitionPenalty: Double? = nil, repetitionContextSize: Int? = nil, prefillStepSize: Int? = nil, maxModelCallsPerTurn: Int? = nil)
public var serverTools: Set<ServerTool>
public func merged(onto base: SessionOptions) -> SessionOptions
public static func == (a: SessionOptions, b: SessionOptions) -> Bool
public enum Effort : String, Sendable, Hashable, CaseIterable, Codable
case off, low, medium, high, xhigh, max
public init?(rawValue: String)
public typealias AllCases = [Effort]
nonisolated public static var allCases: [Effort]
public var rawValue: String
public struct UserLocation : Sendable, Equatable, Codable
public var city: String?
public var region: String?
public var country: String?
public var timezone: String?
public init(city: String? = nil, region: String? = nil, country: String? = nil, timezone: String? = nil)
public static func == (a: UserLocation, b: UserLocation) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public enum ServerTool : Sendable, Hashable
case webSearch(maxUses: Int? = nil, allowedDomains: [String] = [], blockedDomains: [String] = [])
case webFetch
public static func == (a: ServerTool, b: ServerTool) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public struct ServerToolActivity : Sendable, Equatable, Identifiable
public let id: String
public var kind: ServerToolActivity.Kind
public enum Kind : Sendable, Equatable
case webSearch(queries: [String], hits: [WebHit])
case webFetch(url: String)
public static func == (a: ServerToolActivity.Kind, b: ServerToolActivity.Kind) -> Bool
public init(id: String = UUID().uuidString, kind: ServerToolActivity.Kind)
public static func == (a: ServerToolActivity, b: ServerToolActivity) -> Bool
public typealias ID = String
public struct WebHit : Sendable, Equatable, Codable
public var url: String
public var title: String
public var snippet: String?
public init(url: String, title: String, snippet: String? = nil)
public static func == (a: WebHit, b: WebHit) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct Citation : Sendable, Equatable, Codable, Identifiable
public var id: String
public var url: String
public var title: String
public var citedText: String?
public init(url: String, title: String, citedText: String? = nil)
public static func == (a: Citation, b: Citation) -> Bool
public typealias ID = String
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct SystemModelProvider : ModelProvider
public static var scheme: String
public init()
public var advertisedModels: [ModelID]
public func owns(_ id: ModelID) -> Bool
public func makeSession(for id: ModelID, tools: [any Tool], instructions: String?, transcript: Transcript?) throws -> LanguageModelSession
public func availability(for id: ModelID) -> ModelAvailability
public protocol ToolCallAuthorizer : Sendable
public enum ToolCallDecision : Sendable
case allow
case deny(reason: String)
public struct PendingToolCall : Sendable
public let toolName: String
public let arguments: GeneratedContent?
public let argumentsDescription: String
public let origin: ToolOrigin
public let impact: ToolImpact
public let initiator: ToolCallInitiator
public let serverApproval: ToolApproval?
public init(toolName: String, arguments: GeneratedContent?, argumentsDescription: String, origin: ToolOrigin, impact: ToolImpact, initiator: ToolCallInitiator = .model, serverApproval: ToolApproval? = nil)
public var summary: PendingToolCallSummary
public struct PendingToolCallSummary : Codable, Sendable, Equatable
public let toolName: String
public let argumentsDescription: String
public let origin: ToolOrigin
public let impact: ToolImpact
public let initiator: ToolCallInitiator
public let serverApproval: ToolApproval?
public init(toolName: String, argumentsDescription: String, origin: ToolOrigin, impact: ToolImpact, initiator: ToolCallInitiator = .model, serverApproval: ToolApproval? = nil)
public init(from decoder: any Decoder) throws
public static func == (a: PendingToolCallSummary, b: PendingToolCallSummary) -> Bool
public func encode(to encoder: any Encoder) throws
public enum ToolOrigin : Sendable, Codable, Equatable
case host
case mcp(server: MCPServerID, displayName: String)
public static func == (a: ToolOrigin, b: ToolOrigin) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public enum ToolImpact : Int, Sendable, Codable, Comparable, CaseIterable
case read
case mutate
case destructive
public static func < (lhs: ToolImpact, rhs: ToolImpact) -> Bool
public init?(rawValue: Int)
public typealias AllCases = [ToolImpact]
nonisolated public static var allCases: [ToolImpact]
public var rawValue: Int
public protocol ImpactRatedTool : Tool
public protocol OriginTaggedTool : Tool
public func limited(toMaxImpact ceiling: ToolImpact) -> [any Tool]
public enum ToolCallInitiator : Sendable, Hashable, Codable
case model
case app(instance: String)
case host
public static func == (a: ToolCallInitiator, b: ToolCallInitiator) -> Bool
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public enum ToolReference : Sendable, Equatable
case mcp(server: MCPServerID, tool: String)
case host(name: String)
case provider(ServerToolActivity)
public var name: String
public static func == (a: ToolReference, b: ToolReference) -> Bool
public struct ToolCallRecord : Identifiable, Sendable
public enum State : Sendable, Equatable
case awaitingApproval
case running
case finished
case failed(reason: String)
case denied(reason: String)
public static func == (a: ToolCallRecord.State, b: ToolCallRecord.State) -> Bool
public let id: String
public var modelCallID: String?
public let tool: ToolReference
public let initiator: ToolCallInitiator
public let arguments: GeneratedContent?
public let argumentsDescription: String
public var state: ToolCallRecord.State
public var output: String?
public var mcpResult: MCPToolResult?
public let app: MCPAppLink?
public let toolDescriptor: MCPToolDescriptor?
public let startedAt: Date
public var finishedAt: Date?
public typealias ID = String
public protocol ToolConfirmationChannel : Sendable
public struct ConfirmingToolAuthorizer : ToolCallAuthorizer
public init(channel: (any ToolConfirmationChannel)?, policy: ToolPolicy? = nil, hostTools: ToolApproval = .ask(atOrAbove: .mutate, by: .user), timeout: Duration = .seconds(120))
public func authorize(_ call: PendingToolCall) async -> ToolCallDecision
final public class DecisionGate : @unchecked Sendable
public init()
final public func attach(_ continuation: CheckedContinuation<Bool, Never>)
final public func resume(_ value: Bool)
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public var impact: ToolImpact
public struct WeatherTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(description: String? = nil)
public struct Arguments
public var location: String
public init(location: String)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var location: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: WeatherTool.Arguments) async throws -> String
public typealias Output = String
nonisolated public init(_ content: GeneratedContent) throws
public struct PatchResult : Codable, Sendable, Equatable
public var changed: [String]
public var created: [String]
public var deleted: [String]
public var hunksApplied: Int
public static func == (a: WorkspaceAccess.PatchResult, b: WorkspaceAccess.PatchResult) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct WorkspaceLimits : Sendable, Equatable
public var maxReadBytes: Int
public var maxReturnedCharacters: Int
public var maxFileBytes: Int
public var maxRegexInputBytes: Int
public var maxScanBytes: Int
public var maxWriteBytes: Int
public init(maxReadBytes: Int = 8 << 20, maxReturnedCharacters: Int = 2_000_000, maxFileBytes: Int = 64 << 20, maxRegexInputBytes: Int = 8 << 10, maxScanBytes: Int = 256 << 20, maxWriteBytes: Int = 64 << 20)
public static let `default`: WorkspaceAccess.WorkspaceLimits
public static func == (a: WorkspaceAccess.WorkspaceLimits, b: WorkspaceAccess.WorkspaceLimits) -> Bool
public struct SearchMatch : Codable, Sendable, Equatable
public var path: String
public var line: Int
public var text: String
public static func == (a: WorkspaceAccess.SearchMatch, b: WorkspaceAccess.SearchMatch) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public struct SearchResult : Codable, Sendable, Equatable
public var matches: [WorkspaceAccess.SearchMatch]
public var skippedTooLarge: [String]
public var scanBudgetExhausted: Bool
public var hitResultCap: Bool
public static func == (a: WorkspaceAccess.SearchResult, b: WorkspaceAccess.SearchResult) -> Bool
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public enum WorkspaceAccess
public struct WorkspaceError : Error
public var message: String
public struct WorkspaceEntry : Codable, Sendable
public var name: String
public var isDirectory: Bool
public var modifiedDate: Date?
public var size: Int?
public func encode(to encoder: any Encoder) throws
public init(from decoder: any Decoder) throws
public static var maxReadCharacters: Int
public var errorDescription: String?
public struct SearchWorkspaceTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil, limits: WorkspaceAccess.WorkspaceLimits = .default)
public struct Arguments
public var query: String
public var isRegex: Bool?
public var include: String?
public init(query: String, isRegex: Bool? = nil, include: String? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var query: String.PartiallyGenerated?
public var isRegex: Optional<Bool>.PartiallyGenerated?
public var include: Optional<String>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: SearchWorkspaceTool.Arguments) async throws -> String
public typealias Output = String
public struct WorkspaceTreeTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var path: String?
public var maxDepth: Int?
public init(path: String? = nil, maxDepth: Int? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var path: Optional<String>.PartiallyGenerated?
public var maxDepth: Optional<Int>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: WorkspaceTreeTool.Arguments) async throws -> String
public typealias Output = String
public struct ApplyPatchTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil, limits: WorkspaceAccess.WorkspaceLimits = .default)
public struct Arguments
public var diff: String
public init(diff: String)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var diff: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: ApplyPatchTool.Arguments) async throws -> String
public typealias Output = String
public struct ReadFileRangeTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil, limits: WorkspaceAccess.WorkspaceLimits = .default)
public struct Arguments
public var path: String
public var offset: Int
public var limit: Int
public init(path: String, offset: Int, limit: Int)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var path: String.PartiallyGenerated?
public var offset: Int.PartiallyGenerated?
public var limit: Int.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: ReadFileRangeTool.Arguments) async throws -> String
public typealias Output = String
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
public struct ListWorkspaceFilesTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var path: String?
public init(path: String? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var path: Optional<String>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: ListWorkspaceFilesTool.Arguments) async throws -> String
public typealias Output = String
public struct ReadWorkspaceFileTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil, limits: WorkspaceAccess.WorkspaceLimits = .default)
public struct Arguments
public var path: String
public init(path: String)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var path: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: ReadWorkspaceFileTool.Arguments) async throws -> String
public typealias Output = String
public struct WriteWorkspaceFileTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil, limits: WorkspaceAccess.WorkspaceLimits = .default)
public struct Arguments
public var path: String
public var contents: String
public var overwrite: Bool?
public var append: Bool?
public init(path: String, contents: String, overwrite: Bool? = nil, append: Bool? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var path: String.PartiallyGenerated?
public var contents: String.PartiallyGenerated?
public var overwrite: Optional<Bool>.PartiallyGenerated?
public var append: Optional<Bool>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: WriteWorkspaceFileTool.Arguments) async throws -> String
public typealias Output = String
public struct EditWorkspaceFileTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil, limits: WorkspaceAccess.WorkspaceLimits = .default)
public struct Arguments
public var path: String
public var oldString: String
public var newString: String
public var replaceAll: Bool?
public init(path: String, oldString: String, newString: String, replaceAll: Bool? = nil)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var path: String.PartiallyGenerated?
public var oldString: String.PartiallyGenerated?
public var newString: String.PartiallyGenerated?
public var replaceAll: Optional<Bool>.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: EditWorkspaceFileTool.Arguments) async throws -> String
public typealias Output = String
public struct DeleteWorkspaceFileTool : Tool
public static let defaultDescription: String
public let name: String
public let description: String
public init(root: URL, description: String? = nil)
public struct Arguments
public var path: String
public init(path: String)
nonisolated public static var generationSchema: GenerationSchema
nonisolated public var generatedContent: GeneratedContent
nonisolated public struct PartiallyGenerated : Identifiable, nonisolated ConvertibleFromGeneratedContent
public var id: GenerationID
public var path: String.PartiallyGenerated?
nonisolated public init(_ content: GeneratedContent) throws
public typealias ID = GenerationID
nonisolated public func call(arguments: DeleteWorkspaceFileTool.Arguments) async throws -> String
public typealias Output = String
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
nonisolated public init(_ content: GeneratedContent) throws
```

## LocalLMLabSDKClaude

```swift
public struct ClaudeModelProvider : ModelProvider
public static var scheme: String
public enum Auth : Sendable
case apiKey(String)
case appAttest(clientID: String)
public init(auth: ClaudeModelProvider.Auth, extraModels: [String : ClaudeModelSpec] = [:])
public var advertisedModels: [ModelID]
public func makeSession(for id: ModelID, tools: [any Tool], instructions: String?, transcript: Transcript?) throws -> LanguageModelSession
public func makeSession(for id: ModelID, tools: [any Tool], instructions: String?, transcript: Transcript?, options: SessionOptions) throws -> LanguageModelSession
public func turnArtifacts(in transcript: Transcript) -> TurnArtifacts
public func availability(for id: ModelID) -> ModelAvailability
public struct ClaudeModelSpec : Sendable, Hashable
public var id: String
public var effortLevels: Set<String>
public var samplingParams: Bool
public var adaptiveThinking: Bool
public var structuredOutput: Bool
public var imageInput: Bool
public init(id: String, effortLevels: Set<String> = [], samplingParams: Bool = false, adaptiveThinking: Bool = false, structuredOutput: Bool = false, imageInput: Bool = false)
public static func == (a: ClaudeModelSpec, b: ClaudeModelSpec) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
```

## LocalLMLabSDKInference

```swift
public struct MLXCacheLimits : Sendable, Equatable
public var maxTotalCacheBytes: Int64?
public init(maxTotalCacheBytes: Int64? = nil)
public static let `default`: MLXCacheLimits
public static func == (a: MLXCacheLimits, b: MLXCacheLimits) -> Bool
public struct MLXCachedSnapshot : Sendable, Equatable
public var repoID: String
public var revision: String
public var isComplete: Bool
public var isCurrent: Bool
public var exclusiveBytes: Int64
public var sharedBytes: Int64
public var lastModified: Date?
public init(repoID: String, revision: String, isComplete: Bool, isCurrent: Bool, exclusiveBytes: Int64, sharedBytes: Int64, lastModified: Date? = nil)
public static func == (a: MLXCachedSnapshot, b: MLXCachedSnapshot) -> Bool
public func snapshots(for repoID: String) -> [MLXCachedSnapshot]
public func removeSnapshot(_ repoID: String, revision: String) throws -> Int64
public struct MLXPinOverride : Sendable, Equatable
public var base: String
public var revision: String
public init(base: String, revision: String)
public static func == (a: MLXPinOverride, b: MLXPinOverride) -> Bool
public protocol MLXManagedPinStore : Sendable
final public class MLXFileManagedPinStore : MLXManagedPinStore, @unchecked Sendable
final public let fileURL: URL
public init(directory: URL? = nil, fileName: String = "mlx-managed-pins.json")
final public var lastWriteError: (any Error)?
final public var allOverrides: [String : MLXPinOverride]
final public func override(for repoID: String) -> MLXPinOverride?
final public func setOverride(_ override: MLXPinOverride, for repoID: String)
final public func removeOverride(for repoID: String)
final public func removeAllOverrides()
public struct SpeculativeDecodingSpec : Sendable, Equatable
public var draftRepoID: String
public var numDraftTokens: Int
public init(draftRepoID: String, numDraftTokens: Int = 2)
public static func == (a: SpeculativeDecodingSpec, b: SpeculativeDecodingSpec) -> Bool
public enum AdapterSource : Sendable, Equatable
case huggingFace(repoID: String)
case directory(URL)
public static func == (a: AdapterSource, b: AdapterSource) -> Bool
public struct AdapterSpec : Sendable, Equatable
public var source: AdapterSource
public init(source: AdapterSource)
public static func == (a: AdapterSpec, b: AdapterSpec) -> Bool
public struct MLXModelProvider : DownloadableModelProvider
public static var scheme: String
public let maxModelCallsPerTurn: Int
public static let defaultMaxModelCallsPerTurn: Int
public init(cacheDirectory: URL? = nil, residentModelLimit: Int = 1, preflightLimits: MLXPreflightLimits = MLXPreflightLimits(), pinnedRevisions: [String : String] = [:], supplyChainPolicy: MLXSupplyChainPolicy = .default, pinStore: (any MLXPinStore)? = nil, managedPinStore: (any MLXManagedPinStore)? = nil, maxModelCallsPerTurn: Int = MLXModelProvider.defaultMaxModelCallsPerTurn)
public var residencyEventStream: AsyncStream<ResidencyEvent>?
public func effectivePin(for repoID: String) -> MLXPin?
public func buildTimePin(for repoID: String) -> String?
public func pairDraftModel(_ spec: SpeculativeDecodingSpec?, with baseRepoID: String)
public func pairAdapter(_ spec: AdapterSpec?, with baseRepoID: String)
public var advertisedModels: [ModelID]
public func makeSession(for id: ModelID, tools: [any Tool], instructions: String?, transcript: Transcript?) throws -> LanguageModelSession
public func makeSession(for id: ModelID, tools: [any Tool], instructions: String?, transcript: Transcript?, options: SessionOptions) throws -> LanguageModelSession
public func availability(for id: ModelID) -> ModelAvailability
public func prewarm(_ id: ModelID) async
public var installed: [InstalledModel]
public var storageUsed: Int64
public func download(_ repoID: String) -> AsyncThrowingStream<DownloadEvent, any Error>
public func cancelDownload(_ repoID: String)
public func validate(_ repoID: String) async throws -> PreflightResult
public func capabilityProbe(_ id: ModelID) async -> ModelCapabilityReport
public func remove(_ id: ModelID) throws
public func unloadResident(_ id: ModelID, reason: String = "idleTimeout") async
public func unloadAllResident(reason: String = "idleTimeout") async
public protocol MLXModelTrustPolicy : Sendable
public enum MLXModelTrustDecision : Sendable, Equatable
case allow
case deny(reason: String)
public static func == (a: MLXModelTrustDecision, b: MLXModelTrustDecision) -> Bool
public enum MLXPinSource : Sendable, Equatable
case shipped
case captured
public static func == (a: MLXPinSource, b: MLXPinSource) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public struct MLXPin : Sendable, Equatable
public var revision: String
public var source: MLXPinSource
public var buildTimeRevision: String?
public init(revision: String, source: MLXPinSource, buildTimeRevision: String? = nil)
public var isRuntimeOverride: Bool
public static func == (a: MLXPin, b: MLXPin) -> Bool
public protocol MLXPinStore : Sendable
final public class MLXFilePinStore : MLXPinStore, @unchecked Sendable
public static var defaultDirectory: URL
final public let fileURL: URL
public init(directory: URL? = nil, fileName: String = "mlx-pins.json")
final public var lastWriteError: (any Error)?
final public var allPins: [String : String]
final public func pin(for repoID: String) -> String?
final public func setPin(_ revision: String, for repoID: String)
final public func removePin(for repoID: String)
final public func removeAllPins()
public struct MLXFileChange : Sendable, Equatable
public enum Kind : Sendable, Equatable
case added
case removed
case modified
public static func == (a: MLXFileChange.Kind, b: MLXFileChange.Kind) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public var path: String
public var kind: MLXFileChange.Kind
public var oldSize: Int64?
public var newSize: Int64?
public init(path: String, kind: MLXFileChange.Kind, oldSize: Int64? = nil, newSize: Int64? = nil)
public static func == (a: MLXFileChange, b: MLXFileChange) -> Bool
public struct MLXPinUpdateCheck : Sendable, Equatable
public var repoID: String
public var pinnedRevision: String
public var latestRevision: String
public var changes: [MLXFileChange]
public var isUpToDate: Bool
public init(repoID: String, pinnedRevision: String, latestRevision: String, changes: [MLXFileChange] = [])
public static func == (a: MLXPinUpdateCheck, b: MLXPinUpdateCheck) -> Bool
public func checkPinUpdate(_ repoID: String, to revision: String? = nil) async throws -> MLXPinUpdateCheck
public func updatePin(_ repoID: String, to revision: String? = nil, beforeSwitch: (@Sendable () async throws -> Void)? = nil) -> AsyncThrowingStream<DownloadEvent, any Error>
public func updatePins(_ updates: [String : String], beforeSwitch: (@Sendable () async throws -> Void)? = nil) -> AsyncThrowingStream<DownloadEvent, any Error>
public struct MLXPreflightLimits : Sendable, Equatable
public var maxWeightFractionOfRAM: Double
public init(maxWeightFractionOfRAM: Double = 0.7)
public static func == (a: MLXPreflightLimits, b: MLXPreflightLimits) -> Bool
public struct MLXPrefillActivity : Sendable, Equatable
public let repoID: String
public let promptTokens: Int
public let modelCall: Int
public let startedAt: Date
public init(repoID: String, promptTokens: Int, modelCall: Int, startedAt: Date)
public static func == (a: MLXPrefillActivity, b: MLXPrefillActivity) -> Bool
public enum MLXPrefillMonitor
public static var active: [MLXPrefillActivity]
public struct MLXSupplyChainPolicy : Sendable
public var verification: MLXWeightVerification
public var trustPolicy: (any MLXModelTrustPolicy)?
public var cacheLimits: MLXCacheLimits
public init(verification: MLXWeightVerification = .default, trustPolicy: (any MLXModelTrustPolicy)? = nil, cacheLimits: MLXCacheLimits = .default)
public static let `default`: MLXSupplyChainPolicy
public enum MLXUsageMetadataKey
public static let promptTokens: String
public static let generatedTokens: String
public static let promptSeconds: String
public static let generateSeconds: String
public static let promptTokensPerSecond: String
public static let tokensPerSecond: String
public static let rounds: String
public static let stopReason: String
public static let draftTokensProposed: String
public static let draftTokensAccepted: String
public static let speculativeRounds: String
public static let residentMemoryBytes: String
public static let peakMemoryBytes: String
public static let gpuMemoryLimitBytes: String
public enum MLXWeightVerification : Sendable, Equatable
case enabled
case disabled
public static let `default`: MLXWeightVerification
public static func == (a: MLXWeightVerification, b: MLXWeightVerification) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public struct MLXWeightVerificationError : Error, LocalizedError, Sendable
public enum Reason : Sendable, Equatable
case hashMismatch(expected: String, computed: String)
case unrecognizedETagShape(String)
public static func == (a: MLXWeightVerificationError.Reason, b: MLXWeightVerificationError.Reason) -> Bool
public var filename: String
public var reason: MLXWeightVerificationError.Reason
public init(filename: String, reason: MLXWeightVerificationError.Reason)
public var errorDescription: String?
public struct OpenJevWrapper : Sendable, Hashable
public var system: String
public var inputLabel: String
public init(system: String, inputLabel: String)
public static let `default`: OpenJevWrapper
public static func == (a: OpenJevWrapper, b: OpenJevWrapper) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public enum OpenJevWarning : Sendable, Hashable
case mixtureOfExperts
public static func == (a: OpenJevWarning, b: OpenJevWarning) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public struct OpenJevDiagnostics : Sendable
public struct Question : Sendable
public let labels: [String]
public let prompt: String
public let labelMass: Double
public let latency: Duration
public let questions: [String : OpenJevDiagnostics.Question]
public let sharedPrefixTokens: Int
public struct OpenJevDecisionProvider : DecisionProvider
public let scheme: String
public let mlx: MLXModelProvider
public let wrapper: OpenJevWrapper
public let calibration: DecisionCalibration?
public let tuning: DecisionQuestionSet.Tuning?
public init(mlx: MLXModelProvider, wrapper: OpenJevWrapper = .default, calibration: DecisionCalibration? = nil, scheme: String = "openjev")
public init(mlx: MLXModelProvider, tunedWith set: DecisionQuestionSet, scheme: String = "openjev")
public func tuningMismatch(for id: ModelID) -> String?
public var limits: DecisionLimits
public func fidelity(for id: ModelID) -> DecisionFidelity
public func availability(for id: ModelID) -> ModelAvailability
public func warnings(for id: ModelID) -> [OpenJevWarning]
public func prewarm(_ id: ModelID) async
public func decide(_ request: DecisionRequest, using id: ModelID) async throws -> Decision
public func decideWithDiagnostics(_ request: DecisionRequest, using id: ModelID) async throws -> (decision: Decision, diagnostics: OpenJevDiagnostics)
@MainActor public func pair(decider: ModelID, generator: ModelID, registry: ModelRegistry) async throws -> DecisionPairing
```

## LocalLMLabSDKRemote

```swift
public struct JevProviderConfig : Sendable, Equatable
public var scheme: String
public var displayName: String
public var endpoint: URL
public var auth: RemoteProviderConfig.Auth
public var models: [String]
public var allowArbitraryModelIDs: Bool
public var fidelity: DecisionFidelity
public var limits: DecisionLimits
public var responseLimits: RemoteResponseLimits
public var timeout: TimeInterval
public var wire: DecisionWireFormat
public init(scheme: String, displayName: String, endpoint: URL, auth: RemoteProviderConfig.Auth, models: [String] = [], allowArbitraryModelIDs: Bool = true, fidelity: DecisionFidelity, limits: DecisionLimits = .jev, responseLimits: RemoteResponseLimits = .default, timeout: TimeInterval = 60)
public init(scheme: String, displayName: String, endpoint: URL, auth: RemoteProviderConfig.Auth, models: [String] = [], allowArbitraryModelIDs: Bool = true, fidelity: DecisionFidelity, limits: DecisionLimits = .jev, responseLimits: RemoteResponseLimits = .default, timeout: TimeInterval = 60, wire: DecisionWireFormat)
public static func openRouter(key: String) -> JevProviderConfig
public static func featherless(key: String) -> JevProviderConfig
public static func featherlessDemo() -> JevProviderConfig
public static func openAI(key: String) -> JevProviderConfig
public static func openAICompatibleDecisions(baseURL: URL, auth: RemoteProviderConfig.Auth, models: [String], limits: DecisionLimits = .openAIDecisions, scheme: String = "openaicompat", fidelity: DecisionFidelity = .native) -> JevProviderConfig
public func validated() throws -> JevProviderConfig
public static func == (a: JevProviderConfig, b: JevProviderConfig) -> Bool
public struct JevDecisionProvider : DecisionProvider
public let config: JevProviderConfig
public init(_ config: JevProviderConfig)
public var scheme: String
public var limits: DecisionLimits
public func fidelity(for id: ModelID) -> DecisionFidelity
public func availability(for id: ModelID) -> ModelAvailability
public func decide(_ request: DecisionRequest, using id: ModelID) async throws -> Decision
public func probe(for id: ModelID, timeout: Duration = .seconds(8)) async -> ModelAvailability
public static func requestBody(model: String, request: DecisionRequest) throws -> Data
public static func requestBody(model: String, request: DecisionRequest, wire: DecisionWireFormat) throws -> Data
public static func openAI(apiKey: String, models: [RemoteModel] = []) -> RemoteProviderConfig
public static func anthropic(apiKey: String, models: [RemoteModel] = []) -> RemoteProviderConfig
public static func openAIResponses(apiKey: String, models: [RemoteModel] = []) -> RemoteProviderConfig
public static func openRouter(apiKey: String, models: [RemoteModel] = []) -> RemoteProviderConfig
public static func openAICompatible(scheme: String, displayName: String, baseURL: URL, apiKey: String?, models: [RemoteModel] = [], allowArbitraryModelIDs: Bool = true) -> RemoteProviderConfig
public enum RemoteError : Error, LocalizedError
case http(status: Int, message: String)
case transport(any Error)
case dialectNotImplemented(String)
case responseTooLarge(String)
public var errorDescription: String?
public struct RemoteModelProvider : ModelProvider
public static var scheme: String
public init(_ config: RemoteProviderConfig) throws
public init(unchecked config: RemoteProviderConfig)
public var scheme: String
public var advertisedModels: [ModelID]
public func owns(_ id: ModelID) -> Bool
public func availability(for id: ModelID) -> ModelAvailability
public func probe(for id: ModelID, timeout: Duration = .seconds(8)) async -> ModelAvailability
public func makeSession(for id: ModelID, tools: [any Tool], instructions: String?, transcript: Transcript?) throws -> LanguageModelSession
public func makeSession(for id: ModelID, tools: [any Tool], instructions: String?, transcript: Transcript?, options: SessionOptions) throws -> LanguageModelSession
public struct RemoteProviderConfig : Sendable, Equatable
public var scheme: String
public var displayName: String
public var dialect: RemoteProviderConfig.Dialect
public var baseURL: URL
public var auth: RemoteProviderConfig.Auth
public var models: [RemoteModel]
public var capabilities: Set<RemoteProviderConfig.Capability>
public var defaultOptions: SessionOptions
public var allowArbitraryModelIDs: Bool
public var responseLimits: RemoteResponseLimits
public init(scheme: String, displayName: String, dialect: RemoteProviderConfig.Dialect, baseURL: URL, auth: RemoteProviderConfig.Auth, models: [RemoteModel] = [], capabilities: Set<RemoteProviderConfig.Capability> = [], defaultOptions: SessionOptions = .init(), allowArbitraryModelIDs: Bool = false, responseLimits: RemoteResponseLimits = .default)
public enum Dialect : String, Sendable, Hashable, Codable
case openAIChat
case openAIResponses
case anthropicMessages
public init?(rawValue: String)
public var rawValue: String
public enum Auth : Sendable, Hashable
case apiKey(String)
case header(name: String, value: String)
case none
public static func == (a: RemoteProviderConfig.Auth, b: RemoteProviderConfig.Auth) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public enum Capability : String, Sendable, Hashable, Codable
case webSearch
case structuredOutput
case imageInput
public init?(rawValue: String)
public var rawValue: String
public static func == (a: RemoteProviderConfig, b: RemoteProviderConfig) -> Bool
public struct RemoteModel : Sendable, Hashable, Codable, Identifiable
public var id: String
public var displayName: String
public var contextWindow: Int?
public init(id: String, displayName: String? = nil, contextWindow: Int? = nil)
public static func == (a: RemoteModel, b: RemoteModel) -> Bool
public typealias ID = String
public func encode(to encoder: any Encoder) throws
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public init(from decoder: any Decoder) throws
public enum ValidationIssue : Error, LocalizedError, Equatable
case insecureBaseURL(host: String)
case unsupportedURLScheme(String)
case missingHost
case malformedHeaderName(String)
case controlCharactersInCredential
public var errorDescription: String?
public static func == (a: RemoteProviderConfig.ValidationIssue, b: RemoteProviderConfig.ValidationIssue) -> Bool
public func validated() throws -> RemoteProviderConfig
public static func isLoopbackOrLocalHost(_ host: String) -> Bool
public static func isValidHeaderFieldName(_ name: String) -> Bool
public struct RemoteResponseLimits : Sendable, Hashable
public var maxResponseBytes: Int
public var maxStreamedBytes: Int
public var maxSSELineBytes: Int
public var maxEmittedTextBytes: Int
public var maxToolCallArgumentBytes: Int
public var maxErrorBodyBytes: Int
public init(maxResponseBytes: Int = 8 * 1024 * 1024, maxStreamedBytes: Int = 16 * 1024 * 1024, maxSSELineBytes: Int = 1 * 1024 * 1024, maxEmittedTextBytes: Int = 4 * 1024 * 1024, maxToolCallArgumentBytes: Int = 1 * 1024 * 1024, maxErrorBodyBytes: Int = 64 * 1024)
public static let `default`: RemoteResponseLimits
public static func == (a: RemoteResponseLimits, b: RemoteResponseLimits) -> Bool
public func hash(into hasher: inout Hasher)
public var hashValue: Int
public func turnArtifacts(in transcript: Transcript) -> TurnArtifacts
```

## LocalLMLabSDKComponents

> Ships as SOURCE (no xcframework / .swiftinterface) — this is a grep of the public
> declarations in `Components/Sources/`, not a compiler-derived interface.

```swift
public enum Kind: Sendable, Equatable { case added, removed, modified }
public enum ModelOnboardingStepState: Sendable, Equatable
public enum ModelUpdateOwnership: Sendable, Equatable
public enum RemoteProviderKind: String, Sendable, Hashable, CaseIterable
public enum State: Equatable
public extension RemoteProviderDraft
public extension View
public final class MCPElicitationPresenter: ObservableObject, MCPElicitationHandler
public final class MCPServerManagerObservable: ObservableObject
public final class ModelOnboardingModel
public final class ModelUpdateModel
public final class ModelVersionsModel
public final class ToolConfirmationPresenter: ObservableObject, ToolConfirmationChannel
public func cancel()
public func checkForUpdate() async
public func handleElicitation(_ request: MCPElicitationRequest) async -> MCPElicitationResponse
public func refresh() async
public func remove(_ row: ModelVersionRow) async
public func reset()
public func resolve(_ id: MCPElicitationPrompt.ID, _ response: MCPElicitationResponse)
public func resolve(_ id: ToolConfirmationRequest.ID, allow: Bool)
public func revertToShippedVersion() async
public func rollBack() async
public func start()
public func update() async
public init(
public init(apiKey: Binding<String>, onCommit: @escaping () -> Void = {})
public init(core: MCPServerManager)
public init(current: String, available: String, changes: [ModelFileChange] = [])
public init(fallbackTimeout: Duration = .seconds(120))
public init(manager: MCPServerManagerObservable)
public init(manager: MCPServerManagerObservable, onAttach: @escaping (MCPResourceDescriptor, MCPResourceContent) -> Void)
public init(manager: MCPServerManagerObservable, onUse: @escaping (MCPPromptDescriptor, [MCPPromptMessage]) -> Void)
public init(model: ModelUpdateModel) { self.model = model }
public init(model: ModelVersionsModel) { self.model = model }
public init(modelId: String, ok: Bool, detail: String)
public init(path: String, kind: Kind, oldSize: Int64? = nil, newSize: Int64? = nil)
public init(provider: any DownloadableModelProvider)
public init(registry: ModelRegistry)
public init(registry: ModelRegistry, selection: Binding<ModelID?>, show27OnlyModels: Bool = true)
public init(requests: [ModelOnboardingRequest], source: ModelOnboardingSource)
public init(results: [ModelResult], message: String? = nil)
public init(revision: String, isCurrent: Bool, isComplete: Bool = true, freesBytes: Int64, sharedBytes: Int64 = 0)
public init(role: String = "Model", repoID: String, expectedRevision: String? = nil, validates: Bool = true)
public init(serverName: String, onCancel: @escaping () -> Void)
public let call: PendingToolCall
public let core: MCPServerManager
public let id: UUID
public let request: MCPElicitationRequest
public nonisolated func requestDecision(for call: PendingToolCall) async -> Bool
public private(set) var completed: [InstalledModel] = []
public private(set) var currentRevision: String?
public private(set) var isLoading = false
public private(set) var isRunning = false
public private(set) var items: [ModelOnboardingItem]
public private(set) var message: String?
public private(set) var rollbackRevision: String?
public private(set) var state: State = .idle
public private(set) var versions: [ModelVersionRow] = []
public static func unableToRun(_ message: String) -> ProviderTestOutcome
public struct AIModelsSettingsView: View
public struct ClaudeAuthField: View
public struct MCPElicitationPrompt: Identifiable, Sendable
public struct MCPOAuthWaitingView: View
public struct MCPPromptsView: View
public struct MCPResourcesView: View
public struct MCPServerPickerView: View
public struct ModelFileChange: Sendable, Equatable, Identifiable
public struct ModelOnboardingItem: Sendable, Equatable, Identifiable
public struct ModelOnboardingRequest: Sendable, Equatable, Identifiable
public struct ModelOnboardingSource: Sendable
public struct ModelOnboardingView: View
public struct ModelPickerView: View
public struct ModelResult: Sendable, Equatable, Identifiable
public struct ModelUpdateActions: Sendable
public struct ModelUpdateOffer: Sendable, Equatable
public struct ModelUpdateView: View
public struct ModelVersionRow: Sendable, Equatable, Identifiable
public struct ModelVersionsView: View
public struct ProviderSettingsSection: View
public struct ProviderTestOutcome: Sendable, Equatable
public struct RemoteProviderDraft: Identifiable, Hashable, Sendable
public struct ToolConfirmationRequest: Identifiable, Sendable
public var addMenuLabel: String
public var apiKey: String
public var apply: @Sendable (
public var available: String
public var baseURL: String
public var body: some View
public var canUpdate: Bool
public var cancel: @Sendable (String) -> Void
public var changes: [ModelFileChange]
public var check: @Sendable () async throws -> ModelUpdateOffer
public var configured: Bool
public var current: String
public var detail: String
public var displayName: String
public var download: @Sendable (String, @escaping @Sendable (DownloadProgress) -> Void) async throws -> InstalledModel
public var download: ModelOnboardingStepState = .pending
public var downloadFraction: Double?
public var downloadedBytes: Int64 = 0
public var errorDescription: String?
public var expectedRevision: String?
public var freesBytes: Int64
public var hasFailed: Bool { [validate, download, pin].contains { if case .failed = $0 { true } else { false } } }
public var hasFailed: Bool { items.contains { $0.hasFailed } }
public var hasStarted: Bool { items.contains { $0.validate != .pending } }
public var id: String { modelId }
public var id: String { path }
public var id: String { repoID }
public var id: String { request.repoID }
public var id: String { revision }
public var id: String { scheme }
public var isBusy: Bool
public var isComplete: Bool
public var isComplete: Bool { if case .done = pin { true } else { false } }
public var isCurrent: Bool
public var isFinished: Bool { !isRunning && !items.isEmpty && items.allSatisfy(\.isComplete) }
public var isSwitching: Bool { state == .switching }
public var isUpToDate: Bool { current == available }
public var kind: Kind
public var kind: RemoteProviderKind
public var maxSearches: Int
public var message: String?
public var modelId: String
public var models: [String]
public var newSize: Int64?
public var ok: Bool
public var oldSize: Int64?
public var ownership: ModelUpdateOwnership
public var path: String
public var pauseInference: (@Sendable () async throws -> Void)?
public var pin: ModelOnboardingStepState = .pending
public var repoID: String
public var request: ModelOnboardingRequest
public var results: [ModelResult]
public var revision: String
public var role: String
public var scheme: String
public var sharedBytes: Int64
public var shippedRevision: String?
public var sortedServers: [MCPServerState]
public var statusText: String?
public var summary: String
public var totalBytes: Int64 = 0
public var validate: @Sendable (String) async throws -> PreflightResult?
public var validate: ModelOnboardingStepState = .pending
public var validates: Bool
public var webSearchEnabled: Bool
public var webSearchSupported: Bool
```

## LocalLMLabSDKMCPAppsHost

> Ships as SOURCE, like Components — a grep of the public declarations in
> `MCPAppsHost/Sources/`, not a compiler-derived interface.

```swift
public enum Direction: String, Sendable { case fromView, toView }
public enum Kind: Sendable, Equatable
public enum ListElement: Sendable, Equatable { case string, integer, number }
public enum LoadState: Equatable
public enum MCPAppRecreation
public enum MCPAppRecreationDecision: Sendable, Equatable
public enum MCPAppResourceError: Error, Equatable, CustomStringConvertible
public enum MCPAppsDecision: Sendable, Equatable
public enum MCPAppsSandbox
public enum MCPToolInputError: Error, Equatable, CustomStringConvertible
public enum Outcome: String, Sendable { case ok, denied, error, dropped }
public enum State: Sendable, Equatable
public final class MCPAppViewController: NSObject, ObservableObject
public final class MCPAppViewPool: ObservableObject
public final class MCPAppWidgetCache
public final class MCPAppsBridge
public func advertisingMCPApps() -> MCPClientHandlers
public func arguments(from values: [String: String]) -> Result<[String: MCPValue], MCPToolInputError>
public func authorizeMessage(text: String) async -> MCPAppsDecision { .deny("Message sending denied by policy") }
public func authorizeModelContextUpdate() async -> MCPAppsDecision { .deny("Context update denied by policy") }
public func authorizeOpenLink(_ url: URL) async -> MCPAppsDecision { .deny("Link opening denied by policy") }
public func authorizeResourceRead(uri: String) async -> MCPAppsDecision
public func authorizeToolCall(name: String, arguments: [String: MCPValue]) async -> MCPAppsDecision
public func authorizeToolCall(name: String, arguments: [String: MCPValue]) async -> MCPAppsDecision { .allow }
public func bind(recordID: String, sha256: String)
public func callTool(name: String, arguments: [String: MCPValue]) async -> Result<MCPToolResult, MCPServerError>
public func close() async
public func controller(for key: String, make: () throws -> MCPAppViewController) rethrows -> MCPAppViewController
public func currentDescriptor(tool: String) -> MCPToolDescriptor?
public func currentResource(uri: String) async -> Result<MCPResourceContent, MCPServerError>
public func deliverHostContextChange(_ partial: [String: MCPValue])
public func deliverToolCancelled(reason: String? = nil)
public func deliverToolInput(arguments: [String: MCPValue])
public func deliverToolResult(_ result: MCPToolResult)
public func discardSnapshot(for key: String) { snapshots.removeValue(forKey: key) }
public func evaluateInWidget(_ script: String) async throws -> Any?
public func exitFullscreen()
public func fetch(resourceURI: String, server: MCPServerID, manager: MCPServerManager,
public func isLive(_ key: String) -> Bool { controllers[key] != nil }
public func load() async
public func makeNSView(context: Context) -> WKWebView { controller.webView }
public func readResource(uri: String) async -> Result<MCPResourceContent, MCPServerError>
public func receive(_ data: Data) async
public func release(_ key: String) async
public func releaseAll() async
public func resource(sha256: String) -> MCPAppResource?
public func setDisplayMode(_ mode: String)
public func sha256(forRecord recordID: String) -> String? { index.recordVersion[recordID] }
public func snapshot(for key: String) -> NSImage? { snapshots[key] }
public func store(_ content: MCPResourceContent, requestedURI: String) throws -> MCPAppResource
public func teardown(reason: String = "host closing") async
public func touch(_ key: String)
public func updateNSView(_ nsView: WKWebView, context: Context) {}
public func webView(_ webView: WKWebView, createWebViewWith configuration: WKWebViewConfiguration, for navigationAction: WKNavigationAction, windowFeatures: WKWindowFeatures) -> WKWebView?
public func webView(_ webView: WKWebView, decidePolicyFor navigationAction: WKNavigationAction) async -> WKNavigationActionPolicy
public func webView(_ webView: WKWebView, didFail navigation: WKNavigation!, withError error: any Error)
public func webView(_ webView: WKWebView, didFailProvisionalNavigation navigation: WKNavigation!, withError error: any Error)
public func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!)
public func webView(_ webView: WKWebView, requestMediaCapturePermissionFor origin: WKSecurityOrigin, initiatedByFrame frame: WKFrameInfo, type: WKMediaCaptureType, decisionHandler: @escaping @MainActor @Sendable (WKPermissionDecision) -> Void)
public func webView(_ webView: WKWebView, runJavaScriptAlertPanelWithMessage message: String, initiatedByFrame frame: WKFrameInfo, completionHandler: @escaping @MainActor @Sendable () -> Void)
public func webView(_ webView: WKWebView, runJavaScriptConfirmPanelWithMessage message: String, initiatedByFrame frame: WKFrameInfo, completionHandler: @escaping @MainActor @Sendable (Bool) -> Void)
public func webView(_ webView: WKWebView, runJavaScriptTextInputPanelWithPrompt prompt: String, defaultText: String?, initiatedByFrame frame: WKFrameInfo, completionHandler: @escaping @MainActor @Sendable (String?) -> Void)
public func webView(_ webView: WKWebView, runOpenPanelWith parameters: WKOpenPanelParameters, initiatedByFrame frame: WKFrameInfo, completionHandler: @escaping @MainActor @Sendable ([URL]?) -> Void)
public init(
public init(allowedTools: Set<String>? = nil)
public init(camera: Bool = false, microphone: Bool = false, geolocation: Bool = false, clipboardWrite: Bool = false)
public init(connectDomains: [String] = [], resourceDomains: [String] = [], frameDomains: [String] = [], baseUriDomains: [String] = [])
public init(content: MCPResourceContent, requestedURI: String, listedMeta: MCPValue? = nil) throws
public init(controller: MCPAppViewController)
public init(csp: MCPAppCSP = MCPAppCSP(), permissions: MCPAppPermissions = MCPAppPermissions(), domain: String? = nil, prefersBorder: Bool? = nil)
public init(direction: Direction, method: String, outcome: Outcome, detail: String? = nil)
public init(directory: URL? = nil, maxBytes: Int = 64 * 1024 * 1024)
public init(limit: Int = 3)
public init(manager: MCPServerManager, server: MCPServerID)
public init(meta: MCPValue?)
public init(schema: Data)
public init(session: LocalLMLabSession, manager: MCPServerManager, server: MCPServerID, instance: String)
public let defaultText: String?
public let detail: String?
public let direction: Direction
public let directory: URL
public let effectiveCSP: MCPAppCSP
public let fields: [MCPToolInputField]
public let html: String
public let info: MCPAppResourceInfo
public let instance: String
public let isRequired: Bool
public let kind: Kind
public let manager: MCPServerManager
public let method: String
public let name: String
public let outcome: Outcome
public let resource: MCPAppResource
public let server: MCPServerID
public let session: LocalLMLabSession
public let sha256: String
public let summary: String
public let supportedDisplayModes: [String]
public let uri: String
public let webView: WKWebView
public private(set) var bridge: MCPAppsBridge!
public private(set) var displayMode: String
public private(set) var state: State = .awaitingInitialize
public protocol MCPAppWidgetSource
public protocol MCPAppsBackend
public protocol MCPAppsBridgePolicy
public static func cachedResource(recordID: String, cache: MCPAppWidgetCache) -> MCPAppResource?
public static func contentRuleListJSON(for csp: MCPAppCSP) -> String
public static func decide(cachedSHA256: String?, currentSHA256: String?, outputSchemaUnchanged: Bool,
public static func deliver(_ record: ToolCallRecord, to controller: MCPAppViewController) -> Bool
public static func deliver(arguments: GeneratedContent?, result: MCPToolResult, to controller: MCPAppViewController)
public static func effectiveCSP(declared: MCPAppCSP, policy: MCPAppsSandboxPolicy) -> MCPAppCSP
public static func headerValue(for csp: MCPAppCSP) -> String
public static func isSafeOrigin(_ origin: String) -> Bool
public static func revalidate(_ record: ToolCallRecord, source: any MCPAppWidgetSource, cache: MCPAppWidgetCache,
public static func revalidate(recordID: String, resourceURI: String, callDescriptor: MCPToolDescriptor?,
public static func session(
public static func toolInput(from arguments: GeneratedContent?) -> [String: MCPValue]
public static let closed = MCPAppsSandboxPolicy()
public static let mcpAppsExtensionKey = "io.modelcontextprotocol/ui"
public static let mimeType = "text/html;profile=mcp-app"
public static let protocolVersion = "2026-01-26"
public struct MCPAppCSP: Sendable, Equatable
public struct MCPAppPermissions: Sendable, Equatable
public struct MCPAppResource: Sendable, Equatable
public struct MCPAppResourceInfo: Sendable, Equatable
public struct MCPAppView: NSViewRepresentable
public struct MCPAppsAuditEvent: Sendable, Equatable
public struct MCPAppsBridgeConfiguration: Sendable
public struct MCPAppsDefaultPolicy: MCPAppsBridgePolicy
public struct MCPAppsHostActions
public struct MCPAppsSandboxPolicy: Sendable, Equatable
public struct MCPAppsSessionBackend: MCPAppsBackend
public struct MCPServerManagerBackend: MCPAppsBackend
public struct MCPServerManagerWidgetSource: MCPAppWidgetSource
public struct MCPToolInputField: Identifiable, Sendable, Equatable
public struct MCPToolInputForm: Sendable, Equatable
public struct Revalidation: Sendable
public var allowedConnectOrigins: [String]
public var allowedFrameOrigins: [String]
public var allowedResourceOrigins: [String]
public var allowedTools: Set<String>?
public var allowsSameOrigin: Bool
public var availableDisplayModes: [String]
public var baseUriDomains: [String] = []
public var camera = false
public var clipboardWrite = false
public var connectDomains: [String] = []
public var csp: MCPAppCSP
public var decision: MCPAppRecreationDecision
public var description: String
public var domain: String?
public var effectiveCSP: MCPAppCSP
public var effectivePermissions: MCPAppPermissions
public var frameDomains: [String] = []
public var geolocation = false
public var hasRequiredFields: Bool { fields.contains { $0.isRequired } }
public var hostContext: [String: MCPValue]
public var hostName: String
public var hostVersion: String
public var id: String { name }
public var isEmpty: Bool
public var isEmpty: Bool { !(camera || microphone || geolocation || clipboardWrite) }
public var isEmpty: Bool { fields.isEmpty }
public var isInspectable: Bool
public var limit: Int
public var maxBytes: Int
public var maxMessageBytes: Int
public var microphone = false
public var openLink: @MainActor (URL) -> Void
public var permissions: MCPAppPermissions
public var prefersBorder: Bool?
public var requestDisplayMode: @MainActor (_ mode: String) -> Bool
public var resource: MCPAppResource?
public var resourceDomains: [String] = []
public var sendMessage: @MainActor (String) -> Void
public var storedBytes: Int { index.size.values.reduce(0, +) }
public var storedVersions: Set<String> { Set(index.size.keys) }
public var teardownTimeout: Duration
public var updateModelContext: @MainActor (_ content: [MCPValue], _ structuredContent: MCPValue?) -> Void
public var widgetChanged: Bool
```