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


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

اگر از نسخه پیش نمایش Vertex AI in Firebase ( FirebaseVertexAI-Preview ) استفاده کرده اید، باید تغییرات زیر را برای ارتقا برای استفاده از نسخه GA کتابخانه ( FirebaseVertexAI ) انجام دهید.

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

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

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

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

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

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

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

برای به‌روزرسانی پایگاه کد برنامه‌تان برای استفاده از نسخه GA کتابخانه، این دستورالعمل‌ها را دنبال کنید:

  1. در Xcode، با باز بودن پروژه برنامه، بسته Firebase خود را با استفاده از یکی از گزینه‌های زیر به نسخه 11.4.0 یا جدیدتر به‌روزرسانی کنید:

    • گزینه 1 : به روز رسانی همه بسته ها: به File > Packages > Update to Latest Package Versions بروید.

    • گزینه 2 : به‌روزرسانی Firebase به صورت جداگانه: به بسته Firebase در قسمتی به نام Package Dependencies بروید. روی بسته Firebase کلیک راست کنید و سپس Update Package را انتخاب کنید.

  2. مطمئن شوید که بسته Firebase اکنون نسخه 11.4.0 یا بالاتر را نشان می دهد. اگر اینطور نیست، بررسی کنید که بسته مورد نیاز مشخص شده شما اجازه به روز رسانی به نسخه 11.7.0 یا جدیدتر را می دهد.

  3. هدف برنامه خود را در ویرایشگر پروژه انتخاب کنید و سپس به بخش Frameworks, Libraries, and Embedded Content بروید.

  4. دکمه + را انتخاب کنید و سپس FirebaseVertexAI را از بسته Firebase اضافه کنید.

  5. FirebaseVertexAI-Preview را انتخاب کنید و سپس دکمه — را فشار دهید.

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

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

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

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

  • تایم اوت

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

  • شمارش ها

    • بیشتر انواع enum با struct s با متغیرهای استاتیک جایگزین کرد. این تغییر به انعطاف پذیری بیشتری برای تکامل API به روشی سازگار با عقب اجازه می دهد. هنگام استفاده از دستورهای switch ، اکنون باید یک default: case برای پوشش مقادیر ناشناخته یا کنترل نشده، از جمله مقادیر جدیدی که در آینده به SDK اضافه می‌شوند.

    • نام شمارش BlockThreshold به HarmBlockThreshold تغییر نام داد. این نوع در حال حاضر یک struct است.

    • موارد unknown و unspecified را از شمارش‌های زیر حذف کرد (اکنون struct s): 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 تغییر داد. همه آنها در آغازگر قابل تنظیم هستند.

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

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

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