通过 Vertex AI in Firebase SDK 开始使用 Gemini API

iOS+ Android Web Flutter

本指南介绍了如何开始使用适用于所选平台的 Vertex AI in Firebase SDK 直接从应用调用 Vertex AI Gemini API。

使用 Gemini API 的其他方式

• 可选择试用 Gemini API 的替代“Google AI”版本
  使用 Google AI Studio 和 Google AI 客户端 SDK 免费访问（在可用的情况下，且受限）。 这些 SDK 应仅用于移动应用和 Web 应用中的原型设计。

  熟悉 Gemini API 的运作方式后，请迁移到我们的 Vertex AI in Firebase SDK（本文档）。这些 SDK 提供了许多对移动应用和 Web 应用至关重要的其他功能，例如使用 Firebase App Check 保护 API 免遭滥用，以及支持请求中的大型媒体文件。

• 可选地在服务器端调用 Vertex AI Gemini API（例如使用 Python、Node.js 或 Go）
  对于 Gemini API，请使用服务器端 Vertex AI SDK、Firebase Genkit 或 Firebase Extensions。

请注意，您还可以使用本指南开始使用 Vertex AI in Firebase SDK 访问 Imagen 模型。

前提条件

本指南假定您熟悉如何使用 Flutter 开发应用。

• 确保您的开发环境和 Flutter 应用满足以下要求：

  • Dart 3.2.0 或更高版本

• （可选）查看示例应用。

  下载示例应用

  您可以快速试用该 SDK，查看各种用例的完整实现，或者使用示例应用（如果您没有自己的 Flutter 应用）。如需使用示例应用，您需要将其关联到 Firebase 项目。

第 1 步：设置 Firebase 项目并将应用连接到 Firebase

如果您已有 Firebase 项目和已与 Firebase 相关联的应用

1. 在 Firebase 控制台中，前往使用 Gemini 进行构建页面。

2. 点击 Vertex AI in Firebase 卡片可启动一个工作流，帮助您完成以下任务：

   • 升级您的项目，以使用随用随付 Blaze 定价方案。

   • 在项目中启用所需的 API（Vertex AI API 和 Vertex AI in Firebase API）。

3. 继续执行本指南中的下一步，将 SDK 添加到您的应用。

如果您还没有 Firebase 项目和与 Firebase 关联的应用

设置 Firebase 项目

1. 登录 Firebase 控制台。

2. 点击创建项目，然后使用以下任一方法：

   • 方法 1：在“创建项目”工作流的第一步中输入新项目名称，创建一个全新的 Firebase 项目（该操作会自动创建相应的底层 Google Cloud 项目）。

   • 方法 2：在“创建项目”工作流的第一步中从下拉菜单中选择一个现有 Google Cloud 项目的名称，将 Firebase 添加到该现成的 Google Cloud 项目。

   请注意，如果系统提示您是否要设置 Google Analytics，您无需进行此项设置即可使用 Vertex AI in Firebase SDK。

3. 在 Firebase 控制台中，前往使用 Gemini 进行构建页面。

4. 点击 Vertex AI in Firebase 卡片可启动一个工作流，帮助您完成以下任务：

   • 升级您的项目，以使用随用随付 Blaze 定价方案。

   • 在项目中启用所需的 API（Vertex AI API 和 Vertex AI in Firebase API）。

将您的应用关联至 Firebase

1. 安装所需的命令行工具：

   1. 如果您尚未安装 Firebase CLI，请先安装。

   2. 运行以下命令，使用您的 Google 账号登录 Firebase：

      firebase login
      

   3. 从任何目录运行以下命令来安装 FlutterFire CLI：

      dart pub global activate flutterfire_cli
      

2. 将应用配置为使用 Firebase：

   使用 FlutterFire CLI 将您的 Flutter 应用配置为连接到 Firebase。

   从 Flutter 项目目录运行以下命令，启动应用配置工作流：

   flutterfire configure
   

   此 flutterfire configure 工作流有何用途？

   flutterfire configure 工作流会执行以下操作：

   • 要求您选择 Flutter 应用支持的平台（iOS、Android、Web）。对于每个所选平台，FlutterFire CLI 会在您的 Firebase 项目中创建一个新的 Firebase 应用。

     您可以选择使用现有的 Firebase 项目，也可以创建新的 Firebase 项目。如果您已在现有 Firebase 项目中注册应用，FlutterFire CLI 将根据您当前的 Flutter 项目配置尝试匹配这些应用。

   • 创建一个 Firebase 配置文件 (firebase_options.dart)，并将其添加到 Flutter 应用的 lib/ 目录中。

