Investment Advisor

DEPRECATED: this repo is no longer actively maintained. It can still be used as reference, but may contain outdated or unpatched code.

The Investment Advisor Demo combines IBM Watson Personality Insights and IBM Watson Tradeoff Analytics services to recommend suitable funds and agents for clients. Fund recommendation is based on a client's risk propensity. Agent recommendation focuses on building long-term relationships with clients.

Getting Started

1. Create a Bluemix Account

   Sign up in Bluemix, or use an existing account.

2. Download and install the Cloud-foundry CLI tool

3. Edit the manifest.yml file and change the <application-name> to something unique.

   applications:
   - name: <application-name>
   command: node app.js
   path: .
   memory: 1G
   services:
   - personality-insights-service-standard
   - tradeoff-analytics-service-standard

   The name you use will determinate your application url initially, e.g. <application-name>.mybluemix.net.

4. Create a FREE Mongodb database using MongoLab.

5. Copy the database url for MongoDB to credentials.js, under database key.

6. You may optionally modify the users.json file inside data folder. See Setting up users and funds data section for more information.

7. Connect to Bluemix in the command line tool.

   $ cf api https://api.ng.bluemix.net
   $ cf login -u <your user ID>

8. Create the Tradeoff Analytics service in Bluemix.

   $ cf create-service tradeoff_analytics standard tradeoff-analytics-service-standard

9. Create the Personality Insights service in Bluemix.

   $ cf create-service personality_insights tiered personality-insights-service-standard

10. Push it live!

    $ cf push

See the full Getting Started documentation for more details, including code snippets and references.

Running locally

The application uses Node.js and npm so you will have to download and install them as part of the steps below.

1. Copy the credentials from your personality-insights-service-standard and tradeoff-analytics-service-standard service in Bluemix to credentials.js, you can see the credentials using:

   $ cf env <application-name>

   Example output:

   System-Provided:
   {
   "VCAP_SERVICES": {
     "tradeoff_analytics": [{
         "credentials": {
           "url": "<url>",
           "password": "<password>",
           "username": "<username>"
         },
       "label": "tradeoff-analytics",
       "name": "tradeoff-analytics-standard-service",
       "plan": "standard"
    }]
   }
   }

   You need to copy username, password and url.

2. Copy the credentials for MongoDB service in Bluemix to credentials.js, under database key.

3. Install Node.js

4. Go to the project folder in a terminal and run: npm install

5. Start the application

6. npm start

7. Go to http://localhost:3000

Setting up users and funds data

The folder data contains the users and funds data files.

• users.json contains all the application's users. For each user, you can specify one of two sources:

  • generic: The application expects to find user's content items in data/content_items folder. This files are according to Personality Insight's input definition, for example:

    {
      "contentItems": [
        {
          "id": "245160944223793152",
          "userid": "bob",
          "sourceid": "twitter",
          "created": 1427720427,
          "updated": 1427720427,
          "contenttype": "text/plain",
          "charset": "UTF-8",
          "language": "en-us",
          "content": "This is a sample tweet",
          "parentid": "",
          "reply": false,
          "forward": false
        },
        //...
      ]
    }

  • twitter: The application uses the user id as a TwitterID and will retrieve the user's data from twitter. In any case, you can specify/override the user's data in the users.json. You can find an example of this file in data/users.json.example.
• recommendations contains three files used to generate the recommendations:
  • communication_channels.json:
  • funds_dilemma.json: this is the dilemma file to be used in Tradeoff Analytics analysis.
  • funds_personality.json: this data is used to generate the matching between clients and funds. Also provides engagement messages and strategies.
• portraits contains images to be used as portraits.

License

This application code is licensed under Apache 2.0. Full license text is available in LICENSE.

Known bugs

No known bugs.

Troubleshooting

To troubleshoot your Bluemix app the main useful source of information are the logs, to see them, run:

  $ cf logs <application-name> --recent

Contributing

See CONTRIBUTING.

Open Source @ IBM

Find more open source projects on the IBM Github Page