Toolkit for building conversational information access systems.
Project description
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://git@github.com/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://git@github.com/iai-group/dialoguekit.git@faa5c1fca37aaa275105cc1ca7698783719551c2
Usage example
-
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")
-
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)
-
Start conversation
dm.start() dm.close()
Conventions
We follow the IAI Python Style Guide.
Contributors
(Alphabetically ordered by last name)
- Jafar Afzali (2022)
- Krisztian Balog (2021-present)
- Nolwenn Bernard (2022-present)
- Aleksander Drzewiecki (2022)
- Shuo Zhang (2021)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dialoguekit-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6ab4986e3590112bface33798f6d178a63adda5e64b8ebdb1f52b538f523036 |
|
MD5 | 27913c3873e7313f76109c03c098e439 |
|
BLAKE2b-256 | de2bf26dfd1e71917dfcebe8a4b647d2a9c025da97fd72cdc2c8cb72ff16c9d7 |