מעבר לשימוש בגרסה של Vertex AI ב-GA ב-Firebase


Vertex AI in Firebase הושק כגרסה זמינה לכולם (GA) ב-21 באוקטובר 2024.

אם השתמשתם בגרסה המקדימה של ספריית Vertex AI in Firebase (FirebaseVertexAI-Preview), תצטרכו לבצע את השינויים הבאים כדי לשדרג לשימוש בגרסה הרשמית של הספרייה (FirebaseVertexAI).

זו רשימה כללית של השינויים הנדרשים כדי לבצע את ההעברה:

מפעילים את ממשק ה-API הנדרש החדש בפרויקט Firebase (חובה לכולם)

צריך להפעיל את Vertex AI in Firebase API בפרויקט Firebase ולהוסיף אותו לרשימת ההיתרים של מפתח ה-API של Firebase. זהו ממשק API חדש שנדרש כדי להשתמש בגרסה של Vertex AI in Firebase ב-GA.

  1. במסוף Firebase, עוברים לדף Build with Gemini.

  2. בכרטיס Vertex AI in Firebase, לוחצים על תחילת העבודה כדי להפעיל תהליך עבודה שיעזור לכם להפעיל את ה-API הזה ולהוסיף אותו לרשימת ההיתרים של מפתח ה-API של Firebase.

  3. אפשר לדלג על שאר תהליך העבודה במסוף.

מעדכנים את הספרייה לגרסה GA (חובה לכולם)

כדי לעדכן את קוד האפליקציה כך שישתמש בגרסה היציבה של הספרייה:

  1. ב-Xcode, כשפרויקט האפליקציה פתוח, מעדכנים את חבילת Firebase לגרסה 11.4.0 ואילך באמצעות אחת מהאפשרויות הבאות:

    • אפשרות 1: עדכון כל החבילות: עוברים אל קובץ > חבילות > עדכון לגרסאות החבילות העדכניות ביותר.

    • אפשרות 2: מעדכנים את Firebase בנפרד: עוברים לחבילה של Firebase בקטע Package Dependencies. לוחצים לחיצה ימנית על חבילת Firebase ובוחרים באפשרות עדכון החבילה.

  2. מוודאים שחבילת Firebase מופיעה עכשיו בגרסה 11.4.0 ואילך. אם לא, צריך לוודא שדרישות החבילה שציינתם מאפשרות עדכון לגרסה 11.7.0 ואילך.

  3. בוחרים את היעד של האפליקציה בProject Editor, ואז עוברים לקטע Frameworks, Libraries, and Embedded Content.

  4. לוחצים על הלחצן + ומוסיפים את FirebaseVertexAI מחבילת Firebase.

  5. בוחרים באפשרות FirebaseVertexAI-Preview ולוחצים על הלחצן —.

שינויים נוספים (נדרשים בהתאם לתכונות שבהן אתם משתמשים)

