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.

OnDeviceExtension

@PublicPreviewAPI
class OnDeviceExtension

Extension class for performing on-device operations.

Summary

Public functions
`suspend OnDeviceModelStatus`	`checkStatus()` Checks the current status / availability of the on-device AI model.
`Flow<DownloadStatus>`	`download()` Initiates the download of the on-device AI model.
`suspend Unit`	`warmUp()` Warms up the model to reduce latency for the first request.

Public functions

checkStatus

suspend fun checkStatus(): OnDeviceModelStatus

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

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

download

fun download(): Flow<DownloadStatus>

Initiates the download of the on-device AI model.

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

warmUp

suspend fun warmUp(): Unit

Warms up the model to reduce latency for the first request.

Throws
`com.google.firebase.ai.type.FirebaseAIException: com.google.firebase.ai.type.FirebaseAIException`	if the warmup failed.