На этой странице приведены рекомендации и соображения по работе с шаблонами запросов на сервере, в том числе функции, которые пока не поддерживаются. Обратите внимание, что многие из этих функций станут доступны по мере развития шаблонов запросов к серверу, поэтому следите за обновлениями в примечаниях к выпуску.
Рекомендации
Многие из этих рекомендаций также подробно описаны в статье Как управлять шаблонами.
Как создавать версии шаблонов
Создайте идентификаторы шаблонов, добавив к ним версию, в которой используется семантическое управление версиями (semver).
Используйте Firebase Remote Config, чтобы легко менять шаблон и другие значения в запросе.
Защита шаблона
Не редактируйте шаблоны, которые используются в рабочей среде, если вы не протестировали изменения.
Заблокируйте шаблон перед запуском в производство.
Блокировка шаблона защищает от случайного редактирования, но не запрещает его полностью. Участник проекта с соответствующими разрешениями всегда может разблокировать шаблон, чтобы отредактировать его.
Рекомендуем блокировать шаблоны, которые активно используются в коде, особенно в рабочем.
Защита использования Gemini API
Настройте надежную проверку входных данных для входных переменных. Это поможет:
- Помогает защититься от внедрения запросов.
- Помогает убедиться, что запросы выполняются успешно, а ответы соответствуют ожиданиям.
Включите в проекте Firebase режим только шаблонов, чтобы все запросы Gemini API через Firebase AI Logic использовали шаблон запроса на сервере.
Функции, которые пока не поддерживаются шаблонами запросов к серверу
Многие из этих функций станут доступны по мере развития шаблонов запросов к серверу, поэтому следите за обновлениями в примечаниях к выпуску.
Возможности Firebase AI Logic, которые пока не поддерживаются шаблонами
Следующие стандартные возможности Firebase AI Logic пока не поддерживаются в шаблонах запросов к серверу:
- Двунаправленная потоковая передача (Gemini Live API)
- Гибридный вывод или вывод на устройстве
- Ограничение выходных данных списком перечислений
Также обратите внимание, что если вы используете ИИ-мониторинг в консоли Firebase, идентификатор шаблона пока не будет указан ни в одной записи.
Общие элементы Dotprompt, которые пока не поддерживаются шаблонами
Шаблоны запросов на сервере скоро будут поддерживать следующие распространенные элементы Dotprompt:
Используйте спецификацию схемы JSON для входных и выходных схем в метаданных.
- Обратите внимание, что эта спецификация также не поддерживается в запросах шаблонов, не связанных с сервером. В настоящее время мы поддерживаем только спецификацию схемы OpenAPI.
Объявление поля с подстановочным знаком с помощью
*.Использование
@keyили итерация по полям входного объекта (в этом случае@keyактуально).Используйте
@root, чтобы ссылаться на контекст корневой переменной независимо от текущегоthis.
Шаблоны запросов на сервере, скорее всего, не будут поддерживать следующие распространенные элементы Dotprompt:
- Использование фрагментов – многократно используемых фрагментов шаблонов, которые можно включать в другие шаблоны.
Дополнительные рекомендации
По умолчанию при использовании пошагового интерфейса в консоли Firebase мы подготавливаем шаблон во всех поддерживаемых регионах для Firebase AI Logic. Если вы используете Agent Platform Gemini API (formerly Vertex AI) и вам нужно ограничить доступ к данным по местоположению, вы можете указать местоположение для шаблона с помощью REST API.
Если вы хотите предоставить шаблон запроса к серверу в виде файла (а не использовать пошаговый интерфейс консоли Firebase), вы можете использовать REST API. Обратите внимание, что шаблоны запросов на сервере не поддерживают схемы, определенные в коде приложения и переданные в шаблон.
Хотя шаблон находится на сервере, он не может напрямую взаимодействовать с другими серверными ресурсами вашего проекта Firebase (например, с базой данных), за исключением URL Cloud Storage for Firebase (которые можно указать в качестве входных переменных).