آموزش فراخوانی توابع

فراخوانی تابع، دریافت خروجی داده های ساختاریافته از مدل های تولیدی را برای شما آسان تر می کند. سپس می توانید از این خروجی ها برای فراخوانی 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 را تعریف کنید

تابعی بسازید که درخواست API می دهد. این تابع باید در کد برنامه شما تعریف شود، اما می تواند خدمات یا API های خارج از برنامه شما را فراخوانی کند. Gemini API این تابع را مستقیماً فراخوانی نمی کند، بنابراین می توانید نحوه و زمان اجرای این تابع را از طریق کد برنامه خود کنترل کنید. برای اهداف نمایشی، این آموزش یک تابع API ساختگی را تعریف می کند که فقط مقادیر روشنایی درخواستی را برمی گرداند: 

func setLightValues(brightness int, colorTemp string) map[string]any {
    // This mock API returns the requested lighting values
    return map[string]any{
        "brightness":       brightness,
        "colorTemperature": colorTemp}
}

یک اعلان تابع ایجاد کنید

اعلان تابعی را ایجاد کنید که به مدل مولد منتقل می کنید. هنگامی که یک تابع را برای استفاده توسط مدل اعلام می کنید، باید تا حد امکان جزئیات بیشتری را در توضیحات تابع و پارامتر بگنجانید. مدل مولد از این اطلاعات برای تعیین اینکه کدام تابع را انتخاب کند و چگونه مقادیر پارامترهای فراخوانی تابع را ارائه کند، استفاده می کند. کد زیر نحوه اعلام عملکرد کنترل روشنایی را نشان می دهد: 

lightControlTool := &genai.Tool{
    FunctionDeclarations: []*genai.FunctionDeclaration{{
        Name:        "controlLight",
        Description: "Set the brightness and color temperature of a room light.",
        Parameters: &genai.Schema{
            Type: genai.TypeObject,
            Properties: map[string]*genai.Schema{
                "brightness": {
                    Type:        genai.TypeString,
                    Description: "Light level from 0 to 100. Zero is off and"+
                        " 100 is full brightness.",
                },
                "colorTemperature": {
                    Type:        genai.TypeString,
                    Description: "Color temperature of the light fixture which" +
                        " can be `daylight`, `cool` or `warm`.",
                },
            },
            Required: []string{"brightness", "colorTemperature"},
        },
    }},
}

توابع را در طول اولیه سازی مدل اعلام کنید

هنگامی که می خواهید از فراخوانی تابع با یک مدل استفاده کنید، باید اعلان های تابع خود را هنگام مقداردهی اولیه شی مدل ارائه دهید. شما با تنظیم پارامتر Tools مدل، توابع را اعلام می کنید: 

// ...

lightControlTool := &genai.Tool{
    // ...
}

// Use a model that supports function calling, like a Gemini 1.5 model
model := client.GenerativeModel("gemini-1.5-flash")

// Specify the function declaration.
model.Tools = []*genai.Tool{lightControlTool}

یک فراخوانی تابع ایجاد کنید

هنگامی که مدل را با اعلان های تابع خود مقداردهی اولیه کردید، می توانید مدل را با تابع تعریف شده درخواست کنید. شما باید از فراخوانی تابع با استفاده از درخواست چت ( SendMessage() ) استفاده کنید، زیرا فراخوانی تابع عموماً از داشتن متن درخواست ها و پاسخ های قبلی سود می برد. 

// Start new chat session.
session := model.StartChat()

prompt := "Dim the lights so the room feels cozy and warm."

// Send the message to the generative model.
resp, err := session.SendMessage(ctx, genai.Text(prompt))
if err != nil {
    log.Fatalf("Error sending message: %v\n", err)
}

// Check that you got the expected function call back.
part := resp.Candidates[0].Content.Parts[0]
funcall, ok := part.(genai.FunctionCall)
if !ok {
    log.Fatalf("Expected type FunctionCall, got %T", part)
}
if g, e := funcall.Name, lightControlTool.FunctionDeclarations[0].Name; g != e {
    log.Fatalf("Expected FunctionCall.Name %q, got %q", e, g)
}
fmt.Printf("Received function call response:\n%q\n\n", part)

apiResult := map[string]any{
    "brightness":  "30",
    "colorTemperature":  "warm" }

// Send the hypothetical API result back to the generative model.
fmt.Printf("Sending API result:\n%q\n\n", apiResult)
resp, err = session.SendMessage(ctx, genai.FunctionResponse{
    Name:     lightControlTool.FunctionDeclarations[0].Name,
    Response: apiResult,
})
if err != nil {
    log.Fatalf("Error sending message: %v\n", err)
}

// Show the model's response, which is expected to be text.
for _, part := range resp.Candidates[0].Content.Parts {
    fmt.Printf("%v\n", part)
}