Szablony Zdalnej konfiguracji i obsługa wersji


Szablony Zdalnej konfiguracji to zbiory parametrów i warunków w formacie JSON, które zostały utworzone dla Twojego projektu Firebase. Możesz tworzyć szablony klientów, z których aplikacja pobiera wartości, oraz szablony serwera, z których klienty serwera mogą pobierać wartości.

W tej sekcji omawiamy szablony serwerów. Aby dowiedzieć się więcej o szablonach klienta, kliknij Szablony klienta.

Szablon możesz modyfikować i zarządzać nim w konsoli Firebase, która wyświetla zawartość szablonu w formacie graficznym na kartach Parametry i Warunki.

Oto przykład pliku szablonu serwera:

{
  "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
  }
}

W konsoli Firebase możesz wykonywać te zadania związane z zarządzaniem wersjami:

  • Wyświetl listę wszystkich przechowywanych wersji szablonów
  • Pobieranie konkretnej wersji
  • Przywróć określoną wersję klienta
  • Usuń szablony Zdalnej konfiguracji ze strony Historia zmian

Obowiązuje limit 300 przechowywanych wersji bezterminowo na typ szablonu (300 szablonów klienta i 300 szablonów serwera), w tym numery zapisanych wersji usuniętych szablonów. Jeśli w czasie trwania projektu opublikujesz więcej niż 300 wersji szablonów na typ szablonu, zostaną usunięte najstarsze wersje, zachowując przy tym maksymalnie 300 wersji danego typu.

Za każdym razem, gdy aktualizujesz parametry, Zdalna konfiguracja tworzy nowy szablon Zdalnej konfiguracji z różnymi wersjami i zapisuje poprzedni szablon jako wersję, którą możesz pobrać lub przywrócić w razie potrzeby. Numery wersji są zwiększane sekwencyjnie od wartości początkowej zapisanej przez Zdalną konfigurację. Wszystkie szablony zawierają pole version, jak pokazano poniżej, zawierające metadane konkretnej wersji.

W razie potrzeby możesz usunąć szablony Zdalnej konfiguracji z poziomu strony Historia zmian w konsoli Zdalnej konfiguracji.

Zarządzanie wersjami szablonów Zdalnej konfiguracji

W tej sekcji dowiesz się, jak zarządzać wersjami szablonu Zdalnej konfiguracji.

Wyświetl listę wszystkich zapisanych wersji szablonu Zdalnej konfiguracji

Możesz pobrać listę wszystkich zapisanych wersji szablonu Zdalnej konfiguracji. Aby to zrobić:

  1. W konsoli Firebase otwórz Zdalną konfigurację.

  2. Następnie na karcie Parametry wybierz ikonę zegara w prawym górnym rogu.

    Otworzy się strona Historia zmian z menu po prawej stronie z listą wszystkich zapisanych wersji szablonu.

    Lista szablonów zawiera metadane wszystkich przechowywanych wersji, w tym czas aktualizacji, użytkownika, który ją utworzył, i sposób jej wykonania.

Pobieranie konkretnej wersji szablonu Zdalnej konfiguracji

Możesz pobrać dowolną zapisaną wersję szablonu Zdalnej konfiguracji. Aby pobrać zapisaną wersję szablonu:

  1. Otwórz panel szczegółów Historia zmian.

  2. Aby wyświetlić na liście szczegóły innej wersji, wybierz ją w menu po prawej stronie.

  3. Aby wyświetlić szczegółowe różnice między aktywnym szablonem a każdą inną zapisaną wersją, najedź kursorem na menu kontekstowe wybranej wersji i kliknij Porównaj z wybraną wersją.

Cofnięcie do określonej zapisanej wersji szablonu Zdalnej konfiguracji

Możesz przywrócić dowolną zapisaną wersję szablonu. Aby przywrócić poprzednią wersję szablonu:

  1. Znajdź przycisk opcji w prawym górnym rogu strony Historia zmian. Kliknij i potwierdź tę opcję tylko wtedy, gdy na pewno chcesz przywrócić tę wersję i używać tych wartości od razu w przypadku wszystkich aplikacji i użytkowników.

Pamiętaj, że ta operacja przywracania tworzy nową wersję numerowaną. Na przykład powrót z wersji 10 do wersji 6 skutecznie tworzy nową kopię wersji 6, która różni się od oryginału tylko tym, że numer wersji to 11. Oryginalna wersja 6 jest nadal przechowywana, o ile nie upłynęła data ważności, a wersja 11 staje się aktywnym szablonem.