הוחלו כמה שינויים בגרסאות GA של ערכות ה-SDK. כדאי לעיין ברשימות הבאות כדי לבדוק אילו שינויים ייתכן שתצטרכו לבצע בקוד כדי להשתמש בגרסת GA של ה-SDK באפליקציה.

  • קריאה לפונקציה
    אם הטמעתם את התכונה הזו לפני GA, תצטרכו לבצע עדכונים באופן שבו אתם מגדירים את הסכימה. מומלץ לעיין במדריך העדכני לקריאה לפונקציות כדי ללמוד איך לכתוב את הצהרות הפונקציות.

  • יצירת פלט מובנה (כמו JSON) באמצעות responseSchema
    אם הטמעתם את התכונה הזו לפני GA, תצטרכו לבצע עדכונים באופן שבו אתם מגדירים את הסכימה. מומלץ לעיין במדריך החדש בנושא פלט מובנה כדי ללמוד איך לכתוב סכימות JSON.

  • Timeout

    • שינינו את ברירת המחדל של הזמן הקצוב לתפוגה של בקשות ל-180 שניות.

  • רשימות ערכים

    • רוב סוגי enum הוחלפו ב-struct עם משתנים סטטיים. השינוי הזה מאפשר גמישות רבה יותר בפיתוח ה-API באופן תואם לאחור. כשמשתמשים בהצהרות switch, עכשיו צריך לכלול מקרה default: כדי לטפל בערכים לא ידועים או לא מטופלים, כולל ערכים חדשים שיתווספו ל-SDK בעתיד.

    • שינית את השם של המניין BlockThreshold ל-HarmBlockThreshold. הסוג הזה הוא עכשיו struct.

    • הוסר המקרה unknown והמקרה unspecified מהרשימות הבאות (עכשיו struct): HarmCategory,‏ HarmBlockThreshold,‏ HarmProbability,‏ BlockReason ו-FinishReason.

    • החלפת המניין ModelContent.Part בפרוטוקול בשם Part כדי לאפשר הוספה של סוגים חדשים באופן תואם לאחור. השינוי הזה מוסבר בפירוט בקטע חלקי תוכן.

  • חלקי תוכן

    • הסרנו את הפרוטוקול ThrowingPartsRepresentable ופשטנו את המאפיינים המפעילים של ModelContent כדי למנוע שגיאות של המהדר. תמונות שלא מקודדות כראוי עדיין יגרמו לשגיאות כשמשתמשים בהן ב-generateContent.

    • החלפתם את המקרים של ModelContent.Part בסוגי struct הבאים שתואמים לפרוטוקול Part:

      • .text עד TextPart
      • .data עד InlineDataPart
      • .fileData עד FileDataPart
      • .functionCall עד FunctionCallPart
      • .functionResponse עד FunctionResponsePart

  • קטגוריית הנזק

    • שינינו את HarmCategory כך שהוא לא יהיה יותר בתצוגת עץ בסוג SafetySetting. אם אתם מתייחסים אליו בתור SafetySetting.HarmCategory, תוכלו להחליף אותו ב-HarmCategory.

  • משוב בנושא בטיחות

    • הסרתם את הסוג SafetyFeedback כי הוא לא שימש באף אחת מהתשובות.

  • מטא-נתונים של הפניות

    • השם של נכס citationSources השתנה ל-citations ב-CitationMetadata.

  • סה"כ תווים לחיוב

    • שינינו את המאפיין totalBillableCharacters ב-CountTokensResponse לאפשרות, כדי לשקף מצבים שבהם לא נשלחים תווים.

  • תגובה של המועמד/ת

    • השם של CandidateResponse שונה ל-Candidate כדי להתאים לפלטפורמות אחרות.

  • הגדרת הדור

    • השינויים שבוצעו בנכסים הציבוריים של GenerationConfig הם internal. אפשר להגדיר אותם ב-initializer.

שגיאות אפשריות שקשורות להעברה

במהלך המעבר לשימוש בגרסה של Vertex AI in Firebase ב-GA, יכול להיות שתבחינו בשגיאות אם לא השלמתם את כל השינויים הנדרשים כפי שמתואר במדריך הזה.

שגיאה 403: Requests to this API firebasevertexai.googleapis.com ... are blocked.

אם מופיעה שגיאת 403 עם הטקסט Requests to this API firebasevertexai.googleapis.com ... are blocked., בדרך כלל המשמעות היא שמפתח ה-API בקובץ או באובייקט התצורה של Firebase לא מכיל ממשק API נדרש ברשימת ההיתרים של המוצר שבו אתם מנסים להשתמש.

חשוב לוודא שמפתח ה-API שבו משתמשת האפליקציה כולל את כל ממשקי ה-API הנדרשים שכלולים ברשימת ההיתרים 'הגבלות API' של המפתח. ב-Vertex AI in Firebase, מפתח ה-API צריך לכלול לפחות את API ‏Vertex AI in Firebase ברשימת ההיתרים שלו. ה-API הזה אמור להתווסף באופן אוטומטי לרשימת ההיתרים של מפתח ה-API כשמפעילים את ה-API החדש דרך מסוף Firebase.

אפשר לראות את כל מפתחות ה-API בחלונית APIs & Services > Credentials במסוף Google Cloud.