Eğitim: Gemini API ile işlev çağrısı

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

İşlev çağrısı, üretici 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ı olarak oluşturulan içeriğin en güncel ve doğru bilgileri içermesini sağlar.

Gemini modellerine işlevlerin açıklamalarını sağlayabilirsiniz. Bunlar, uygulamanızın dilinde yazdığınız işlevlerdir (Google Cloud Functions değildir). Model, bir işlev ç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 edinmek için İşlev çağrısına giriş bölümüne göz atın.

Projenizi oluşturun

Gemini API'yi çağırmadan önce Xcode projenizi ayarlamanız gerekir. Bu aşamaya API anahtarınızı oluşturma, SDK paketini Xcode projenize ekleme ve model başlatma dahildir.

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

İşlev çağrısı ayarlama

Bu eğiticide modelin, aşağıdaki parametreleri destekleyen varsayımsal bir para birimi değişim API'si ile etkileşim kurmasını göreceksiniz:

Örnek API isteği

{
  "currencyFrom": "USD",
  "currencyTo": "SEK"
}

Örnek API yanıtı

{
  "base": "USD",
  "rates": {"SEK": 0.091}
}

1. Adım: API isteğinde bulunan işlevi oluşturun

Henüz yapmadıysanız önce API isteği yapan işlevi oluşturun.

Bu eğiticide örnek amaçlı olarak gerçek bir API isteği göndermek yerine, sabit kodlu değerleri gerçek bir API'nin döndüreceği biçimde döndüreceksiniz.

func makeAPIRequest(currencyFrom: String,
                    currencyTo: String) -> JSONObject {
  // This hypothetical API returns a JSON such as:
  // {"base":"USD","rates":{"SEK": 0.091}}
  return [
    "base": .string(currencyFrom),
    "rates": .object([currencyTo: .number(0.091)]),
  ]
}

2. Adım: Bir işlev bildirimi oluşturun

Üretken modele ileteceğiniz işlev bildirimini oluşturun (bu eğiticinin bir sonraki adımı).

İşlev ve parametre açıklamalarına mümkün olduğunca fazla ayrıntı ekleyin. Üretken model, hangi işlevin seçileceğini ve işlev çağrısındaki parametrelere nasıl değer sağlanacağını belirlemek için bu bilgileri kullanır.

let getExchangeRate = FunctionDeclaration(
  name: "getExchangeRate",
  description: "Get the exchange rate for currencies between countries",
  parameters: [
    "currencyFrom": Schema(
      type: .string,
      description: "The currency to convert from."
    ),
    "currencyTo": Schema(
      type: .string,
      description: "The currency to convert to."
    ),
  ],
  requiredParameters: ["currencyFrom", "currencyTo"]
)

3. Adım: Model başlatma sırasında işlev bildirimini belirtin

Üretken modeli başlatırken modelin tools parametresini ayarlayarak işlev bildirimini belirtin:

// Use a model that supports function calling, like Gemini 1.0 Pro.
// See "Supported models" in the "Introduction to function calling" page.
let generativeModel = GenerativeModel(
  name: "gemini-1.0-pro",
  apiKey: apiKey,
  // Specify the function declaration.
  tools: [Tool(functionDeclarations: [getExchangeRate])]
)

4. Adım: Bir işlev çağrısı oluşturun

Şimdi modele tanımlı işlevle istem gönderebilirsiniz.

İşlev çağrıları, sohbetin çok dönüşlü yapısıyla uyumlu olduğundan, işlev çağrısının kullanılması önerilen yol sohbet arayüzüdür.

let chat = generativeModel.startChat()

let prompt = "How much is 50 US dollars worth in Swedish krona?"

// 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 == "getExchangeRate" else {
  fatalError("Unexpected function called: \(functionCall.name)")
}
// Verify that the names and types of the parameters match the declaration
guard case let .string(currencyFrom) = functionCall.args["currencyFrom"] else {
  fatalError("Missing argument: currencyFrom")
}
guard case let .string(currencyTo) = functionCall.args["currencyTo"] else {
  fatalError("Missing argument: currencyTo")
}

// Call the hypothetical API
let apiResponse = makeAPIRequest(currencyFrom: currencyFrom, currencyTo: currencyTo)

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