Отправить запрос в GigaChat

Отправить запрос в GigaChat Версия 1 (Python)

Группа "Сервисы Сбера", подгруппа "GigaChat"

Описание

Действие отправляет запрос с заданными параметрами в GigaChat

Параметры

Входные параметры

Контекст – контекст для подключения к GigaChat.
Результат выполнения действия "Авторизоваться в GigaChat" (группа "Сервисы Сбера", подгруппа "Авторизация").

Модель – модель GigaChat, используемая для генерации ответа. Информацию о доступных моделях можно найти в профиле и в документации к GigaChat.

Сообщение – сообщение, на которое требуется получить ответ.
Задаётся в произвольной форме. Может содержать инструкцию для модели и информацию, которую необходимо обработать.

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

При использовании параметра "История чата" инструкция должна передаваться в первом запросе – с которого начинается история чата.
Это связано с тем, что структура запроса к GigaChat требует, чтобы системное сообщение для модели передавалось в массиве сообщений первым.

Источник данных – информация, на основе которой модель будет генерировать ответы. Дополнительно задаёт контекст повествования модели. Используется для поддержки RAG.
Информация может передаваться в дополнение к имеющейся в истории чата – модель генерирует ответы на основе всех полученных данных.

Температура – случайность выбора токенов для формирования ответа. Чем выше значение, тем более случайным будет ответ. При значениях больше 2 ответ может отличаться избыточной случайностью. Допустимые значения: от 0 и выше.
Значение по умолчанию зависит от выбранной модели.

Ограничение маловероятных токенов – чем выше значение, тем больше возможных токенов, даже менее вероятных, рассматривает модель, что делает текст ответа более разнообразным. Допустимые значения: от 0 до 1 включительно.
Значение по умолчанию зависит от выбранной модели.

Количество ответов – количество ответов модели на запрос. Допустимые значения: целые числа от 1 до 4 включительно. По умолчанию: 1.

Количество токенов – максимальное количество токенов для генерации ответа. При малом значении параметра модель может вернуть неполный ответ. Допустимые значения: целые числа больше 0.
Значение по умолчанию зависит от выбранной модели.

Повторение слов – ограничение повторения слов в ответе. При значениях от 0 до 1 модель будет повторять уже использованные слова. При значении больше 1 модель будет стараться не повторять слова. Допустимые значения: от 0 и выше.
Значение по умолчанию зависит от выбранной модели.

История чата – передача истории чата позволяет GigaChat работать с результатами прошлых запросов и учитывать их при генерации ответов.

Тайм-аут, мс – время в миллисекундах, в течение которого повторяются попытки получения ответа от сервиса. По умолчанию: 15000 мс.

Выходные параметры

Ответ – ответ на запрос в GigaChat.
Возвращается в виде коллекции. В зависимости от значения параметра "Количество ответов", содержит от 1 до 4 включительно элементов с типом "Строка".

История чата – история чата для использования в других запросах к GigaChat. Возвращается в виде JSON. Содержит массив сообщений.
Пример

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

[
    {
        "role": "system",
        "content": "Отвечай как научный сотрудник"
    },
    {
        "role": "user",
        "content": "Напиши 5 вариантов названий для космической станции"
    },
    {
        "role": "assistant",
        "content": "1. МИР 2. ЗЕМЛЯ 3. ЛУНА 4. НОВАЯ ЗЕМЛЯ 5. ПОЛЮС"
    },
    {
        "role": "user",
        "content": "А если представить, что они будут на Марсе?"
    },
    {
        "role": "assistant",
        "content": "1. МИР-МАРС 2. ЗЕМЛЯ-МАРС 3. ЛУНА-МАРС 4. НОВАЯ ЗЕМЛЯ-МАРС 5. ПОЛЮС-МАРС"
    }
]

Настройки

