从 Vertex AI in Firebase SDK 的预览版迁移到 Firebase AI Logic SDK

Swift

1. 在 Xcode 中，打开您的应用项目，然后使用以下任一选项将 Firebase 软件包更新到 v11.13.0 或更高版本：

   • 方法 1：更新所有软件包：依次选择 File > Packages > Update to Latest Package Versions。

   • 方法 2：单独更新 Firebase：前往名为软件包依赖项的部分，找到 Firebase 软件包。右键点击 Firebase 软件包，然后选择 Update Package。

2. 确保 Firebase 软件包现在显示 v11.13.0 或更高版本。如果不符合，请验证您指定的软件包要求是否允许更新到 v11.13.0 或更高版本。

3. 在项目编辑器中选择应用的目标，然后前往 Frameworks, Libraries, and Embedded Content（框架、库和嵌入内容）部分。

4. 添加新库：选择 + 按钮，然后从 Firebase 软件包中添加 FirebaseAI。

5. 完成应用迁移（请参阅本指南的其余部分）后，请务必移除旧库：
   选择 FirebaseVertexAI-Preview，然后按 — 按钮。

Kotlin

1. 在您的模块（应用级）Gradle 文件（通常是 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle）中，将旧依赖项（如适用）替换为以下内容。

   请注意，在删除旧依赖项之前，迁移应用的代码库（请参阅本指南的其余部分）可能更容易。

   // BEFORE
   dependencies {
     implementation("com.google.firebase:firebase-vertexai:16.0.0-betaXX")
   }
   
   
   // AFTER
   dependencies {
     // Import the BoM for the Firebase platform
     implementation(platform("com.google.firebase:firebase-bom:33.14.0"))
   
     // Add the dependency for the Firebase AI Logic library
     // When using the BoM, you don't specify versions in Firebase library dependencies
     implementation("com.google.firebase:firebase-ai")
   }

2. 将您的 Android 项目与 Gradle 文件同步。

请注意，如果您选择不使用 Firebase Android BoM，只需为 firebase-ai 库添加依赖项，并接受 Android Studio 建议的最新版本即可。

Java

1. 在您的模块（应用级）Gradle 文件（通常是 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle）中，将旧依赖项（如适用）替换为以下内容。

   请注意，在删除旧依赖项之前，迁移应用的代码库（请参阅本指南的其余部分）可能更容易。

   // BEFORE
   dependencies {
     implementation("com.google.firebase:firebase-vertexai:16.0.0-betaXX")
   }
   
   
   // AFTER
   dependencies {
     // Import the BoM for the Firebase platform
     implementation(platform("com.google.firebase:firebase-bom:33.14.0"))
   
     // Add the dependency for the Firebase AI Logic library
     // When using the BoM, you don't specify versions in Firebase library dependencies
     implementation("com.google.firebase:firebase-ai")
   }

2. 将您的 Android 项目与 Gradle 文件同步。

请注意，如果您选择不使用 Firebase Android BoM，只需为 firebase-ai 库添加依赖项，并接受 Android Studio 建议的最新版本即可。

Web

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

   npm i firebase@latest

   或

   yarn add firebase@latest

2. 在导入该库的所有位置，请更新导入语句，改用 firebase/ai。

   请注意，在删除旧导入内容之前，迁移应用的代码库（请参阅本指南的其余部分）可能更容易。

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

Dart

1. 更新为在 pubspec.yaml 文件中使用 firebase_ai 软件包，方法是在 Flutter 项目目录中运行以下命令：

   flutter pub add firebase_ai

2. 重新构建您的 Flutter 项目：

   flutter run

3. 完成应用迁移（请参阅本指南的其余部分）后，请务必删除旧软件包：

   flutter pub remove firebase_vertexai

Unity

“Vertex AI in Firebase”不支持 Unity。

了解如何开始使用适用于 Unity 的 Firebase AI Logic SDK。

Swift

import FirebaseAI

// Initialize the Gemini Developer API backend service
let ai = FirebaseAI.firebaseAI(backend: .googleAI())

// Create a `GenerativeModel` instance with a model that supports your use case
let model = ai.generativeModel(modelName: "gemini-2.0-flash")

Kotlin

// Initialize the Gemini Developer API backend service
// Create a `GenerativeModel` instance with a model that supports your use case
val model = Firebase.ai(backend = GenerativeBackend.googleAI())
                        .generativeModel("gemini-2.0-flash")

Java

