MachineLearning class

Stay organized with collections Save and categorize content based on your preferences.

The Firebase MachineLearning service interface.

Signature:

exportdeclareclassMachineLearning

Properties

Methods

MachineLearning.app

The App associated with the current MachineLearning service instance.

Signature:

getapp():App;

MachineLearning.createModel()

Creates a model in the current Firebase project.

Signature:

createModel(model:ModelOptions):Promise<Model>;

Parameters

Returns:

Promise<Model>

A Promise fulfilled with the created model.

MachineLearning.deleteModel()

Deletes a model from the current project.

Signature:

deleteModel(modelId:string):Promise<void>;

Parameters

Returns:

Promise<void>

MachineLearning.getModel()

Gets the model specified by the given ID.

Signature:

getModel(modelId:string):Promise<Model>;

Parameters

Returns:

Promise<Model>

A Promise fulfilled with the model object.

MachineLearning.listModels()

Lists the current project's models.

Signature:

listModels(options?:ListModelsOptions):Promise<ListModelsResult>;

Parameters

Returns:

Promise<ListModelsResult>

A promise that resolves with the current (filtered) list of models and the next page token. For the last page, an empty list of models and no page token are returned.

MachineLearning.publishModel()

Publishes a Firebase ML model.

A published model can be downloaded to client apps.

Signature:

publishModel(modelId:string):Promise<Model>;

Parameters

Returns:

Promise<Model>

A Promise fulfilled with the published model.

MachineLearning.unpublishModel()

Unpublishes a Firebase ML model.

Signature:

unpublishModel(modelId:string):Promise<Model>;

Parameters

Returns:

Promise<Model>

A Promise fulfilled with the unpublished model.

MachineLearning.updateModel()

Updates a model's metadata or model file.

Signature:

updateModel(modelId:string,model:ModelOptions):Promise<Model>;

Parameters

Returns:

Promise<Model>

A Promise fulfilled with the updated model.