Свойство	Описание	Тип	Пример заполнения	Обязательность заполнения поля
Параметры
Контекст	Контекст для подключения к GigaChat	Контекст GigaChat	"Авторизоваться в GigaChat"."Контекст"	Да
Модель	Модель GigaChat, используемая для генерации ответа. Информацию о доступных моделях можно найти в профиле и в документации к GigaChat	Строка	GigaChat:latest	Да
Сообщение	Сообщение, на которое требуется получить ответ	Строка	Сейсмические явления – что это?	Да
Инструкция	Инструкция для модели, задающая критерии обработки сообщения и правила ответа на него (роль, стиль, форма ответа, пр.). При использовании параметра "История чата" инструкция должна передаваться в первом запросе – с которого начинается история чата	Строка	Отвечай, добавляя через каждые несколько слов слова "вроде", "типа", "как бы".	Нет
Источник данных	Информация, на основе которой модель будет генерировать ответы. Дополнительно задаёт контекст повествования модели. Используется для поддержки RAG	Строка	Сейсмические явления – это процессы движения пород, магмы и флюидов в литосфере и мантии Земли, способные генерировать сейсмическую энергию и реализовывать её посредством механических импульсов: поступательного импульса в виде поперечных сейсмических волн Р и вращательного импульса в виде продольных сейсмических волн S, проявляющих себя как землетрясения, извержения вулканов, горные удары, обвалы, выбросы пород и газа из горного массива. Большинство сейсмических явлений носят природный характер, но отдельные явления могут быть вызваны военной или хозяйственной деятельностью человека, например: испытаниями атомного оружия, взрывными работами большой мощности, горными работами, устройством гидротехнических сооружений и т. д. На вопрос образования энергии сейсмических явлений у научного сообщества геофизиков до сих пор нет вразумительного ответа, а существующие гипотезы разработанные в XX веке опираются на законы механики твёрдого тела и не соответствуют современному уровню знаний, как классической физики и химии, так и квантовых систем и поэтому противоречивы.	Нет
Температура	Случайность выбора токенов для формирования ответа. Чем выше значение, тем более случайным будет ответ. При значениях больше 2 ответ может отличаться избыточной случайностью. Допустимые значения: от 0 и выше	Число	0.9	Нет
Ограничение маловероятных токенов	Чем выше значение, тем больше возможных токенов, даже менее вероятных, рассматривает модель, что делает текст ответа более разнообразным. Допустимые значения: от 0 до 1 включительно	Число	0.6	Нет
Количество ответов	Количество ответов модели на запрос. Допустимые значения: целые числа от 1 до 4 включительно. По умолчанию: 1	Число	2	Нет
Количество токенов	Максимальное количество токенов для генерации ответа. При малом значении параметра модель может вернуть неполный ответ. Допустимые значения: целые числа больше 0	Число	512	Нет
Повторение слов	Ограничение повторения слов в ответе. При значениях от 0 до 1 модель будет повторять уже использованные слова. При значении больше 1 модель будет стараться не повторять слова. Допустимые значения: от 0 и выше	Число	1.2	Нет
История чата	Передача истории чата позволяет GigaChat работать с результатами прошлых запросов и учитывать их при генерации ответов	JSON	"Отправить запрос в GigaChat"."История чата"	Нет
Тайм-аут, мс	Время в миллисекундах, в течение которого повторяются попытки получения ответа от сервиса. По умолчанию: 15000 мс	Число	10000	Нет
Результаты
Ответ	Ответ на запрос в GigaChat	Коллекция
История чата	История чата для использования в других запросах к GigaChat	JSON

Особые условия использования

Особых условий нет.

Пример использования

Задача

Направить запрос в GigaChat с заданной инструкцией и получить несколько ответов.

Решение

Воспользоваться действиями "Авторизоваться в GigaChat" и "Отправить запрос в GigaChat".

Реализация

Установить в схему проекта действия "Авторизоваться в GigaChat" и "Отправить запрос в GigaChat".
В действии "Авторизоваться в GigaChat" установить значения параметров "Авторизационные данные" и "Версия API".
В действии "Отправить запрос в GigaChat" установить значения параметров "Контекст" и "Модель", "Сообщение", "Инструкция" и "Количество ответов".
Запустить выполнение робота нажатием кнопки "Старт" на панели управления роботом.