Вызов функций с использованием API Gemini,Вызов функций с использованием API Gemini


Генеративные модели эффективны при решении многих типов проблем. Однако они ограничены такими ограничениями, как:

  • Они замораживаются после обучения, что приводит к устаревшим знаниям.
  • Они не могут запрашивать или изменять внешние данные.

Вызов функций может помочь вам преодолеть некоторые из этих ограничений. Вызов функций иногда называют использованием инструментов , поскольку он позволяет модели использовать внешние инструменты, такие как API и функции, для генерации окончательного ответа.

Вы можете узнать больше о вызове функций в документации Google Cloud , включая полезный список вариантов использования вызова функций .

Вызов функций поддерживается Gemini 1.0 Pro, Gemini 1.5 Pro и Gemini 1.5 Flash.

В этом руководстве показано, как можно реализовать настройку вызова функции, аналогичную примеру, описанному в следующем основном разделе этой страницы. Вкратце, вот шаги по настройке вызова функций в вашем приложении:

  1. Напишите функцию, которая может предоставить модели информацию, необходимую для генерации окончательного ответа (например, функция может вызывать внешний API).

  2. Создайте объявление функции, описывающее функцию и ее параметры.

  3. Предоставьте объявление функции во время инициализации модели, чтобы модель знала, как она может использовать эту функцию, если это необходимо.

  4. Настройте свое приложение так, чтобы модель могла отправлять необходимую информацию вашему приложению для вызова функции.

  5. Передайте ответ функции обратно в модель, чтобы модель могла сгенерировать окончательный ответ.

Перейти к реализации кода

Обзор примера вызова функции

Отправляя запрос модели, вы также можете предоставить модели набор «инструментов» (например, функций), которые она может использовать для генерации окончательного ответа. Чтобы использовать эти функции и вызывать их («вызов функций»), модель и ваше приложение должны передавать информацию друг другу взад и вперед, поэтому рекомендуемый способ использования вызова функций — через многоповоротный интерфейс чата. .

Представьте, что у вас есть приложение, в котором пользователь может ввести запрос типа: What was the weather in Boston on October 17, 2024? .

Модели Gemini могут не знать эту информацию о погоде; однако представьте, что вам известен API внешней службы погоды, который может ее предоставить. Вы можете использовать вызов функций, чтобы предоставить модели Gemini путь к этому API и информации о погоде.

Сначала вы пишете в своем приложении функцию fetchWeather , которая взаимодействует с этим гипотетическим внешним API, имеющим следующие входные и выходные данные:

Параметр Тип Необходимый Описание
Вход
location Объект Да Название города и его штат, для которого можно узнать погоду.
Поддерживаются только города США. Всегда должен быть вложенным объектом city и state .
date Нить Да Дата, для которой нужно получить прогноз погоды (всегда должна быть в формате YYYY-MM-DD ).
Выход
temperature Целое число Да Температура (в градусах Фаренгейта)
chancePrecipitation Нить Да Вероятность осадков (выражена в процентах)
cloudConditions Нить Да Облачность (одна из clear , partlyCloudy , mostlyCloudy , cloudy )

При инициализации модели вы сообщаете модели, что эта функция fetchWeather существует и как ее можно использовать для обработки входящих запросов, если это необходимо. Это называется «объявлением функции». Модель не вызывает функцию напрямую . Вместо этого, пока модель обрабатывает входящий запрос, она решает, может ли функция fetchWeather помочь ей ответить на запрос. Если модель решает, что функция действительно может быть полезна, она генерирует структурированные данные, которые помогут вашему приложению вызвать функцию .

Посмотрите еще раз на входящий запрос: What was the weather in Boston on October 17, 2024? . Модель, скорее всего, решит, что функция fetchWeather может помочь ей сгенерировать ответ. Модель будет смотреть, какие входные параметры необходимы для fetchWeather , а затем генерировать структурированные входные данные для функции, которая выглядит примерно так:

{
  functionName: fetchWeather,
  location: {
    city: Boston,
    state: Massachusetts  // the model can infer the state from the prompt
  },
  date: 2024-10-17
}

