Tutorial: chamada de funções com a API Gemini

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

A chamada de função facilita a geração de saídas de dados estruturados de modelos generativos. Assim, é possível usar essas saídas para chamar outras APIs e retornar os dados de resposta relevantes para o modelo. Em outras palavras, a chamada de função ajuda a conectar modelos generativos a sistemas externos para que o conteúdo gerado inclua as informações mais atualizadas e precisas.

É possível fornecer modelos do Gemini com descrições de funções. São funções que você escreve na linguagem do seu app (ou seja, não são funções do Google Cloud). O modelo pode pedir que você chame uma função e envie o resultado para ajudar o modelo a processar a consulta.

Se ainda não fez isso, confira a Introdução à chamada de função para saber mais.

Configurar seu projeto

Antes de chamar a API Gemini, você precisa configurar seu projeto Android, o que inclui configurar sua chave de API, adicionar as dependências do SDK ao projeto Android e inicializar o modelo.

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

val generativeModel = GenerativeModel(

    // Use a model that supports function calling, like a Gemini 1.5 model
    modelName = "gemini-1.5-flash",

    // Access your API key as a Build Configuration variable (see "Set up your API key" above).
    apiKey = BuildConfig.apiKey
)

Configurar uma chamada de função

Neste tutorial, o modelo vai interagir com uma API hipotética de troca de moedas compatível com os seguintes parâmetros:

Exemplo de solicitação de API

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

Exemplo de resposta da API

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

Etapa 1: criar a função que faz a solicitação de API

Comece criando a função que faz uma solicitação de API, caso ainda não tenha feito isso.

Para fins de demonstração neste tutorial, em vez de enviar uma solicitação de API real, você retornará valores fixados no código no mesmo formato que uma API real retornaria.

suspend fun makeApiRequest(
    currencyFrom: String,
    currencyTo: String
): JSONObject {
    // This hypothetical API returns a JSON such as:
    // {"base":"USD","rates":{"SEK": 0.091}}
    return JSONObject().apply {
        put("base", currencyFrom)
        put("rates", hashMapOf(currencyTo to 0.091))
    }
}

Etapa 2: criar uma declaração de função

Crie a declaração da função que você vai transmitir para o modelo generativo (próxima etapa deste tutorial).

Inclua o máximo de detalhes possível nas descrições da função e do parâmetro. O modelo generativo usa essas informações para determinar qual função selecionar e como fornecer valores para os parâmetros na chamada de função.

val getExchangeRate = defineFunction(
  name = "getExchangeRate",
  description = "Get the exchange rate for currencies between countries",
  Schema.str("currencyFrom", "The currency to convert from."),
  Schema.str("currencyTo", "The currency to convert to.")
) { from, to ->
    // Call the function that you declared above
    makeApiRequest(from, to)
}

Etapa 3: especificar a declaração da função durante a inicialização do modelo

Especifique a declaração da função ao inicializar o modelo generativo transmitindo-o para o parâmetro tools do modelo:

val generativeModel = GenerativeModel(
  // Use a model that supports function calling, like a Gemini 1.5 model
  modelName = "gemini-1.5-flash",
  // Access your API key as a Build Configuration variable (see "Set up your API key" above)
  apiKey = BuildConfig.apiKey,
  // Specify the function declaration.
  tools = listOf(Tool(listOf(getExchangeRate)))
)

Etapa 4: gerar uma chamada de função

Agora é possível solicitar o modelo com a função definida.

A maneira recomendada de usar a chamada de funções é pela interface de chat, já que as chamadas de função se encaixam perfeitamente na estrutura de várias interações do chat.

val chat = generativeModel.startChat()

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

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