فراخوانی تابع، دریافت خروجی داده های ساختاریافته از مدل های تولیدی را برای شما آسان تر می کند. سپس می توانید از این خروجی ها برای فراخوانی API های دیگر و برگرداندن داده های پاسخ مربوطه به مدل استفاده کنید. به عبارت دیگر، فراخوانی تابع به شما کمک می کند تا مدل های تولیدی را به سیستم های خارجی متصل کنید تا محتوای تولید شده شامل به روزترین و دقیق ترین اطلاعات باشد.
می توانید مدل های Gemini را با توضیحاتی در مورد عملکردها ارائه دهید. اینها توابعی هستند که شما به زبان برنامه خود می نویسید (یعنی توابع Google Cloud نیستند). مدل ممکن است از شما بخواهد که یک تابع را فراخوانی کنید و نتیجه را برای کمک به مدل در رسیدگی به درخواست شما ارسال کنید.
اگر قبلاً این کار را نکردهاید، برای کسب اطلاعات بیشتر ، مقدمه فراخوانی تابع را بررسی کنید.
API مثال برای کنترل روشنایی
تصور کنید یک سیستم کنترل روشنایی اولیه با یک رابط برنامه نویسی کاربردی (API) دارید و می خواهید به کاربران اجازه دهید تا از طریق درخواست های متنی ساده، چراغ ها را کنترل کنند. میتوانید از ویژگی فراخوانی تابع برای تفسیر درخواستهای تغییر نور از سوی کاربران و ترجمه آنها به فراخوانهای API برای تنظیم مقادیر نور استفاده کنید. این سیستم کنترل روشنایی فرضی به شما امکان می دهد روشنایی نور و دمای رنگ آن را کنترل کنید که به عنوان دو پارامتر جداگانه تعریف می شود:
پارامتر | تایپ کنید | مورد نیاز | توضیحات |
---|---|---|---|
brightness | شماره | بله | سطح نور از 0 تا 100. صفر خاموش است و 100 روشنایی کامل است. |
colorTemperature | رشته | بله | دمای رنگ دستگاه نور که می تواند daylight ، cool یا warm باشد. |
برای سادگی، این سیستم نورپردازی خیالی تنها یک نور دارد، بنابراین کاربر مجبور نیست اتاق یا مکان را مشخص کند. در اینجا نمونه ای از درخواست JSON است که می توانید برای تغییر سطح نور با استفاده از دمای رنگ نور روز به API کنترل روشنایی ارسال کنید:
{
"brightness": "50",
"colorTemperature": "daylight"
}
این آموزش به شما نشان میدهد که چگونه یک Function Call را برای Gemini API تنظیم کنید تا درخواستهای روشنایی کاربران را تفسیر کند و آنها را به تنظیمات API برای کنترل مقدار روشنایی و دمای رنگ نور تنظیم کنید.
قبل از شروع: پروژه و کلید API خود را تنظیم کنید
قبل از فراخوانی Gemini API، باید پروژه خود را راه اندازی کرده و کلید API خود را پیکربندی کنید.
کلید API خود را دریافت و ایمن کنید
برای فراخوانی Gemini API به یک کلید API نیاز دارید. اگر قبلاً یکی ندارید، یک کلید در Google AI Studio ایجاد کنید.
اکیداً توصیه می شود که یک کلید API را در سیستم کنترل نسخه خود بررسی نکنید .
برای کلید API خود باید از یک فروشگاه اسرار مانند Google Cloud Secret Manager استفاده کنید.
گزینه جایگزین دیگر این است که آن را در یک فایل GenerativeAI-Info.plist
ذخیره کنید و سپس کلید API را از فایل .plist
بخوانید. مطمئن شوید که این فایل .plist
را در پوشه ریشه برنامه خود قرار داده و آن را از کنترل نسخه حذف کنید. کد زیر نحوه بازیابی یک کلید API را از یک فایل .plist
نشان می دهد:
enum APIKey {
// Fetch the API key from `GenerativeAI-Info.plist`
static var `default`: String {
guard let filePath = Bundle.main.path(forResource: "GenerativeAI-Info", ofType: "plist")
else {
fatalError("Couldn't find file 'GenerativeAI-Info.plist'.")
}
let plist = NSDictionary(contentsOfFile: filePath)
guard let value = plist?.object(forKey: "API_KEY") as? String else {
fatalError("Couldn't find key 'API_KEY' in 'GenerativeAI-Info.plist'.")
}
if value.starts(with: "_") {
fatalError(
"Follow the instructions at https://ai.google.dev/tutorials/setup to get an API key."
)
}
return value
}
}
همچنین میتوانید برنامه نمونه AI مولد Swift را مرور کنید تا یاد بگیرید چگونه کلید API خود را در یک فایل .plist
ذخیره کنید. این آموزش فرض میکند که شما به کلید API خود از این فایل .plist
. منبع درخواستی دسترسی دارید.
بسته SDK را وارد کنید و کلید API خود را پیکربندی کنید
برای استفاده از Gemini API در برنامه Swift خود، بسته GoogleGenerativeAI
را به پروژه توسعه برنامه Xcode خود اضافه کنید:
در Xcode، روی پروژه خود در ناوبر پروژه کلیک راست کنید.
از منوی زمینه گزینه Add Packages را انتخاب کنید.
در گفتگوی افزودن بستهها ، URL بسته را در نوار جستجو جایگذاری کنید:
https://github.com/google/generative-ai-swift
روی Add Package کلیک کنید تا Xcode بسته
GoogleGenerativeAI
را به پروژه شما اضافه کند.
یک تابع API را تعریف کنید
تابعی ایجاد کنید که درخواست API را ایجاد کند. این تابع باید در کد برنامه شما تعریف شود، اما می تواند خدمات یا API های خارج از برنامه شما را فراخوانی کند. Gemini API این تابع را مستقیماً فراخوانی نمی کند، بنابراین می توانید نحوه و زمان اجرای این تابع را از طریق کد برنامه خود کنترل کنید. برای اهداف نمایشی، این آموزش یک تابع API ساختگی را تعریف می کند که فقط مقادیر روشنایی درخواستی را برمی گرداند:
func setLightValues(brightness: String,
colorTemp: String) -> JSONObject {
// This mock API returns the requested lighting values
return [
"brightness": .string(brightness),
"colorTemperature": .string(colorTemp)
]
}
ایجاد اعلان عملکرد
اعلان تابعی را ایجاد کنید که به مدل مولد منتقل می کنید. هنگامی که یک تابع را برای استفاده توسط مدل اعلام می کنید، باید تا حد امکان جزئیات بیشتری را در توضیحات تابع و پارامتر بگنجانید. مدل مولد از این اطلاعات برای تعیین اینکه کدام تابع را انتخاب کند و چگونه مقادیر پارامترهای فراخوانی تابع را ارائه کند، استفاده می کند. کد زیر نحوه اعلام عملکرد کنترل روشنایی را نشان می دهد:
let controlLightFunctionDeclaration = FunctionDeclaration(
name: "controlLight",
description: "Set the brightness and color temperature of a room light.",
parameters: [
"brightness": Schema(
type: .string,
description: "Light level from 0 to 100. Zero is off and 100 is full brightness."
),
"colorTemperature": Schema(
type: .string,
description: "Color temperature of the light fixture which can be `daylight`, `cool` or `warm`."
),
],
requiredParameters: ["brightness", "colorTemperature"]
)
توابع را در طول اولیه سازی مدل اعلام کنید
هنگامی که می خواهید از فراخوانی تابع با یک مدل استفاده کنید، باید اعلان های تابع خود را هنگام مقداردهی اولیه شی مدل ارائه دهید. شما با تنظیم پارامتر tools
مدل، توابع را اعلام می کنید:
// Use a model that supports function calling, like a Gemini 1.5 model
let generativeModel = GenerativeModel(
name: "gemini-1.5-flash",
apiKey: apiKey,
// Specify the function declaration.
tools: [Tool(functionDeclarations: [controlLightFunctionDeclaration])]
)
یک فراخوانی تابع ایجاد کنید
هنگامی که مدل را با اعلان های تابع خود مقداردهی اولیه کردید، می توانید مدل را با تابع تعریف شده درخواست کنید. شما باید از فراخوانی تابع با استفاده از درخواست چت ( sendMessage()
) استفاده کنید، زیرا فراخوانی تابع عموماً از داشتن متن درخواست ها و پاسخ های قبلی سود می برد.
let chat = generativeModel.startChat()
let prompt = "Dim the lights so the room feels cozy and warm."
// Send the message to the generative model
let response1 = try await chat.sendMessage(prompt)
// Check if the model responded with a function call
guard let functionCall = response1.functionCalls.first else {
fatalError("Model did not respond with a function call.")
}
// Print an error if the returned function was not declared
guard functionCall.name == "controlLight" else {
fatalError("Unexpected function called: \(functionCall.name)")
}
// Verify that the names and types of the parameters match the declaration
guard case let .string(brightness) = functionCall.args["brightness"] else {
fatalError("Missing argument: brightness")
}
guard case let .string(colorTemp) = functionCall.args["colorTemperature"] else {
fatalError("Missing argument: colorTemperature")
}
// Call the hypothetical API
let apiResponse = setLightValues(brightness: brightness, colorTemperature: colorTemp)
// Send the API response back to the model so it can generate a text response that can be
// displayed to the user.
let response = try await chat.sendMessage([ModelContent(
role: "function",
parts: [.functionResponse(FunctionResponse(
name: functionCall.name,
response: apiResponse
))]
)])
// Log the text response.
guard let modelResponse = response.text else {
fatalError("Model did not respond with text.")
}
print(modelResponse)