Модель передает эти структурированные входные данные в ваше приложение, чтобы ваше приложение могло вызвать функцию fetchWeather . Когда ваше приложение получает данные о погодных условиях от API, оно передает эту информацию в модель. Эта информация о погоде позволяет модели завершить окончательную обработку и сгенерировать ответ на первоначальный запрос « What was the weather in Boston on October 17, 2024?

Модель могла бы дать окончательный ответ на естественном языке, например: On October 17, 2024, in Boston, it was 38 degrees Fahrenheit with partly cloudy skies.

Диаграмма, показывающая, как вызов функции включает взаимодействие модели с функцией в вашем приложении.

Реализация вызова функции

Прежде чем начать

Если вы еще этого не сделали, прочтите руководство по началу работы с Vertex AI in Firebase SDK . Убедитесь, что вы выполнили все следующее:

  1. Настройте новый или существующий проект Firebase, включая использование тарифного плана Blaze и включение необходимых API.

  2. Подключите свое приложение к Firebase, включая регистрацию вашего приложения и добавление конфигурации Firebase в ваше приложение.

  3. Добавьте SDK и инициализируйте службу Vertex AI и генеративную модель в своем приложении.

После того как вы подключили свое приложение к Firebase, добавили SDK и инициализировали службу Vertex AI и генеративную модель, вы готовы вызвать Gemini API .

Остальные шаги в этом руководстве показывают, как реализовать настройку вызова функции, аналогичную рабочему процессу, описанному в разделе «Обзор примера вызова функции» (см. верхний раздел этой страницы).

Полный пример кода для этого примера вызова функции можно просмотреть далее на этой странице.

Шаг 1 : Напишите функцию

Представьте, что у вас есть приложение, в котором пользователь может ввести запрос типа: What was the weather in Boston on October 17, 2024? . Модели Gemini могут не знать эту информацию о погоде; однако представьте, что вы знаете API внешнего метеорологического сервиса, который может его предоставить. Пример в этом руководстве основан на этом гипотетическом внешнем API.

Напишите в своем приложении функцию, которая будет взаимодействовать с гипотетическим внешним API и предоставлять модели информацию, необходимую для генерации окончательного запроса. В этом примере с погодой это будет функция fetchWeather , которая вызывает этот гипотетический внешний API.

Шаг 2. Создайте объявление функции.

Создайте объявление функции, которое вы позже предоставите модели (следующий шаг этого руководства).

В своем объявлении включите как можно больше подробностей в описания функции и ее параметров.

Модель использует информацию в объявлении функции, чтобы определить, какую функцию выбрать и как предоставить значения параметров для фактического вызова функции. См . раздел «Дополнительные варианты поведения и параметры» далее на этой странице, чтобы узнать, как модель может выбирать между функциями, а также как вы можете контролировать этот выбор.

Обратите внимание на следующую информацию о предоставленной вами схеме:

  • Вы должны предоставить объявления функций в формате схемы, совместимом со схемой OpenAPI . Vertex AI предлагает ограниченную поддержку схемы OpenAPI.

    • Поддерживаются следующие атрибуты: type , nullable , required , format , description , properties , items , enum .

    • Следующие атрибуты не поддерживаются: default , optional , maximum , oneOf .

  • По умолчанию для Vertex AI in Firebase SDK все поля считаются обязательными , если вы не укажете их как необязательные в массиве optionalProperties . Для этих необязательных полей модель может заполнять поля или пропускать их. Обратите внимание, что это противоположно поведению по умолчанию для Vertex AI Gemini API .

Рекомендации по использованию объявлений функций, включая советы по именам и описаниям, см. в разделе «Рекомендации» в документации Google Cloud .

Вот как вы можете написать объявление функции:

Шаг 3. Предоставьте объявление функции во время инициализации модели.

Максимальное количество объявлений функций, которые вы можете предоставить вместе с запросом, составляет 128. См. раздел «Дополнительные варианты поведения и параметры» ниже на этой странице, чтобы узнать, как модель может выбирать между функциями, а также как вы можете контролировать этот выбор (с помощью toolConfig для установки режим вызова функции ).

Узнайте, как выбрать модель Gemini и, при необходимости, местоположение, подходящее для вашего варианта использования и приложения.

Шаг 4. Вызовите функцию для вызова внешнего API.

