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


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

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

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

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

  • شناسه‌های الگو را با نسخه‌ای که از نسخه‌بندی معنایی (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»، مکان را برای قالبتان مشخص کنید.

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

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