Zur GA-Version von Vertex AI in Firebase migrieren


Vertex AI in Firebase wurde am 21. Oktober 2024 allgemein verfügbar gemacht.

Wenn Sie die Vorabversion der Vertex AI in Firebase-Bibliothek (FirebaseVertexAI-Preview) verwendet haben, müssen Sie die folgenden Änderungen vornehmen, um auf die GA-Version der Bibliothek (FirebaseVertexAI) umzustellen.

Hier eine allgemeine Liste der für die Migration erforderlichen Änderungen:

Aktivieren Sie die neue erforderliche API in Ihrem Firebase-Projekt (für alle erforderlich)

Sie müssen die Vertex AI in Firebase API in Ihrem Firebase-Projekt aktivieren und sie der Zulassungsliste Ihres Firebase API-Schlüssels hinzufügen. Dies ist eine neue API, die für die Verwendung der GA-Version von Vertex AI in Firebase erforderlich ist.

  1. Rufen Sie in der Firebase Console die Seite Mit Gemini erstellen auf.

  2. Klicken Sie auf der Karte Vertex AI in Firebase auf Jetzt starten, um einen Workflow zu starten, mit dem Sie diese API aktivieren und der Zulassungsliste Ihres Firebase API-Schlüssels hinzufügen können.

  3. Sie können den Rest des Workflows in der Console überspringen.

Auf die GA-Version der Bibliothek aktualisieren (für alle erforderlich)

Folgen Sie dieser Anleitung, um die Codebasis Ihrer App so zu aktualisieren, dass die GA-Version der Bibliothek verwendet wird:

  1. Aktualisieren Sie Ihr Firebase-Paket in Xcode auf Version 11.4.0 oder höher. Verwenden Sie dazu eine der folgenden Optionen:

    • Option 1: Alle Pakete aktualisieren: Gehen Sie zu Datei > Pakete > Auf die neuesten Paketversionen aktualisieren.

    • Option 2: Firebase einzeln aktualisieren: Rufen Sie im Bereich Paketabhängigkeiten das Firebase-Paket auf. Klicken Sie mit der rechten Maustaste auf das Firebase-Paket und wählen Sie Paket aktualisieren aus.

  2. Achten Sie darauf, dass für das Firebase-Paket jetzt Version 11.4.0 oder höher angezeigt wird. Andernfalls prüfen Sie, ob die von Ihnen angegebenen Paketanforderungen ein Update auf Version 11.6.0 oder höher zulassen.

  3. Wählen Sie im Project Editor das Ziel Ihrer App aus und gehen Sie dann zum Bereich Frameworks, Libraries und eingebettete Inhalte.

  4. Wählen Sie die Schaltfläche + aus und fügen Sie dann FirebaseVertexAI aus dem Firebase-Paket hinzu.

  5. Wählen Sie FirebaseVertexAI-Preview aus und drücken Sie die Schaltfläche —.

Weitere Änderungen (je nach verwendeten Funktionen erforderlich)