3. 在本指南的后续步骤中，您将向应用添加 Vertex AI in Firebase SDK，并完成使用该 SDK 和 Gemini API 所需的初始化。

注意 ：我们强烈建议您在 Firebase 控制台中设置 Firebase App Check。如果您只是试用 Gemini API，则无需立即设置 App Check；不过，我们建议您在开始认真开发应用时尽快设置 App Check。

第 2 步：添加 SDK

设置完 Firebase 项目并将应用关联到 Firebase（请参阅上一步）后，您现在可以将 Vertex AI in Firebase SDK 添加到应用了。

iOS+ Android Web Flutter

适用于 Flutter 的 Vertex AI in Firebase 插件 (firebase_vertexai) 提供对 API 的访问权限，以便与 Gemini 和 Imagen 模型交互。

1. 在您的 Flutter 项目目录中，运行以下命令以安装核心插件和 Vertex AI in Firebase 插件：

   flutter pub add firebase_core && flutter pub add firebase_vertexai
   

2. 在 lib/main.dart 文件中，导入您之前生成的 Firebase 核心插件、Vertex AI in Firebase 插件和配置文件：

   import 'package:firebase_core/firebase_core.dart';
   import 'package:firebase_vertexai/firebase_vertexai.dart';
   import 'firebase_options.dart';
   

3. 同样在 lib/main.dart 文件中，使用配置文件导出的 DefaultFirebaseOptions 对象初始化 Firebase：

   await Firebase.initializeApp(
     options: DefaultFirebaseOptions.currentPlatform,
   );
   

4. 重新构建 Flutter 应用：

   flutter run
   

第 3 步：初始化 Vertex AI 服务和生成式模型

您需要先初始化 Vertex AI 服务和生成式模型，然后才能发出任何 API 调用并提示 Gemini 模型。

注意 ：如果您想提示 Imagen 模型，可以参阅使用 Imagen 生成图片，了解如何设置其初始化。

import 'package:firebase_vertexai/firebase_vertexai.dart';
import 'package:firebase_core/firebase_core.dart';
import 'firebase_options.dart';

// Initialize FirebaseApp
await Firebase.initializeApp(
  options: DefaultFirebaseOptions.currentPlatform,
);

// Initialize the Vertex AI service and the generative model
// Specify a model that supports your use case
final model =
      FirebaseVertexAI.instance.generativeModel(model: 'gemini-2.0-flash');

完成本入门指南后，了解如何选择适合您的应用场景和应用的模型和（可选）位置。

第 4 步：向模型发送提示请求

现在，您已将应用与 Firebase 相关联、添加了 SDK，并初始化了 Vertex AI 服务和生成式模型，接下来可以向 Gemini 模型发送提示请求了。

您可以使用 generateContent() 根据纯文本提示请求生成文本：

import 'package:firebase_vertexai/firebase_vertexai.dart';
import 'package:firebase_core/firebase_core.dart';
import 'firebase_options.dart';

await Firebase.initializeApp(
  options: DefaultFirebaseOptions.currentPlatform,
);

// Initialize the Vertex AI service and the generative model
// Specify a model that supports your use case
final model =
      FirebaseVertexAI.instance.generativeModel(model: 'gemini-2.0-flash');

// Provide a prompt that contains text
final prompt = [Content.text('Write a story about a magic backpack.')];

// To generate text output, call generateContent with the text input
final response = await model.generateContent(prompt);
print(response.text);

Gemini API 还可以流式传输响应以加快互动速度，以及处理包含图片、视频和音频等内容的多模态提示。请参阅本页下文中 Gemini API 的所有功能。

如果您收到错误消息，请确保Firebase 项目设置正确，并已启用 Blaze 定价方案和所需的 API。

您还可以执行以下操作

详细了解支持的模型

了解适用于各种用例的模型及其配额和价格。

试用 Gemini API 的其他功能

• 详细了解如何根据仅包含文本的提示生成文本，包括如何流式传输回答。
• 从多模态提示（包括文本、图片、PDF、视频和音频）生成文本。
• 构建多轮对话（聊天）。
• 从文本和多模态提示生成结构化输出（例如 JSON）。
• 使用函数调用将生成式模型连接到外部系统和信息。

了解如何控制内容生成

• 了解提示设计，包括最佳实践、策略和示例提示。
• 配置模型参数，例如温度和输出 token 数上限（适用于 Gemini）或宽高比和人物生成（适用于 Imagen）。
• 使用安全设置来调整收到可能被视为有害的回答的可能性。

您还可以使用 Vertex AI Studio 对提示和模型配置进行实验。

提供有关 Vertex AI in Firebase 使用体验的反馈