Tutorial sobre chamada de função

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

A chamada de função facilita o recebimento de saídas de dados estruturados de modelos generativos. Você pode usar essas saídas para chamar outras APIs e retornar os dados de resposta relevantes ao modelo. Em outras palavras, a chamada de função ajuda você conecta modelos generativos a sistemas externos para que o conteúdo gerado inclui as informações mais atualizadas e precisas.

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

Confira a Introdução à chamada de função para aprender mais.

Exemplo de API para controle de iluminação

Imagine que você tem um sistema básico de controle de iluminação com um aplicativo de programação interface de usuário (API) e quer permitir que os usuários controlem as luzes por meio de interfaces solicitações de texto. Use o recurso de chamada de função para interpretar a iluminação alterar solicitações de usuários e convertê-las em chamadas de API para definir a iluminação e a distribuição dos valores dos dados. Esse sistema hipotético de controle de iluminação permite controlar brilho da luz e sua temperatura da cor, definidas como dois elementos parâmetros:

Para simplificar, esse sistema de iluminação imaginário tem apenas uma luz, então o usuário não precisa especificar uma sala ou um local. Este é um exemplo de solicitação JSON você pode enviar à API de controle de iluminação para mudar o nível de luz para 50% usando a temperatura da cor da luz do dia:

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

Neste tutorial, mostramos como configurar uma chamada de função para a API Gemini para interpretar solicitações de iluminação dos usuários e mapeá-las para as configurações da API para controlar uma o brilho da luz e os valores de temperatura da cor.

Antes de começar: configurar o projeto e a chave de API

Antes de chamar a API Gemini, você precisa definir seu projeto e configurar sua chave de API.

dart pub add google_generative_ai

flutter pub add google_generative_ai

Definir uma função de API

Crie uma função que faça uma solicitação de API. Essa função precisa ser definida no código do aplicativo, mas podem chamar serviços ou APIs seu aplicativo. A API Gemini não chama essa função diretamente, então você pode controlar como e quando essa função é executada por meio do seu aplicativo o código-fonte. Para fins de demonstração, este tutorial define uma função de API simulada que retorna apenas os valores de iluminação solicitados:

Future<Map<String, Object?>> setLightValues(
  Map<String, Object?> arguments,
) async =>
    // This mock API returns the requested lighting values
    {
      'brightness': arguments['brightness'],
      'colorTemperature': arguments['colorTemp'],
    };

Criar declarações de função

Crie a declaração de função que você vai transmitir para o modelo generativo. Quando declarar uma função a ser usada pelo modelo, inclua o máximo de detalhes possível nas descrições de funções e parâmetros. 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. O código a seguir mostra como declare a função de controle de iluminação:

final lightControlTool = FunctionDeclaration(
    'setLightValues',
    'Set the brightness and color temperature of a room light.',
    Schema(SchemaType.object, properties: {
      'brightness': Schema(SchemaType.number,
          description: 'Light level from 0 to 100. '
              'Zero is off and 100 is full brightness.'),
      'colorTemperature': Schema(SchemaType.string,
          description: 'Color temperature of the light fixture, '
              'which can be `daylight`, `cool` or `warm`.'),
    }, requiredProperties: [
      'brightness',
      'colorTemperature'
    ]));

Declarar funções durante a inicialização do modelo

Para usar a chamada de função com um modelo, você precisa fornecer seu declarações de função quando você inicializa o objeto de modelo. Você declara definindo o parâmetro tools do modelo. O SDK do Dart também oferece suporte declarar as funções como argumentos para a generateContent ou APIs do generateContentStream.

final model = GenerativeModel(
  model: 'gemini-1.5-flash',
  apiKey: apiKey,

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

Gerar uma chamada de função

Depois de inicializar o modelo com as declarações da função, é possível solicitar o modelo com a função definida. Use a chamada de função com comandos de chat (sendMessage()), já que a chamada de função geralmente se beneficia da ter o contexto de comandos e respostas anteriores.

final chat = model.startChat(); final prompt =
  'Dim the lights so the room feels cozy and warm.';

// 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.
    'setLightValues' => await setLightValues(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);
}