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

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

İşlev çağrısı, üretken modeller. Ardından, diğer API'leri çağırmak ve ilgili yanıt verilerini modele döndürmek için bu çıkışları kullanabilirsiniz. Başka bir deyişle, işlev çağrısı üretken modelleri harici sistemlere bağlarsınız. Böylece, en güncel ve doğru bilgileri içerir.

Gemini modellerine işlev açıklamaları sağlayabilirsiniz. Bunlar: uygulamanızın dilinde yazdığınız işlevler (yani Google Cloud Functions). 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

Bir uygulama programlaması ile temel bir ışıklandırma kontrol sisteminiz olduğunu düşünün API'sını kullanıyor ve kullanıcıların ışıkları basit bir şekilde kontrol etmesine izin vermek metin istekleri. Işıklandırmayı yorumlamak için İşlev Çağrısı özelliğini kullanabilirsiniz ışıklandırmayı ayarlamak için kullanıcılardan gelen istekleri değiştirme ve bunları API çağrılarına dönüştürme değerler. 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ğiticide, Gemini API için İşlev Çağrısı'nın nasıl kontrol etmek için kullanıcıların ışıklandırma isteklerini yorumlamak ve API ayarlarıyla eşlemek ışığın parlaklık ve renk sıcaklığı değerlerini yansıtabilir.

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.

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 fonksiyon tanımlanmalıdır. olup olmadığını kontrol edebilir, ancak en iyi yoludur. Gemini API doğrudan bu işlevi çağrımaz. Bu nedenle, bu işlevin uygulamanız üzerinden nasıl ve ne zaman yürütüleceğini kontrol edebilir girin. 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 bildirimleri oluşturma

Üretken modele ileteceğiniz işlev bildirimini 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

İşlev çağrısını bir modelle kullanmak istediğinizde işlev bildirimlerinin her biri için bir ekran görüntüsü sunar. İşlevleri açıkladınız modelin tools parametresini ayarlayarak:

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

İşlev bildirimlerinizle modeli başlattıktan sonra, tanımlanan işleve sahip modeli kullanır. İşlev çağrısını sohbet istemi (sendMessage()), çünkü işlev çağrısı genellikle önceki istemlerin ve yanıtların bağlamına bakın.

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)