برای استفاده از نسخه GA Vertex AI در Firebase، مهاجرت برای استفاده از نسخه GA Vertex AI در Firebase


Vertex AI در Firebase در 21 اکتبر 2024 برای دسترسی عمومی (GA) راه اندازی شد.

اگر از نسخه بتا Vertex AI در کتابخانه Firebase ( firebase-vertexai:16.0.0-betaXX ) استفاده کرده‌اید، باید تغییرات زیر را برای ارتقا برای استفاده از نسخه GA کتابخانه ( firebase-vertexai:16.0.0 یا بالاتر) انجام دهید.

در اینجا یک لیست سطح بالا از تغییرات مورد نیاز برای مهاجرت آمده است:

API مورد نیاز جدید را در پروژه Firebase خود فعال کنید (برای همه لازم است)

شما باید Vertex AI را در Firebase API در پروژه Firebase خود فعال کنید و آن را به لیست مجاز کلید Firebase API خود اضافه کنید. این یک API جدید است که برای استفاده از نسخه GA Vertex AI در Firebase لازم است.

  1. در کنسول Firebase ، به صفحه Build with Gemini بروید.

  2. در کارت Vertex AI در Firebase ، روی Get start کلیک کنید تا گردش کاری راه اندازی شود که به شما کمک می کند این API را فعال کنید و آن را به لیست مجاز کلید API Firebase خود اضافه کنید.

  3. می توانید از بقیه گردش کار در کنسول صرف نظر کنید.

به‌روزرسانی به نسخه GA کتابخانه (برای همه لازم است)

برای به‌روزرسانی وابستگی‌های خود برای استفاده از آخرین نسخه Firebase Android BoM این دستورالعمل‌ها را دنبال کنید. استفاده از BoM الزامی نیست، اما ما قویاً استفاده از آن را توصیه می‌کنیم زیرا به اطمینان از اینکه برنامه شما از نسخه‌های سازگار هر کتابخانه Firebase استفاده می‌کند کمک می‌کند.

  1. در فایل Gradle ماژول (سطح برنامه) خود (معمولا <project>/<app-module>/build.gradle.kts یا <project>/<app-module>/build.gradle) ، وابستگی برای Vertex AI در Firebase را با موارد زیر جایگزین کنید:

    // 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. پروژه اندروید خود را با فایل های Gradle همگام سازی کنید.

توجه داشته باشید که اگر تصمیم گرفتید از Firebase BoM استفاده نکنید، فقط آخرین نسخه firebase-vertexai را که توسط Android Studio پیشنهاد شده است، بپذیرید.

تغییرات اضافی (بسته به ویژگی هایی که استفاده می کنید لازم است)

چندین تغییر برای نسخه های GA از SDK ها اعمال شد. فهرست‌های زیر را برای هرگونه تغییری که ممکن است لازم باشد در کد خود انجام دهید تا نسخه GA SDK را در برنامه خود انجام دهید، مرور کنید.

  • فراخوانی تابع
    اگر این ویژگی را قبل از GA پیاده‌سازی کرده‌اید، باید نحوه تعریف طرحواره خود را به‌روزرسانی کنید. توصیه می کنیم راهنمای فراخوانی عملکرد به روز شده را مرور کنید تا نحوه نوشتن اعلان عملکرد خود را بیاموزید.

  • تولید خروجی ساختاریافته (مانند JSON) با استفاده از responseSchema
    اگر این ویژگی را قبل از GA پیاده‌سازی کرده‌اید، باید نحوه تعریف طرحواره خود را به‌روزرسانی کنید. توصیه می‌کنیم راهنمای خروجی ساختاریافته جدید را برای یادگیری نحوه نوشتن طرحواره‌های JSON مرور کنید.

  • تایم اوت

    • مدت زمان پیش‌فرض درخواست‌ها را 180 ثانیه تغییر داد.
  • شمارش ها

    • کلاس‌های enum و کلاس‌های sealed با کلاس‌های معمولی جایگزین شدند. این تغییر به انعطاف پذیری بیشتری برای تکامل API به روشی سازگار با عقب اجازه می دهد.

    • نام شمارش BlockThreshold را به HarmBlockThreshold تغییر داد.

    • مقادیر از شمارش های زیر حذف شد: HarmBlockThreshold ، HarmProbability ، HarmSeverity ، BlockReason ، و FinishReason .

  • روش های لکه ای

    • همه متدهایی را که Blob به عنوان بخشی از نام آن‌ها درج می‌کردند تغییر نام داد تا به جای آن InlineData استفاده کند.
  • تنظیمات ایمنی

    • method فیلد را تغییر داد تا nullable باشد.
  • کلاس مدت

    • تمام موارد استفاده از کلاس Duration Kotlin را حذف کرد و آن را با long جایگزین کرد. این تغییر قابلیت همکاری بهتر با جاوا را فراهم می کند.
  • فراداده استناد

    • تمام فیلدهایی که قبلاً در CitationMetadata اعلام شده بودند را در یک کلاس جدید به نام Citation قرار داد. نقل‌قول‌ها را می‌توان در فهرستی به نام citations در CitationMetadata یافت. این تغییر باعث می شود تا انواع بهتری در بین پلتفرم ها تراز شوند.
  • توکن ها را بشمار

    • فیلد totalBillableCharacters به تهی تغییر داد.
  • مجموع کاراکترهای قابل پرداخت

    • ویژگی totalBillableCharacters را در CountTokensResponse تغییر داد تا برای منعکس کردن موقعیت‌هایی که هیچ کاراکتری ارسال نمی‌شود، اختیاری باشد.
  • نمونه سازی یک مدل

    • پارامتر requestOptions را به انتهای لیست پارامترها منتقل کرد تا با پلتفرم های دیگر تراز شود.

خطاهای احتمالی مربوط به مهاجرت

همانطور که در حال مهاجرت برای استفاده از نسخه GA Vertex AI در Firebase هستید، اگر همه تغییرات مورد نیاز را همانطور که در این راهنمای مهاجرت توضیح داده شده انجام ندهید، ممکن است با خطاهایی روبرو شوید.

خطای 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 در Firebase ، کلید API شما باید حداقل دارای Vertex AI در Firebase API در لیست مجاز خود باشد. زمانی که API جدید را از طریق کنسول Firebase فعال کردید، این API باید به‌طور خودکار به فهرست مجاز کلید API شما اضافه می‌شد.

می‌توانید همه کلیدهای API خود را در APIs & Services > پنل اعتبارنامه‌ها در کنسول Google Cloud مشاهده کنید.