// Initialize the Gemini Developer API backend service
// Create a `GenerativeModel` instance with a model that supports your use case
GenerativeModel ai = FirebaseAI.getInstance(GenerativeBackend.googleAI())
        .generativeModel("gemini-2.0-flash");

// Use the GenerativeModelFutures Java compatibility layer which offers
// support for ListenableFuture and Publisher APIs
GenerativeModelFutures model = GenerativeModelFutures.from(ai);

Web

import { initializeApp } from "firebase/app";
import { getAI, getGenerativeModel, GoogleAIBackend } from "firebase/ai";

// TODO(developer) Replace the following with your app's Firebase configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize FirebaseApp
const firebaseApp = initializeApp(firebaseConfig);

// Initialize the Gemini Developer API backend service
const ai = getAI(firebaseApp, { backend: new GoogleAIBackend() });

// Create a `GenerativeModel` instance with a model that supports your use case
const model = getGenerativeModel(ai, { model: "gemini-2.0-flash" });

Dart

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

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

// Initialize the Gemini Developer API backend service
// Create a `GenerativeModel` instance with a model that supports your use case
final model =
      FirebaseAI.googleAI().generativeModel(model: 'gemini-2.0-flash');

Unity

“Vertex AI in Firebase”不支持 Unity。

了解如何开始使用适用于 Unity 的 Firebase AI Logic SDK。

Swift

• 枚举

  • 将大多数 enum 类型替换成了包含静态变量的 struct。此更改让您能够更灵活地以向后兼容的方式改进 API。现在，使用 switch 语句时，您必须添加 default: 情况来涵盖未知或未处理的值，包括将来添加到 SDK 中的新值。

  • 将 BlockThreshold 枚举重命名为 HarmBlockThreshold；此类型现在是 struct。

  • 从以下枚举（现在是 struct）中移除了 unknown 和 unspecified 情况：HarmCategory、HarmBlockThreshold、HarmProbability、BlockReason 和 FinishReason。

  • 将枚举 ModelContent.Part 替换为名为 Part 的协议，以允许以向后兼容的方式添加新类型。内容部分部分对此变更进行了更详细的介绍。

• 内容部分

  • 移除了 ThrowingPartsRepresentable 协议，并简化了 ModelContent 的初始化程序，以避免偶尔出现编译器错误。未正确编码的图片在 generateContent 中使用时仍会抛出错误。

  • 将 ModelContent.Part 情况替换为符合 Part 协议的以下 struct 类型：

    • .text 到 TextPart
    • .data 至 InlineDataPart
    • .fileData 至 FileDataPart
    • .functionCall 至 FunctionCallPart
    • .functionResponse 到 FunctionResponsePart

• 危害类别

  • 更改了 HarmCategory，使其不再嵌套在 SafetySetting 类型中。如果您将其称为 SafetySetting.HarmCategory，则可以将其替换为 HarmCategory。

• 安全反馈

  • 移除了 SafetyFeedback 类型，因为它未在任何响应中使用。

• 引用元数据

  • 将 CitationMetadata 中的 citationSources 属性重命名为 citations。

• 应计费字符总数

  • 将 CountTokensResponse 中的 totalBillableCharacters 属性更改为可选属性，以反映未发送任何字符的情况。

• 候选回答

  • 将 CandidateResponse 重命名为 Candidate，以与其他平台保持一致。

• 生成配置

  • 将 GenerationConfig 的公开属性更改为 internal。它们仍然可以在初始化程序中进行配置。

Kotlin

• 枚举

  • 将 enum 类和 sealed 类替换为常规类。此更改让您能够更灵活地以向后兼容的方式改进 API。

  • 将 BlockThreshold 枚举重命名为 HarmBlockThreshold。

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

• Blob 方法

  • 重命名了名称中包含 Blob 的所有方法，改为使用 InlineData。

• 安全设置

  • 将 method 字段更改为了可为空字段。

• 时长类

  • 移除了 Kotlin 的 Duration 类的所有用法，并将其替换为 long。此变更可提高与 Java 的互操作性。

• 引用元数据

  • 将之前在 CitationMetadata 中声明的所有字段封装到名为 Citation 的新类中。您可以在 CitationMetadata 中名为 citations 的列表中找到引文。此变更有助于更好地在各个平台上对齐类型。

• 统计词元数

  • 将 totalBillableCharacters 字段更改为了可为空字段。

• 应计费字符总数

  • 将 CountTokensResponse 中的 totalBillableCharacters 属性更改为可选属性，以反映未发送任何字符的情况。

