Modelos e controle de versões da Configuração remota

Os modelos da Configuração remota são conjuntos de parâmetros e condições no formato JSON que você criou para seu projeto do Firebase. Você pode criar modelos de cliente, de onde seu app busca valores, e de servidor, de onde os clientes do servidor podem buscar valores.

Esta seção aborda os modelos de servidor. Para saber mais sobre modelos específicos do cliente, clique em Modelos de cliente.

É possível modificar e gerenciar o modelo usando o Console do Firebase, que exibe o conteúdo do modelo em formato de gráfico nas guias Parâmetros e Condições.

Confira um exemplo de arquivo de modelo de servidor:

{
  "parameters": {
    "preamble_prompt": {
      "defaultValue": {
        "value": "You are a helpful assistant who knows everything there is to know about Firebase! "
      },
      "description": "Add this prompt to the user's prompt",
      "valueType": "STRING"
    },
    "model_name": {
      "defaultValue": {
        "value": "gemini-pro-test"
      },
      "valueType": "STRING"
    },
    "generation_config": {
      "defaultValue": {
        "value": "{\"temperature\": 0.9, \"maxOutputTokens\": 2048, \"topP\": 0.9, \"topK\": 20}"
      },
      "valueType": "JSON"
    },
  },
  "version": {
    "versionNumber": "19",
    "isLegacy": true
  }
}

É possível realizar estas tarefas de gerenciamento de versões com o console do Firebase:

Listar todas as versões de modelos armazenadas.
Recuperar uma versão específica.
Reverter para uma versão específica de cliente
Exclua os modelos da Configuração remota na página Histórico de alterações

Há um limite total de 300 versões armazenadas com ciclo de vida por tipo de modelo (300 modelos de cliente e 300 de servidor), o que inclui números de versão armazenados para modelos excluídos. Se você publicar mais de 300 por tipo de modelo durante a vida útil de um projeto, as versões mais antigas são excluídas, mantendo no máximo 300 versões desse tipo.

Sempre que os parâmetros são atualizados, o Configuração remota cria um novo modelo com controle de versão e armazena o anterior como uma versão que você pode recuperar ou reverter conforme necessário. Os números de versão são aumentados sequencialmente partindo do valor inicial armazenado pelo Configuração remota. Todos os modelos incluem um campo version conforme mostrado. Ele contém metadados sobre essa versão específica.

É possível excluir os modelos da Configuração remota conforme necessário na página Histórico de alterações do console da Configuração remota.

Gerenciar versões do modelo da Configuração remota

Veja nesta seção como gerenciar versões do modelo da Configuração remota.

Listar todas as versões armazenadas do modelo da Configuração remota

É possível recuperar uma lista de todas as versões armazenadas de modelos do Configuração remota. As etapas para fazer isso:

No console do Firebase, abra a Configuração remota.
Depois, na guia Parâmetros, selecione o ícone de relógio exibido no canto superior direito.

Após clicar nesta opção, a página Histórico de alterações será exibida com todas as versões de modelo em um menu em lista.

A lista de modelos inclui metadados para todas as versões armazenadas, incluindo a hora da atualização, o usuário que a fez e como ela foi feita.

Recuperar uma versão específica do modelo do Configuração remota

É possível recuperar qualquer versão armazenada específica do modelo do Configuração remota. Para recuperar uma versão de modelo armazenada:

Abra o painel de detalhes do Histórico de alterações.
Para conferir detalhes de outra versão na lista, selecione-a no menu à direita.
Para visualizar uma comparação detalhada entre o modelo ativo e qualquer outra versão armazenada, passe o cursor sobre o menu de contexto de qualquer versão não selecionada e clique em Comparar com a versão selecionada.

Reverter para uma versão específica armazenada do modelo do Configuração remota

É possível reverter para qualquer versão armazenada do modelo. Para reverter um modelo:

