Utiliser Remote Config dans des environnements de serveur


Firebase Remote Config est compatible avec la configuration côté serveur à l'aide du SDK Admin Firebase Node.js v12.1.0 ou version ultérieure. Cette fonctionnalité vous permet de gérer de manière dynamique le comportement et la configuration des applications côté serveur à l'aide de Remote Config. Cela inclut les implémentations sans serveur telles que Cloud Functions.

Contrairement aux SDK client Firebase, qui récupèrent une configuration spécifique au client dérivée du modèle Remote Config, le SDK Remote Config côté serveur télécharge un modèle Remote Config complet depuis Firebase. Votre serveur peut ensuite évaluer le modèle avec chaque requête entrante et utiliser sa propre logique pour fournir une réponse personnalisée avec une latence très faible. Vous pouvez utiliser des conditions pour contrôler et personnaliser les réponses en fonction de pourcentages aléatoires et d'attributs client définis dans les signaux personnalisés.

Avec Remote Config côté serveur, vous pouvez :

  • Définissez des paramètres de configuration pour les applications exécutées sur votre serveur ou accessibles via celui-ci, ce qui permet des cas d'utilisation tels que la configuration à distance des paramètres et des invites de modèles d'IA, ainsi que d'autres intégrations, afin de garantir la sécurité de vos clés API.
  • Ajustez dynamiquement les paramètres en réponse aux changements dans votre environnement ou à d'autres modifications d'application, comme la mise à jour des paramètres LLM et des points de terminaison du modèle.
  • Contrôlez les coûts en mettant à jour à distance les API appelées par votre serveur.
  • Générez des configurations personnalisées à la volée pour les clients qui accèdent à votre serveur.
  • Enregistrez les clients qui ont reçu une valeur de paramètre et utilisez-la dans Cloud Functions dans le cadre d'un système de vérification des droits d'accès.

Vous pouvez déployer Remote Config côté serveur sur Cloud Run, Cloud Functions ou dans des environnements de serveur auto-hébergés.

Avant de commencer

Suivez les instructions de la section Ajouter le SDK Admin Firebase à votre serveur pour créer un projet Firebase, configurer un compte de service et ajouter le SDK Admin Firebase Node.js à votre serveur.

Étape 1 : Initialiser le SDK Firebase Admin Node.js et autoriser les requêtes API

Lorsque vous initialisez le SDK Admin sans aucun paramètre, il utilise les identifiants d'application par défaut Google et lit les options à partir de la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS. Pour initialiser le SDK et ajouter Remote Config :

import { initializeApp } from "firebase-admin/app";
import { getRemoteConfig } from "firebase-admin/remote-config";

// Initialize Firebase
const firebaseApp = initializeApp();

Étape 2 : Identifiez les valeurs de paramètre par défaut pour votre application serveur

Identifiez les variables de votre application que vous souhaitez mettre à jour de manière dynamique avec Remote Config. Ensuite, réfléchissez aux variables qui doivent être définies par défaut dans votre application et à leurs valeurs par défaut. Cela garantit que votre application s'exécute correctement même si sa connexion au serveur backend Remote Config est interrompue.

Par exemple, si vous écrivez une application serveur qui gère une fonction d'IA générative, vous pouvez définir un nom de modèle par défaut, un préambule d'invite et une configuration d'IA générative, comme suit :

Nom du paramètre Description Type Valeur par défaut
model_name Nom de l'API du modèle Chaîne gemini-2.0-flash
preamble_prompt Requête à ajouter au début de la requête de l'utilisateur Chaîne I'm a developer who wants to learn about Firebase and you are a helpful assistant who knows everything there is to know about Firebase!
generation_config Paramètres à envoyer au modèle JSON {"stopSequences": ["I hope this helps"], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}

Étape 3 : Configurez votre application serveur

