Добавить расширение x-yc-apigateway-integration:http для интеграции с YandexGPT API
-
В консоли управления
выберите каталог, в котором создали или хотите создать API-шлюз. -
В списке сервисов выберите API Gateway.
-
Выберите API-шлюз или нажмите кнопку Создать API-шлюз, чтобы создать новый.
-
В поле Спецификация нажмите значок
. -
Укажите в поле:
- Путь — относительный путь к интеграции, который будет добавлен к URL-адресу API Gateway. Переменные указывайте в фигурных скобках, например
/static/{function_id}
. Подробнее см. спецификацию OpenAPI 3.0 . - HTTP-метод — метод, который будет использоваться для взаимодействия с интеграцией.
- Сервисный аккаунт — сервисный аккаунт для авторизации при обращении к YandexGPT API. Если у вас нет сервисного аккаунта, создайте его.
- Путь — относительный путь к интеграции, который будет добавлен к URL-адресу API Gateway. Переменные указывайте в фигурных скобках, например
-
В блоке Используемая модель выберите модель и укажите:
- Для модели
YandexGPT
— идентификатор каталога, который будет указан в URI модели YandexGPT API. - Для модели
DataSphere
— идентификатор модели, дообученной в Yandex DataSphere.
- Для модели
-
В блоке Способ передачи промта выберите источник промта и укажите:
- Для источника
Query-параметр
— имя query-параметра, в котором будет передаваться промт для запроса к YandexGPT API. - Для источника
Тело запроса
— имя поля тела запроса, в котором будет передаваться промт для запроса к YandexGPT API.
- Для источника
-
В блоке Сценарий использования выберите сценарий использования модели и задайте параметры, соответствующие выбранному сценарию:
-
Генерация текста
:- (Опционально) Температура — определяет вариативность ответа модели: укажите значение от
0
до1
. Чем выше температура, тем более креативными и случайными будут ответы модели. Значение по умолчанию —0.3
. - (Опционально) Количество токенов — максимальное число токенов генерации. По умолчанию
5
. Позволяет при необходимости ограничить объем ответа модели.
- (Опционально) Температура — определяет вариативность ответа модели: укажите значение от
-
Классификация текста
:-
Описание задания — текстовое описание задания для классификатора.
-
Классы — список классов, к которым может относиться текст. Чтобы добавить класс, нажмите значок
.Чтобы получить корректные результаты, используйте осмысленные названия классов.
-
(Опционально) Примеры запросов — примеры текстовых запросов для классов в формате
текстовый запрос:класс
. Чтобы добавить пример, нажмите значок . Подробнее см. в разделе Классификатор Few-shot.
-
-
-
Нажмите кнопку Добавить.
В поле Спецификация отобразится OpenAPI-спецификация с указанными значениями параметров.
Требования к структуре входящего запроса
Чтобы API-шлюз корректно обрабатывал входящие запросы, для них должно быть задано значение заголовка Content-Type: application/json
. Кроме этого:
-
Если в качестве способа передачи промта выбрана опция
Query-параметр
, запрос должен содержать заданный в блоке Способ передачи промта query-параметр и его значение.Пример пути для вызова шлюза:
<путь_к_интеграции>?<заданный_query-параметр>=<содержимое_промта>
. -
Если в качестве способа передачи промта выбрана опция
Тело запроса
, тело запроса должно содержать поле, заданное в блоке Способ передачи промта, и его значение.Пример тела запроса:
{"<имя_поля_тела_запроса_>": "<содержимое_промта>"}
.