Документация API

Формат POST запроса:

URL:	(http/https)* api.g-bot.ru/api/v1/post
metod:	POST
	parametrs (form-data):
guid	string	уникальный идентификатор подготовленной модели ассистента
session_id	null / string**	идентификатор сессии для идентификации диалога с пользователем.Если пустое значение — генерируется новый.
client_id	null / string**	идентификатор клиента/пользователя для идентификации диалога. Если пустое значение — генерируется новый
user_message	text	Сообщение пользователя.
Системные запросы. Не использовать на публичных страницах.
system_query	null / string**	Тип системного запроса. Опции: dataset_request — запрос содержимого датасета prompt_request — запрос содержимого промпта trainingdata_request — запрос содержимого поисковой выборки данных prompt_update — изменение содержимого промпта dataset_update — изменение содержимого датасета
system_query_value	text	Передаваемое содержание промпта или датасета в зависимости от типа запроса. Актуально в случае: prompt_update — изменение содержимого промпта dataset_update — изменение содержимого датасета
system_query_auth	null / string**	Ключ аутентификации пользователя (получить в «параметрах аккаунта»). При отсутствии или несовпадении ключа и владельца модели все системные запросы будут проигнорированы.

Формат GET запрос:

URL:	(http/https)* api.g-bot.ru/api/v1/get
metod:	GET
	parametrs:
guid	string	уникальный идентификатор подготовленной модели ассистента
session_id	null / string**	идентификатор сессии для идентификации диалога с пользователем. Если пустое значение — генерируется новый.
client_id	null / string**	идентификатор клиента/пользователя для идентификации диалога. Если пустое значение — генерируется новый.
user_message	text	Сообщение пользователя.

*Формат HTTP запроса введен для совместимости с приложениями, которые не могут работать по протоколу HTTPS. Если нет подобных ограничений рекомендуется использовать протокол HTTPS.

**Параметр client_id может отвечать за идентификацию пользователя (например, id пользователя Вконтакте) и соответствующего диалога. Изменение этого параметра приведет к созданию нового уникального диалога. Передача пустого параметра вызовет автоматическую генерацию нового диалога и нового уникального значения client_id. Также в настройках модели можно отключить хранение и использование истории диалога.

**Параметр session_id может отвечать за сессию пользователя и соответствующего диалога. Изменение этого параметра приведет к созданию нового уникального диалога, таким образом можно, например, «очищать» диалог в рамках одного client_id. Передача пустого параметра вызовет автоматическую генерацию нового диалога и нового уникального значения session_id. Также в настройках модели можно отключить хранение и использование истории диалога.

Следует помнить, что диалог также передается в запрос и определяет количество токенов, что влияет на стоимость запроса. И также не следует забывать об ограничениях по токенам уже самого сервиса ИИ.

Пример post запроса:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Пример post запроса</title>
</head>
<body>
<form method="post" action="https://api.g-bot.ru/api/v1/post">
    <input type="text" name="guid" value="N7QXZ1688928919Xs74e" hidden="hidden">
    <input type="text" name="session_id" value="session_id_123" hidden="hidden">
    <input type="text" name="client_id" value="client_id_123" hidden="hidden">
    <label for="user_message">Сообщение:</label>
    <textarea name="user_message" id="user_message" cols="30" rows="1"></textarea>
    <input type="text" name="client_id" value="client_id_123" hidden="hidden">
    <input type="submit" value="Отправить">
</form>
</body>
</html>

Коллекция Postman:

https://www.postman.com/warped-meteor-924061/workspace/g-bot-public/collection/32349472-7cb5abb3-cad1-4fd0-9708-1ae9f002cedb?action=share&source=copy-link&creator=32349472

Формат ответа:

format:	JSON
	parametrs:
success	boolean	успех (true) ошибка(false) запроса.
session_id	string	идентификатор сессии для идентификации диалога с пользователем. Если было передано пустое значение — генерируется новый ключ.
client_id	string	идентификатор клиента/пользователя для идентификации диалога. Если было передано пустое значение — генерируется новый ключ.
bot_message	text	Ответ ассистента.
user_message	text	Исходное сообщение пользователя.
system_message	{}	системные данные
	system_message:
error_message	text	Ошибки. возникшие при обработке запроса.
system_query	string	Соответствует типу системного запроса. Если запроса не было — поле отсутствует.
system_query_success	boolean	Успех/не успех выполнения системного запроса. Если запроса не было — поле отсутствует.
system_query_value	text	Содержание возвращаемых данных промпт или датасет в зависимости от типа системного запроса. Заполняется в случае передачи. prompt_request — запрос содержимого промпта dataset_request — запрос содержимого датасета Если запроса не было — поле отсутствует.
created_at	float	дата и время ответа в секундах с начала эпохи (1 января 1970 года).
history_chat	{}	Массив с предыдущим диалогом.
embedding_cost_input	float	Стоимость ембеддинга датасета.
embedding_tokens_input	integer	Количество токенов в датасете.
answer_cost_input	float	Стоимость входящего запроса к ассистенту.
answer_tokens_input	integer	Количество токенов во входящем запросе.
answer_cost_output	float	Стоимость ответа ассистента.
answer_tokens_output	integer	Количество токенов в ответе ассистента.
route	json	Массив с данными дочерней модели при переадресации.
	dialog_history:	массив данных истории диалога
user_message	text	запрос пользователя
bot_message	text	ответ ассистента
created_at	float	дата и время ответа в секундах с начала эпохи (1 января 1970 года).

Login