Après avoir déterminé les paramètres que vous souhaitez utiliser avec Remote Config, configurez votre application pour définir des valeurs par défaut, extraire le modèle Remote Config spécifique au serveur et utiliser ses valeurs. Les étapes suivantes décrivent comment configurer votre application Node.js.

  1. Accédez au modèle et chargez-le.

    // Initialize server-side Remote Config
    const rc = getRemoteConfig(firebaseApp);
    const template = rc.initServerTemplate();
    
    // Load Remote Config
    await template.load();
    

    Si vous utilisez Node.js dans un Cloud Functions, vous pouvez utiliser getServerTemplate asynchrone pour initialiser et charger le modèle en une seule étape :

    // Initialize server-side Remote Config
    const rc = getRemoteConfig(firebaseApp);
    const template = await rc.getServerTemplate();
    
  2. Pour vous assurer que votre application s'exécute correctement même si sa connexion au serveur backend Remote Config est interrompue, ajoutez des valeurs par défaut pour chaque paramètre à votre application. Pour ce faire, ajoutez un defaultConfig dans votre fonction de modèle initServerTemplate ou getServerTemplate :

    const template = rc.initServerTemplate({
      defaultConfig: {
        model_name: "gemini-pro",
        generation_config: '{"stopSequences": [], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}',
        preamble_prompt: "I'm a developer who wants to learn about Firebase and you are a helpful assistant who knows everything there is to know about Firebase!"
      },
    });
    
    // Load Remote Config
    await template.load()
    
  3. Une fois le modèle chargé, utilisez template.evaluate() pour importer les paramètres et les valeurs du modèle :

    // Add template parameters to config
    const config = template.evaluate();
    
  4. Si vous définissez des conditions dans votre modèle Remote Config, définissez et fournissez les valeurs souhaitées :

    • Si vous utilisez des conditions de pourcentage, ajoutez le randomizationId que vous souhaitez utiliser pour évaluer vos conditions dans la fonction template.evaluate().
    • Si vous utilisez des signaux personnalisés, définissez les attributs et leurs valeurs. Les signaux personnalisés sont disponibles avec le SDK Admin Firebase Node.js 12.5.0 et versions ultérieures.

    Par exemple, vous pouvez définir un ID d'installation Firebase comme randomizationId ou un ID utilisateur pour vous assurer que chaque utilisateur qui contacte votre serveur est ajouté au bon groupe aléatoire, version comme signal personnalisé pour cibler des versions client spécifiques et platform comme signal personnalisé pour cibler la plate-forme client.

    Pour en savoir plus sur les conditions, consultez Types de règles de condition.

    // Add template parameters to `config`. Evaluates the
    // template and returns the parameter value assigned to
    // the group assigned to the {randomizationId} and version.
    const config = template.evaluate({
      randomizationId: "2ac93c28-c459-4760-963d-a3974ec26c04",
      version: "1.0",
      platform: "Android"
    });
    
    
  5. Ensuite, extrayez les valeurs de paramètre dont vous avez besoin à partir de la constante de configuration. Utilisez getters pour caster les valeurs de Remote Config dans le format attendu. Les types suivants sont acceptés :

    • Booléen : getBoolean
    • Objet : getValue
    • Numéro : getNumber
    • Chaîne : getString

    Par exemple, si vous implémentez Vertex AI sur votre serveur et que vous souhaitez modifier le modèle et les paramètres du modèle, vous pouvez configurer les paramètres pour model_name et generation_config. Voici un exemple d'accès aux valeurs de Remote Config :

    // Replace defaults with values from Remote Config.
    const generationConfig =
      JSON.parse(
        config.getString('generation_config'));
    
    const is_ai_enabled = config.getBool('is_ai_enabled');
    
    const model = config.getString('model_name');
    
    // Generates a prompt comprised of the Remote Config
    // parameter and prepends it to the user prompt
    const prompt = `${config.getString('preamble_prompt')} ${req.query.prompt}`;
    
  6. Si votre serveur est de longue durée, contrairement à un environnement sans serveur, utilisez setInterval pour recharger régulièrement le modèle et vérifier que vous récupérez le modèle le plus récent à partir du serveur Remote Config.

Étape 4 : Définissez les valeurs des paramètres spécifiques au serveur dans Remote Config

Ensuite, créez un modèle Remote Config de serveur et configurez les paramètres et les valeurs à utiliser dans votre application.

Pour créer un modèle Remote Config spécifique à un serveur :

  1. Ouvrez la page Paramètres de la console Firebase Remote Config, puis sélectionnez Serveur dans le sélecteur Client/Serveur.
  2. Définissez des paramètres Remote Config avec les mêmes noms et types de données que ceux que vous avez définis dans votre application, puis fournissez des valeurs. Ces valeurs remplaceront le defaultConfig que vous avez défini dans Configurer votre application serveur lorsque vous récupérerez et évaluerez le modèle, et que vous attribuerez ces valeurs à vos variables.
  3. Vous pouvez également définir des conditions pour appliquer des valeurs de manière persistante à un échantillon aléatoire d'instances ou à des signaux personnalisés que vous définissez. Pour en savoir plus sur les conditions, consultez Types de règles de condition.
  4. Lorsque vous avez terminé d'ajouter des paramètres, cliquez sur Publier les modifications.
  5. Vérifiez les modifications, puis cliquez à nouveau sur Publier les modifications.

Étape 5 : Déployer avec Cloud Functions ou Cloud Run

Si votre application serveur est légère et basée sur des événements, vous devriez envisager de déployer votre code à l'aide de Cloud Functions. Par exemple, supposons que vous ayez une application qui inclut des dialogues de personnages alimentés par une API d'IA générative (par exemple, Google AI ou Vertex AI). Dans ce cas, vous pouvez héberger votre logique de diffusion de LLM dans une fonction que votre application appelle à la demande.

Si vous créez une application Web avec rendu côté serveur, App Hosting est compatible avec les frameworks Web populaires.

Sinon, vous pouvez envisager d'utiliser Cloud Run. Pour déployer votre application serveur avec Cloud Run, suivez le guide Guide de démarrage rapide : déployer un service Node.js sur Cloud Run.

Pour en savoir plus sur les cas d'utilisation les plus adaptés à Cloud Functions et à Cloud Run, consultez Cloud Functions vs Cloud Run : quand utiliser l'un plutôt que l'autre.