İşlev çağrısı eğiticisi

Python Node.js Git Dart (Flutter) Android Swift Web

İşlev çağrısı, üretken modellerden yapılandırılmış veri çıkışları almanızı kolaylaştırır. Daha sonra bu çıkışları kullanarak diğer API'leri çağırabilir ve ilgili yanıt verilerini modele döndürebilirsiniz. Başka bir deyişle, işlev çağrısı, üretken modelleri harici sistemlere bağlamanıza yardımcı olur. Böylece, oluşturulan içerik en güncel ve doğru bilgileri içerir.

Gemini modellerine işlevlerin açıklamalarını sağlayabilirsiniz. Bunlar, uygulamanızın dilinde yazdığınız işlevlerdir (Google Cloud Functions değildirler). Model, bir işlevi çağırmanızı ve modelin sorgunuzu işlemesine yardımcı olmak için sonucu geri göndermenizi isteyebilir.

Henüz yapmadıysanız daha fazla bilgi için İşlev çağrısına giriş sayfasına göz atın.

Aydınlatma kontrolü için örnek API

Uygulama programlama arayüzüne (API) sahip temel bir ışıklandırma kontrol sisteminiz olduğunu ve kullanıcıların basit metin istekleriyle ışıkları kontrol etmesine izin vermek istediğinizi düşünün. Işıklandırma değerlerini ayarlamak amacıyla kullanıcılardan gelen ışık değişikliği isteklerini yorumlamak ve bunları API çağrılarına dönüştürmek için İşlev Çağrısı özelliğini kullanabilirsiniz. Bu varsayımsal ışıklandırma kontrol sistemi, ışığın parlaklığını ve renk sıcaklığını kontrol etmenizi sağlar. Bunlar, iki ayrı parametreyle tanımlanır:

Basitlik sağlaması açısından bu hayali aydınlatma sisteminde yalnızca tek bir ışığa sahip olduğundan kullanıcının oda veya konum belirtmesi gerekmez. İşte gün ışığı renk sıcaklığını kullanarak ışık seviyesini %50 olarak değiştirmek için aydınlatma kontrolü API'sine gönderebileceğiniz örnek bir JSON isteği:

{
  "brightness": "50",
  "colorTemperature": "daylight"
}

Bu eğitim, kullanıcıların ışık isteklerini yorumlamak ve ışığın parlaklığı ile renk sıcaklığı değerlerini kontrol etmek için bunları API ayarlarıyla eşlemek amacıyla Gemini API için İşlev Çağrısı'nın nasıl ayarlanacağını gösterir.

Başlamadan önce: Projenizi ve API anahtarınızı oluşturun

Gemini API'yi çağırmadan önce projenizi ayarlamanız ve API anahtarınızı yapılandırmanız gerekir.

// Access your API key as a Build Configuration variable
val apiKey = BuildConfig.apiKey

API işlevleri tanımlayın

API isteğinde bulunan bir işlev oluşturun. Bu işlev, uygulamanızın kodunda tanımlanmalıdır ancak uygulamanızın dışındaki hizmetleri veya API'leri çağırabilir. Gemini API bu işlevi doğrudan çağrımaz. Böylece, bu işlevin nasıl ve ne zaman yürütüleceğini uygulama kodunuzla kontrol edebilirsiniz. Gösterim amacıyla bu eğiticide, istenen ışıklandırma değerlerini döndüren örnek bir API işlevi tanımlanmaktadır:

suspend fun setLightValues(
    brightness: Int,
    colorTemp: String
): JSONObject {
    // This mock API returns the requested lighting values
    return JSONObject().apply {
        put("brightness", brightness)
        put("colorTemperature", colorTemp)
    }
}

İşlev bildirimleri oluşturma

Üretken modele ileteceğiniz işlev bildirimini oluşturun. Modelin kullanması için bir işlev bildirdiğinizde, işleve ve parametre açıklamalarına mümkün olduğunca fazla ayrıntı eklemeniz gerekir. Üretken model, bu bilgileri kullanarak hangi işlevin seçileceğini ve işlev çağrısındaki parametreler için değerlerin nasıl sağlanacağını belirler. Aşağıdaki kodda ışık kontrolü işlevinin nasıl tanımlanacağı gösterilmektedir:

val lightControlTool = defineFunction(
  name = "setLightValues",
  description = "Set the brightness and color temperature of a room light.",
  Schema.int("brightness", "Light level from 0 to 100. Zero is off and 100" +
    " is full brightness."),
  Schema.str("colorTemperature", "Color temperature of the light fixture" +
    " which can be `daylight`, `cool` or `warm`.")
) { brightness, colorTemp ->
    // Call the function you declared above
    setLightValues(brightness.toInt(), colorTemp)
}

Model başlatma sırasında işlevleri bildirme

İşlev çağrısını bir modelle kullanmak istiyorsanız model nesnesini ilk kullanıma hazırlarken işlev bildirimlerinizi sağlamanız gerekir. Modelin tools parametresini ayarlayarak işlevleri tanımlarsınız:

val generativeModel = GenerativeModel(
    modelName = "gemini-1.5-flash",

    // Access your API key as a Build Configuration variable
    apiKey = BuildConfig.apiKey,

    // Specify the function declaration.
    tools = listOf(Tool(listOf(lightControlTool)))
)

İşlev çağrısı oluşturma

Modeli işlev bildirimlerinizle başlattıktan sonra, tanımlı işlevle modele istem girebilirsiniz. İşlev çağrısı genellikle önceki istemlerin ve yanıtların bağlamının kullanılmasından fayda sağladığından, işlev çağrısı özelliğini sohbet istemi (sendMessage()) kullanarak kullanmalısınız.

val chat = generativeModel.startChat()

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

// Send the message to the generative model
var response = chat.sendMessage(prompt)

// Check if the model responded with a function call
response.functionCall?.let { functionCall ->
  // Try to retrieve the stored lambda from the model's tools and
  // throw an exception if the returned function was not declared
  val matchedFunction = generativeModel.tools?.flatMap { it.functionDeclarations }
      ?.first { it.name == functionCall.name }
      ?: throw InvalidStateException("Function not found: ${functionCall.name}")

  // Call the lambda retrieved above
  val apiResponse: JSONObject = matchedFunction.execute(functionCall)

  // Send the API response back to the generative model
  // so that it generates a text response that can be displayed to the user
  response = chat.sendMessage(
    content(role = "function") {
        part(FunctionResponsePart(functionCall.name, apiResponse))
    }
  )
}

// Whenever the model responds with text, show it in the UI
response.text?.let { modelResponse ->
    println(modelResponse)
}