روال‌های مطلوب و ملاحظات مربوط به الگوها


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

روال‌های مطلوب

بسیاری از این روال‌های مطلوب در مدیریت الگوها نیز به‌طور مفصل شرح داده شده‌اند.

الگوهایتان را نسخه‌بندی کنید

  • شناسه‌های الگویی ایجاد کنید که نسخه‌ای به آن‌ها اضافه شده باشد که از نسخه‌بندی معنایی (semver) استفاده می‌کند.

  • از Firebase Remote Config استفاده کنید تا بتوانید به‌راحتی الگو و مقادیر دیگر را در درخواستتان تغییر دهید.

محافظت از الگو

  • از ویرایش الگوهایی که در تولید استفاده می‌شوند اجتناب کنید، مگراینکه تغییر را به‌طور کامل آزمایش کرده باشید.

  • قبل‌از رفتن به تولید، الگوی خود را قفل کنید.

    • قفل کردن الگو به‌عنوان محافظتی دربرابر ویرایش ناخواسته عمل می‌کند، اما قفل کردن ویرایش را کاملاً مسدود نمی‌کند. عضو پروژه با اجازه‌های مناسب همیشه می‌تواند قفل الگو را برای ویرایش آن باز کند.

    • توصیه می‌کنیم الگوهایی را که به‌طور فعال توسط کد استفاده می‌شوند قفل کنید – به‌ویژه کد تولید.

محافظت از استفاده از Gemini API

  • اعتبارسنجی ورودی قوی برای متغیرهای ورودی‌تان بنویسید که می‌تواند به موارد زیر کمک کند:

    • می‌تواند به محافظت دربرابر تزریق پیام‌واره کمک کند.
    • می‌تواند به اطمینان از موفقیت درخواست‌ها و مطابقت پاسخ‌ها با انتظارات کمک کند.
  • حالت فقط الگو را برای پروژه Firebase خود اعمال کنید تا همه درخواست‌های Gemini API ازطریق Firebase AI Logic ملزم به استفاده از الگوی پیام‌واره سرور باشند.

ویژگی‌هایی که هنوز توسط الگوهای پیام‌واره سرور پشتیبانی نمی‌شوند

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

قابلیت‌های Firebase AI Logic هنوز توسط الگوها پشتیبانی نمی‌شود

قابلیت‌های استاندارد زیر از Firebase AI Logic هنوز ازطریق الگوهای پیام‌واره سرور پشتیبانی نمی‌شوند:

  • جاری‌سازی دوطرفه (Gemini Live API)
  • استنتاج ترکیبی یا درون‌دستگاهی
  • محدود کردن برونداد به فهرستی از شمارش‌ها

همچنین توجه داشته باشید که اگر از پایش هوش مصنوعی در کنسول Firebase استفاده می‌کنید، شناسه الگو هنوز در هیچ سابقه‌ای درج نشده است.

عناصر رایج Dotprompt که هنوز توسط الگوها پشتیبانی نمی‌شوند

الگوهای پیام‌واره سرور احتمالاً به‌زودی از عناصر رایج زیر در Dotprompt پشتیبانی خواهند کرد:

  • استفاده از مشخصات طرحواره JSON برای طرحواره‌های ورودی و خروجی در فرانت‌متر.

    • توجه داشته باشید که این مشخصات در درخواست‌های الگوی غیرسروری نیز پشتیبانی نمی‌شود. درحال‌حاضر فقط از مشخصات طرح‌واره OpenAPI پشتیبانی می‌کنیم.
  • اعلام تعریف فیلد عام بااستفاده از *.

  • استفاده از @key یا به‌طور کلی تکرار کردن فیلدهای ورودی شیء (که در این مورد @key مرتبط است).

  • استفاده از @root، که به شما امکان می‌دهد بدون توجه به this فعلی، به بافت متغیر ریشه ارجاع دهید.

الگوهای پیام‌واره سرور احتمالاً از عناصر رایج Dotprompt زیر پشتیبانی نخواهند کرد:

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

سایر ملاحظات

  • به‌طور پیش‌فرض، وقتی از واسط کاربر راهنمایی‌شده در کنسول Firebase استفاده می‌کنید، الگو را در همه مناطق پشتیبانی‌شده برای Firebase AI Logic تأمین می‌کنیم. اگر از Agent Platform Gemini API (formerly Vertex AI) استفاده می‌کنید و اگر مورد استفاده شما به محدودیت‌های مبتنی بر مکان نیاز دارد، می‌توانید بااستفاده از REST API مکان الگوی خود را مشخص کنید.

  • اگر می‌خواهید الگوی پیام‌واره سرور را به‌صورت فایل ارائه دهید (به‌جای استفاده از واسط کاربر راهنمایی‌شده کنسول Firebase)، می‌توانید از REST API استفاده کنید. توجه داشته باشید که الگوهای پیام‌واره سرور از طرح‌واره تعریف‌شده در کد برنامه و ارسال‌شده به الگو پشتیبانی نمی‌کنند.

  • اگرچه الگو در سرور است، نمی‌تواند مستقیماً با دیگر منابع سمت سرور پروژه Firebase شما (مانند پایگاه داده) تعامل داشته باشد، به‌جز نشانی‌های وب Cloud Storage for Firebase (که می‌توانند به‌عنوان متغیرهای ورودی ارائه شوند).