Usar a Configuração remota em ambientes de servidor

Agora, a Configuração remota do Firebase é compatível com a configuração do lado do servidor usando o SDK Admin para Node.js do Firebase v12.1.0 e versões mais recentes. Com esse novo recurso, você gerencia dinamicamente o comportamento e a configuração de aplicativos do lado do servidor usando o Configuração remota. Isso inclui implementações sem servidor, como o Cloud Functions.

Ao contrário dos SDKs do cliente do Firebase, que buscam uma configuração específica do cliente derivada do modelo da Configuração remota, o SDK da Configuração remota do lado do servidor faz o download de um modelo completo da Configuração remota do Firebase. Seu servidor pode avaliar o modelo com cada solicitação recebida e usar a própria lógica para exibir uma resposta personalizada com latência muito baixa.

Com a Configuração remota do lado do servidor, você pode:

  • Defina os parâmetros de configuração dos aplicativos em execução ou acessados por meio do seu servidor, permitindo casos de uso como configurar remotamente parâmetros e prompts do modelo de IA e outras integrações, para garantir que suas chaves de API permaneçam seguras.
  • Ajuste dinamicamente os parâmetros em resposta a mudanças no seu ambiente ou outras mudanças no aplicativo, como atualização de parâmetros de LLM e endpoints de modelo.
  • Atualize remotamente as APIs que seu servidor chama para controlar os custos.
  • Gere configurações personalizadas rapidamente para clientes que acessam seu servidor.
  • Registre quais clientes receberam um valor de parâmetro e use-o no Cloud Functions como parte de um sistema de verificação de direitos.

É possível implantar a Configuração remota do lado do servidor no Cloud Run, no Cloud Functions ou em ambientes de servidor auto-hospedados.

Antes de começar

Siga as instruções em Adicionar o SDK Admin do Firebase ao seu servidor para criar um projeto do Firebase, configurar uma conta de serviço e adicionar o SDK Admin para Node.js do Firebase ao seu servidor.

Etapa 1: inicializar o SDK Admin para Node.js do Firebase e autorizar solicitações de API

Quando você inicializa o SDK Admin sem parâmetros, o SDK usa o Google Application Default Credentials e faz a leitura das opções na variável de ambiente GOOGLE_APPLICATION_CREDENTIALS. Por exemplo, para inicializar o SDK e adicionar a Configuração remota:

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

// Initialize Firebase
const firebaseApp = initializeApp();

Etapa 2: identificar os valores de parâmetros padrão do aplicativo de servidor

Identifique as variáveis no seu app que você quer atualizar dinamicamente com a Configuração remota. Em seguida, pense em quais variáveis precisam ser definidas por padrão no aplicativo e quais devem ser os valores padrão. Isso garante que seu aplicativo seja executado com êxito, mesmo que a conexão com o servidor de back-end da Configuração remota seja interrompida.

Por exemplo, se você estiver criando um aplicativo de servidor que gerencia uma função de IA generativa, poderá definir um nome de modelo padrão, um preâmbulo do comando e uma configuração de IA generativa, como a seguinte:

Nome do parâmetro Descrição Tipo Valor padrão
model_name Nome da API Model String gemini-1.5-pro
preamble_prompt Prompt para anexar à consulta do usuário String 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 Parâmetros a serem enviados ao modelo JSON {"stopSequences": ["I hope this helps"], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}

Etapa 3: configurar o aplicativo de servidor

