hubot-ibmcloud-service-suggest

hubot-bluemix-suggest

A hubot script for providing assistance to a user who needs help finding Bluemix service(s) that match his needs.

Getting Started

• Usage
• Commands
• Hubot Adapter Setup
• Cognitive Setup
• Development
• License
• Contribute

Usage

Steps for adding this to your existing hubot:

1. cd into your hubot directory
2. Install the app management functionality with npm install hubot-ibmcloud-service-suggest --save
3. Add hubot-ibmcloud-service-suggest to your external-scripts.json
4. Add the necessary environment variables:

export HUBOT_WATSON_NLC_URL=<API URL for Watson Natural Language Classifier>
export HUBOT_WATSON_NLC_USERNAME=<Watson NLC Username>
export HUBOT_WATSON_NLC_PASSWORD=<Watson NLC Password>
export HUBOT_WATSON_NLC_SUGGEST_PREFIX=<Optional prefix to include in NLC classifier name>

1. Start up your bot & off to the races!

Commands

• hubot suggest list - Show services bot is trained to suggest.
• hubot suggest services to ... - Suggest services to fit your needs.

Hubot Adapter Setup

Hubot supports a variety of adapters to connect to popular chat clients. For more feature rich experiences you can setup the following adapters:

• Slack setup
• Facebook Messenger setup

Cognitive Setup

This project supports natural language interactions using Watson and other Bluemix services. For more information on enabling these features, refer to Cognitive Setup.

Development

Please refer to the CONTRIBUTING.md before starting any work. Steps for running this script for development purposes:

NLC training

1. Update env in the config folder, with the following contents:

export HUBOT_BLUEMIX_API=<Bluemix API URL>
export HUBOT_BLUEMIX_ORG=<Bluemix Organization>
export HUBOT_BLUEMIX_SPACE=<Bluemix space>
export HUBOT_BLUEMIX_USER=<Bluemix User ID>
export HUBOT_BLUEMIX_PASSWORD=<Password for the Bluemix use>

1. Download the jquery.min.js library into the hubot-ibmcloud-service-suggest project folder. This can be obtained from here: http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js
2. Run npm run update-config to generate or update data/services-data.json.
3. Review data/services-data.json file changes. Load the doc page of added services to confirm quality of doc and what the service is called on the doc pages. If services is referred to by names other than their doc_name attribute, then add those names to doc_name.

• Optional: Full manual training can be done by adding class_text array of strings in nlc_class_info objects.
• Optional: To still using crawler generated data, but also include partial manual training data add additional_class_text instead of class_text.

1. Use crawler to produce training data:

• npm run crawler -- --key=<YOUR_ALCHEMY_API_KEY>

1. Review output from crawler and copy the generated csv file into the data directory using the next version number of the data/hubot-service-suggest .csv file.

• cp output/nlcTrainingData.csv data/hubot-service-suggest_v2.csv

1. Review potential deprecated services. The crawler will log a list of such services to output/deprecation_watch_list.json. If these services are truly deprecated, then remove them from the nlc_class_info section of data/services-data.json and add them to the blacklist section. Also remove them from the new .csv training data file.
2. Remove the previous version of the .csv file

• rm data/hubot-service-suggest_v1.csv

The bot will automatically detect the version update and train with the new .csv file.

Configuration Setup

1. Create config folder in root of this project.
2. Create env in the config folder, with the following contents:

export HUBOT_WATSON_NLC_URL=<API URL for Watson Natural Language Classifier>
export HUBOT_WATSON_NLC_USERNAME=<Watson NLC Username>
export HUBOT_WATSON_NLC_PASSWORD=<Watson NLC Password>

1. In order to view content in chat clients you will need to add hubot-ibmcloud-formatter to your external-scripts.json file. Additionally, if you want to use hubot-help to make sure your command documentation is correct. Create external-scripts.json in the root of this project

[
    "hubot-help",
    "hubot-ibmcloud-formatter"
]

1. Lastly, run npm install to obtain all the dependent node modules.

Running Hubot with Adapters

Hubot supports a variety of adapters to connect to popular chat clients.

If you just want to use:

• Terminal: run npm run start
• Slack: link to setup instructions
• Facebook Messenger: link to setup instructions

License

See LICENSE.txt for license information.

Contribute

Please check out our Contribution Guidelines for detailed information on how you can lend a hand.