Sunucu ortamlarında Remote Config'i kullanın

Firebase Remote Config artık Firebase Admin Node.js SDK'sı 12.1.0 ve sonraki sürümleri kullanarak sunucu tarafı yapılandırmayı destekliyor. Bu yeni özellik, Remote Config'ı kullanarak sunucu tarafı uygulamaların davranışını ve yapılandırmasını dinamik olarak yönetmenize olanak tanır. Buna Cloud Functions gibi sunucusuz uygulamalar da dahildir.

Remote Config şablonundan türetilmiş istemciye özgü bir yapılandırma getiren Firebase istemci SDK'larının aksine, sunucu tarafı Remote Config SDK'sı Firebase'den tam bir Remote Config şablonu indirir. Sunucunuz daha sonra gelen her istekle şablonu değerlendirebilir ve çok düşük gecikmeli özelleştirilmiş bir yanıt sunmak için kendi mantığını kullanabilir. Yanıtları, özel sinyallerde tanımlanan rastgele yüzdelere ve müşteri özelliklerine göre kontrol etmek ve özelleştirmek için koşulları kullanabilirsiniz.

Sunucu tarafı Remote Config ile şunları yapabilirsiniz:

  • Sunucunuzda çalışan veya sunucunuz üzerinden erişilen uygulamalar için yapılandırma parametreleri tanımlayarak API anahtarlarınızın güvende kalmasını sağlamak amacıyla yapay zeka modeli parametrelerini, istemleri ve diğer entegrasyonları uzaktan yapılandırma gibi kullanım alanlarına olanak tanıyın.
  • Ortamınızdaki değişikliklere veya LLM parametrelerinin ve model uç noktalarının güncellenmesi gibi diğer uygulama değişikliklerine yanıt olarak parametreleri dinamik olarak ayarlayın.
  • Sunucunuzun çağırdığı API'leri uzaktan güncelleyerek maliyetleri kontrol edin.
  • Sunucunuza erişen istemciler için anında özel yapılandırmalar oluşturun.
  • Hangi istemcilerin bir parametre değeri aldığını kaydedin ve bu bilgiyi Cloud Functions'te bir uygunluk doğrulama sistemi kapsamında kullanın.

Sunucu tarafı Remote Config'ü Cloud Run, Cloud Functions veya kendi bünyesinde barındırılan sunucu ortamlarına dağıtabilirsiniz.

Başlamadan önce

Firebase Admin SDK'sını sunucunuza ekleme başlıklı makaledeki talimatları uygulayarak bir Firebase projesi oluşturun, bir hizmet hesabı oluşturun ve Firebase Admin Node.js SDK'sını sunucunuza ekleyin.

1. adım: Firebase Admin Node.js SDK'sını başlatın ve API isteklerini yetkilendirin

Yönetici SDK'sını parametre olmadan başlattığınızda SDK, Google Uygulama Varsayılan Kimlik Bilgileri'ni kullanır ve seçenekleri GOOGLE_APPLICATION_CREDENTIALS ortam değişkeninden okur. Örneğin, SDK'yı başlatmak ve Remote Config eklemek için:

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

// Initialize Firebase
const firebaseApp = initializeApp();

2. adım: Sunucu uygulamanız için varsayılan parametre değerlerini belirleyin

Uygulamanızda Remote Config ile dinamik olarak güncellemek istediğiniz değişkenleri tanımlayın. Ardından, uygulamanızda hangi değişkenlerin varsayılan olarak ayarlanması gerektiğini ve varsayılan değerlerinin ne olması gerektiğini düşünün. Bu sayede, Remote Config arka uç sunucusuyla bağlantısı kesintiye uğrasa bile uygulamanızın başarılı bir şekilde çalışması sağlanır.

Örneğin, üretken yapay zeka işlevini yöneten bir sunucu uygulaması yazıyorsanız varsayılan bir model adı, istem girişi ve üretken yapay zeka yapılandırması ayarlayabilirsiniz. Örneğin:

Parametre adı Açıklama Tür Varsayılan değer
model_name Model API adı Dize gemini-1.5-pro
preamble_prompt Kullanıcının sorgusuna ön ek ekleme istemi Dize 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 Modele gönderilecek parametreler JSON {"stopSequences": ["I hope this helps"], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}

3. Adım: Sunucu uygulamanızı yapılandırın

