Действия

SES. Руководство пользователя: различия между версиями

Материал из Флора AI

Нет описания правки
Строка 19: Строка 19:


{| class="wikitable" style="width: 110%"
{| class="wikitable" style="width: 110%"
|+''Описание методов API''
|+''Методы API''
! style="color:blue;width: 15%" |'''GET'''
|-
! colspan="4" style="text-align: center"|'''<big>Группа методов ses</big>'''
|-
! style="color:green;width: 15%" |'''POST/ses/ask/{robot_id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:green;width: 15%" |'''POST/ses/log'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:blue;width: 15%" |'''GET/ses/session/{robot_id}/{session_id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! colspan="4" style="text-align: center"|'''<big>Группа методов ses/robot/<big>'''
|-
! style="color:green;width: 15%" |'''POST/ses/robot/add'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/apply/{id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/cleardraft/{id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/commit/{id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/delete/{id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/export/{id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/get/{id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/import/{id}'''
! colspan="3" style="width: 85%" |описание
! colspan="3" style="width: 85%" |описание
|-
|-
Строка 26: Строка 91:
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
|-
! style="color:green;width: 15%" |'''POST'''
! style="color:blue;width: 15%" |'''GET/ses/robot/list'''
! colspan="3" style="width: 85%" |описание
! colspan="3" style="width: 85%" |описание
|-
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/modify/{id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/restore/{id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! colspan="4" style="text-align: center"|'''<big>Группа методов ses/robot/data<big>'''
|-
! style="color:green;width: 15%" |'''POST/ses/robot/data/add/{robot}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/data/delete/{robot}/{id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/get/{robot}/{id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/list/{robot}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/data/modify/{robot}/{id}'''
! colspan="3" style="width: 85%" |описание
|-
| colspan="2" style="width: 50%" |<small>Входные параметры </small>
| colspan="2" style="width: 50%" |<small>выходные параметры</small>
|-
! colspan="4" style="text-align: center"|'''<big>Группа методов ses/robot/endpoint<big>'''
|}
|}

Версия от 16:06, 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 со всеми методами с возможностью их проверки.

Методы API
Группа методов 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
Источник — https://wiki.connect2ai.net/index.php?title=SES._Руководство_пользователя&oldid=1883