При использовании шаблонов серверных запросов вы можете обновлять значения в заданном шаблоне без выпуска новой версии вашего приложения. Однако, поскольку любые изменения в шаблоне будут практически немедленно использоваться запросами из вашего приложения, вам следует проявлять осторожность при внесении изменений, которые могут нарушить работу вашего приложения или вызвать неожиданные изменения в его поведении.
Таким образом, если вы хотите внести более существенные изменения или внедрять изменения постепенно, вам не следует менять шаблон, используемый в рабочем коде.
Вместо этого мы рекомендуем использовать Firebase Remote Config для управления значением идентификатора шаблона, используемого в запросе к модели.
Firebase Remote Config позволяет динамически и удаленно обновлять значения параметров в вашем приложении (например, идентификатор шаблона) из консоли Firebase , без необходимости выпуска новой версии приложения. Он также обладает упрощенными возможностями и интеграциями для развертывания изменений, а также для A/B-тестирования.
В этом руководстве описывается, как реализовать функцию Remote Config в вашем приложении, в частности, для управления идентификатором шаблона, используемым в вашем приложении .
Шаг 1 : Установите значение параметра в консоли Firebase
Создайте шаблон клиента Remote Config и настройте параметр template_id и его значение для получения и использования в приложении.
Откройте свой проект Firebase в консоли Firebase . Затем в меню навигации разверните раздел «Выполнить» и выберите Remote Config .
Убедитесь, что в верхней части страницы в поле выбора "Клиент/Сервер" выбран параметр "Клиент" .
Чтобы создать шаблон клиента, нажмите кнопку «Создать конфигурацию» (или «Добавить параметр», если вы уже использовали шаблоны клиентов).
Определите параметр
template_id:Имя параметра Описание Тип Значение по умолчанию template_idИдентификатор шаблона. Нить my-first-template-v1-0-0После добавления этого параметра нажмите «Опубликовать изменения» . Если это не новый шаблон Remote Config , просмотрите изменения и снова нажмите «Опубликовать изменения» .
Шаг 2 : Добавьте и инициализируйте Remote Config в вашем приложении.
Добавьте библиотеку Remote Config и настройте Remote Config в своем приложении.
Быстрый
В рамках настройки Firebase AI Logic вы уже добавили Firebase SDK в свое приложение, но вам также потребуется добавить Remote Config .
В Xcode, открыв проект, перейдите в меню File > Add Package Dependencies .
Выберите firebase-ios-sdk и нажмите «Добавить пакет» .
В навигаторе проекта выберите ваше приложение > Цели > ваше приложение.
На вкладке «Общие» прокрутите вниз до раздела «Фреймворки, библиотеки и встроенный контент» .
Нажмите кнопку «+» и выберите FirebaseRemoteConfig , затем нажмите «Добавить» .
Добавьте импорт
FirebaseRemoteConfigв свой код:import FirebaseRemoteConfigВнутри соответствующего класса вашего приложения инициализируйте Firebase и добавьте Remote Config в основную логику приложения.
Здесь вам нужно будет импортировать Remote Config и слушатель событий реального времени Remote Config , чтобы приложение могло получать новые значения в режиме реального времени, а также добавить минимальный интервал получения данных:
let remoteConfig = RemoteConfig.remoteConfig() let settings = RemoteConfigSettings() settings.minimumFetchInterval = 3600 remoteConfig.configSettings = settings
Kotlin
Добавьте зависимость Remote Config в файл Gradle вашего модуля (на уровне приложения) (обычно
app/build.gradle.ktsилиapp/build.gradle):dependencies { implementation(platform("com.google.firebase:firebase-bom:34.7.0")) implementation("com.google.firebase:firebase-ai") implementation("com.google.firebase:firebase-config") // ... other dependencies }Добавьте Remote Config в основную логику вашего приложения. Здесь вы инициализируете Remote Config и зададите минимальный интервал выборки:
val remoteConfig: FirebaseRemoteConfig = Firebase.remoteConfig val configSettings = remoteConfigSettings { minimumFetchIntervalInSeconds = 3600 } remoteConfig.setConfigSettingsAsync(configSettings)
Java
Добавьте зависимость Remote Config в файл Gradle вашего модуля (на уровне приложения) (обычно
app/build.gradle.ktsилиapp/build.gradle):dependencies { implementation(platform("com.google.firebase:firebase-bom:34.7.0")) implementation("com.google.firebase:firebase-ai") implementation("com.google.firebase:firebase-config") // ... other dependencies }Добавьте Remote Config в основную логику вашего приложения. Здесь вы инициализируете Remote Config и зададите минимальный интервал выборки:
FirebaseRemoteConfig mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance(); FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder() .setMinimumFetchIntervalInSeconds(3600) .build(); mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);
Web
Откройте свой код в текстовом редакторе и импортируйте Remote Config :
import { getRemoteConfig } from 'firebase/remote-config';Внутри вашей основной функции, после инициализации приложения Firebase для Firebase AI Logic SDK, выполните инициализацию Remote Config :
// Initialize Remote Config and get a reference to the service const remoteConfig = getRemoteConfig(app);Установите минимальный интервал получения данных:
remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
Dart
В каталоге вашего проекта Flutter установите и добавьте Remote Config , используя следующую команду:
flutter pub add firebase_remote_configОткройте файл
./lib/main.dartи добавьте импорт после других импортов, которые вы добавили для поддержки Firebase AI Logic :import 'package:firebase_vertexai/firebase_ai.dart'; import 'package:firebase_core/firebase_core.dart'; import 'package:firebase_remote_config/firebase_remote_config.dart';Добавьте переменную
_modelNameв ваше приложение, чтобы вы могли использовать её позже:late final String _modelName; late final String _systemInstructions; late final String _prompt;Получите экземпляр объекта Remote Config и установите минимальный интервал выборки, чтобы обеспечить частое обновление. Обязательно добавьте это после инициализации Firebase.
final remoteConfig = FirebaseRemoteConfig.instance; await remoteConfig.setConfigSettings(RemoteConfigSettings( fetchTimeout: const Duration(seconds: 3600), minimumFetchInterval: const Duration(seconds: 3600), ));
Единство
Добавьте Remote Config в свой проект Unity, следуя этим инструкциям .
Получите экземпляр объекта Remote Config и установите минимальный интервал выборки, чтобы обеспечить частое обновление. Обязательно добавьте это после инициализации Firebase.
var remoteConfig = FirebaseRemoteConfig.DefaultInstance; const int MillisecondsPerSecond = 1000; await remoteConfig.SetConfigSettingsAsync(new ConfigSettings() { FetchTimeoutInMilliseconds = 3600 * MillisecondsPerSecond, MinimumFetchIntervalInMilliseconds = 3600 * MillisecondsPerSecond });
Шаг 3 : Установите значение параметра в приложении.
В объекте Remote Config следует задать значения параметров по умолчанию для всего приложения. Это гарантирует корректную работу приложения, даже если оно не сможет получить значения из службы Remote Config .
Быстрый
В консоли Firebase откройте Remote Config .
На вкладке «Параметры» откройте меню и выберите «Загрузить значения по умолчанию» .
При появлении запроса включите поддержку файлов .plist для iOS , затем нажмите «Загрузить файл» .
Сохраните файл в каталоге вашего приложения.
В Xcode щелкните правой кнопкой мыши по своему приложению и выберите «Добавить файлы».
Выберите файл remote_config_defaults.plist , затем нажмите «Добавить» .
Обновите код вашего приложения, чтобы он ссылался на файл настроек по умолчанию:
// Set default values for Remote Config parameters. remoteConfig.setDefaults(fromPlist: "remote_config_defaults")
Kotlin
В консоли Firebase откройте Remote Config .
На вкладке «Параметры» откройте меню и выберите «Загрузить значения по умолчанию» .
При появлении запроса включите поддержку .xml для Android , затем нажмите «Скачать файл» .
Сохраните файл в каталоге XML-ресурсов вашего приложения.
Обновите основной файл активности, добавив значения по умолчанию после ранее добавленных
configSettings:// Set default values for Remote Config parameters. remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)
Java
В консоли Firebase откройте Remote Config .
На вкладке «Параметры» откройте меню и выберите «Загрузить значения по умолчанию» .
При появлении запроса включите поддержку .xml для Android , затем нажмите «Скачать файл» .
Сохраните файл в каталоге XML-ресурсов вашего приложения.
Обновите основной файл активности, добавив значения по умолчанию после ранее добавленных
configSettings:// Set default values for Remote Config parameters. mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);
Web
Вы можете задать значение по умолчанию для имени модели непосредственно в своем коде:
// Set default values for Remote Config parameters.
remoteConfig.defaultConfig = {
template_id: 'my-first-template-v1-0-0',
};
Dart
Вы можете задать значение по умолчанию для имени модели непосредственно в своем коде:
// Set default values for Remote Config parameters.
remoteConfig.setDefaults(const {
"template_id": "my-first-template-v1-0-0"
});
Единство
Вы можете задать значение по умолчанию для имени модели непосредственно в своем коде:
// Set default values for Remote Config parameters.
await remoteConfig.SetDefaultsAsync(
new System.Collections.Generic.Dictionary<string, object>() {
{ "template_id", "my-first-template-v1-0-0" }
}
);
Шаг 4 : Получите и активируйте значение.
После установки значения по умолчанию для имени модели добавьте следующее, чтобы получить и активировать значения.
Быстрый
// Fetch and activate Remote Config values
remoteConfig.fetchAndActivate { status, error in
if let error = error {
print("Error fetching Remote Config: \(error.localizedDescription)")
}
}
Это должно обновлять объект Remote Config всякий раз, когда публикуется новый шаблон Remote Config .
Kotlin
// Fetch and activate Remote Config values
remoteConfig.fetchAndActivate()
.addOnCompleteListener(this) { task ->
if (task.isSuccessful) {
val updated = task.result
Log.d(TAG, "Remote Config values fetched and activated: $updated")
} else {
Log.e(TAG, "Error fetching Remote Config", task.exception)
}
}
Java
// Fetch and activate Remote Config values
mFirebaseRemoteConfig.fetchAndActivate()
.addOnCompleteListener(this, new OnCompleteListener<Boolean>() {
@Override
public void onComplete(@NonNull Task<Boolean> task) {
if (task.isSuccessful()) {
boolean updated = task.getResult();
Log.d(TAG, "Config params updated: " + updated);
} else {
Log.e(TAG, "Error fetching Remote Config", task.exception)
}
}
});
Web
Добавьте
getValueиfetchAndActivateв список импортируемых переменных:import { getValue, fetchAndActivate } from 'firebase/remote-config';Найдите фрагмент кода, где указывается значение по умолчанию для имени модели. Сразу после этого блока кода добавьте следующий код для получения и активации конфигурации и присвоения полученного значения константе
templateID.// Fetch and activate Remote Config. try { await fetchAndActivate(remoteConfig); } catch(err) { console.error('Remote Config fetch failed', err); } console.log('Remote Config fetched.'); // Assign Remote Config values. const templateID = getValue(remoteConfig, 'template_id').asString();
Dart
// Fetch and activate Remote Config.
remoteConfig.fetchAndActivate();
// Assign Remote Config values.
String? _templateID = remoteConfig.getString("template_id");
Единство
// Fetch and activate Remote Config values.
await remoteConfig.FetchAndActivateAsync();
Шаг 5 : Добавьте прослушиватель Remote Config в реальном времени.
Добавьте в приложение обработчик Remote Config в реальном времени, чтобы гарантировать, что изменения, внесенные в шаблон Remote Config будут передаваться клиенту сразу после их обновления.
Приведенный ниже код обновляет объект Remote Config всякий раз, когда изменяется значение параметра.
Быстрый
// Add real-time Remote Config
remoteConfig.addOnConfigUpdateListener { configUpdate, error in
guard let configUpdate = configUpdate, error == nil else {
print("Error listening for config updates: \(error?.localizedDescription ?? "No error available")")
return
}
print("Updated keys: \(configUpdate.updatedKeys)")
remoteConfig.activate { changed, error in
guard error == nil else {
print("Error activating config: \(error?.localizedDescription ?? "No error available")")
return
}
print("Activated config successfully")
}
}
Kotlin
При желании вы также можете настроить действие внутри активации addOnCompleteListener :
// Add a real-time Remote Config listener
remoteConfig.addOnConfigUpdateListener(object : ConfigUpdateListener {
override fun onUpdate(configUpdate : ConfigUpdate) {
Log.d(ContentValues.TAG, "Updated keys: " + configUpdate.updatedKeys);
remoteConfig.activate().addOnCompleteListener {
// Optionally, add an action to perform on update here.
}
}
override fun onError(error : FirebaseRemoteConfigException) {
Log.w(ContentValues.TAG, "Config update error with code: " + error.code, error)
}
}
Java
При желании вы также можете настроить действие внутри активации addOnCompleteListener :
// Add a real-time Remote Config listener
remoteConfig.addOnConfigUpdateListener(new ConfigUpdateListener() {
@Override
public void onUpdate(ConfigUpdate configUpdate) {
Log.d(ContentValues.TAG, "Updated keys: " + configUpdate.getUpdatedKeys());
remoteConfig.activate().addOnCompleteListener(new OnCompleteListener<Boolean>() {
@Override
public void onComplete(@NonNull Task<Boolean> task) {
// Optionally, add an action to perform on update here.
}
});
}
@Override
public void onError(FirebaseRemoteConfigException error) {
Log.w(ContentValues.TAG, "Config update error with code: " + error.getCode(), error);
}
});
Web
Для веб-приложений не поддерживаются обработчики Remote Config в реальном времени .
Dart
// Add a real-time Remote Config listener
remoteConfig.onConfigUpdated.listen((event) async {
await remoteConfig.activate();
});
Единство
// Add a real-time Remote Config listener to automatically update whenever
// a new template is published.
// Note: the parameters can be anonymous as they are unused.
remoteConfig.OnConfigUpdateListener += (_, _) => {
remoteConfig.ActivateAsync();
};
Шаг 6 : Обновите запросы к API Gemini , чтобы использовать значение из параметра Remote Config
Чтобы просмотреть контент и код, относящиеся к вашему поставщику API Gemini , нажмите на него. |
Теперь, когда Remote Config полностью настроен, обновите свой код, заменив жестко заданные значения значениями, полученными из Remote Config .
Быстрый
import FirebaseAI
let templateID = remoteConfig.configValue(forKey: "template_id").stringValue
let model = FirebaseAI.firebaseAI(backend: .googleAI()).templateGenerativeModel()
let customerName = "Jane"
// When making the `generateContent` call, source the template ID value from Remote Config
let response = try await model.generateContent(
templateID: templateID,
// Provide the values for any input variables required by your template.
inputs: [
"customerName": customerName
]
)
// ...
Kotlin
// ...
val model = Firebase.ai(backend = GenerativeBackend.googleAI()).templateGenerativeModel()
val customerName = "Jane"
// When making the `generateContent` call, source the template ID value from Remote Config
val response = model.generateContent(
remoteConfig.getString("template_id"),
// Provide the values for any input variables required by your template.
mapOf(
"customerName" to customerName
)
)
val text = response.text
println(text)
Java
// ...
TemplateGenerativeModel ai = FirebaseAI.getInstance()
.templateGenerativeModel(null /* Request Options */);
TemplateGenerativeModelFutures model = TemplateGenerativeModelFutures.from(ai);
String customerName = "Jane";
// When making the `generateContent` call, source the template ID value from Remote Config
Future<GenerateContentResponse> response = model.generateContent(
remoteConfig.getString("template_id"),
// Provide the values for any input variables required by your template.
mapOf("customerName", customerName)
);
addCallback(response,
new FutureCallback<GenerateContentResponse>() {
public void onSuccess(GenerateContentResponse result) {
System.out.println(result.getText());
}
public void onFailure(Throwable t) {
reportError(t);
}
}
executor);
// ...
Web
// ...
const ai = getAI(firebaseApp, { backend: new GoogleAIBackend() });
const model = getTemplateGenerativeModel(ai);
const templateID = getValue(remoteConfig, 'template_id').asString();
const customerName = 'Jane';
// When making the `generateContent` call, source the template ID value from Remote Config
const result = await model.generateContent(
templateID,
// Provide the values for any input variables required by your template
{
customerName: customerName,
}
);
// ...
Dart
// ...
final model = FirebaseAI.googleAI().templateGenerativeModel();
final templateID = remoteConfig.getString("template_id");
final customerName = 'Jane';
// When making the `generateContent` call, source the template ID value from Remote Config
var response = await model.generateContent(
templateID,
// Provide the values for any input variables required by your template
inputs: {
'customerName': customerName,
},
);
// ...
Единство
// ...
var ai = FirebaseAI.GetInstance(FirebaseAI.Backend.GoogleAI());
var templateID = remoteConfig.GetValue("template_id").StringValue;
var model = ai.GetTemplateGenerativeModel();
var customerName = "Jane";
try
{
// When making the `generateContent` call, source the template ID value from Remote Config
var response = await model.GenerateContentAsync(
templateID,
// Provide the values for any input variables required by your template
new Dictionary<string, object>
{
{ "customerName", customerName },
}
);
Debug.Log($"Response Text: {response.Text}");
}
catch (Exception e)
{
Debug.LogError($"An error occurred: {e.Message}");
}
// ...
Шаг 7 : Запустите приложение
Соберите и запустите приложение и убедитесь, что оно работает. Внесите изменения в конфигурацию на странице Remote Config в консоли Firebase , опубликуйте изменения и проверьте результат.
Следующие шаги
Узнайте больше о реализации других вариантов использования Remote Config и Firebase AI Logic .
Для мобильных приложений и игр:
Проверяйте изменения шаблона с помощью Remote Config и A/B Testing .
Внедряйте изменения постепенно, используя развертывание Remote Config (только для iOS+ и Android).
Используйте персонализацию Remote Config , чтобы с помощью машинного обучения определить оптимальные настройки для отдельных пользователей (только для iOS+, Android и Unity).