این راهنما به شما نشان می‌دهد که چگونه می‌توانید با استفاده از Vertex AI in Firebase SDK برای پلتفرم انتخابی خود، مستقیماً از برنامه خود با Vertex AI Gemini API تماس بگیرید.
به صورت اختیاری با نسخه جایگزین « Google AI » از Gemini API آزمایش کنید
با استفاده از Google AI Studio و Google AI Client SDK، دسترسی رایگان (در محدوده و در صورت وجود) دریافت کنید. این SDK ها باید فقط برای نمونه سازی در برنامه های موبایل و وب استفاده شوند.بعد از اینکه با نحوه عملکرد Gemini API آشنا شدید، به Vertex AI in Firebase SDK (این مستندات) مهاجرت کنید ، که دارای بسیاری از ویژگی‌های اضافی مهم برای برنامه‌های موبایل و وب هستند، مانند محافظت از API در برابر سوء استفاده با استفاده از Firebase App Check و پشتیبانی از فایل های رسانه ای بزرگ در درخواست ها
به صورت اختیاری Vertex AI Gemini API سمت سرور را فراخوانی کنید (مانند Python، Node.js یا Go)
از Vertex AI SDK ، Firebase Genkit یا Firebase Extensions برای Gemini API استفاده کنید.
پیش نیازها
این راهنما فرض می کند که شما با توسعه برنامه ها با Flutter آشنا هستید.
اطمینان حاصل کنید که محیط توسعه و برنامه Flutter شما شرایط زیر را برآورده می کند:
- دارت 3.2.0+
(اختیاری) برنامه نمونه را بررسی کنید.
می‌توانید SDK را به سرعت امتحان کنید، اجرای کامل موارد استفاده مختلف را مشاهده کنید، یا اگر برنامه Flutter خود را ندارید از برنامه نمونه استفاده کنید. برای استفاده از برنامه نمونه، باید آن را به پروژه Firebase متصل کنید .
مرحله 1 : یک پروژه Firebase راه اندازی کنید و برنامه خود را به Firebase متصل کنید
اگر قبلاً یک پروژه Firebase و یک برنامه متصل به Firebase دارید
در کنسول Firebase ، به صفحه Build with Gemini بروید.
روی Vertex AI in Firebase کلیک کنید تا یک گردش کاری راه اندازی شود که به شما کمک می کند کارهای زیر را انجام دهید:
پروژه خود را ارتقا دهید تا از طرح قیمت گذاری Blaze استفاده کنید.
API های مورد نیاز را در پروژه خود فعال کنید ( Vertex AI API و Vertex AI in Firebase API).
برای افزودن SDK به برنامه خود، مرحله بعدی این راهنما را ادامه دهید.
اگر قبلاً یک پروژه Firebase و یک برنامه متصل به Firebase ندارید
وارد کنسول Firebase شوید.
روی ایجاد پروژه کلیک کنید و سپس از یکی از گزینه های زیر استفاده کنید:
گزینه 1 : با وارد کردن نام پروژه جدید در اولین مرحله از گردش کار «ایجاد پروژه»، یک پروژه کاملاً جدید Firebase (و پروژه Google Cloud زیربنایی آن به صورت خودکار) ایجاد کنید.
گزینه 2 : «افزودن Firebase» به پروژه Google Cloud موجود با انتخاب نام پروژه Google Cloud خود از منوی کشویی در مرحله اول گردش کار «ایجاد پروژه».
توجه داشته باشید که وقتی از شما خواسته شد، برای استفاده از Vertex AI in Firebase SDK نیازی به تنظیم Google Analytics ندارید .
در کنسول Firebase ، به صفحه Build with Gemini بروید.
روی Vertex AI in Firebase کلیک کنید تا یک گردش کاری راه اندازی شود که به شما کمک می کند کارهای زیر را انجام دهید:
پروژه خود را ارتقا دهید تا از طرح قیمت گذاری Blaze استفاده کنید.
API های مورد نیاز را در پروژه خود فعال کنید ( Vertex AI API و Vertex AI in Firebase API).
ابزارهای خط فرمان مورد نیاز را نصب کنید:
اگر قبلاً این کار را نکرده‌اید، Firebase CLI را نصب کنید .
با اجرای دستور زیر با استفاده از حساب Google خود وارد Firebase شوید:
firebase loginFlutterFire CLI را با اجرای دستور زیر از هر دایرکتوری نصب کنید:
dart pub global activate flutterfire_cli
برنامه های خود را برای استفاده از Firebase پیکربندی کنید:
از FlutterFire CLI برای پیکربندی برنامه های Flutter خود برای اتصال به Firebase استفاده کنید.
از دایرکتوری پروژه Flutter خود، دستور زیر را برای شروع گردش کار پیکربندی برنامه اجرا کنید:
flutterfire configureگردش کار
flutterfire configureموارد زیر را انجام می دهد:از شما می‌خواهد پلتفرم‌های پشتیبانی شده (iOS، Android، Web) را در برنامه Flutter خود انتخاب کنید. برای هر پلتفرم انتخاب شده، FlutterFire CLI یک برنامه Firebase جدید در پروژه Firebase شما ایجاد می کند.
می توانید انتخاب کنید که از یک پروژه Firebase موجود استفاده کنید یا یک پروژه Firebase جدید ایجاد کنید. اگر قبلاً برنامه‌هایی را در پروژه Firebase ثبت کرده‌اید، FlutterFire CLI سعی می‌کند آنها را بر اساس پیکربندی پروژه Flutter فعلی شما مطابقت دهد.
یک فایل پیکربندی Firebase (
firebase_options.dart) ایجاد می کند و آن را به دایرکتوریlib/برنامه Flutter شما اضافه می کند.
در مراحل بعدی این راهنما، Vertex AI in Firebase SDK را به برنامه خود اضافه می‌کنید و مقدار اولیه مورد نیاز برای استفاده از SDK و Gemini API را تکمیل می‌کنید.
مرحله 2 : SDK را اضافه کنید
با راه اندازی پروژه Firebase و اتصال برنامه به Firebase (مرحله قبل را ببینید)، اکنون می توانید Vertex AI in Firebase SDK را به برنامه خود اضافه کنید.
پلاگین Vertex AI in Firebase برای Flutter ( firebase_vertexai ) دسترسی به Vertex AI Gemini API را فراهم می کند.
از دایرکتوری پروژه Flutter خود، دستور زیر را برای نصب افزونه هسته و پلاگین Vertex AI in Firebase اجرا کنید:
flutter pub add firebase_core && flutter pub add firebase_vertexaiدر فایل
lib/main.dartخود، افزونه هسته Firebase، پلاگین Vertex AI in Firebase و فایل پیکربندی که قبلاً ایجاد کرده‌اید را وارد کنید:import 'package:firebase_core/firebase_core.dart'; import 'package:firebase_vertexai/firebase_vertexai.dart'; import 'firebase_options.dart';همچنین در فایل
lib/main.dartخود، Firebase را با استفاده از شیDefaultFirebaseOptionsصادر شده توسط فایل پیکربندی مقداردهی اولیه کنید:await Firebase.initializeApp( options: DefaultFirebaseOptions.currentPlatform, );برنامه Flutter خود را بازسازی کنید:
flutter run
مرحله 3 : سرویس Vertex AI و مدل مولد را راه اندازی کنید
قبل از اینکه بتوانید تماس API برقرار کنید، باید سرویس Vertex AI و مدل تولیدی را مقداردهی اولیه کنید.
import 'package:firebase_vertexai/firebase_vertexai.dart';
import 'package:firebase_core/firebase_core.dart';
import 'firebase_options.dart';
// Initialize FirebaseApp
await Firebase.initializeApp(
options: DefaultFirebaseOptions.currentPlatform,
);
// Initialize the Vertex AI service and the generative model
// Specify a model that supports your use case
// Gemini 1.5 models are versatile and can be used with all API capabilities
final model =
FirebaseVertexAI.instance.generativeModel(model: 'gemini-1.5-flash');
وقتی راهنمای شروع کار را تمام کردید، یاد بگیرید که چگونه یک مدل Gemini و (به صورت اختیاری) مکان مناسب برای مورد استفاده و برنامه خود را انتخاب کنید.
مرحله 4 : Vertex AI Gemini API را فراخوانی کنید
اکنون که برنامه خود را به Firebase متصل کرده‌اید، SDK را اضافه کرده‌اید و سرویس Vertex AI و مدل تولیدی را راه‌اندازی کرده‌اید، آماده فراخوانی Vertex AI Gemini API هستید.
شما می توانید generateContent() برای تولید متن از یک درخواست اعلان متنی استفاده کنید:
import 'package:firebase_vertexai/firebase_vertexai.dart';
import 'package:firebase_core/firebase_core.dart';
import 'firebase_options.dart';
await Firebase.initializeApp(
options: DefaultFirebaseOptions.currentPlatform,
);
// Initialize the Vertex AI service and the generative model
// Specify a model that supports your use case
// Gemini 1.5 models are versatile and can be used with all API capabilities
final model =
FirebaseVertexAI.instance.generativeModel(model: 'gemini-1.5-flash');
// Provide a prompt that contains text
final prompt = [Content.text('Write a story about a magic backpack.')];
// To generate text output, call generateContent with the text input
final response = await model.generateContent(prompt);
print(response.text);
چه کار دیگری می توانید انجام دهید؟
در مورد مدل های جمینی بیشتر بدانید
در مورد مدل های موجود برای موارد استفاده مختلف و سهمیه ها و قیمت آنها اطلاعات کسب کنید.سایر قابلیت های Gemini API را امتحان کنید
- درباره ایجاد متن از اعلان‌های فقط متنی ، از جمله نحوه پخش جریانی پاسخ، بیشتر بیاموزید.
- متن را از اعلان‌های چندوجهی (شامل متن، تصاویر، PDF، ویدئو و صدا) تولید کنید.
- مکالمات چند نوبتی (چت) بسازید.
- خروجی ساختاریافته (مانند JSON) را هم از دستورات متنی و هم از چند وجهی ایجاد کنید.
- از فراخوانی تابع برای اتصال مدل های مولد به سیستم ها و اطلاعات خارجی استفاده کنید.
یاد بگیرید چگونه تولید محتوا را کنترل کنید
- طراحی سریع، از جمله بهترین شیوه‌ها، استراتژی‌ها و درخواست‌های نمونه را درک کنید .
- پارامترهای مدل مانند دما و حداکثر نشانه های خروجی را پیکربندی کنید .
- از تنظیمات ایمنی برای تنظیم احتمال دریافت پاسخ هایی که ممکن است مضر تلقی شوند استفاده کنید .
درباره تجربه خود با Vertex AI in Firebase بازخورد بدهید
این راهنما به شما نشان می‌دهد که چگونه می‌توانید با استفاده از Vertex AI in Firebase SDK برای پلتفرم انتخابی خود، مستقیماً از برنامه خود با Vertex AI Gemini API تماس بگیرید.
به صورت اختیاری با نسخه جایگزین « Google AI » از Gemini API آزمایش کنید
با استفاده از Google AI Studio و Google AI Client SDK، دسترسی رایگان (در محدوده و در صورت وجود) دریافت کنید. این SDK ها باید فقط برای نمونه سازی در برنامه های موبایل و وب استفاده شوند.بعد از اینکه با نحوه عملکرد Gemini API آشنا شدید، به Vertex AI in Firebase SDK (این مستندات) مهاجرت کنید ، که دارای بسیاری از ویژگی‌های اضافی مهم برای برنامه‌های موبایل و وب هستند، مانند محافظت از API در برابر سوء استفاده با استفاده از Firebase App Check و پشتیبانی از فایل های رسانه ای بزرگ در درخواست ها
به صورت اختیاری Vertex AI Gemini API سمت سرور را فراخوانی کنید (مانند Python، Node.js یا Go)
از Vertex AI SDK ، Firebase Genkit یا Firebase Extensions برای Gemini API استفاده کنید.
پیش نیازها
این راهنما فرض می کند که شما با توسعه برنامه ها با Flutter آشنا هستید.
اطمینان حاصل کنید که محیط توسعه و برنامه Flutter شما شرایط زیر را برآورده می کند:
- دارت 3.2.0+
(اختیاری) برنامه نمونه را بررسی کنید.
می‌توانید SDK را به سرعت امتحان کنید، اجرای کامل موارد استفاده مختلف را مشاهده کنید، یا اگر برنامه Flutter خود را ندارید از برنامه نمونه استفاده کنید. برای استفاده از برنامه نمونه، باید آن را به پروژه Firebase متصل کنید .
مرحله 1 : یک پروژه Firebase راه اندازی کنید و برنامه خود را به Firebase متصل کنید
اگر قبلاً یک پروژه Firebase و یک برنامه متصل به Firebase دارید
در کنسول Firebase ، به صفحه Build with Gemini بروید.
روی Vertex AI in Firebase کلیک کنید تا یک گردش کاری راه اندازی شود که به شما کمک می کند کارهای زیر را انجام دهید:
پروژه خود را ارتقا دهید تا از طرح قیمت گذاری Blaze استفاده کنید.
API های مورد نیاز را در پروژه خود فعال کنید ( Vertex AI API و Vertex AI in Firebase API).
برای افزودن SDK به برنامه خود، مرحله بعدی این راهنما را ادامه دهید.
اگر قبلاً یک پروژه Firebase و یک برنامه متصل به Firebase ندارید
وارد کنسول Firebase شوید.
روی ایجاد پروژه کلیک کنید و سپس از یکی از گزینه های زیر استفاده کنید:
گزینه 1 : با وارد کردن نام پروژه جدید در اولین مرحله از گردش کار «ایجاد پروژه»، یک پروژه کاملاً جدید Firebase (و پروژه Google Cloud زیربنایی آن به صورت خودکار) ایجاد کنید.
گزینه 2 : «افزودن Firebase» به پروژه Google Cloud موجود با انتخاب نام پروژه Google Cloud خود از منوی کشویی در مرحله اول گردش کار «ایجاد پروژه».
توجه داشته باشید که وقتی از شما خواسته شد، برای استفاده از Vertex AI in Firebase SDK نیازی به تنظیم Google Analytics ندارید .
در کنسول Firebase ، به صفحه Build with Gemini بروید.
روی Vertex AI in Firebase کلیک کنید تا یک گردش کاری راه اندازی شود که به شما کمک می کند کارهای زیر را انجام دهید:
پروژه خود را ارتقا دهید تا از طرح قیمت گذاری Blaze استفاده کنید.
API های مورد نیاز را در پروژه خود فعال کنید ( Vertex AI API و Vertex AI in Firebase API).
ابزارهای خط فرمان مورد نیاز را نصب کنید:
اگر قبلاً این کار را نکرده‌اید، Firebase CLI را نصب کنید .
با اجرای دستور زیر با استفاده از حساب Google خود وارد Firebase شوید:
firebase loginFlutterFire CLI را با اجرای دستور زیر از هر دایرکتوری نصب کنید:
dart pub global activate flutterfire_cli
برنامه های خود را برای استفاده از Firebase پیکربندی کنید:
از FlutterFire CLI برای پیکربندی برنامه های Flutter خود برای اتصال به Firebase استفاده کنید.
از دایرکتوری پروژه Flutter خود، دستور زیر را برای شروع گردش کار پیکربندی برنامه اجرا کنید:
flutterfire configureگردش کار
flutterfire configureموارد زیر را انجام می دهد:از شما می‌خواهد پلتفرم‌های پشتیبانی شده (iOS، Android، Web) را در برنامه Flutter خود انتخاب کنید. برای هر پلتفرم انتخاب شده، FlutterFire CLI یک برنامه Firebase جدید در پروژه Firebase شما ایجاد می کند.
می توانید انتخاب کنید که از یک پروژه Firebase موجود استفاده کنید یا یک پروژه Firebase جدید ایجاد کنید. اگر قبلاً برنامه‌هایی را در پروژه Firebase ثبت کرده‌اید، FlutterFire CLI سعی می‌کند آنها را بر اساس پیکربندی پروژه Flutter فعلی شما مطابقت دهد.
یک فایل پیکربندی Firebase (
firebase_options.dart) ایجاد می کند و آن را به دایرکتوریlib/برنامه Flutter شما اضافه می کند.
در مراحل بعدی این راهنما، Vertex AI in Firebase SDK را به برنامه خود اضافه می‌کنید و مقدار اولیه مورد نیاز برای استفاده از SDK و Gemini API را تکمیل می‌کنید.
مرحله 2 : SDK را اضافه کنید
با راه اندازی پروژه Firebase و اتصال برنامه به Firebase (مرحله قبل را ببینید)، اکنون می توانید Vertex AI in Firebase SDK را به برنامه خود اضافه کنید.
پلاگین Vertex AI in Firebase برای Flutter ( firebase_vertexai ) دسترسی به Vertex AI Gemini API را فراهم می کند.
از دایرکتوری پروژه Flutter خود، دستور زیر را برای نصب افزونه هسته و پلاگین Vertex AI in Firebase اجرا کنید:
flutter pub add firebase_core && flutter pub add firebase_vertexaiدر فایل
lib/main.dartخود، افزونه هسته Firebase، پلاگین Vertex AI in Firebase و فایل پیکربندی که قبلاً ایجاد کرده‌اید را وارد کنید:import 'package:firebase_core/firebase_core.dart'; import 'package:firebase_vertexai/firebase_vertexai.dart'; import 'firebase_options.dart';همچنین در فایل
lib/main.dartخود، Firebase را با استفاده از شیDefaultFirebaseOptionsصادر شده توسط فایل پیکربندی مقداردهی اولیه کنید:await Firebase.initializeApp( options: DefaultFirebaseOptions.currentPlatform, );برنامه Flutter خود را بازسازی کنید:
flutter run
مرحله 3 : سرویس Vertex AI و مدل مولد را راه اندازی کنید
قبل از اینکه بتوانید تماس API برقرار کنید، باید سرویس Vertex AI و مدل تولیدی را مقداردهی اولیه کنید.
import 'package:firebase_vertexai/firebase_vertexai.dart';
import 'package:firebase_core/firebase_core.dart';
import 'firebase_options.dart';
// Initialize FirebaseApp
await Firebase.initializeApp(
options: DefaultFirebaseOptions.currentPlatform,
);
// Initialize the Vertex AI service and the generative model
// Specify a model that supports your use case
// Gemini 1.5 models are versatile and can be used with all API capabilities
final model =
FirebaseVertexAI.instance.generativeModel(model: 'gemini-1.5-flash');
وقتی راهنمای شروع کار را تمام کردید، یاد بگیرید که چگونه یک مدل Gemini و (به صورت اختیاری) مکان مناسب برای مورد استفاده و برنامه خود را انتخاب کنید.
مرحله 4 : Vertex AI Gemini API را فراخوانی کنید
اکنون که برنامه خود را به Firebase متصل کرده‌اید، SDK را اضافه کرده‌اید و سرویس Vertex AI و مدل تولیدی را راه‌اندازی کرده‌اید، آماده فراخوانی Vertex AI Gemini API هستید.
شما می توانید generateContent() برای تولید متن از یک درخواست اعلان متنی استفاده کنید:
import 'package:firebase_vertexai/firebase_vertexai.dart';
import 'package:firebase_core/firebase_core.dart';
import 'firebase_options.dart';
await Firebase.initializeApp(
options: DefaultFirebaseOptions.currentPlatform,
);
// Initialize the Vertex AI service and the generative model
// Specify a model that supports your use case
// Gemini 1.5 models are versatile and can be used with all API capabilities
final model =
FirebaseVertexAI.instance.generativeModel(model: 'gemini-1.5-flash');
// Provide a prompt that contains text
final prompt = [Content.text('Write a story about a magic backpack.')];
// To generate text output, call generateContent with the text input
final response = await model.generateContent(prompt);
print(response.text);
چه کار دیگری می توانید انجام دهید؟
در مورد مدل های جمینی بیشتر بدانید
در مورد مدل های موجود برای موارد استفاده مختلف و سهمیه ها و قیمت آنها اطلاعات کسب کنید.سایر قابلیت های Gemini API را امتحان کنید
- درباره ایجاد متن از اعلان‌های فقط متنی ، از جمله نحوه پخش جریانی پاسخ، بیشتر بیاموزید.
- متن را از اعلان‌های چندوجهی (شامل متن، تصاویر، PDF، ویدئو و صدا) تولید کنید.
- مکالمات چند نوبتی (چت) بسازید.
- خروجی ساختاریافته (مانند JSON) را هم از دستورات متنی و هم از چند وجهی ایجاد کنید.
- از فراخوانی تابع برای اتصال مدل های مولد به سیستم ها و اطلاعات خارجی استفاده کنید.
یاد بگیرید چگونه تولید محتوا را کنترل کنید
- طراحی سریع، از جمله بهترین شیوه‌ها، استراتژی‌ها و درخواست‌های نمونه را درک کنید .
- پارامترهای مدل مانند دما و حداکثر نشانه های خروجی را پیکربندی کنید .
- از تنظیمات ایمنی برای تنظیم احتمال دریافت پاسخ هایی که ممکن است مضر تلقی شوند استفاده کنید .
درباره تجربه خود با Vertex AI in Firebase بازخورد بدهید