/personality-insights-java

Sample Java Application for the IBM Watson Personality Insights Service

Primary LanguageCSSApache License 2.0Apache-2.0

Personality Insights Java Starter Application

The IBM Watson Personality Insights service uses linguistic analysis to extract cognitive and social characteristics from input text such as email, text messages, tweets, forum posts, and more. By deriving cognitive and social preferences, the service helps users to understand, connect to, and communicate with other people on a more personalized level.

Give it a try! Click the button below to fork into IBM DevOps Services and deploy your own copy of this application on Bluemix.

Deploy to Bluemix

Getting Started

  1. Create a Bluemix Account

    Sign up in Bluemix or use an existing account. Watson Services in Beta are free to use.

  2. Download and install the Cloud-foundry CLI tool.

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

applications:
- services:
  - personality-insights-service
  name: <application-name>
  path: output/webApp.war
  memory: 512M

The name you use determines your initial application URL, e.g., <application-name>.mybluemix.net.

  1. Connect to Bluemix in the command line tool.
$ cf api https://api.ng.bluemix.net
$ cf login -u <your-user-ID>
  1. Create the Personality Insights service in Bluemix.
$ cf create-service personality_insights "IBM Watson Personality Insights Monthly Plan" personality-insights-service
  1. Download and install the ant compiler.

  2. Build the project.

    You need to use the Apache ant compiler to build the Java application. For information about the ant compiler and to download a copy for your operating system, visit ant.apache.org.

$ ant
  1. Push it live!
$ cf push

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

Running locally

The application uses the WebSphere Liberty profile runtime as its server, so you need to download and install the profile as part of the steps below.

  1. Copy the credentials from your personality-insights-service service in Bluemix to DemoServlet.java. You can use the following command to see the credentials:

    $ cf env <application-name>

    Example output:

    System-Provided:
    {
    "VCAP_SERVICES": {
      "personality-insights": [{
          "credentials": {
            "url": "<url>",
            "password": "<password>",
            "username": "<username>"
          },
        "label": "personality-insights",
        "name": "personality-insights-service",
        "plan": "IBM Watson Personality Insights Monthly Plan"
     }]
    }
    }
     You need to copy the `username`, `password`, and `url`.
    
  2. Install the Liberty profile runtime (for Mac OSX, check this guide).

  3. Create a Liberty profile server in Eclipse.

  4. Add the application to the server.

  5. Start the server.

  6. Go to http://localhost:9080/app/ to see the running application.

Troubleshooting

To troubleshoot your Bluemix application, the most useful source of information is the log files. To see them, run the following command:

$ cf logs <application-name> --recent

License

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

Contributing

See CONTRIBUTING.

Open Source @ IBM

Find more open source projects on the IBM Github Page.