Chat with this bot, ask about its metadata and make the bot apply changes to itself.

The Python code supports chatbots in any language. A German and English version is provided. The EgoBot runs locally and uses the IBM Watson Conversation service which is offered on IBM Bluemix.

A sample session:

If you have been working with the Watson service and Python before, you probably already have everything installed. If not, you need to install Python and then head over to the Watson Developer Tools and follow the link to the Python SDK. Install the SDK, too. Now download a copy of this repository or clone it.
To use the tool, copy config.json.sample to config.json and insert your service credentials for the IBM Watson Conversation service. Note that the service URL depends on the IBM Bluemix region. It is shown as part of the credentials. You can read here more about how to manage the Bluemix service keys.

English setup:

python egobot.py -setup -name egoEnglish -lang en

German setup:

python egobot.py -setup -name egoDeutsch -lang de

Wait 1-5 minutes for the training of Watson Conversation to be completed.

Once the setup is done, start a dialog:

python egobot.py -dialog -id "fasda5-xxxx-yyyy-913e-cde11d305ccf"

The id is the workspace_id as returned during the setup. The dialog language depends on the workspace language. The EgoBot first queries the workspace details, obtains its language, then reads in the localization file. Thus, for a German (de) conversation EgoBot starts like this:

Ich beginne mit dem Dialog. Stopp durch Ctrl+C oder Eingabe von 'bye'

=========================

Deine Eingabe:

For an English (en) workspace the dialog may begin like this:

Starting the dialog. To stop use Ctrl+C or type 'bye'

=========================

Your input:

The EgoBot dialog currently supports these features:

• Ask for metadata of existing intents ("Show me your intents", "Zeige mir deine Ziele", ...).
• Let the EgoBot print the available entities ("What are your entities", "Was sind deine Entities").
• Add new intents ("Add a new intent", "Lege einen neuen Intent an") by providing an intent name, a short description and samples. Samples need to be separated by /. An input line might look like "How is the weather/ Rain or shine/How will it be tomorrow".

Note that support for error processing (and catching them) is very basic at this moment. Feel free to improve the code and open a pull request.

If you forgot it, then you can obtain it by using the list feature:

python egobot.py -l

This will return all available workspaces and list their details, including the workspace_id.

The EgoBot supports access to the conversation logs. This helps to debug and improve a dialog. The logs for a workspace can be obtained as follows, passing the correct workspace_id:

python egobot.py -logs -id "fasda5-xxxx-yyyy-913e-cde11d305ccf"

The EgoBot is written in Python with all code in the file egobot.py. Sources for a German and an English conversation workspace are provided in the resources directory. The files are needed for the setup.
To easily adapt the code to different spoken languages the program is localized. The language files are in the folder lang. Feel free to adapt the phrases. The language file is loaded at the beginning of the setup process, and at the start of a dialog once the workspace language has been determined.

Here are some useful links to documentation and other resources:

• Watson Conversation service: https://www.ibm.com/watson/developercloud/doc/conversation/index.html
• API for Watson Conversation service: https://www.ibm.com/watson/developercloud/conversation/api/v1/#introduction
• Python SDK, Watson Developer Cloud: https://github.com/watson-developer-cloud/python-sdk
• Conversation API file in Python SDK: https://github.com/watson-developer-cloud/python-sdk/blob/master/watson_developer_cloud/conversation_v1.py
• The argparse module used for this tool: https://docs.python.org/2/library/argparse.html
• Watson Conversation Tool: https://github.com/data-henrik/watson-conversation-tool

See LICENSE for license information.

The tool is provided on a "as-is" basis and is un-supported. Use with care...

If you have found errors or some instructions are not working anymore, then please open an GitHub issue or, better, create a pull request with your desired changes.

You can find more tutorials and sample code at: https://ibm-bluemix.github.io/