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


İş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 projenizi ayarlamanız gerekir. Bu aşamaya API anahtarınızı oluşturma, SDK'yı yayıncı bağımlılıklarınıza ekleme ve modeli başlatma dahildir.

İş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:

Parametre Tür Gerekli Açıklama
currencyDate dize evet
için döviz kurunun alınacağı tarih (Dönem belirtilmemişse her zaman YYYY-AA-GG biçiminde olmalıdır veya latest değeri olmalıdır)
currencyFrom dize evet Dönüştürülecek para birimi
currencyTo dize no Dönüştürülecek para birimi

Örnek API isteği

{
  "currencyDate": "2024-04-17",
  "currencyFrom": "USD",
  "currencyTo": "SEK"
}

Örnek API yanıtı

{
  "base": "USD",
  "date": "2024-04-17",
  "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.

Future<Map<String, Object?>> findExchangeRate(
  Map<String, Object?> arguments,
) async =>
    // This hypothetical API returns a JSON such as:
    // {"base":"USD","date":"2024-04-17","rates":{"SEK": 0.091}}
    {
      'date': arguments['currencyDate'],
      'base': arguments['currencyFrom'],
      'rates': <String, Object?>{arguments['currencyTo'] as String: 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.

final exchangeRateTool = FunctionDeclaration(
    'findExchangeRate',
    'Returns the exchange rate between currencies on given date.',
    Schema(SchemaType.object, properties: {
      'currencyDate': Schema(SchemaType.string,
          description: 'A date in YYYY-MM-DD format or '
              'the exact value "latest" if a time period is not specified.'),
      'currencyFrom': Schema(SchemaType.string,
          description: 'The currency code of the currency to convert from, '
              'such as "USD".'),
      'currencyTo': Schema(SchemaType.string,
          description: 'The currency code of the currency to convert to, '
              'such as "USD".')
    }, requiredProperties: [
      'currencyDate',
      'currencyFrom'
    ]));

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

Üretken modeli başlatırken modelin tools parametresine ileterek işlev bildirimini belirtin:

final model = GenerativeModel(
  // Use a model that supports function calling, like Gemini 1.0 Pro
  // See "Supported models" in the "Introduction to function calling" page.
  model: 'gemini-1.0-pro',
  apiKey: apiKey,

  // Specify the function declaration.
  tools: [
    Tool(functionDeclarations: [exchangeRateTool])
  ],
);

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.

final chat = model.startChat();
final prompt = 'How much is 50 US dollars worth in Swedish krona?';

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

final functionCalls = response.functionCalls.toList();
// When the model response with a function call, invoke the function.
if (functionCalls.isNotEmpty) {
  final functionCall = functionCalls.first;
  final result = switch (functionCall.name) {
    // Forward arguments to the hypothetical API.
    'findExchangeRate' => await findExchangeRate(functionCall.args),
    // Throw an exception if the model attempted to call a function that was
    // not declared.
    _ => throw UnimplementedError(
        'Function not implemented: ${functionCall.name}')
  };
  // Send the response to the model so that it can use the result to generate
  // text for the user.
  response = await chat
      .sendMessage(Content.functionResponse(functionCall.name, result));
}
// When the model responds with non-null text content, print it.
if (response.text case final text?) {
  print(text);
}