• 实例化模型

  • 将 requestOptions 参数移到了参数列表的末尾，以与其他平台保持一致。

• Live API

  • 移除了枚举类 ResponseModality 的 UNSPECIFIED 值。请改为使用 null。

  • 将 LiveGenerationConfig.setResponseModalities 重命名为了 LiveGenerationConfig.setResponseModality。

  • 移除了 LiveContentResponse.Status 类，改为将状态字段嵌套为 LiveContentResponse 的属性。

  • 移除了 LiveContentResponse 类，改为提供了与模型响应匹配的 LiveServerMessage 子类。

  • 将 LiveModelFutures.connect 更改为返回 ListenableFuture<LiveSessionFutures>，而不是 ListenableFuture<LiveSession>。

Java

• 枚举

  • 将 enum 类和 sealed 类替换为常规类。此更改让您能够更灵活地以向后兼容的方式改进 API。

  • 将 BlockThreshold 枚举重命名为 HarmBlockThreshold。

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

• Blob 方法

  • 重命名了名称中包含 Blob 的所有方法，改为使用 InlineData。

• 安全设置

  • 将 method 字段更改为了可为空字段。

• 时长类

  • 移除了 Kotlin 的 Duration 类的所有用法，并将其替换为 long。此变更可提高与 Java 的互操作性。

• 引用元数据

  • 将之前在 CitationMetadata 中声明的所有字段封装到名为 Citation 的新类中。您可以在 CitationMetadata 中名为 citations 的列表中找到引文。此变更有助于更好地在各个平台上对齐类型。

• 统计词元数

  • 将 totalBillableCharacters 字段更改为了可为空字段。

• 应计费字符总数

  • 将 CountTokensResponse 中的 totalBillableCharacters 属性更改为可选属性，以反映未发送任何字符的情况。

• 实例化模型

  • 将 requestOptions 参数移到了参数列表的末尾，以与其他平台保持一致。

• Live API

  • 移除了枚举类 ResponseModality 的 UNSPECIFIED 值。请改为使用 null。

  • 将 LiveGenerationConfig.setResponseModalities 重命名为了 LiveGenerationConfig.setResponseModality。

  • 移除了 LiveContentResponse.Status 类，改为将状态字段嵌套为 LiveContentResponse 的属性。

  • 移除了 LiveContentResponse 类，改为提供了与模型响应匹配的 LiveServerMessage 子类。

  • 将 LiveModelFutures.connect 更改为返回 ListenableFuture<LiveSessionFutures>，而不是 ListenableFuture<LiveSession>。

• 更改了各种 Java 构建器方法，使其现在正确返回其类的实例，而不是 void。

Web

• 枚举

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

• 屏蔽原因

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

仅当您开始使用 Gemini Developer API（而非 Vertex AI Gemini API）时，才需要进行更改：

• 安全设置

  • 移除了不受支持的 SafetySetting.method 的用法。

• 内嵌数据

  • 移除了不受支持的 InlineDataPart.videoMetadata 的用法。

Dart

• 枚举

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

• 数据部分

  • 将 DataPart 重命名为 InlineDataPart，并将 static data 函数重命名为 inlineData，以便与其他平台保持一致。

• 请求选项

  • 移除了 RequestOptions，因为 timeout 无法正常运行。我们将在不久的将来重新添加此类型，但会将其移至 GenerativeModel 类型，以与其他平台保持一致。

• 停止序列

  • 将 GenerationConfig 中的 stopSequences 参数更改为可选参数，并将其默认值更改为 null（而非空数组）。

• 引用

  • 将 CitationMetadata 中的 citationSources 属性重命名为 citations。CitationSource 类型已重命名为 Citation，以与其他平台保持一致。

• 不必要的公共类型、方法和属性

  • 移除了以下无意中公开的类型、方法和属性：defaultTimeout、CountTokensResponseFields、parseCountTokensResponse、parseEmbedContentResponse、parseGenerateContentResponse、parseContent、BatchEmbedContentsResponse、ContentEmbedding、EmbedContentRequest 和 EmbedContentResponse。

• 统计词元数

  • 从 countTokens 函数中移除了不再需要的额外字段。只需 contents 即可。

• 实例化模型

  • 将 systemInstruction 参数移到了参数列表的末尾，以与其他平台保持一致。

• 嵌入功能

  • 从模型中移除了不受支持的嵌入功能 (embedContent 和 batchEmbedContents)。

Unity

“Vertex AI in Firebase”不支持 Unity。

了解如何开始使用适用于 Unity 的 Firebase AI Logic SDK。