Usuń szablon Zdalnej konfiguracji

Szablony Zdalnej konfiguracji możesz usunąć z poziomu konsoli Firebase. Aby usunąć szablon Zdalnej konfiguracji:

1. Na stronie Parametry Zdalnej konfiguracji kliknij Historia zmian.

  1. Przejdź do szablonu, który chcesz usunąć, kliknij Więcej, a następnie wybierz Usuń.

  2. Gdy pojawi się prośba o potwierdzenie usunięcia, kliknij Usuń.

Pobieranie i publikowanie szablonów Zdalnej konfiguracji

Pobieraj i publikuj szablony Zdalnej konfiguracji, aby zintegrować je z systemami źródłowymi i kompilacji, automatyzować aktualizacje konfiguracji oraz synchronizować parametry i wartości w wielu projektach.

Aktualnie aktywny szablon Zdalnej konfiguracji możesz pobraćz konsoli Firebase. Następnie możesz zaktualizować wyeksportowany plik JSON i opublikować go w tym samym projekcie albo opublikować w nowym lub istniejącym projekcie.

Załóżmy, że masz wiele projektów reprezentujących różne etapy cyklu tworzenia oprogramowania, takich jak środowisko programistyczne, testowe, przejściowe i środowisko produkcyjne. W takim przypadku możesz przenieść w pełni przetestowany szablon ze środowiska testowego do środowiska produkcyjnego. W tym celu pobierz go z projektu przejściowego i opublikuj w projekcie produkcyjnym.

Za pomocą tej metody możesz też przenieść konfiguracje z jednego projektu do innego lub wypełnić nowy projekt parametrami i wartościami ze skonfigurowanego projektu.

Parametry i ich wartości utworzone specjalnie jako warianty w eksperymencie A/B nie są uwzględniane w eksportowanych szablonach.

Aby wyeksportować lub zaimportować szablony Zdalnej konfiguracji:

  1. Pobierz aktualny szablon Zdalnej konfiguracji.
  2. Zweryfikuj szablon Zdalnej konfiguracji.
  3. Opublikuj szablon Zdalnej konfiguracji.

Pobierz bieżący szablon Zdalnej konfiguracji

Aby pobrać aktywny szablon Zdalnej konfiguracji w formacie JSON, użyj tego polecenia:

  1. Na karcie Parametry lub warunki Zdalnej konfiguracji otwórz menu i wybierz Pobierz bieżący plik konfiguracyjny.
  2. Gdy pojawi się prośba, kliknij Pobierz plik konfiguracyjny, wybierz lokalizację, w której chcesz zapisać plik, a następnie kliknij Zapisz.

Weryfikowanie szablonu Zdalnej konfiguracji

Szablony serwera są sprawdzane podczas publikowania z poziomu konsoli Firebase. Pamiętaj, że można zaimportować dane z wartością losową wartość procentową, ale każdy nieobsługiwany warunek wygeneruje błąd podczas przesyłania. Jeśli próbujesz opublikować szablon, który został pierwotnie wyeksportowany z szablonu klienta, pamiętaj, aby najpierw usunąć wszystkie warunki dotyczące konkretnego klienta.

Opublikuj szablon Zdalnej konfiguracji.

Po pobraniu szablonu, wprowadzeniu odpowiednich zmian w treści JSON i zweryfikowaniu go możesz opublikować w projekcie.

Opublikowanie szablonu powoduje zastąpienie całego istniejącego szablonu konfiguracji zaktualizowanym plikiem i zwiększenie wersji szablonu o 1. Zastąpi się cała konfiguracja, więc jeśli usuniesz parametr z pliku JSON i opublikujesz go, parametr zostanie usunięty z serwera i nie będzie już dostępny dla klientów.

Po opublikowaniu zmiany parametrów i wartości są od razu dostępne dla aplikacji i użytkowników. W razie potrzeby możesz przywrócić poprzednią wersję.

Aby opublikować szablon, użyj tych poleceń:

  1. Na karcie Parametry lub warunki Zdalnej konfiguracji otwórz menu i wybierz Opublikuj z pliku.
  2. Gdy pojawi się prośba, kliknij Przeglądaj, przejdź do pliku Zdalnej konfiguracji, który chcesz opublikować, i kliknij Wybierz.
  3. Plik zostanie sprawdzony. Jeśli operacja się uda, możesz kliknąć Opublikuj, aby natychmiast udostępnić konfigurację aplikacjom i użytkownikom.

Dalsze kroki