IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

FirebaseAIOnDevice

public static class FirebaseAIOnDevice

Entry point for Firebase AI On-Device functionality.

Note: This class does not provides any inference-related functionality for the on-device AI model.

Summary

Public fields
`static @NonNull FirebaseAIOnDevice`	`INSTANCE`

Public methods
`static final @NonNull OnDeviceModelStatus`	`checkStatus()` Checks the current status / availability of the on-device AI model.
`static final @NonNull Flow<@NonNull DownloadStatus>`	`download()` Initiates the download of the on-device AI model.

Public fields

INSTANCE

public static @NonNull FirebaseAIOnDevice INSTANCE

Public methods

checkStatus

public static final @NonNull OnDeviceModelStatus checkStatus()

Checks the current status / availability of the on-device AI model.

Returns
`@NonNull OnDeviceModelStatus`	An `OnDeviceModelStatus` object indicating the current state of the model.

download

public static final @NonNull Flow<@NonNull DownloadStatus> download()

Initiates the download of the on-device AI model.

This method returns a Flow that emits DownloadStatus updates as the download progresses. Consumers should collect the flow to start the download process, and optionally process any updates on the download state, progress, and completion or failure.

Returns
`@NonNull Flow<@NonNull DownloadStatus>`	A `Flow` of `DownloadStatus` objects representing the download lifecycle.