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


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

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

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

在 Firebase 项目中启用所需的新 API(所有人都需要)

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

  1. Firebase 控制台中,前往 Build with Gemini 页面

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

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

更新到库的正式版(所有人都需要)

请按照以下说明更新应用的代码库,以使用该库的正式版:

  1. 使用 npm 获取最新版本的 Firebase JS SDK for Web:

    npm i firebase@latest

    yarn add firebase@latest
  2. 无论从何处导入库,都需要更新 import 语句以使用 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。

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

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

  • 超时

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

    • 从以下枚举中移除了值:HarmCategoryBlockThresholdHarmProbabilityHarmSeverityBlockReasonFinishReason
  • 屏蔽原因

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