Lakukan migrasi untuk menggunakan Vertex AI versi GA di Firebase


Vertex AI in Firebase diluncurkan ke Ketersediaan Umum (GA) pada 21 Oktober 2024.

Jika menggunakan library Vertex AI in Firebase versi beta (firebase-vertexai:16.0.0-betaXX), Anda perlu melakukan perubahan berikut untuk mengupgrade guna menggunakan library versi GA (firebase-vertexai:16.0.0 atau yang lebih tinggi).

Berikut adalah daftar umum perubahan yang diperlukan untuk melakukan migrasi:

Aktifkan API baru yang diperlukan di project Firebase Anda (diperlukan untuk semua orang)

Anda perlu mengaktifkan Vertex AI in Firebase API di project Firebase dan menambahkannya ke daftar yang diizinkan kunci Firebase API Anda. Ini adalah API baru yang diperlukan untuk menggunakan Vertex AI in Firebase versi GA.

  1. Di Firebase console, buka halaman Build with Gemini.

  2. Di kartu Vertex AI in Firebase, klik Mulai untuk meluncurkan alur kerja yang membantu Anda mengaktifkan API ini dan menambahkannya ke daftar yang diizinkan kunci Firebase API Anda.

  3. Anda dapat melewati alur kerja lainnya di konsol.

Mengupdate ke versi GA library (diperlukan untuk semua orang)

Ikuti petunjuk ini untuk mengupdate dependensi Anda agar dapat menggunakan versi terbaru Firebase Android BoM. Penggunaan BoM tidak wajib, tetapi sebaiknya gunakan karena membantu memastikan bahwa aplikasi Anda menggunakan versi yang kompatibel dari setiap library Firebase.

  1. Dalam file Gradle modul (level aplikasi) (biasanya <project>/<app-module>/build.gradle.kts atau <project>/<app-module>/build.gradle), ganti dependensi untuk Vertex AI in Firebase dengan yang berikut:

    // 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.10.0"))

  // Add the dependency for the Vertex AI in Firebase library
  // When using the BoM, you don't specify versions in Firebase library dependencies
  implementation("com.google.firebase:firebase-vertexai")
}

  2. Sinkronkan project Android Anda dengan file Gradle.

Perhatikan bahwa jika Anda memilih untuk tidak menggunakan Firebase BoM, cukup setujui firebase-vertexai versi terbaru yang disarankan oleh Android Studio.

Perubahan lainnya (diperlukan bergantung pada fitur yang Anda gunakan)

Beberapa perubahan diterapkan untuk SDK versi GA. Tinjau daftar berikut untuk mengetahui perubahan yang mungkin perlu Anda buat dalam kode untuk menyesuaikan penggunaan SDK versi GA di aplikasi Anda.

  • Panggilan fungsi
    Jika Anda menerapkan fitur ini sebelum GA, Anda harus melakukan pembaruan pada cara menentukan skema. Sebaiknya tinjau panduan panggilan fungsi yang telah diperbarui untuk mempelajari cara menulis deklarasi fungsi Anda.

  • Membuat output terstruktur (seperti JSON) menggunakan responseSchema
    Jika Anda menerapkan fitur ini sebelum GA, Anda harus melakukan pembaruan pada cara menentukan skema. Sebaiknya tinjau panduan output terstruktur baru untuk mempelajari cara menulis skema JSON.

  • Waktu tunggu

    • Mengubah waktu tunggu default untuk permintaan menjadi 180 detik.

  • Enumerasi

    • Mengganti class enum dan class sealed dengan class reguler. Perubahan ini memungkinkan fleksibilitas yang lebih besar untuk mengembangkan API dengan cara yang kompatibel dengan versi sebelumnya.

    • Mengganti nama enumerasi BlockThreshold menjadi HarmBlockThreshold.

    • Menghapus nilai dari enumerasi berikut: HarmBlockThreshold, HarmProbability, HarmSeverity, BlockReason, dan FinishReason.

  • Metode blob

    • Mengganti nama semua metode yang menyertakan Blob sebagai bagian dari namanya untuk menggunakan InlineData sebagai gantinya.

  • Setelan keamanan

    • Mengubah kolom method menjadi nullable.

  • Class durasi

    • Menghapus semua penggunaan class Duration Kotlin, dan menggantinya dengan long. Perubahan ini memberikan interoperabilitas yang lebih baik dengan Java.

  • Metadata kutipan

    • Menggabungkan semua kolom yang sebelumnya dideklarasikan di CitationMetadata ke dalam class baru yang disebut Citation. Kutipan dapat ditemukan dalam daftar yang disebut citations di CitationMetadata. Perubahan ini memungkinkan penyelarasan jenis yang lebih baik di seluruh platform.

  • Token jumlah

    • Mengubah kolom totalBillableCharacters menjadi nullable.

  • Total karakter yang dapat ditagih

    • Mengubah properti totalBillableCharacters di CountTokensResponse menjadi opsional untuk mencerminkan situasi saat tidak ada karakter yang dikirim.

  • Membuat instance model

    • Memindahkan parameter requestOptions ke akhir daftar parameter agar selaras dengan platform lain.

Kemungkinan error yang terkait dengan migrasi

Saat bermigrasi untuk menggunakan Vertex AI in Firebase versi GA, Anda mungkin mengalami error jika belum menyelesaikan semua perubahan yang diperlukan seperti yang dijelaskan dalam panduan migrasi ini.

Error 403: Requests to this API firebasevertexai.googleapis.com ... are blocked.

Jika Anda menerima error 403 yang bertuliskan Requests to this API firebasevertexai.googleapis.com ... are blocked., biasanya hal ini berarti kunci API dalam file/objek konfigurasi Firebase Anda tidak memiliki API yang diperlukan dalam daftar yang diizinkan untuk produk yang Anda coba gunakan.

Pastikan kunci API yang digunakan oleh aplikasi Anda memiliki semua API yang diperlukan yang disertakan dalam daftar yang diizinkan "pembatasan API" kunci. Untuk Vertex AI in Firebase, kunci API Anda harus memiliki setidaknya Vertex AI in Firebase API dalam daftar yang diizinkan. API ini seharusnya telah ditambahkan secara otomatis ke daftar yang diizinkan kunci API saat Anda mengaktifkan API baru melalui konsol Firebase.

Anda dapat melihat semua kunci API di panel APIs & Services > Credentials di Google Cloud console.