Vertex AI in Firebase SDK のプレビュー版から Firebase AI Logic SDK に移行する

Swift

1. Xcode でアプリ プロジェクトを開いたまま、次のいずれかの方法で Firebase パッケージを v12.5.0 以降に更新します。

   • オプション 1: すべてのパッケージを更新する。[File] > [Packages] > [Update to Latest Package Versions] に移動します。

   • オプション 2: Firebase を個別に更新する: [パッケージの依存関係] セクションで Firebase パッケージに移動します。Firebase パッケージを右クリックし、[Update Package] を選択します。

2. Firebase パッケージが v12.5.0 以降になっていることを確認します。そうでない場合は、指定したパッケージ要件で v12.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.0.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.0.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 の最新バージョンを取得します。

   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 のサポートをご利用いただけませんでした。

Unity 向け Firebase AI Logic SDK のスタートガイドをご覧ください。

Swift

• 列挙型

  • ほとんどの enum 型を静的変数を持つ struct に置き換えました。この変更により、下位互換性を維持しながら API を進化させる柔軟性が向上します。switch ステートメントを使用する場合は、将来 SDK に追加される新しい値など、不明な値や処理されない値をカバーするために、default: ケースを含める必要があります。

  • 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 を NULL 値許容フィールドに変更しました。

• Duration クラス

  • Kotlin の Duration クラスの使用をすべて削除し、long に置き換えました。この変更により、Java との相互運用性が向上します。

• 引用メタデータ

  • CitationMetadata で以前に宣言されたすべてのフィールドを Citation という新しいクラスにラップしました。引用は、CitationMetadata の citations というリストにあります。この変更により、プラットフォーム間で型をより適切に調整できるようになります。

• トークンのカウント

  • totalBillableCharacters フィールドを NULL 可能に変更しました。

• 課金対象の合計文字数

  • 文字が送信されない状況を反映するため、CountTokensResponse の totalBillableCharacters プロパティを省略可能に変更しました。

• モデルのインスタンス化

  • 他のプラットフォームと整合性を保つため、requestOptions パラメータをパラメータ リストの末尾に移動しました。

• Live API

  • 列挙型クラス ResponseModality の UNSPECIFIED 値を削除しました。代わりに null を使用します。

  • LiveGenerationConfig.setResponseModalities の名前を LiveGenerationConfig.setResponseModality に変更しました。

  • LiveContentResponse.Status クラスを削除し、ステータス フィールドを LiveContentResponse のプロパティとしてネストしました。

  • LiveContentResponse クラスを削除し、代わりにモデルからのレスポンスと一致する LiveServerMessage のサブクラスを提供しました。

  • ListenableFuture<LiveSession> ではなく ListenableFuture<LiveSessionFutures> を返すように LiveModelFutures.connect を変更しました。

Java

• 列挙型

  • enum クラスと sealed クラスを通常のクラスに置き換えました。この変更により、下位互換性のある方法で API を進化させるための柔軟性が向上します。

  • BlockThreshold 列挙型の名前を HarmBlockThreshold に変更しました。

  • HarmBlockThreshold、HarmProbability、HarmSeverity、BlockReason、FinishReason の列挙型から値を削除しました。

• Blob メソッド

  • 名前に Blob を含むすべてのメソッドの名前を変更し、代わりに InlineData を使用するようにしました。

• 安全に関する設定

  • method を NULL 値許容フィールドに変更しました。

• Duration クラス

  • Kotlin の Duration クラスの使用をすべて削除し、long に置き換えました。この変更により、Java との相互運用性が向上します。

• 引用メタデータ

  • CitationMetadata で以前に宣言されたすべてのフィールドを Citation という新しいクラスにラップしました。引用は、CitationMetadata の citations というリストにあります。この変更により、プラットフォーム間で型をより適切に調整できるようになります。

• トークンのカウント

  • totalBillableCharacters フィールドを NULL 可能に変更しました。

• 課金対象の合計文字数

  • 文字が送信されない状況を反映するため、CountTokensResponse の totalBillableCharacters プロパティを省略可能に変更しました。

• モデルのインスタンス化

  • 他のプラットフォームと整合性を保つため、requestOptions パラメータをパラメータ リストの末尾に移動しました。

• Live API

  • 列挙型クラス ResponseModality の UNSPECIFIED 値を削除しました。代わりに null を使用します。

  • LiveGenerationConfig.setResponseModalities の名前を LiveGenerationConfig.setResponseModality に変更しました。

  • LiveContentResponse.Status クラスを削除し、ステータス フィールドを LiveContentResponse のプロパティとしてネストしました。

  • LiveContentResponse クラスを削除し、代わりにモデルからのレスポンスと一致する LiveServerMessage のサブクラスを提供しました。

  • ListenableFuture<LiveSession> ではなく ListenableFuture<LiveSessionFutures> を返すように LiveModelFutures.connect を変更しました。

• さまざまな Java ビルダー メソッドを変更し、void ではなく、クラスのインスタンスを正しく返すようにしました。

Web

• 列挙型

  • HarmCategory、BlockThreshold、HarmProbability、HarmSeverity、BlockReason、FinishReason の列挙型から値を削除しました。

• ブロックの理由

  • PromptFeedback の blockReason を省略可能に変更しました。

Agent Platform Gemini API (formerly Vertex AI) ではなく Gemini Developer API の使用を開始する場合にのみ変更が必要です。

• 安全に関する設定

  • サポートされていない 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 のスタートガイドをご覧ください。