این راهنما به شما نشان میدهد که چگونه میتوانید با استفاده از 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 استفاده کنید.
پیش نیازها
این راهنما فرض میکند که با استفاده از Android Studio برای توسعه برنامهها برای Android آشنا هستید.
اطمینان حاصل کنید که محیط توسعه و برنامه Android شما شرایط زیر را برآورده می کند:
- اندروید استودیو (آخرین نسخه)
- برنامه Android شما باید سطح API 21 یا بالاتر را هدف قرار دهد.
(اختیاری) برنامه نمونه را بررسی کنید.
میتوانید SDK را به سرعت امتحان کنید، اجرای کامل موارد استفاده مختلف را مشاهده کنید، یا اگر برنامه اندرویدی خود را ندارید از برنامه نمونه استفاده کنید. برای استفاده از برنامه نمونه، باید آن را به پروژه 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، که شامل این وظایف است، به گردش کار AI مولد کنسول ادامه دهید:
ثبت برنامه خود در پروژه Firebase
افزودن فایل پیکربندی Firebase شما (
google-services.json
) وپلاگین google-services
Gradle به برنامه شما.
در مراحل بعدی این راهنما، Vertex AI in Firebase SDK را به برنامه خود اضافه میکنید و مقدار اولیه مورد نیاز برای استفاده از SDK و Gemini API را تکمیل میکنید.
مرحله 2 : SDK را اضافه کنید
با راه اندازی پروژه Firebase و اتصال برنامه به Firebase (مرحله قبل را ببینید)، اکنون می توانید Vertex AI in Firebase SDK را به برنامه خود اضافه کنید.
Vertex AI in Firebase SDK for Android ( firebase-vertexai
) دسترسی به Vertex AI Gemini API را فراهم می کند.
در فایل Gradle ماژول (سطح برنامه) خود (مانند <project>/<app-module>/build.gradle.kts
)، وابستگی Vertex AI in Firebase برای Android اضافه کنید. توصیه میکنیم از Firebase Android BoM برای کنترل نسخهسازی کتابخانه استفاده کنید.
Kotlin+KTX
dependencies { // ... other androidx dependencies // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.6.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") }
Java
برای جاوا، باید دو کتابخانه اضافی اضافه کنید.
dependencies { // ... other androidx dependencies // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.6.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") // Required for one-shot operations (to use `ListenableFuture` from Guava Android) implementation("com.google.guava:guava:31.0.1-android") // Required for streaming operations (to use `Publisher` from Reactive Streams) implementation("org.reactivestreams:reactive-streams:1.0.4") }
با استفاده از Firebase Android BoM ، برنامه شما همیشه از نسخههای سازگار کتابخانههای Firebase Android استفاده میکند.
اگر تصمیم گرفتید از Firebase BoM استفاده نکنید، باید هر نسخه کتابخانه Firebase را در خط وابستگی آن مشخص کنید.
توجه داشته باشید که اگر از چندین کتابخانه Firebase در برنامه خود استفاده می کنید، ما قویاً توصیه می کنیم از BoM برای مدیریت نسخه های کتابخانه استفاده کنید، که تضمین می کند همه نسخه ها سازگار هستند.
dependencies { // Add the dependency for the Vertex AI in Firebase library // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-vertexai:16.0.2") }
مرحله 3 : سرویس Vertex AI و مدل مولد را راه اندازی کنید
قبل از اینکه بتوانید تماس API برقرار کنید، باید سرویس Vertex AI و مدل تولیدی را مقداردهی اولیه کنید.
Kotlin+KTX
برای Kotlin، روشهای موجود در این SDK توابع تعلیق هستند و باید از یک محدوده Coroutine فراخوانی شوند.// 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
val generativeModel = Firebase.vertexAI.generativeModel("gemini-1.5-flash")
Java
برای جاوا، روشهای پخش در این SDK یک نوعPublisher
از کتابخانه Reactive Streams برمیگرداند.// 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
GenerativeModel gm = FirebaseVertexAI.getInstance()
.generativeModel("gemini-1.5-flash");
// Use the GenerativeModelFutures Java compatibility layer which offers
// support for ListenableFuture and Publisher APIs
GenerativeModelFutures model = GenerativeModelFutures.from(gm);
وقتی راهنمای شروع کار را تمام کردید، یاد بگیرید که چگونه یک مدل Gemini و (به صورت اختیاری) مکان مناسب برای مورد استفاده و برنامه خود را انتخاب کنید.
مرحله 4 : Vertex AI Gemini API را فراخوانی کنید
اکنون که برنامه خود را به Firebase متصل کردهاید، SDK را اضافه کردهاید و سرویس Vertex AI و مدل تولیدی را راهاندازی کردهاید، آماده فراخوانی Vertex AI Gemini API هستید.
شما می توانید generateContent()
برای تولید متن از یک درخواست اعلان متنی استفاده کنید:
Kotlin+KTX
برای Kotlin، روشهای موجود در این SDK توابع تعلیق هستند و باید از یک محدوده Coroutine فراخوانی شوند.// 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
val generativeModel = Firebase.vertexAI.generativeModel("gemini-1.5-flash")
// Provide a prompt that contains text
val prompt = "Write a story about a magic backpack."
// To generate text output, call generateContent with the text input
val response = generativeModel.generateContent(prompt)
print(response.text)
Java
برای جاوا، روشهای موجود در این SDK یکListenableFuture
برمیگردانند.// 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
GenerativeModel gm = FirebaseVertexAI.getInstance()
.generativeModel("gemini-1.5-flash");
GenerativeModelFutures model = GenerativeModelFutures.from(gm);
// Provide a prompt that contains text
Content prompt = new Content.Builder()
.addText("Write a story about a magic backpack.")
.build();
// To generate text output, call generateContent with the text input
ListenableFuture<GenerateContentResponse> response = model.generateContent(prompt);
Futures.addCallback(response, new FutureCallback<GenerateContentResponse>() {
@Override
public void onSuccess(GenerateContentResponse result) {
String resultText = result.getText();
System.out.println(resultText);
}
@Override
public void onFailure(Throwable t) {
t.printStackTrace();
}
}, executor);
چه کار دیگری می توانید انجام دهید؟
در مورد مدل های جمینی بیشتر بدانید
در مورد مدل های موجود برای موارد استفاده مختلف و سهمیه ها و قیمت آنها اطلاعات کسب کنید.سایر قابلیت های 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 استفاده کنید.
پیش نیازها
این راهنما فرض میکند که با استفاده از Android Studio برای توسعه برنامهها برای Android آشنا هستید.
اطمینان حاصل کنید که محیط توسعه و برنامه Android شما شرایط زیر را برآورده می کند:
- اندروید استودیو (آخرین نسخه)
- برنامه Android شما باید سطح API 21 یا بالاتر را هدف قرار دهد.
(اختیاری) برنامه نمونه را بررسی کنید.
میتوانید SDK را به سرعت امتحان کنید، اجرای کامل موارد استفاده مختلف را مشاهده کنید، یا اگر برنامه اندرویدی خود را ندارید از برنامه نمونه استفاده کنید. برای استفاده از برنامه نمونه، باید آن را به پروژه 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، که شامل این وظایف است، به گردش کار AI مولد کنسول ادامه دهید:
ثبت برنامه خود در پروژه Firebase
افزودن فایل پیکربندی Firebase شما (
google-services.json
) وپلاگین google-services
Gradle به برنامه شما.
در مراحل بعدی این راهنما، Vertex AI in Firebase SDK را به برنامه خود اضافه میکنید و مقدار اولیه مورد نیاز برای استفاده از SDK و Gemini API را تکمیل میکنید.
مرحله 2 : SDK را اضافه کنید
با راه اندازی پروژه Firebase و اتصال برنامه به Firebase (مرحله قبل را ببینید)، اکنون می توانید Vertex AI in Firebase SDK را به برنامه خود اضافه کنید.
Vertex AI in Firebase SDK for Android ( firebase-vertexai
) دسترسی به Vertex AI Gemini API را فراهم می کند.
در فایل Gradle ماژول (سطح برنامه) خود (مانند <project>/<app-module>/build.gradle.kts
)، وابستگی Vertex AI in Firebase برای Android اضافه کنید. توصیه میکنیم از Firebase Android BoM برای کنترل نسخهسازی کتابخانه استفاده کنید.
Kotlin+KTX
dependencies { // ... other androidx dependencies // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.6.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") }
Java
برای جاوا، باید دو کتابخانه اضافی اضافه کنید.
dependencies { // ... other androidx dependencies // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.6.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") // Required for one-shot operations (to use `ListenableFuture` from Guava Android) implementation("com.google.guava:guava:31.0.1-android") // Required for streaming operations (to use `Publisher` from Reactive Streams) implementation("org.reactivestreams:reactive-streams:1.0.4") }
با استفاده از Firebase Android BoM ، برنامه شما همیشه از نسخههای سازگار کتابخانههای Firebase Android استفاده میکند.
اگر تصمیم گرفتید از Firebase BoM استفاده نکنید، باید هر نسخه کتابخانه Firebase را در خط وابستگی آن مشخص کنید.
توجه داشته باشید که اگر از چندین کتابخانه Firebase در برنامه خود استفاده می کنید، ما قویاً توصیه می کنیم از BoM برای مدیریت نسخه های کتابخانه استفاده کنید، که تضمین می کند همه نسخه ها سازگار هستند.
dependencies { // Add the dependency for the Vertex AI in Firebase library // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-vertexai:16.0.2") }
مرحله 3 : سرویس Vertex AI و مدل مولد را راه اندازی کنید
قبل از اینکه بتوانید تماس API برقرار کنید، باید سرویس Vertex AI و مدل تولیدی را مقداردهی اولیه کنید.
Kotlin+KTX
برای Kotlin، روشهای موجود در این SDK توابع تعلیق هستند و باید از یک محدوده Coroutine فراخوانی شوند.// 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
val generativeModel = Firebase.vertexAI.generativeModel("gemini-1.5-flash")
Java
برای جاوا، روشهای پخش در این SDK یک نوعPublisher
از کتابخانه Reactive Streams برمیگرداند.// 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
GenerativeModel gm = FirebaseVertexAI.getInstance()
.generativeModel("gemini-1.5-flash");
// Use the GenerativeModelFutures Java compatibility layer which offers
// support for ListenableFuture and Publisher APIs
GenerativeModelFutures model = GenerativeModelFutures.from(gm);
وقتی راهنمای شروع کار را تمام کردید، یاد بگیرید که چگونه یک مدل Gemini و (به صورت اختیاری) مکان مناسب برای مورد استفاده و برنامه خود را انتخاب کنید.
مرحله 4 : Vertex AI Gemini API را فراخوانی کنید
اکنون که برنامه خود را به Firebase متصل کردهاید، SDK را اضافه کردهاید و سرویس Vertex AI و مدل تولیدی را راهاندازی کردهاید، آماده فراخوانی Vertex AI Gemini API هستید.
شما می توانید generateContent()
برای تولید متن از یک درخواست اعلان متنی استفاده کنید:
Kotlin+KTX
برای Kotlin، روشهای موجود در این SDK توابع تعلیق هستند و باید از یک محدوده Coroutine فراخوانی شوند.// 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
val generativeModel = Firebase.vertexAI.generativeModel("gemini-1.5-flash")
// Provide a prompt that contains text
val prompt = "Write a story about a magic backpack."
// To generate text output, call generateContent with the text input
val response = generativeModel.generateContent(prompt)
print(response.text)
Java
برای جاوا، روشهای موجود در این SDK یکListenableFuture
برمیگردانند.// 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
GenerativeModel gm = FirebaseVertexAI.getInstance()
.generativeModel("gemini-1.5-flash");
GenerativeModelFutures model = GenerativeModelFutures.from(gm);
// Provide a prompt that contains text
Content prompt = new Content.Builder()
.addText("Write a story about a magic backpack.")
.build();
// To generate text output, call generateContent with the text input
ListenableFuture<GenerateContentResponse> response = model.generateContent(prompt);
Futures.addCallback(response, new FutureCallback<GenerateContentResponse>() {
@Override
public void onSuccess(GenerateContentResponse result) {
String resultText = result.getText();
System.out.println(resultText);
}
@Override
public void onFailure(Throwable t) {
t.printStackTrace();
}
}, executor);
چه کار دیگری می توانید انجام دهید؟
در مورد مدل های جمینی بیشتر بدانید
در مورد مدل های موجود برای موارد استفاده مختلف و سهمیه ها و قیمت آنها اطلاعات کسب کنید.سایر قابلیت های Gemini API را امتحان کنید
- درباره ایجاد متن از اعلانهای فقط متنی ، از جمله نحوه پخش جریانی پاسخ، بیشتر بیاموزید.
- متن را از اعلانهای چندوجهی (شامل متن، تصاویر، PDF، ویدئو و صدا) تولید کنید.
- مکالمات چند نوبتی (چت) بسازید.
- خروجی ساختاریافته (مانند JSON) را هم از دستورات متنی و هم از چند وجهی ایجاد کنید.
- از فراخوانی تابع برای اتصال مدل های مولد به سیستم ها و اطلاعات خارجی استفاده کنید.
یاد بگیرید چگونه تولید محتوا را کنترل کنید
- طراحی سریع، از جمله بهترین شیوهها، استراتژیها و درخواستهای نمونه را درک کنید .
- پارامترهای مدل مانند دما و حداکثر نشانه های خروجی را پیکربندی کنید .
- از تنظیمات ایمنی برای تنظیم احتمال دریافت پاسخ هایی که ممکن است مضر تلقی شوند استفاده کنید .
درباره تجربه خود با Vertex AI in Firebase بازخورد بدهید