@@ -1224,14 +1224,20 @@ declare namespace admin.machineLearning {
1224
1224
1225
1225
/**
1226
1226
* A TensorFlow Lite Model output object
1227
+ *
1228
+ * One of either the `gcsTfliteUri` or `automlModel` properties will be
1229
+ * defined.
1227
1230
*/
1228
1231
interface TFLiteModel {
1229
1232
/** The size of the model. */
1230
1233
readonly sizeBytes : number ;
1231
1234
1232
1235
/** The URI from which the model was originally provided to Firebase. */
1233
1236
readonly gcsTfliteUri ?: string ;
1234
- /** The AutoML URI from which the model was originally provided to Firebase. */
1237
+ /**
1238
+ * The AutoML model reference from which the model was originally provided
1239
+ * to Firebase.
1240
+ */
1235
1241
readonly automlModel ?: string ;
1236
1242
}
1237
1243
@@ -1242,10 +1248,16 @@ declare namespace admin.machineLearning {
1242
1248
/** The ID of the model. */
1243
1249
readonly modelId : string ;
1244
1250
1245
- /** The model's name. This is the name you use from your app to load the model. */
1251
+ /**
1252
+ * The model's name. This is the name you use from your app to load the
1253
+ * model.
1254
+ */
1246
1255
readonly displayName : string ;
1247
1256
1248
- /** The model's tags. */
1257
+ /**
1258
+ * The model's tags, which can be used to group or filter models in list
1259
+ * operations.
1260
+ */
1249
1261
readonly tags ?: string [ ] ;
1250
1262
1251
1263
/** The timestamp of the model's creation. */
@@ -1314,7 +1326,7 @@ declare namespace admin.machineLearning {
1314
1326
* state.published = true
1315
1327
* ```
1316
1328
*
1317
- * See https://firebase.google.com/docs/ml-kit /manage-hosted-models#list_your_projects_models
1329
+ * See https://firebase.google.com/docs/ml/manage-hosted-models#list_your_projects_models
1318
1330
*/
1319
1331
filter ?: string ;
1320
1332
@@ -1352,7 +1364,7 @@ declare namespace admin.machineLearning {
1352
1364
app : admin . app . App ;
1353
1365
1354
1366
/**
1355
- * Creates a model in Firebase ML .
1367
+ * Creates a model in the current Firebase project .
1356
1368
*
1357
1369
* @param {ModelOptions } model The model to create.
1358
1370
*
@@ -1361,7 +1373,7 @@ declare namespace admin.machineLearning {
1361
1373
createModel ( model : ModelOptions ) : Promise < Model > ;
1362
1374
1363
1375
/**
1364
- * Updates a model in Firebase ML .
1376
+ * Updates a model's metadata or model file .
1365
1377
*
1366
1378
* @param {string } modelId The ID of the model to update.
1367
1379
* @param {ModelOptions } model The model fields to update.
@@ -1371,7 +1383,9 @@ declare namespace admin.machineLearning {
1371
1383
updateModel ( modelId : string , model : ModelOptions ) : Promise < Model > ;
1372
1384
1373
1385
/**
1374
- * Publishes a model in Firebase ML.
1386
+ * Publishes a Firebase ML model.
1387
+ *
1388
+ * A published model can be downloaded to client apps.
1375
1389
*
1376
1390
* @param {string } modelId The ID of the model to publish.
1377
1391
*
@@ -1380,7 +1394,7 @@ declare namespace admin.machineLearning {
1380
1394
publishModel ( modelId : string ) : Promise < Model > ;
1381
1395
1382
1396
/**
1383
- * Unpublishes a model in Firebase ML.
1397
+ * Unpublishes a Firebase ML model .
1384
1398
*
1385
1399
* @param {string } modelId The ID of the model to unpublish.
1386
1400
*
@@ -1389,7 +1403,7 @@ declare namespace admin.machineLearning {
1389
1403
unpublishModel ( modelId : string ) : Promise < Model > ;
1390
1404
1391
1405
/**
1392
- * Gets a model from Firebase ML .
1406
+ * Gets the model specified by the given ID .
1393
1407
*
1394
1408
* @param {string } modelId The ID of the model to get.
1395
1409
*
@@ -1398,7 +1412,7 @@ declare namespace admin.machineLearning {
1398
1412
getModel ( modelId : string ) : Promise < Model > ;
1399
1413
1400
1414
/**
1401
- * Lists models from Firebase ML .
1415
+ * Lists the current project's models .
1402
1416
*
1403
1417
* @param {ListModelsOptions } options The listing options.
1404
1418
*
@@ -1410,7 +1424,7 @@ declare namespace admin.machineLearning {
1410
1424
listModels ( options ?: ListModelsOptions ) : Promise < ListModelsResult > ;
1411
1425
1412
1426
/**
1413
- * Deletes a model from Firebase ML .
1427
+ * Deletes a model from the current project .
1414
1428
*
1415
1429
* @param {string } modelId The ID of the model to delete.
1416
1430
*/
0 commit comments