Remote Config ile kullanmak istediğiniz parametreleri belirledikten sonra uygulamanızı varsayılan değerleri ayarlayacak, sunucuya özgü Remote Config şablonunu alacak ve değerlerini kullanacak şekilde yapılandırın. Aşağıdaki adımlarda, Node.js uygulamanızın nasıl yapılandırılacağı açıklanmaktadır.

  1. Şablona erişip şablonu yükleyin.

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

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

    Cloud Functions içinde Node.js kullanıyorsanız şablonu tek bir adımda getirmek ve yüklemek için eşzamansız getServerTemplate işlevini kullanabilirsiniz:

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

  2. Uygulamanızın, Remote Config arka uç sunucusuyla bağlantısı kesilse bile başarılı bir şekilde çalıştığından emin olmak için her parametrenin varsayılan değerini uygulamanıza ekleyin. Bunu yapmak için initServerTemplate veya getServerTemplate şablon işlevinizin içine bir defaultConfig ekleyin:

    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. Şablon yüklendikten sonra şablondaki parametreleri ve değerleri içe aktarmak için template.evaluate() simgesini kullanın:

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

  4. İsteğe bağlı olarak, Remote Config şablonunuzda koşullar belirlerseniz istediğiniz değerleri tanımlayıp sağlayın:

    • Yüzde koşulları kullanıyorsanız koşullarınızı değerlendirmek için kullanmak istediğiniz randomizationId değerini template.evaluate() işlevine ekleyin.
    • Özel sinyaller kullanıyorsanız özellikleri ve değerlerini tanımlayın. Özel sinyaller, Firebase Yönetici Node.js SDK'sı 12.5.0 ve sonraki sürümlerde kullanılabilir.

    Örneğin, sunucunuzla iletişime geçen her kullanıcının uygun rastgele gruplara eklenmesini sağlamak için randomizationId olarak bir Firebase kurulum kimliği veya kullanıcı kimliği, belirli istemci sürümlerini hedeflemek için özel sinyal olarak version ve istemci platformunu hedeflemek için özel sinyal olarak platform ayarlayabilirsiniz.

    Koşullar hakkında daha fazla bilgi için Koşul kuralı türleri başlıklı makaleyi inceleyin.

    // 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. Ardından, ihtiyacınız olan parametre değerlerini yapılandırma sabitinden çıkarın. Remote Config içindeki değerleri beklenen biçime dönüştürmek için getters'ü kullanın. Aşağıdaki türler desteklenir:

    • Boole: getBoolean
    • Nesne: getValue
    • Numara: getNumber
    • Dize: getString

    Örneğin, sunucunuzda Vertex AI'ı uygularken model ve model parametrelerini değiştirmek istiyorsanız model_name ve generationConfig parametrelerini yapılandırabilirsiniz. Remote Config değerlerine nasıl erişebileceğinize dair bir örnek aşağıda verilmiştir:

    // 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. Sunucunuz sunucusuz bir ortam yerine uzun süredir çalışıyorsa Remote Config sunucusundan düzenli olarak en güncel şablonu getirdiğinizden emin olmak için şablonu düzenli olarak yeniden yüklemek üzere setInterval kullanın.

4. Adım: Remote Config dosyasında sunucuya özgü parametre değerlerini ayarlayın

Ardından, bir sunucu Remote Config şablonu oluşturun ve uygulamanızda kullanılacak parametreleri ve değerleri yapılandırın.

Sunucuya özel bir Remote Config şablonu oluşturmak için:

  1. Firebase konsolu Remote Config parametreleri sayfasını açın ve İstemci/Sunucu seçiciden Sunucu'yu seçin.
  2. Uygulamanızda tanımladığınız parametrelerle aynı ad ve veri türlerine sahip Remote Config parametreleri tanımlayın ve değerler sağlayın. Şablonu getirip değerlendirdiğinizde ve bu değerleri değişkenlerinize atadığınızda bu değerler, Sunucu uygulamanızı yapılandırma bölümünde ayarladığınız defaultConfig değerini geçersiz kılar.
  3. İsteğe bağlı olarak, değerleri rastgele bir örnekleme veya tanımladığınız özel sinyallere sürekli olarak uygulayacak koşullar belirleyin. Koşullar hakkında daha fazla bilgi için Koşul kuralı türleri başlıklı makaleyi inceleyin.
  4. Parametre ekleme işlemini tamamladığınızda Değişiklikleri yayınla'yı tıklayın.
  5. Değişiklikleri inceleyin ve Değişiklikleri yayınla'yı tekrar tıklayın.

5. Adım: Cloud Functions veya Cloud Run ile dağıtın

Sunucu uygulamanız hafif ve etkinlik odaklıysa kodunuzu Cloud Functions kullanarak dağıtmayı düşünebilirsiniz. Örneğin, üretken yapay zeka API'si (ör. Google AI veya Vertex AI) tarafından desteklenen karakter diyaloğu içeren bir uygulamanız olduğunu varsayalım. Bu durumda, LLM sunma mantığınızı uygulamanızın isteğe bağlı olarak çağırdığı bir işlevde barındırabilirsiniz.

Uygulamanızın uzun süre çalıştırılması gerekiyorsa (ör. öğeleri olan bir web uygulaması) Cloud Run'u kullanabilirsiniz. Sunucu uygulamanızı Cloud Run ile dağıtmak için Hızlı başlangıç: Node.js hizmetini Cloud Run'a dağıtma başlıklı makaledeki kılavuzu uygulayın.

Cloud Run ve Cloud Functions için en iyi kullanım alanları hakkında daha fazla bilgi edinmek isterseniz Cloud Functions ve Cloud Run: Hangisini ne zaman kullanacağınız başlıklı makaleyi inceleyin.