שימוש ב'הגדרת תצורה מרחוק' בסביבות שרת


‫Firebase Remote Config תומך בהגדרת תצורה בצד השרת באמצעות Firebase Admin Node.js SDK v12.1.0 ומעלה. היכולת הזו מאפשרת לכם לנהל באופן דינמי את ההתנהגות וההגדרה של אפליקציות בצד השרת באמצעות Remote Config. זה כולל הטמעות ללא שרתים כמו Cloud Functions.

בניגוד לערכות SDK של לקוח ב-Firebase, שמאחזרות תצורה ספציפית ללקוח שנגזרת מתבנית Remote Config, ערכת Remote Config SDK בצד השרת מורידה תבנית Remote Config מלאה מ-Firebase. לאחר מכן, השרת יכול להעריך את התבנית בכל בקשה נכנסת ולהשתמש בלוגיקה שלו כדי להציג תגובה מותאמת אישית עם זמן אחזור נמוך מאוד. אתם יכולים להשתמש בתנאים כדי לשלוט בתשובות ולהתאים אותן אישית על סמך אחוזים אקראיים ומאפייני לקוח שמוגדרים באותות מותאמים אישית.

בעזרת Remote Config בצד השרת, אפשר:

  • הגדרת פרמטרים של אפליקציות שפועלות בשרת או שיש להן גישה לשרת, כדי לאפשר תרחישי שימוש כמו הגדרה מרחוק של פרמטרים והנחיות של מודלים של AI ושילובים אחרים, כדי להבטיח שמפתחות ה-API יישארו מאובטחים.
  • התאמה דינמית של פרמטרים בתגובה לשינויים בסביבה או לשינויים אחרים באפליקציה, כמו עדכון של פרמטרים של LLM ונקודות קצה של מודלים.
  • אפשר לשלוט בעלויות על ידי עדכון מרחוק של ממשקי ה-API שהשרת קורא להם.
  • יצירת הגדרות בהתאמה אישית בזמן אמת ללקוחות שניגשים לשרת שלכם.
  • לרשום אילו לקוחות קיבלו ערך פרמטר ולהשתמש בערך הזה ב-Cloud Functions כחלק ממערכת לאימות הרשאות.

אפשר לפרוס תיוג בצד השרת Remote Config ב-Cloud Run, Cloud Functions או בסביבות שרת באירוח עצמי.

לפני שמתחילים

פועלים לפי ההוראות במאמר הוספת Firebase Admin SDK לשרת כדי ליצור פרויקט Firebase, להגדיר חשבון שירות ולהוסיף את Firebase Admin Node.js SDK לשרת.

שלב 1: מאתחלים את Firebase Admin Node.js SDK ומאשרים בקשות API

כשמפעילים את Admin SDK ללא פרמטרים, ה-SDK משתמש באישורי ברירת מחדל של אפליקציית Google וקורא אפשרויות ממשתנה הסביבה GOOGLE_APPLICATION_CREDENTIALS. כדי לאתחל את ה-SDK ולהוסיף את Remote Config:

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

// Initialize Firebase
const firebaseApp = initializeApp();

שלב 2: זיהוי ערכי ברירת מחדל של פרמטרים באפליקציית השרת

מזהים את המשתנים באפליקציה שרוצים לעדכן באופן דינמי באמצעות Remote Config. לאחר מכן, צריך לחשוב אילו משתנים צריך להגדיר כברירת מחדל באפליקציה ומה צריכים להיות ערכי ברירת המחדל שלהם. כך אפשר לוודא שהאפליקציה תפעל בהצלחה גם אם החיבור שלה לשרת הקצה העורפי Remote Config ייקטע.

לדוגמה, אם אתם כותבים אפליקציית שרת שמנהלת פונקציית AI גנרטיבי, אתם יכולים להגדיר שם מודל שמוגדר כברירת מחדל, פתיח להנחיה והגדרת AI גנרטיבי, כמו בדוגמה הבאה:

שם הפרמטר תיאור סוג ערך ברירת המחדל
model_name שם ה-API של המודל מחרוזת gemini-2.0-flash
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!
generation_config פרמטרים לשליחה למודל JSON {"stopSequences": ["I hope this helps"], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}

שלב 3: הגדרת אפליקציית השרת

אחרי שמחליטים אילו פרמטרים רוצים להשתמש עם Remote Config, מגדירים את האפליקציה כך שתגדיר ערכי ברירת מחדל, תאחזר את תבנית Remote Config הספציפית לשרת ותשתמש בערכים שלה. בשלבים הבאים מוסבר איך להגדיר את אפליקציית Node.js.

  1. ניגשים לתבנית וטוענים אותה.

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

