firebase-admin/lib/machine-learning/index.d.ts

Firebase admin SDK for Node.js

/*! firebase-admin v14.4.0 */
/*!
 * Copyright 2020 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * Firebase Machine Learning.
 *
 * @packageDocumentation
 * @deprecated 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
 */
import { App } from '../app';
import { MachineLearning } from './machine-learning';
export { MachineLearning, ListModelsResult, Model, TFLiteModel, } from './machine-learning';
export { GcsTfliteModelOptions, ListModelsOptions, ModelOptions, ModelOptionsBase, } from './machine-learning-api-client';
/**
 * Gets the {@link MachineLearning} service for the default app or a given app.
 *
 * `getMachineLearning()` can be called with no arguments to access the
 * default app's `MachineLearning` service or as `getMachineLearning(app)` to access
 * the `MachineLearning` service associated with a specific app.
 *
 * @example
 * ```javascript
 * // Get the MachineLearning service for the default app
 * const defaultMachineLearning = getMachineLearning();
 * ```
 *
 * @example
 * ```javascript
 * // Get the MachineLearning service for a given app
 * const otherMachineLearning = getMachineLearning(otherApp);
 * ```
 *
 * @param app - Optional app whose `MachineLearning` service to
 *   return. If not provided, the default `MachineLearning` service
 *   will be returned.
 *
 * @returns The default `MachineLearning` service if no app is provided or the
 *   `MachineLearning` service associated with the provided app.
 *
 * @deprecated 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
 */
export declare function getMachineLearning(app?: App): MachineLearning;
export { FirebaseMachineLearningError, MachineLearningErrorCode } from './error';