Если модель решит, что функция fetchWeather действительно может помочь ей сгенерировать окончательный ответ, вашему приложению необходимо выполнить фактический вызов этой функции, используя структурированные входные данные, предоставленные моделью.

Поскольку информацию необходимо передавать туда и обратно между моделью и приложением, рекомендуемый способ использования вызова функций — через многоповоротный интерфейс чата.

В следующем фрагменте кода показано, как вашему приложению сообщается, что модель хочет использовать функцию fetchWeather . Это также показывает, что модель предоставила необходимые значения входных параметров для вызова функции (и лежащего в ее основе внешнего API).

В этом примере входящий запрос содержал подсказку What was the weather in Boston on October 17, 2024? . Из этого приглашения модель вывела входные параметры, необходимые для функции fetchWeather (то есть city , state и date ).

Шаг 5. Предоставьте выходные данные функции модели для генерации окончательного ответа.

После того как функция fetchWeather вернет информацию о погоде, вашему приложению необходимо передать ее обратно в модель.

Затем модель выполняет окончательную обработку и генерирует окончательный ответ на естественном языке, например: On October 17, 2024 in Boston, it was 38 degrees Fahrenheit with partly cloudy skies.

Дополнительные варианты поведения и параметры

Вот некоторые дополнительные варианты поведения при вызове функций, которые вам необходимо включить в свой код, и параметры, которыми вы можете управлять.

Модель может попросить снова вызвать функцию или другую функцию.

Если ответа от одного вызова функции недостаточно для того, чтобы модель сгенерировала окончательный ответ, модель может запросить дополнительный вызов функции или запросить вызов совершенно другой функции. Последнее может произойти только в том случае, если вы предоставите модели более одной функции в списке объявлений функций.

Ваше приложение должно учитывать, что модель может запрашивать дополнительные вызовы функций.

Модель может попросить вызвать несколько функций одновременно.

Вы можете предоставить модели до 128 функций в списке объявлений функций. Учитывая это, модель может решить, что необходимо несколько функций, чтобы помочь ей сгенерировать окончательный ответ. И он может решить вызвать некоторые из этих функций одновременно — это называется вызовом параллельных функций .

Ваше приложение должно учитывать, что модель может запрашивать одновременное выполнение нескольких функций, и ваше приложение должно предоставлять все ответы от функций обратно в модель.

Параллельный вызов функций поддерживается Gemini 1.5 Pro и Gemini 1.5 Flash.

Вы можете контролировать, как и может ли модель запрашивать вызов функций.

Вы можете наложить некоторые ограничения на то, как и должна ли модель использовать предоставленные объявления функций. Это называется установкой режима вызова функции . Вот несколько примеров:

  • Вместо того, чтобы позволять модели выбирать между немедленным ответом на естественном языке и вызовом функции, вы можете заставить ее всегда использовать вызовы функций. Это называется принудительным вызовом функции .

  • Если вы предоставляете несколько объявлений функций, вы можете ограничить модель использованием только подмножества предоставленных функций.

Вы реализуете эти ограничения (или режимы), добавляя конфигурацию инструмента ( toolConfig ) вместе с приглашением и объявлениями функций. В конфигурации инструмента можно указать один из следующих режимов . Самый полезный режим — ANY .

Режим Описание
AUTO Поведение модели по умолчанию. Модель решает, использовать ли вызов функции или ответ на естественном языке.
ANY Модель должна использовать вызовы функций («принудительный вызов функций»). Чтобы ограничить модель подмножеством функций, укажите разрешенные имена функций в allowedFunctionNames .
NONE Модель не должна использовать вызовы функций. Такое поведение эквивалентно запросу модели без каких-либо связанных объявлений функций.

Режим вызова функций поддерживается Gemini 1.5 Pro и Gemini 1.5 Flash.

Что еще вы можете сделать?

Попробуйте другие возможности Gemini API

Узнайте, как контролировать создание контента

Вы также можете поэкспериментировать с подсказками и конфигурациями модели с помощью Vertex AI Studio .

Узнайте больше о моделях Gemini

Узнайте о моделях, доступных для различных вариантов использования , а также об их квотах и ​​ценах .


Оставьте отзыв о своем опыте использования Vertex AI in Firebase