// Load Remote Config
await template.load();

    אם אתם משתמשים ב-Node.js בתוך Cloud Functions, אתם יכולים להשתמש ב-getServerTemplate האסינכרוני כדי לאתחל ולטעון את התבנית בשלב אחד:

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

  2. כדי לוודא שהאפליקציה פועלת בצורה תקינה גם אם החיבור שלה לשרת העורפי Remote Config מופרע, מוסיפים ערכי ברירת מחדל לכל פרמטר באפליקציה. כדי לעשות זאת, מוסיפים defaultConfig בתוך פונקציית התבנית initServerTemplate או 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. אחרי שהתבנית נטענת, משתמשים ב-template.evaluate() כדי לייבא פרמטרים וערכים מהתבנית:

    // Add template parameters to config
const config = template.evaluate();

  4. אם הגדרתם תנאים בתבנית Remote Config, אתם יכולים להגדיר ולספק את הערכים הרצויים:

    • אם משתמשים בתנאי אחוזים, צריך להוסיף את randomizationId שרוצים להשתמש בו כדי להעריך את התנאים בפונקציה template.evaluate().
    • אם משתמשים באותות מותאמים אישית, צריך להגדיר את המאפיינים ואת הערכים שלהם. האותות המותאמים אישית זמינים ב-Firebase Admin Node.js SDK מגרסה 12.5.0 ואילך.

    לדוגמה, אפשר להגדיר מזהה התקנה של Firebase כ-randomizationId, או מזהה משתמש, כדי לוודא שכל משתמש שיוצר קשר עם השרת שלכם יתווסף לקבוצה האקראית המתאימה, version כאות מותאם אישית לטירגוט גרסאות ספציפיות של לקוחות, ו-platform כאות מותאם אישית לטירגוט פלטפורמת לקוח.

    מידע נוסף על תנאים זמין במאמר סוגי כללי תנאים.

    // 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. לאחר מכן, מחלצים את ערכי הפרמטרים שצריך מהקבוע של ההגדרה. משתמשים ב-getters כדי להמיר את הערכים מ-Remote Config לפורמט הצפוי. יש תמיכה בסוגים הבאים:

    • בוליאני: getBoolean
    • אובייקט: getValue
    • מספר: getNumber
    • מחרוזת: getString

    לדוגמה, אם מטמיעים את Vertex AI בשרת ורוצים לשנות את המודל ואת הפרמטרים שלו, כדאי להגדיר פרמטרים ל-model_name ול-generation_config. לדוגמה, כך אפשר לגשת לערכים של 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. אם השרת שלכם פועל לאורך זמן, בניגוד לסביבה ללא שרת, צריך להשתמש ב-setInterval כדי לטעון מחדש את התבנית באופן תקופתי ולוודא שאתם מאחזרים את התבנית העדכנית ביותר מהשרת Remote Config.

שלב 4: הגדרת ערכי פרמטרים ספציפיים לשרת ב-Remote Config

לאחר מכן, יוצרים תבנית של שרת Remote Config ומגדירים פרמטרים וערכים לשימוש באפליקציה.

כדי ליצור תבנית Remote Config ספציפית לשרת:

  1. פותחים את הדף 'פרמטרים' במסוף Firebase Remote Config ובתפריט Client/Server בוחרים באפשרות Server.
  2. מגדירים Remote Config פרמטרים עם אותם שמות וסוגי נתונים כמו הפרמטרים שהגדרתם באפליקציה, ומספקים ערכים. הערכים האלה יבטלו את הערכים של defaultConfig שהגדרתם בהגדרת אפליקציית השרת כשמאחזרים ומעריכים את התבנית ומקצים את הערכים האלה למשתנים.
  3. אפשר גם להגדיר תנאים להחלת ערכים באופן קבוע על מדגם אקראי של מופעים או על אותות מותאמים אישית שהגדרתם. מידע נוסף על תנאים זמין במאמר סוגים של כללי תנאים.
  4. כשמסיימים להוסיף פרמטרים, לוחצים על פרסום השינויים.
  5. בודקים את השינויים ולוחצים שוב על פרסום השינויים.

שלב 5: פריסה באמצעות Cloud Functions או Cloud Run

אם אפליקציית השרת שלכם קלה ומונעת על ידי אירועים, כדאי לפרוס את הקוד באמצעות Cloud Functions. לדוגמה, נניח שיש לכם אפליקציה שכוללת דיאלוג של דמויות שמבוסס על API של AI גנרטיבי (לדוגמה, Google AI או Vertex AI). במקרה כזה, תוכלו לארח את הלוגיקה של שירות LLM בפונקציה שהאפליקציה שלכם קוראת לה לפי דרישה.

אם האפליקציה שלכם מיועדת לפעול לאורך זמן (למשל, אפליקציית אינטרנט עם נכסים), כדאי לשקול את האפשרות Cloud Run. כדי לפרוס את אפליקציית השרת באמצעות Cloud Run, פועלים לפי המדריך מדריך למתחילים: פריסת שירות Node.js ב-Cloud Run.

למידע נוסף על התרחישים הכי מתאימים לשימוש ב-Cloud Run וב-Cloud Functions, אפשר לעיין במאמר Cloud Functions לעומת Cloud Run: מתי כדאי להשתמש באחד מהם ולא בשני.