SES. Руководство пользователя: различия между версиями
Материал из Флора AI
| Строка 1: | Строка 1: | ||
======'''Общее описание'''====== | ======'''Общее описание'''====== | ||
Сервис предназначен для создания | Сервис предназначен для создания сценарных машин и обеспечения их работы. | ||
====== '''Термины и определения''' ====== | ====== '''Термины и определения''' ====== | ||
Script engine service (SES) - сервис обеспечения работы и создания | Script engine service (SES) - сервис обеспечения работы и создания сценарных машин. | ||
Swagger UI – интерактивная веб-консоль с кратким описанием методов АPI и возможностью выполнять запросы к сервису SES в реальном времени | Swagger UI – интерактивная веб-консоль с кратким описанием методов АPI и возможностью выполнять запросы к сервису SES в реальном времени | ||
Версия от 16:20, 2 ноября 2024
Общее описание
Сервис предназначен для создания сценарных машин и обеспечения их работы.
Термины и определения
Script engine service (SES) - сервис обеспечения работы и создания сценарных машин. Swagger UI – интерактивная веб-консоль с кратким описанием методов АPI и возможностью выполнять запросы к сервису SES в реальном времени
Описание методов API
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SES. По умолчанию используется порт 6189/tcp.
Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок "accept: application/json"
Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл.
Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6190 будет отображен интерфейс swagger со всеми методами с возможностью их проверки.
| Группа методов ses | |||
|---|---|---|---|
| POST/ses/ask/{robot_id} | описание | ||
| Входные параметры | выходные параметры | ||
| POST/ses/log | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/session/{robot_id}/{session_id} | описание | ||
| Входные параметры | выходные параметры | ||
| Группа методов ses/robot/ | |||
| POST/ses/robot/add | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/apply/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/cleardraft/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/commit/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| DELETE/ses/robot/delete/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/export/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/get/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| POST/ses/robot/import/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/list | описание | ||
| Входные параметры | выходные параметры | ||
| POST/ses/robot/modify/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/restore/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| Группа методов ses/robot/data | |||
| POST/ses/robot/data/add/{robot} | описание | ||
| Входные параметры | выходные параметры | ||
| DELETE/ses/robot/data/delete/{robot}/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/data/get/{robot}/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/data/list/{robot} | описание | ||
| Входные параметры | выходные параметры | ||
| POST/ses/robot/data/modify/{robot}/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| Группа методов ses/robot/endpoint | |||
| POST/ses/robot/endpoint/add/{robot} | описание | ||
| Входные параметры | выходные параметры | ||
| DELETE/ses/robot/endpoint/delete/{robot}/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/endpoint/get/{robot}/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/endpoint/list/{robot} | описание | ||
| Входные параметры | выходные параметры | ||
| POST/ses/robot/endpoint/modify/{robot}/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| Группа методов ses/robot/script | |||
| POST/ses/robot/script/add/{robot} | описание | ||
| Входные параметры | выходные параметры | ||
| DELETE/ses/robot/script/delete/{robot}/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/script/get/{robot}/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/robot/script/list/{robot} | описание | ||
| Входные параметры | выходные параметры | ||
| POST/ses/robot/script/modify/{robot}/{id} | описание | ||
| Входные параметры | выходные параметры | ||
| Группа методов ses/testapi | |||
| GET/ses/testapi/list | описание | ||
| Входные параметры | выходные параметры | ||
| POST/ses/testapi/{request} | описание | ||
| Входные параметры | выходные параметры | ||
| GET/ses/testapi/{request} | описание | ||
| Входные параметры | выходные параметры | ||