Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Component: FoundationModels

Functions for Foundation Models from Apple to run a local AI LLM model.

Version macOS Windows Linux Server iOS SDK
15.5 ✅ Yes ❌ No ❌ No ❌ No ✅ Yes

Item Details
FoundationModels.Available   New in 15.5
Checks whether the model is available.
Mac/iOS
15.5
FoundationModels.AvailableStatus   New in 15.5
Queries the availability.
Mac/iOS
15.5
FoundationModels.BeginSession   New in 15.5
Start a new session in blank slate state with instructions.
Mac/iOS
15.5
FoundationModels.CloseSession   New in 15.5
Closes the current model session.
Mac/iOS
15.5
FoundationModels.GetMaximumResponseTokens   New in 15.5
Queries the maximum number of tokens the model is allowed to produce in its response.
Mac/iOS
15.5
FoundationModels.GetTemperature   New in 15.5
Queries the temperature.
Mac/iOS
15.5
FoundationModels.Initialize   New in 15.5
Initializes Foundation Models by loading a system model.
Mac/iOS
15.5
FoundationModels.List   New in 15.5
Returns the list of model identifiers.
Mac/iOS
15.5
FoundationModels.Prewarm   New in 15.5
Prewarm the model.
Mac/iOS
15.5
FoundationModels.Release   New in 15.5
Release memory for a loaded model.
Mac/iOS
15.5
FoundationModels.ReleaseAll   New in 15.5
Releases all models.
Mac/iOS
15.5
FoundationModels.Respond   New in 15.5
Produces a response to a prompt.
Mac/iOS
15.5
FoundationModels.SetMaximumResponseTokens   New in 15.5
Sets the maximum number of tokens the model is allowed to produce in its response.
Mac/iOS
15.5
FoundationModels.SetTemperature   New in 15.5
Sets the temperature.
Mac/iOS
15.5
FoundationModels.SupportedLanguages   New in 15.5
Queries the languages that the model supports.
Mac/iOS
15.5
FoundationModels.SupportsLocale   New in 15.5
Returns a Boolean indicating whether the given locale is supported by the model.
Mac/iOS
15.5
FoundationModels.Transcript   New in 15.5
A full history of interactions, including user inputs and model responses.
Mac/iOS
15.5

17 functions shown.

Release notes

Blog Entries

Example Databases