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


Vertex AI in Firebase est disponible en disponibilité générale (DG) depuis le 21 octobre 2024.

Si vous avez utilisé la version Preview de la bibliothèque Vertex AI in Firebase (FirebaseVertexAI-Preview), vous devez apporter les modifications suivantes pour passer à la version GA de la bibliothèque (FirebaseVertexAI).

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 Vertex AI.

  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 le code de base de votre application afin qu'elle utilise la version GA de la bibliothèque:

  1. Dans Xcode, à partir de votre projet d'application ouvert, mettez à jour votre package Firebase vers la version 11.4.0 ou ultérieure à l'aide de l'une des options suivantes:

    • Option 1: Mettre à jour tous les packages: accédez à File > Packages > Update to Latest Package Versions (Fichier > Packages > Mettre à jour vers les dernières versions des packages).

    • Option 2: Mettre à jour Firebase individuellement: accédez au package Firebase dans la section Dépendances de package. Effectuez un clic droit sur le package Firebase, puis sélectionnez Mettre à jour le package.

  2. Assurez-vous que le package Firebase affiche désormais la version 11.4.0 ou ultérieure. Si ce n'est pas le cas, vérifiez que les exigences concernant les packages que vous avez spécifiées permettent la mise à niveau vers la version 11.9.0 ou ultérieure.

  3. Sélectionnez la cible de votre application dans l'éditeur de projet, puis accédez à la section Frameworks, bibliothèques et contenus intégrés.

  4. Sélectionnez le bouton +, puis ajoutez FirebaseVertexAI à partir du package Firebase.

  5. Sélectionnez FirebaseVertexAI-Preview, puis appuyez sur le bouton —.

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

    • La plupart des types enum ont été remplacés par des struct avec des variables statiques. Ce changement offre plus de flexibilité pour faire évoluer l'API de manière rétrocompatible. Lorsque vous utilisez des instructions switch, vous devez désormais inclure un cas default: pour couvrir les valeurs inconnues ou non gérées, y compris les nouvelles valeurs ajoutées au SDK à l'avenir.

    • Renommage de l'énumération BlockThreshold en HarmBlockThreshold. Ce type est désormais un struct.

    • Suppression des cas unknown et unspecified des énumérations suivantes (désormais struct): HarmCategory, HarmBlockThreshold, HarmProbability, BlockReason et FinishReason.

    • Remplacement de l'énumération ModelContent.Part par un protocole nommé Part pour permettre l'ajout de nouveaux types de manière rétrocompatible. Ce changement est décrit plus en détail dans la section Parties de contenu.

  • Parties de contenu

    • Suppression du protocole ThrowingPartsRepresentable et simplification des initialisateurs pour ModelContent afin d'éviter les erreurs de compilation occasionnelles. Les images qui ne sont pas correctement encodées génèrent toujours des erreurs lorsqu'elles sont utilisées dans generateContent.

    • Remplacement des cas ModelContent.Part par les types struct suivants conformes au protocole Part:

      • De .text à TextPart
      • De .data à InlineDataPart
      • De .fileData à FileDataPart
      • De .functionCall à FunctionCallPart
      • De .functionResponse à FunctionResponsePart

  • Catégorie de préjudice

    • Modification de HarmCategory pour qu'il ne soit plus imbriqué dans le type SafetySetting. Si vous utilisez SafetySetting.HarmCategory, vous pouvez le remplacer par HarmCategory.

  • Commentaires sur la sécurité

    • Suppression du type SafetyFeedback, car il n'a été utilisé dans aucune des réponses.

  • Métadonnées de citation

    • Remplacement de la propriété citationSources par citations dans CitationMetadata.

  • 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é.

  • Réponse du candidat

    • CandidateResponse a été renommé Candidate pour correspondre aux autres plates-formes.

  • Configuration de la génération

    • Remplacement des propriétés publiques de GenerationConfig par internal. Ils restent tous configurables dans l'initialiseur.

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.