dialoguekit.participant.user

Abstract representation of core user-related data and functionality.

For communicating with an agent, the specific user instance needs to be connected with a DialogueConnector by invoking register_dialogue_connector().

Classes

UserType

Represents different types of users (humans vs simulated users).

User

Represents a user.

Module Contents

class dialoguekit.participant.user.UserType

Bases: enum.Enum

Represents different types of users (humans vs simulated users).

HUMAN = 0
SIMULATOR = 1
class dialoguekit.participant.user.User(id: str, user_type: UserType = UserType.HUMAN)

Bases: dialoguekit.participant.participant.Participant

Represents a user.

Parameters:

  • id – User ID.

  • user_type – User type (default: HUMAN).

property ready_for_input: bool

Returns whether the user is ready to listen for input.

handle_input(text: str) → None

Gets called every time there is a new user input.

Parameters:

text – User input.

receive_utterance(utterance: dialoguekit.core.utterance.Utterance) → None

Gets called every time there is a new agent utterance.

Parameters:

utterance – Agent utterance.