dialoguekit.platforms.terminal_platform
=======================================

.. py:module:: dialoguekit.platforms.terminal_platform

.. autoapi-nested-parse::

   Terminal platform.

   This platform is used for getting user input and displaying agent responses in
   the terminal.



Classes
-------

.. autoapisummary::

   dialoguekit.platforms.terminal_platform.TerminalPlatform


Module Contents
---------------

.. py:class:: TerminalPlatform(agent_class: Type[dialoguekit.participant.Agent], user_id: str = 'terminal_user')

   Bases: :py:obj:`dialoguekit.platforms.Platform`


   Represents a terminal platform. It handles a single user.

   :param agent_class: The class of the agent.
   :param user_id: User ID. Defaults to "terminal_user".


   .. py:method:: start() -> None

      Starts the platform.



   .. py:method:: display_agent_utterance(utterance: dialoguekit.core.Utterance, agent_id: str, user_id: str = None) -> None

      Displays an agent utterance.

      :param utterance: An instance of Utterance.
      :param agent_id: Agent ID.
      :param user_id: User ID of the recipient. Defaults to None.



   .. py:method:: display_user_utterance(utterance: dialoguekit.core.Utterance, user_id: str) -> None

      Displays a user utterance.

      :param utterance: An instance of Utterance.
      :param user_id: User ID.