dialoguekit 0.0.7

Toolkit for building conversational information access systems.

DialogueKit

DialogueKit is a library for conversational information access (CIA). It contains based classes for fundamental concepts, such as dialogue participants, dialogue management, natural language understanding, natural language generation, etc. In addition to the fundamental concepts DialogueKit contains an evaluation module, for evaluating the performance of and CIA systems. Consult the documentation for details.

Install as a package

DialogueKit is published to PyPI, install it by running:

pip install dialoguekit

If you want to install a DialogueKit from a specific commit or straight from github this is still possible.

The command will install the latest version from the main branch.

• On Windows you may need to run this command before pip installing

ssh -t git github.com    

• pip install

pip install git+ssh://[e-mail]/iai-group/dialoguekit.git

If you want to specify a specific commit as the source of the package append the commit hash to the end of the command separated with a "@".

• Specific commit as the source of the package.

pip install git+ssh://[e-mail]/iai-group/dialoguekit.git@faa5c1fca37aaa275105cc1ca7698783719551c2

Usage example

1. Define agent and user

   from dialoguekit.core.utterance import Utterance
   from dialoguekit.participant.user import User, UserType
   from sample_agents.parrot_agent import ParrotAgent
   
   # Participants
   agent = ParrotAgent("A01")
   user = User("U01")
   

2. Create and connect platform and dialogue manager

   from dialoguekit.platforms.platform import Platform
   from dialoguekit.manager.dialogue_manager import DialogueManager
   
   platform = Platform()
   dm = DialogueManager(agent, user, platform)
   
   user.connect_dialogue_manager(dm)
   agent.connect_dialogue_manager(dm)
   

3. Start conversation

     dm.start()
     dm.close()
   

Planned future features

• Rework imports
• Versioning for docs
• Unified dialogue reader

Conventions

We follow the IAI Python Style Guide.

Contributors

(Alphabetically ordered by last name) Jafar Afzali, Krisztian Balog, Aleksander Drzewiecki and Shuo Zhang