Migrez pour utiliser la version en disponibilité générale de Vertex AI dans Firebase


Vertex AI in Firebase est disponible pour tous les utilisateurs depuis le 21 octobre 2024.

Si vous avez utilisé la version bêta de la bibliothèque Vertex AI in Firebase (firebase-vertexai:16.0.0-betaXX), vous devez apporter les modifications suivantes pour passer à la version GA de la bibliothèque (firebase-vertexai:16.0.0 ou version ultérieure).

Voici une liste des modifications requises pour la migration:

Activez la nouvelle API requise dans votre projet Firebase (obligatoire pour tous).

Vous devez activer l'API Vertex AI in Firebase dans votre projet Firebase et l'ajouter à la liste d'autorisation de votre clé API Firebase. Il s'agit d'une nouvelle API requise pour utiliser la version GA de Vertex AI in Firebase.

  1. Dans la console Firebase, accédez à la page Build with Gemini (Développer avec Gemini).

  2. Dans la fiche Vertex AI in Firebase, cliquez sur Commencer pour lancer un workflow qui vous aide à activer cette API et à l'ajouter à la liste d'autorisation de votre clé API Firebase.

  3. Vous pouvez ignorer le reste du workflow dans la console.

Passez à la version GA de la bibliothèque (obligatoire pour tous)

Suivez ces instructions pour mettre à jour vos dépendances afin d'utiliser la dernière version de Firebase Android BoM. L'utilisation de BoM n'est pas obligatoire, mais nous vous la recommandons vivement, car elle permet de vous assurer que votre application utilise des versions compatibles de chaque bibliothèque Firebase.

  1. Dans votre fichier Gradle de module (au niveau de l'application) (généralement <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle)), remplacez la dépendance pour Vertex AI in Firebase par la suivante:

    // 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. Synchronisez votre projet Android avec les fichiers Gradle.

Notez que si vous choisissez de ne pas utiliser Firebase BoM, il vous suffit d'accepter la dernière version de firebase-vertexai suggérée par Android Studio.

Modifications supplémentaires (obligatoires selon les fonctionnalités que vous utilisez)

Plusieurs modifications ont été apportées aux versions GA des SDK. Consultez les listes suivantes pour identifier les modifications que vous devrez peut-être apporter à votre code afin d'utiliser la version GA du SDK dans votre application.

  • Appel de fonction
    Si vous avez implémenté cette fonctionnalité avant la version GA, vous devrez modifier la façon dont vous définissez votre schéma. Nous vous recommandons de consulter le guide d'appel de fonction mis à jour pour savoir comment écrire vos déclarations de fonction.

  • Générer une sortie structurée (comme JSON) à l'aide de responseSchema
    Si vous avez implémenté cette fonctionnalité avant la version GA, vous devrez modifier la façon dont vous définissez votre schéma. Nous vous recommandons de consulter le nouveau guide de sortie structurée pour apprendre à écrire des schémas JSON.

  • Délai avant expiration

    • Le délai avant expiration par défaut des requêtes a été défini sur 180 secondes.

  • Énumérations

    • Remplacement des classes enum et sealed par des classes standards. Ce changement offre plus de flexibilité pour faire évoluer l'API de manière rétrocompatible.

    • L'énumération BlockThreshold a été rebaptisée HarmBlockThreshold.

    • Suppression de valeurs des énumérations suivantes: HarmBlockThreshold, HarmProbability, HarmSeverity, BlockReason et FinishReason.

  • Méthodes Blob

    • Toutes les méthodes qui incluaient Blob dans leur nom ont été rebaptisées et utilisent désormais InlineData.

  • Paramètres de sécurité

    • Le champ method est défini comme nullable.

  • Catégorie de durée

    • Suppression de toutes les utilisations de la classe Duration de Kotlin et remplacement par long. Cette modification améliore l'interopérabilité avec Java.

  • Métadonnées de citation

    • Encapsulation de tous les champs précédemment déclarés dans CitationMetadata dans une nouvelle classe appelée Citation. Les citations se trouvent dans la liste appelée citations dans CitationMetadata. Cette modification permet un meilleur alignement des types sur les plates-formes.

  • Compter les jetons

    • Le champ totalBillableCharacters est défini comme nullable.

  • Nombre total de caractères facturables

    • La propriété totalBillableCharacters dans CountTokensResponse a été définie comme facultative pour refléter les situations où aucun caractère n'est envoyé.

  • Instancier un modèle

    • Le paramètre requestOptions a été déplacé à la fin de la liste des paramètres pour s'aligner sur les autres plates-formes.

Erreurs possibles liées à la migration

Lorsque vous passez à la version GA de Vertex AI in Firebase, vous pouvez rencontrer des erreurs si vous n'avez pas effectué toutes les modifications requises, comme décrit dans ce guide de migration.

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

Si vous recevez une erreur 403 indiquant Requests to this API firebasevertexai.googleapis.com ... are blocked., cela signifie généralement que la clé API de votre fichier/objet de configuration Firebase ne contient pas d'API requise dans sa liste d'autorisation pour le produit que vous essayez d'utiliser.

Assurez-vous que la clé API utilisée par votre application inclut toutes les API requises dans la liste d'autorisation "Restrictions d'API" de la clé. Pour Vertex AI in Firebase, votre clé API doit inclure au moins l'API Vertex AI in Firebase dans sa liste d'autorisation. Cette API aurait dû être automatiquement ajoutée à la liste d'autorisation de votre clé API lorsque vous avez activé la nouvelle API via la console Firebase.

Vous pouvez afficher toutes vos clés API dans le panneau API et services > Identifiants de la console Google Cloud.