controller.controller_flask_socket

This file contains the Controller class which controls the flow of the conversation while the user interacts with the agent using Flask Socket IO.

Module Contents

Classes

ControllerFlaskSocket

Helper class that provides a standard way to create an ABC using

ChatNamespace

Attributes

logger

controller.controller_flask_socket.logger
class controller.controller_flask_socket.ControllerFlaskSocket(agent_class: Type[moviebot.agent.agent.MovieBotAgent], agent_args: Dict[str, Any] = {})

Bases: moviebot.controller.controller.Controller, dialoguekit.platforms.flask_socket_platform.FlaskSocketPlatform

Helper class that provides a standard way to create an ABC using inheritance.

start(host: str = '127.0.0.1', port: str = '5000') → None

Starts the platform.

Parameters:

  • host – Hostname. Defaults to 127.0.0.1.

  • port – Port. Defaults to 5000.

display_agent_utterance(user_id: str, utterance: dialoguekit.core.Utterance) → None

Displays agent utterance to the client.

Parameters:

  • user_id – User ID.

  • utterance – An instance of Utterance.

class controller.controller_flask_socket.ChatNamespace(namespace: str, platform: ControllerFlaskSocket)

Bases: dialoguekit.platforms.flask_socket_platform.ChatNamespace

on_register(data: Dict[str, Any]) → None

Registers client.

Parameters:

data – Data received from client.

on_login(data: Dict[str, Any]) → None

Logs in client.

Parameters:

data – Data received from client.

on_start_conversation(data: Dict[str, Any]) → None

Starts conversation with client. :param data: Data received from client.