Für die GA-Versionen der SDKs wurden mehrere Änderungen implementiert. In den folgenden Listen finden Sie alle Änderungen, die Sie möglicherweise an Ihrem Code vornehmen müssen, um die GA-Version des SDK in Ihrer App zu verwenden.

  • Funktionsaufruf
    Wenn Sie diese Funktion vor der allgemeinen Verfügbarkeit implementiert haben, müssen Sie die Definition Ihres Schemas aktualisieren. Weitere Informationen zum Erstellen von Funktionsdeklarationen finden Sie im aktualisierten Leitfaden zu Funktionsaufrufen.

  • Strukturierte Ausgabe (z. B. JSON) mit responseSchema
    generieren Wenn Sie diese Funktion vor der allgemeinen Verfügbarkeit implementiert haben, müssen Sie die Definition Ihres Schemas aktualisieren. Weitere Informationen zum Erstellen von JSON-Schemas finden Sie im neuen Leitfaden für strukturierte Datenausgaben.

  • Zeitlimit

    • Das Standardzeitlimit für Anfragen wurde auf 180 Sekunden geändert.

  • Aufzählungen

    • Die meisten enum-Typen wurden durch struct-Typen mit statischen Variablen ersetzt. Diese Änderung ermöglicht eine größere Flexibilität bei der Weiterentwicklung der API auf rückwärtskompatible Weise. Wenn Sie switch-Anweisungen verwenden, müssen Sie jetzt einen default:-Fall für unbekannte oder nicht verarbeitete Werte angeben, einschließlich neuer Werte, die dem SDK in Zukunft hinzugefügt werden.

    • Die Aufzählung BlockThreshold wurde in HarmBlockThreshold umbenannt. Dieser Typ ist jetzt eine struct.

    • Die Fälle unknown und unspecified wurden aus den folgenden Aufzählungen entfernt (jetzt struct): HarmCategory, HarmBlockThreshold, HarmProbability, BlockReason und FinishReason.

    • Die Aufzählung ModelContent.Part wurde durch ein Protokoll namens Part ersetzt, damit neue Typen auf rückwärtskompatible Weise hinzugefügt werden können. Diese Änderung wird im Abschnitt Inhaltselemente ausführlicher beschrieben.

  • Inhaltselemente

    • Das ThrowingPartsRepresentable-Protokoll wurde entfernt und die Initialisierer für ModelContent wurden vereinfacht, um gelegentliche Compilerfehler zu vermeiden. Bei Bildern, die nicht richtig codiert sind, treten weiterhin Fehler auf, wenn sie in generateContent verwendet werden.

    • Die ModelContent.Part-Fälle wurden durch die folgenden struct-Typen ersetzt, die dem Part-Protokoll entsprechen:

      • .text bis TextPart
      • .data nach InlineDataPart
      • .fileData nach FileDataPart
      • .functionCall nach FunctionCallPart
      • .functionResponse bis FunctionResponsePart

  • Kategorie

    • HarmCategory ist nicht mehr im Typ SafetySetting verschachtelt. Wenn Sie es als SafetySetting.HarmCategory bezeichnen, kann das durch HarmCategory ersetzt werden.

  • Feedback zur Sicherheit

    • Der Typ SafetyFeedback wurde entfernt, da er in keiner der Antworten verwendet wurde.

  • Zitatmetadaten

    • Die Property citationSources wurde in citations in CitationMetadata umbenannt.

  • Abrechnungsfähige Zeichen insgesamt

    • Die Eigenschaft totalBillableCharacters in CountTokensResponse wurde zu einer optionalen Eigenschaft, um Situationen widerzuspiegeln, in denen keine Zeichen gesendet werden.

  • Antwort des Kandidaten

    • CandidateResponse in Candidate umbenannt, um mit anderen Plattformen übereinzustimmen.

  • Konfiguration der Erzeugung

    • Die öffentlichen Eigenschaften von GenerationConfig wurden in internal geändert. Sie können weiterhin in der Initialisiererfunktion konfiguriert werden.

Mögliche Fehler bei der Migration

Wenn Sie zur GA-Version von Vertex AI in Firebase migrieren, können Fehler auftreten, wenn Sie nicht alle erforderlichen Änderungen wie in diesem Migrationsleitfaden beschrieben vorgenommen haben.

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

Wenn Sie den 403-Fehler Requests to this API firebasevertexai.googleapis.com ... are blocked. erhalten, bedeutet das in der Regel, dass der API-Schlüssel in Ihrer Firebase-Konfigurationsdatei/-objekt nicht die erforderliche API auf der Zulassungsliste für das Produkt enthält, das Sie verwenden möchten.

Der von Ihrer App verwendete API-Schlüssel muss alle erforderlichen APIs enthalten, die in der Zulassungsliste „API-Einschränkungen“ des Schlüssels aufgeführt sind. Für Vertex AI in Firebase muss Ihr API-Schlüssel mindestens die Vertex AI in Firebase API auf der Zulassungsliste haben. Diese API sollte der Zulassungsliste Ihres API-Schlüssels automatisch hinzugefügt worden sein, als Sie die neue API über die Firebase-Konsole aktiviert haben.

Sie können alle Ihre API-Schlüssel in der Google Cloud-Console im Bereich APIs & Dienste > Anmeldedaten aufrufen.