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
public final class OnDeviceExtension

Extension class for performing on-device operations.

Summary

Public methods
`final @NonNull OnDeviceModelStatus`	`checkStatus()` Checks the current status / availability of the on-device AI model.
`final @NonNull Flow<@NonNull DownloadStatus>`	`download()` Initiates the download of the on-device AI model.
`final @NonNull String`	`getModelName()` Returns the name of the on-device model.
`final void`	`warmUp()` Warms up the model to reduce latency for the first request.

Public methods

checkStatus

public 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 final @NonNull Flow<@NonNull DownloadStatus> download()

Initiates the download of the on-device AI model.

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

getModelName

public final @NonNull String getModelName()

Returns the name of the on-device model.

warmUp

public final void warmUp()

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.