Робот класса JsonRobotLogic

Принцип работы робота

Текущее состояние при диалоге с роботом хранится в объекте чата в поле external_data с ключом 'json_robot_current_state'.

При назначении чата на робота (производится только в том случае, если логика робота в дескрипторе была описана верно) робот устанавливает в качестве текущего состояние "start", далее выполняются связанные с ним actions и выводятся возможные steps.

При переходе к новому состоянию тут же выполняются actions, которые связаны с текущим состоянием, затем выводится список возможных переходов (step), которые можно осуществить, а также ключевых слов, которые нужно вводить для осуществления перехода.

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

Из всех состояний, за исключением содержащих действие redirect_to_queue, должна быть предусмотрена возможность перехода в другие состояния (к примеру, возврата в главное меню). В противном случае при переходе в это состояние бот выдаст размещённое там сообщение, но затем переведёт обращение в очередь операторов.

Если пользователь пишет что-то непонятное вместо ключевых слов, возникает ошибка "unrecognized_response" и выполняются связанные с ней actions.

При откреплении чата от робота в объекте чата полю external_data с ключом 'json_robot_current_state' присваивается значение None.

Пример реального JSON-бота (с изменёнными названиями) Вы можете скачать здесь.

Структура конфигурационного файла

JSON-файл, используемый роботом, должен иметь определенный формат:

{  
   "states": {  
      "start": State,
      "state1": State,
      ...
   },
   "errors": {  
      "unrecognized_response": Error,
      "error1": Error,
      ...
   },
   "general_properties": {  
      "steps_header": String,
      "steps_template": String,
      "message_if_no_operators_online": String
   }
}

State

Состояние (вершина графа) описывает текущее состояние робота: его название, действия, шаги в другие состояния.

Формат:

{  
   "title": String,
   "actions": [  
      action1,
      ...
   ],
   "steps": [  
      step1,
      ...
   ]
}

steps может не быть в состояниях, которые в конечном итоге переводят чат на оператора. Если явный переход на оператора не осуществлен, но в состоянии не описаны steps, состояние считается тупиковым и чат переводится на оператора.

Обязательно описывается состояние "start" — с этого состояния начинается любой диалог с роботом.

Action

Действия, которые выполняются в момент перехода в новое состояние либо при возникновении ошибки. По сути это ссылка на метод, который будет вызываться, а также его параметры.

Формат:

{  
   "type": String,
   "parameters": {
      "parameter1": String,
      ...
   }
}

При необходимости добавления новых методов для новых, еще не реализованных actions, в класс JsonRobotLogic следует добавить метод вида:

def on_action_ACTION_NAME(self, parameter1, ...):
    ...

Step

Описывает возможный переход от текущего состояния к другому состоянию.

Формат:

{  
   "keyword": String,
   "step_id": String
}

Error

Штатная ошибка при общении с роботом. При ее возникновении выполняются связанные с ней action.

Формат:

{  
   "actions":[  
      "action1",
      ...
   ]
}

Обязательно должна быть описана ошибка "unrecognized_response" — возникает в случае, когда визитор не ввел ключевое слово, а ввел что-то непонятное. Другие ошибки пока не реализованы, но если возникнет такая необходимость, их можно будет добавить.