این راهنما به شما نشان می دهد که چگونه می توانید با استفاده از Vertex AI SDK برای Firebase مستقیماً از برنامه خود تماس با Gemini API را شروع کنید.
پیش نیازها
این راهنما فرض میکند که شما با استفاده از Xcode برای توسعه برنامهها برای پلتفرمهای اپل (مانند iOS) آشنا هستید.
اطمینان حاصل کنید که محیط توسعه و برنامه پلتفرم های اپل شرایط زیر را برآورده می کند:
- Xcode 15.0 یا بالاتر
- برنامه شما باید iOS 15 یا بالاتر یا macOS 12 یا بالاتر را هدف قرار دهد.
(اختیاری) برنامه نمونه را بررسی کنید.
میتوانید SDK را به سرعت امتحان کنید، اجرای کامل موارد استفاده مختلف را مشاهده کنید، یا اگر برنامه پلتفرمهای اپل خود را ندارید از برنامه نمونه استفاده کنید. برای استفاده از برنامه نمونه، باید آن را به پروژه Firebase متصل کنید .
مرحله 1 : یک پروژه Firebase راه اندازی کنید و برنامه خود را به Firebase متصل کنید
اگر قبلاً یک پروژه Firebase و یک برنامه متصل به Firebase دارید
در کنسول Firebase، به صفحه Build with Gemini بروید و سپس روی کارت دوم کلیک کنید تا یک گردش کاری راه اندازی شود که به شما در انجام کارهای زیر کمک می کند. اگر طرح کارت را نمیبینید، این کارها کامل شدهاند.
پروژه خود را ارتقا دهید تا از طرح قیمت گذاری پرداختی Blaze استفاده کنید.
دو API زیر را برای پروژه خود فعال کنید:
aiplatform.googleapis.com
وfirebaseml.googleapis.com
.
برای افزودن SDK به برنامه خود، مرحله بعدی این راهنما را ادامه دهید.
اگر قبلاً یک پروژه Firebase و یک برنامه متصل به Firebase ندارید
وارد کنسول Firebase شوید.
روی ایجاد پروژه کلیک کنید و سپس از یکی از گزینه های زیر استفاده کنید:
گزینه 1 : با وارد کردن نام پروژه جدید در اولین مرحله از گردش کار «ایجاد پروژه»، یک پروژه کاملاً جدید Firebase (و پروژه Google Cloud زیربنایی آن به صورت خودکار) ایجاد کنید.
گزینه 2 : «افزودن Firebase» به پروژه Google Cloud موجود با انتخاب نام پروژه Google Cloud خود از منوی کشویی در مرحله اول گردش کار «ایجاد پروژه».
توجه داشته باشید که وقتی از شما خواسته شد، برای استفاده از Vertex AI SDKs برای Firebase نیازی به تنظیم Google Analytics ندارید .
در کنسول Firebase، به صفحه Build with Gemini بروید و سپس روی کارت دوم کلیک کنید تا یک گردش کاری راه اندازی شود که به شما در انجام کارهای زیر کمک می کند. اگر طرح کارت را نمیبینید، این کارها کامل شدهاند.
پروژه خود را ارتقا دهید تا از طرح قیمت گذاری پرداختی Blaze استفاده کنید.
دو API زیر را برای پروژه خود فعال کنید:
aiplatform.googleapis.com
وfirebaseml.googleapis.com
.
برای اتصال برنامه خود به Firebase، که شامل این وظایف است، به گردش کار AI مولد کنسول ادامه دهید:
ثبت برنامه خود در پروژه Firebase
افزودن فایل پیکربندی Firebase شما (
GoogleService-Info.plist
) به برنامه شما.
در مراحل بعدی این راهنما، Vertex AI SDK for Firebase را به برنامه خود اضافه میکنید و مقدار اولیه مورد نیاز را برای استفاده از SDK و Gemini API تکمیل میکنید.
مرحله 2 : SDK را اضافه کنید
با راه اندازی پروژه Firebase و اتصال برنامه به Firebase (مرحله قبل را ببینید)، اکنون می توانید Vertex AI SDK for Firebase را به برنامه خود اضافه کنید.
Vertex AI SDK for Firebase دسترسی به Gemini API را فراهم می کند و به عنوان بخشی از Firebase SDK برای پلتفرم های اپل ( firebase-ios-sdk
) در شاخه vertexai-preview-0.1.0
گنجانده شده است. برای استفاده از Vertex AI SDK، باید از Swift Package Manager برای نصب و مدیریت وابستگی های Firebase استفاده کنید. سایر مدیران بسته، مانند CocoaPods، در حال حاضر پشتیبانی نمی شوند.
دستورالعملهای مربوط به نصب بسته Firebase را در پروژه Xcode خود مشاهده کنید:
در Xcode، با باز بودن پروژه برنامه، به File > Add Packages بروید.
در کادر Search یا Enter Package URL ، URL مخزن را وارد کنید
https://github.com/firebase/firebase-ios-sdk
.برای قانون وابستگی ، Branch را از منوی کشویی انتخاب کنید و سپس شاخه را روی
قرار دهید.vertexai-preview-0.1.0 روی افزودن بسته کلیک کنید.
کتابخانه
FirebaseVertexAI-Preview
را انتخاب کنید و سپس روی Add Package کلیک کنید.
در Xcode، با باز بودن پروژه برنامه، پروژه خود را در Project Navigator انتخاب کنید.
روی نام پروژه خود کلیک کنید (نه نام هدف)، و سپس برگه بسته بندی وابستگی ها را انتخاب کنید.
قانون وابستگی را برای بسته Firebase (
firebase-ios-sdk
) ویرایش کنید تا از نسخه پیشنمایش SDK استفاده کنید:Branch را از منوی کشویی انتخاب کنید و شاخه را روی
قرار دهید.vertexai-preview-0.1.0 Xcode بسته را در پسزمینه بارگذاری مجدد میکند.
در هدف برنامه خود، روی دکمه
در بخش Frameworks, Libraries and Embedded Content کلیک کنید.کتابخانه
FirebaseVertexAI-Preview
را انتخاب کنید و سپس روی Add کلیک کنید.
مرحله 3 : سرویس Vertex AI و مدل مولد را راه اندازی کنید
قبل از اینکه بتوانید تماس API برقرار کنید، باید سرویس Vertex AI و مدل تولیدی را مقداردهی اولیه کنید.
ماژول
FirebaseVertexAI
را وارد کنید:import FirebaseVertexAI
سرویس Vertex AI و مدل مولد را راه اندازی کنید:
import FirebaseVertexAI // Initialize the Vertex AI service let vertex = VertexAI.vertexAI() // Initialize the generative model with a model that supports your use case // Gemini 1.5 Pro is versatile and can accept both text-only or multimodal prompt inputs let model = vertex.generativeModel(modelName: "gemini-1.5-pro-preview-0409")
وقتی راهنمای شروع کار را به پایان رساندید، یاد بگیرید که چگونه یک مدل Gemini مناسب برای مورد استفاده خود انتخاب کنید.
مرحله 4 : با Gemini API تماس بگیرید
اکنون که برنامه خود را به Firebase متصل کرده اید، SDK را اضافه کرده اید و سرویس Vertex AI و مدل تولیدی را راه اندازی کرده اید، آماده فراخوانی Gemini API هستید.
انتخاب کنید که آیا میخواهید پاسخ را پخش جریانی کنید ( generateContentStream
) یا منتظر پاسخ باشید تا کل نتیجه تولید شود ( generateContent
).
جریان
بهطور پیشفرض، مدل پس از تکمیل کل فرآیند تولید، پاسخی را برمیگرداند. با این حال، میتوانید با منتظر ماندن برای کل نتیجه، به تعاملات سریعتری دست پیدا کنید و در عوض از جریان برای رسیدگی به نتایج جزئی استفاده کنید.
شما می توانید از generateContentStream()
برای پخش متن تولید شده از یک درخواست سریع که فقط شامل متن است استفاده کنید:
import FirebaseVertexAI
// Initialize the Vertex AI service
let vertex = VertexAI.vertexAI()
// Initialize the generative model with a model that supports your use case
// Gemini 1.5 Pro is versatile and can accept both text-only or multimodal prompt inputs
let model = vertex.generativeModel(modelName: "gemini-1.5-pro-preview-0409")
// Provide a prompt that contains text
let prompt = "Write a story about a magic backpack."
// To stream generated text output, call generateContentStream with the text input
let contentStream = model.generateContentStream(prompt)
for try await chunk in contentStream {
if let text = chunk.text {
print(text)
}
}
بدون پخش جریانی
از طرف دیگر، می توانید به جای پخش جریانی، منتظر کل نتیجه باشید. نتیجه تنها پس از تکمیل مدل کل فرآیند تولید برگردانده می شود.
میتوانید از generateContent()
برای تولید متن از یک درخواست سریع که فقط شامل متن است استفاده کنید:
import FirebaseVertexAI
// Initialize the Vertex AI service
let vertex = VertexAI.vertexAI()
// Initialize the generative model with a model that supports your use case
// Gemini 1.5 Pro is versatile and can accept both text-only or multimodal prompt inputs
let model = vertex.generativeModel(modelName: "gemini-1.5-pro-preview-0409")
// Provide a prompt that contains text
let prompt = "Write a story about a magic backpack."
// To generate text output, call generateContent with the text input
let response = try await model.generateContent(prompt)
if let text = response.text {
print(text)
}
شما چه کار دیگه ای میتوانید انجام دهید.
در مورد مدل های جمینی بیشتر بدانید
در مورد مدل های موجود برای موارد استفاده مختلف و سهمیه ها و قیمت آنها اطلاعات کسب کنید.
سایر قابلیت های Gemini API را امتحان کنید
- درباره ارسال پیامهای متنی بیشتر بیاموزید.
- درخواستهای فوری چندوجهی را با اعلانهای متنی و رسانهای (از جمله تصاویر، فایلهای PDF، ویدئو و صدا) ارسال کنید.
- مکالمات چند نوبتی (چت) بسازید.
یاد بگیرید چگونه تولید محتوا را کنترل کنید
- طراحی سریع، از جمله بهترین شیوهها، استراتژیها و درخواستهای نمونه را درک کنید .
- پارامترهای مدل مانند دما و حداکثر نشانه های خروجی را پیکربندی کنید .
- از تنظیمات ایمنی برای تنظیم احتمال دریافت پاسخ هایی که ممکن است مضر تلقی شوند استفاده کنید .
همچنین میتوانید با استفاده از Vertex AI Studio، دستورات و پیکربندیهای مدل را آزمایش کنید.
درباره تجربه خود با Vertex AI SDKs برای Firebase بازخورد بدهید