從 Vertex AI in Firebase SDK 的預先發布版遷移至 Firebase AI Logic SDK

Swift

1. 在 Xcode 中開啟應用程式專案，然後使用下列任一選項，將 Firebase 套件更新至 12.5.0 以上版本：

   • 方法 1：更新所有套件：依序前往「File」>「Packages」>「Update to Latest Package Versions」。

   • 方法 2：個別更新 Firebase：在「Package Dependencies」部分，前往 Firebase 套件。在 Firebase 套件上按一下滑鼠右鍵，然後選取「Update Package」。

2. 確認 Firebase 套件現在顯示 12.5.0 以上版本。如果沒有，請確認指定的套件需求條件允許更新至 12.5.0 以上版本。

3. 在專案編輯器中選取應用程式的目標，然後前往「Frameworks, Libraries, and Embedded Content」部分。

4. 新增程式庫：選取「+」按鈕，然後從 Firebase 套件新增 FirebaseAILogic。

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:35.1.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:35.1.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. 在 Flutter 專案目錄中執行下列指令，更新 pubspec.yaml 檔案，改用 firebase_ai 套件：

   flutter pub add firebase_ai

2. 重建 Flutter 專案：

   flutter run

3. 完成應用程式遷移後 (請參閱本指南的其餘部分)，請務必刪除舊套件：

   flutter pub remove firebase_vertexai

Unity

「Vertex AI in Firebase」不支援 Unity。

瞭解如何開始使用 Firebase AI Logic SDK for Unity。

Swift

import FirebaseAILogic

// 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-3.8-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-3.8-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-3.8-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-3.8-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-3.8-flash');

Unity

「Vertex AI in Firebase」不支援 Unity。

瞭解如何開始使用 Firebase AI Logic SDK for Unity。

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 欄位變更為可為空值。

• Duration 類別

  • 移除 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 欄位變更為可為空值。

• Duration 類別

  • 移除 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 (而非 Agent Platform Gemini API (formerly Vertex AI)) 時，才需要進行變更：

• 安全性設定

  • 移除不支援的 SafetySetting.method 用途。

• 內嵌資料

  • 移除不支援的 InlineDataPart.videoMetadata 用途。

Dart

• 列舉

  • 已從下列列舉中移除值：HarmCategory、HarmProbability、BlockReason 和 FinishReason。

• 資料部分

  • 將 DataPart 重新命名為 InlineDataPart，並將 static data 函式重新命名為 inlineData，以便與其他平台保持一致。

• 要求選項

  • 由於 timeout 無法運作，因此已移除 RequestOptions。我們會在不久後重新加入，但會移至 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。

瞭解如何開始使用 Firebase AI Logic SDK for Unity。