Depois de determinar os parâmetros que você quer usar com a Configuração remota, configure seu aplicativo para definir valores padrão, busque o modelo da Configuração remota específico do servidor e use os valores dele. As etapas a seguir descrevem como configurar seu aplicativo Node.js.

  1. Acesse e carregue o modelo.

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

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

    Se estiver usando o Node.js em um Cloud Functions, você poderá usar o getServerTemplate assíncrono para buscar e carregar o modelo em uma única etapa:

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

  2. Para garantir que seu aplicativo seja executado com êxito, mesmo que a conexão com o servidor de back-end da Configuração remota seja interrompida, adicione valores padrão para cada parâmetro ao app. Para fazer isso, adicione um defaultConfig dentro da função de modelo 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. Depois que o modelo for carregado, use template.evaluate() para importar parâmetros e valores do modelo:

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

  4. Como opção, se você definir condições de porcentagem no modelo da Configuração remota, defina e forneça o randomizationId que você quer usar para avaliar as condições na função template.evaluate().

    Por exemplo, você pode definir um ID de instalação do Firebase como randomizationId ou um ID de usuário para garantir que cada usuário que entrar em contato com o servidor seja adicionado ao grupo aleatório adequado. O exemplo a seguir é básico, mas é possível configurar o servidor para gerar diferentes randomizationIds para diferentes solicitações de clientes, a fim de garantir que os usuários recebam valores consistentes da Configuração remota com base na participação deles em grupos de condições percentuais.

    Para saber mais sobre condições de porcentagem, consulte Usuário em porcentagem aleatória.

    // Set the randomizationId
const randomizationId = "2ac93c28-c459-4760-963d-a3974ec26c04"

// Add template parameters to `config`. Evaluates the
// template and returns the parameter value assigned to
// the group assigned to the {randomizationId}.
const config = template.evaluate({
  randomizationId
});

  5. Em seguida, extraia os valores de parâmetro necessários da constante de configuração. Use getters para transmitir os valores da Configuração remota para o formato esperado. Veja a seguir os tipos compatíveis:

    • Booleano: getBoolean
    • Objeto: getValue
    • Número: getNumber
    • String: getString

    Por exemplo, se você estiver implementando a Vertex AI no seu servidor e quiser alterar os parâmetros do modelo e do modelo, configure os parâmetros para model_name e generationConfig. Confira um exemplo de como acessar os valores da Configuração remota:

    // 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. Se o servidor for de longa duração, em vez de um ambiente sem servidor, use setInterval para recarregar o modelo periodicamente e garantir que você esteja buscando periodicamente o modelo mais atualizado do servidor da Configuração remota.

Etapa 4: definir valores de parâmetros específicos do servidor na Configuração remota

Em seguida, crie um modelo do servidor da Configuração remota e defina os parâmetros e valores para usar no seu app.

Para criar um modelo específico do servidor da Configuração remota:

  1. Abra a página de parâmetros da Configuração remota do Console do Firebase e, no seletor Cliente/servidor, selecione Servidor.
  2. Defina os parâmetros da Configuração remota com os mesmos nomes e tipos de dados que os parâmetros que você definiu no seu app e forneça valores. Esses valores vão substituir o defaultConfig definido em Configurar seu aplicativo de servidor ao buscar e avaliar o modelo e atribuir esses valores às suas variáveis.
  3. Também é possível definir condições de porcentagem para aplicar um valor a uma amostra aleatória de instâncias de forma permanente. Para saber mais sobre condições de porcentagem, consulte Usuário em porcentagem aleatória.
  4. Quando terminar de adicionar parâmetros, clique em Publicar alterações.
  5. Analise as alterações e clique em Publicar alterações novamente.

Etapa 5: implantar com o Cloud Functions ou o Cloud Run

Se o aplicativo de servidor for leve e orientado a eventos, considere implantar o código usando o Cloud Functions. Por exemplo, digamos que você tenha um app que inclua diálogos de personagens com uma API de IA generativa (como a IA do Google ou a Vertex AI). Nesse caso, você pode hospedar sua lógica de disponibilização de LLM em uma função que seu app chama sob demanda.

Se o aplicativo for criado para ser de longa duração (por exemplo, um app da Web com recursos), considere o Cloud Run. Para implantar seu app de servidor com o Cloud Run, siga o guia em Guia de início rápido: implantar um serviço Node.js no Cloud Run.

Para mais informações sobre os melhores casos de uso do Cloud Run e do Cloud Functions, consulte Cloud Functions vs. Cloud Run: quando usar um em vez do outro.