Model class

Firebase ML is deprecated and will be shut down on June 15, 2027. To host custom models, you must migrate to another solution. You can use Cloud Storage for Firebase as an alternative for hosting custom models. For more info, see https://firebase.google.com/docs/ml/migrate-to-cloud-storage

A Firebase ML Model output object.

Signature:

export declare class Model 

Properties

Methods

Model.createTime

The timestamp of the model's creation.

Signature:

get createTime(): string;

Model.displayName

The model's name. This is the name you use from your app to load the model.

Signature:

get displayName(): string;

Model.etag

The ETag identifier of the current version of the model. This value changes whenever you update any of the model's properties.

Signature:

get etag(): string;

Model.locked

True if the model is locked by a server-side operation. You can't make changes to a locked model. See Model.waitForUnlocked().

Signature:

get locked(): boolean;

Model.modelHash

The hash of the model's tflite file. This value changes only when you upload a new TensorFlow Lite model.

Signature:

get modelHash(): string | undefined;

Model.modelId

The ID of the model.

Signature:

get modelId(): string;

Model.published

True if the model is published.

Signature:

get published(): boolean;

Model.tags

The model's tags, which can be used to group or filter models in list operations.

Signature:

get tags(): string[];

Model.tfliteModel

Metadata about the model's TensorFlow Lite model file.

Signature:

get tfliteModel(): TFLiteModel | undefined;

Model.updateTime

The timestamp of the model's most recent update.

Signature:

get updateTime(): string;

Model.validationError

Error message when model validation fails.

Signature:

get validationError(): string | undefined;

Model.toJSON()

Return the model as a JSON object.

Signature:

toJSON(): {
        [key: string]: any;
    };

Returns:

{ [key: string]: any; }

Model.waitForUnlocked()

Firebase ML is deprecated and will be shut down on June 15, 2027. To host custom models, you must migrate to another solution. You can use Cloud Storage for Firebase as an alternative for hosting custom models. For more info, see https://firebase.google.com/docs/ml/migrate-to-cloud-storage

Wait for the model to be unlocked.

Signature:

waitForUnlocked(maxTimeMillis?: number): Promise<void>;

Parameters

Returns:

Promise<void>

A promise that resolves when the model is unlocked or the maximum wait time has passed.