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

Python Node.js Go Dart (Flutter) Android Swift Web REST

İşlev çağrısı, üretken modellerden yapılandırılmış veri çıkışları almanızı kolaylaştırır. Ardından, diğer API'leri çağırmak ve ilgili yanıt verilerini modele döndürmek için bu çıkışları kullanabilirsiniz. Diğer bir deyişle, işlev çağrısı, oluşturulan içeriğin en güncel ve doğru bilgileri içermesi için üretken modelleri harici sistemlere bağlamanıza yardımcı olur.

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

Henüz yapmadıysanız daha fazla bilgi edinmek için İşlev çağırmaya giriş başlıklı makaleyi inceleyin.

Aydınlatma kontrolü için örnek API

Uygulama programlama arayüzü (API) olan temel bir aydınlatma kontrol sisteminiz olduğunu ve kullanıcıların basit metin istekleri aracılığıyla ışıkları kontrol etmesine izin vermek istediğinizi varsayalım. Kullanıcılardan gelen ışıklandırma değişikliği isteklerini yorumlamak ve ışıklandırma değerlerini ayarlamak için işlev çağırma özelliğini kullanabilirsiniz. Bu varsayımsal aydınlatma kontrol sistemi, ışığın parlaklığını ve renk sıcaklığını iki ayrı parametre olarak kontrol etmenize olanak tanır:

Basitlik açısından bu hayali aydınlatma sisteminde yalnızca bir ışık vardır. Bu nedenle kullanıcının oda veya konum belirtmesi gerekmez. Gün ışığı renk sıcaklığını kullanarak ışık seviyesini %50'ye değiştirmek için aydınlatma kontrolü API'sine gönderebileceğiniz örnek bir JSON isteği aşağıda verilmiştir:

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

Bu eğitimde, kullanıcıların ışıklandırma isteklerini yorumlamak ve ışığın parlaklığı ile renk sıcaklığı değerlerini kontrol etmek için Gemini API için bir işlev çağrısının nasıl ayarlanacağı gösterilmektedir.

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

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

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
  }
}

API işlevi tanımlama

API isteği gönderen 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 çalmaz. Bu nedenle, uygulama kodunuz aracılığıyla bu işlevin nasıl ve ne zaman çalışacağını kontrol edebilirsiniz. Bu eğitimde, yalnızca istenen aydınlatma değerlerini döndüren bir örnek API işlevi tanımlanmıştır:

func setLightValues(brightness: String,
                    colorTemp: String) -> JSONObject {
  // This mock API returns the requested lighting values
  return [
    "brightness": .string(brightness),
    "colorTemperature": .string(colorTemp)
  ]
}

İşlev tanımları oluşturma

Üretken modele ileteceğiniz işlev tanımını oluşturun. Model tarafından kullanılacak bir işlev tanımlarken işlev ve parametre açıklamalarına mümkün olduğunca fazla ayrıntı eklemeniz gerekir. Üretken model, hangi işlevin seçileceğini ve işlev çağrısındaki parametreler için değerlerin nasıl sağlanacağını belirlemek üzere bu bilgileri kullanır. Aşağıdaki kodda, aydınlatma kontrol işlevinin nasıl tanımlanacağı gösterilmektedir:

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"]
)

Modeli başlatırken işlevleri tanımlama

Bir modelde işlev çağrısını kullanmak istediğinizde model nesnesini başlatırken işlev beyanlarınızı sağlamanız gerekir. Modelin tools parametresini ayarlayarak işlevleri bildirirsiniz:

// 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])]
)

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

Modeli işlev beyanlarınızla başlattıktan sonra, modele tanımlanmış işlevi isteyebilirsiniz. İşlev çağrısı genellikle önceki istemlerin ve yanıtların bağlamından yararlandığından, sohbet istemi (sendMessage()) kullanarak işlev çağrısı yapmalısınız.

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)