迁移到使用 Vertex AI in Firebase 的 GA 版


Vertex AI in Firebase 已于 2024 年 10 月 21 日发布正式版 (GA)。

如果您使用的是 Vertex AI in Firebase 库的预览版 (firebase/vertexai-preview)，则需要进行以下更改，才能升级为使用该库的 GA 版 (firebase/vertexai)。

下面简要列出了迁移所需的更改：

在 Firebase 项目中启用新的必需 API（对所有人均为必需）

您需要在 Firebase 项目中启用 Vertex AI in Firebase API，并将其添加到 Firebase API 密钥的许可名单中。这是新推出的 API，必须使用 Vertex AI in Firebase 的 GA 版本。

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

  2. 在 Vertex AI in Firebase 卡片中，点击开始以启动工作流，该工作流可帮助您启用此 API 并将其添加到 Firebase API 密钥的许可名单中。

  3. 您可以在控制台中跳过工作流的其余部分。

更新到该库的 GA 版本（所有开发者都必须更新）

请按照以下说明更新应用的代码库，以使用该库的 GA 版本：

  1. 使用 npm 获取最新版 Firebase JS SDK for Web：

    npm i firebase@latest

    或

    yarn add firebase@latest

  2. 在导入该库的任何位置，更新导入语句以使用 firebase/vertexai：

    // BEFORE
import { initializeApp } from "firebase/app";
import { getVertexAI, getGenerativeModel } from "firebase/vertexai-preview";

// AFTER
import { initializeApp } from "firebase/app";
import { getVertexAI, getGenerativeModel } from "firebase/vertexai";

其他更改（根据您使用的功能而定）

我们对 SDK 的 GA 版本进行了多项更改。请查看以下列表，了解您可能需要在代码中进行哪些更改，以便在应用中使用 GA 版 SDK。

  • 函数调用
    如果您在 GA 之前实现了此功能，则需要更新架构定义方式。建议您查看更新后的函数调用指南，了解如何编写函数声明。

  • 使用 responseSchema 生成结构化输出（例如 JSON）
    如果您在 GA 发布之前实现了此功能，则需要更新架构定义方式。建议您查看新的结构化输出指南，了解如何编写 JSON 架构。

  • 超时

    • 将请求的默认超时时间更改为 180 秒。

  • 枚举

    • 从以下枚举中移除了值：HarmCategory、BlockThreshold、HarmProbability、HarmSeverity、BlockReason 和 FinishReason。

  • 屏蔽原因

    • 将 PromptFeedback 中的 blockReason 更改为可选。

与迁移相关的可能错误

在迁移到 GA 版 Vertex AI in Firebase 时，如果您尚未完成本迁移指南中所述的所有必要更改，可能会遇到错误。

403 错误：Requests to this API firebasevertexai.googleapis.com ... are blocked.

如果您收到内容为 Requests to this API firebasevertexai.googleapis.com ... are blocked. 的 403 错误，通常表示 Firebase 配置文件/对象中的 API 密钥在其许可名单中没有您尝试使用的商品的必需 API。

请确保您的应用使用的 API 密钥包含密钥“API 限制”许可名单中的所有必需 API。对于 Vertex AI in Firebase，您的 API 密钥的许可名单中至少需要包含 Vertex AI in Firebase API。当您通过 Firebase 控制台启用新 API 时，此 API 应已自动添加到 API 密钥的许可名单中。

您可以在 Google Cloud 控制台的 API 和服务 > 凭据面板中查看所有 API 密钥。