Localize o botão de opção no canto superior direito da página Histórico de alterações. Clique e confirme essa opção apenas se tiver certeza de que você quer reverter para essa versão e usar esses valores imediatamente para todos os apps e usuários.

Na realidade, essa operação de reversão cria uma nova versão numerada. Por exemplo, a reversão da versão 10 para a versão 6 cria uma nova cópia da versão 6, que é diferente da original apenas porque o número de versão é 11. A versão 6 original ainda é armazenada, caso não tenha atingido a expiração, e a versão 11 se torna o modelo ativo.

Excluir um modelo da Configuração remota

Você pode excluir modelos da Configuração remota no console do Firebase. Para excluir um modelo da Configuração remota:

1. Na página Parâmetros da Configuração remota, clique em Histórico de alterações.

Alterne para o modelo que você quer excluir, clique em Mais e selecione Excluir.
Clique em Excuir para confirmar a exclusão.

Fazer o download e publicar modelos da Configuração remota

Faça o download e publique modelos da Configuração remota para integrá-los aos seus sistemas de compilação e controle de origem, automatizar atualizações de configurações e manter os parâmetros e valores sincronizados em vários projetos.

É possível fazer o download do modelo da Configuração remota ativo no momento, no Console do Firebase. É possível atualizar o arquivo JSON exportado e publicá-lo no mesmo projeto ou em um projeto novo ou existente.

Digamos que você tenha vários projetos que representem estágios diferentes do ciclo de vida de desenvolvimento de software, como ambientes de desenvolvimento, teste, preparo e produção. Nesse caso, é possível promover um modelo totalmente testado do seu ambiente de preparo para seu ambiente de produção, fazendo o download dele no projeto de preparo e a publicação no projeto de produção.

Também é possível usar esse método para migrar configurações de um projeto para outro ou preencher automaticamente um novo projeto com parâmetros e valores de um projeto estabelecido.

Os parâmetros e os valores de parâmetro criados especificamente como variantes em um experimento do Teste A/B não estão incluídos nos modelos exportados.

Para exportar e importar modelos da Configuração remota:

Faça o download do modelo atual da Configuração remota.
Valide o modelo da Configuração remota.
Publique o modelo da Configuração remota.

Faça o download do modelo atual da Configuração remota

Use o seguinte para fazer o download do modelo ativo da Configuração remota no formato JSON:

Na guia Parâmetros ou condições da Configuração remota, abra o Menu e selecione Fazer o download do arquivo de configuração atual.
Quando solicitado, clique em Fazer o download do arquivo de configuração, escolha o local onde você quer salvar o arquivo e clique em Salvar.

Validar o modelo da Configuração remota

Os modelos de servidor são validados quando você tenta publicar pelo console do Firebase. O usuário nas condições de porcentagem aleatória pode ser importado, mas as condições incompatíveis geram um erro durante o upload. Se você estiver tentando publicar um modelo que foi originalmente exportado de um modelo de cliente, primeiro remova as condições específicas do cliente.

Publicar o modelo da Configuração remota

Depois de fazer o download de um modelo, fazer as alterações necessárias no conteúdo JSON e validá-lo, é possível publicar o modelo em um projeto.

A publicação substitui todo o modelo da configuração atual pelo arquivo atualizado e incrementa a versão do modelo em um. Como toda a configuração é substituída, se você excluir um parâmetro do arquivo JSON e publicá-lo, o parâmetro é deletado do servidor e fica indisponível para os clientes.

Após a publicação, as alterações nos parâmetros e valores são disponibilizadas imediatamente para os apps e usuários. Se necessário, reverta para a versão anterior.

Use os seguintes comandos para publicar o modelo:

Na guia Parâmetros ou condições da Configuração remota, abra o Menu e selecione Publicar de um arquivo.
Quando solicitado, clique em Procurar, navegue até o arquivo da Configuração remota que você quer publicar e clique em Selecionar.
O arquivo vai ser validado e, se for bem-sucedido, você pode clicar em Publicar para disponibilizar a configuração imediatamente para seus apps e usuários.