diff --git a/README.md b/README.md index 078e1ce..1c9cc1e 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ The application is designed and trained for chatting with a cognitive car. The Commands may be issued to the car to perform simple operations. These commands are run against a small set of sample data trained with intents like "turn_on", "weather", and "capabilities". -Example commands that can be executed by the Conversation service are: +Example commands that can be executed by the Conversation service are: turn on windshield wipers play music @@ -36,55 +36,43 @@ To watch a video about the code behind this app, see below. ![](readme_images/Deploy on Bluemix - EIR app.png) ## Before you begin -1 Ensure that you have a [Bluemix account](https://console.ng.bluemix.net/registration/). - -2 Ensure that you have the necessary space available in your Bluemix account. This action deploys 1 application and 3 services. - * You can view this on your Bluemix Dashboard. Tiles will show what space you have available. - * For example, for Services & APIS - -             ![](readme_images/services.PNG) +1. Ensure that you have a [Bluemix account](https://console.ng.bluemix.net/registration/).
+2. Ensure that you have the necessary space available in your Bluemix account. This action deploys 1 application and 3 services. + - You can view this on your Bluemix Dashboard. Tiles will show what space you have available. + - For example, for Services & APIS
+ ## Deploy the App -1 Select Deploy to Bluemix - -             [![Deploy to Bluemix](https://bluemix.net/deploy/button.png)](https://bluemix.net/deploy?repository=https://github.com/watson-developer-cloud/conversation-enhanced) - -2 Log in with an existing Bluemix account or sign up. - -3 Name your app and select your REGION, ORGANIZATION, and SPACE. Then select DEPLOY. - -             ![](readme_images/deployapp1.PNG) - -* This performs multiple actions: - - Creates the app - - Creates a Document Conversion service instance for use with the Retrieve & Rank tooling - - Creates a Conversation service instance that the user needs for workspace creation - - Creates a Retrieve & Rank service instance - -* The status of the deployment is shown. This can take some time. - -            ![](readme_images/createproject.PNG) - -4 Once your app has deployed, select VIEW YOUR APP. - -            ![](readme_images/viewyourapp.PNG) - -5 This lauches more actions, including: +1. Select Deploy to Bluemix
+ [![Deploy to Bluemix](https://bluemix.net/deploy/button.png)](https://bluemix.net/deploy?repository=https://github.com/watson-developer-cloud/conversation-enhanced)
+2. Log in with an existing Bluemix account or sign up.
+3. Name your app and select your REGION, ORGANIZATION, and SPACE. Then select DEPLOY.
+ ![](readme_images/deployapp1.PNG)
+ This performs multiple actions: + - Creates the app + - Creates a Document Conversion service instance for use with the Retrieve & Rank tooling + - Creates a Conversation service instance that the user needs for workspace creation + - Creates a Retrieve & Rank service instance
+ + The status of the deployment is shown. This can take some time. + + ![](readme_images/createproject.PNG) +4. Once your app has deployed, select VIEW YOUR APP.
+ ![](readme_images/viewyourapp.PNG)
+5. This lauches more actions, including: - Creating a SOLR cluster, config, and collection in the Retrieve & Rank service - Ingesting documents into the collection - Creating a trained ranker to aide in answering questions -A dialog shows the progress. - -            ![](readme_images/deployPicture.PNG) + A dialog shows the progress. -When setup is complete, you are informed that you need to add a WORKSPACE_ID. - - -6 Navigate to your Bluemix Dashboard and [import a workspace](#workspace). Setup your workspace then return to these steps. - + ![](readme_images/deployPicture.PNG) -7 After you have set up a workspace, [add the WORKSPACE_ID environment variable](#env). + When setup is complete, you are informed that you need to add a WORKSPACE_ID.
+ +6. Navigate to your Bluemix Dashboard and [import a workspace](#workspace). Setup your workspace then return to these steps. +
+7. After you have set up a workspace, [add the WORKSPACE_ID environment variable](#env). # Getting Started locally @@ -98,68 +86,60 @@ When setup is complete, you are informed that you need to add a WORKSPACE_ID. - Ensure that you have a [Bluemix account](https://console.ng.bluemix.net/registration/). While you can do part of this deployment locally, you must still use Bluemix. - Ensure that you have [Websphere Liberty Profile Server](https://developer.ibm.com/wasdev/downloads/liberty-profile-using-non-eclipse-environments/). - -## Setup Bluemix components - -1 In Bluemix, [create a Conversation Service](http://www.ibm.com/watson/developercloud/doc/conversation/convo_getstart.shtml). -- Create the [Service Credentials](#credentials). -- [Import a workspace](#workspace) +## Setup Bluemix components -2 In Bluemix, [create a Retrieve and Rank Service](http://www.ibm.com/watson/developercloud/doc/retrieve-rank/get_start.shtml). -- Create the [Service Credentials](#credentials). +1. In Bluemix, [create a Conversation Service](http://www.ibm.com/watson/developercloud/doc/conversation/convo_getstart.shtml). + * Create the [Service Credentials](#credentials). + * [Import a workspace](#workspace). + +2. In Bluemix, [create a Retrieve and Rank Service](http://www.ibm.com/watson/developercloud/doc/retrieve-rank/get_start.shtml).
+ * Create the [Service Credentials](#credentials). + ## Building locally To build the application: -1 Git clone the project `https://github.com/watson-developer-cloud/conversation-enhanced` +1. Git clone the project `https://github.com/watson-developer-cloud/conversation-enhanced` -2 Navigate to the `conversation-enhanced` folder +2. Navigate to the `conversation-enhanced` folder -3 For Windows, type `gradlew.bat build`. Otherwise, type `gradlew build`. -- If you prefer, use your locally installed Gradle plugin instead of this provided wrapper. +3. For Windows, type `gradlew.bat build`. Otherwise, type `gradlew build`. + - If you prefer, use your locally installed Gradle plugin instead of this provided wrapper. -4 The built WAR file (conversation-enhanced-0.1-SNAPSHOT.war) is in the `conversation-enhanced/build/libs/` folder. +4. The built WAR file (conversation-enhanced-0.1-SNAPSHOT.war) is in the `conversation-enhanced/build/libs/` folder. ## Running locally -1 Copy the WAR file generated above into the Liberty install directory's dropins folder. For example, `/usr/servers//dropins`. - -2 Navigate to the `conversation-enhanced/src/main/resources` folder. Copy the `server.env` file. - -3 Navigate to the `/usr/servers//` folder (where < server name > is the name of the Liberty server you wish to use). Paste the `server.env` here. - -4 In the `server.env` file, search for **"retrieve_and_rank"**: -- Replace the "name" field with the name you gave your Retrieve and Rank Service. -- Replace the "password" field. -- Replace the "username" field. - -5 In the `server.env`, search for **"conversation"**. -- Replace the "name" field with the name you gave your Conversation Service. -- Replace the "password" field. -- Replace the "username" field. - -6 Add the **WORKSPACE_ID** that you [copied earlier](#workspaceID). - -7 Start the server using Eclipse or CLI with the command `server run ` (use the name you gave your server). - -8 Liberty notifies you when the server starts and includes the port information. - -9 Open your browser of choice and go to the URL displayed in Step 6. By default, this is `http://localhost:9080/`. +1. Copy the WAR file generated above into the Liberty install directory's dropins folder. For example, `/usr/servers//dropins`.
+2. Navigate to the `conversation-enhanced/src/main/resources` folder. Copy the `server.env` file.
+3. Navigate to the `/usr/servers//` folder (where < server name > is the name of the Liberty server you wish to use). Paste the `server.env` here.
+4. In the `server.env` file, search for **"retrieve_and_rank"**: + - Replace the "name" field with the name you gave your Retrieve and Rank Service. + - Replace the "password" field. + - Replace the "username" field.
+5. In the `server.env`, search for **"conversation"**. + - Replace the "name" field with the name you gave your Conversation Service. + - Replace the "password" field. + - Replace the "username" field.
+6. Add the **WORKSPACE_ID** that you [copied earlier](#workspaceID).
+7. Start the server using Eclipse or CLI with the command `server run ` (use the name you gave your server).
+8. Liberty notifies you when the server starts and includes the port information.
+9. Open your browser of choice and go to the URL displayed in Step 6. By default, this is `http://localhost:9080/`. # Service Credentials -1 Go to the Bluemix Dashboard and select the Conversation service instance. Once there, select the **Service Credentials** menu item. +1. Go to the Bluemix Dashboard and select the Conversation service instance. Once there, select the **Service Credentials** menu item. -            ![](readme_images/credentials.PNG) + -2 Select **ADD CREDENTIALS**. Name your credentials then select **ADD**. +2. Select **New Credential**. Name your credentials then select **Add**. -3 Copy the credentials (or remember this location) for later use. +3. Copy the credentials (or remember this location) for later use. # Import a workspace @@ -169,31 +149,31 @@ To use the app you're creating, you need to add a worksapce to your Conversation For more information on workspaces, see the full [Conversation service documentation](http://www.ibm.com/watson/developercloud/doc/conversation/). -1 Navigate to the Bluemix dashboard and select the **Conversation** service you created. +1. Navigate to the Bluemix dashboard and select the **Conversation** service you created. -             ![](readme_images/workspace_dashboard.png) + ![](readme_images/workspace_dashboard.png) -2 Click the **Launch Tool** button under the **Manage** tab. This opens a new tab in your browser, where you are prompted to login if you have not done so before. Use your Bluemix credentials. +2. Click the **Launch Tool** button under the **Manage** tab. This opens a new tab in your browser, where you are prompted to login if you have not done so before. Use your Bluemix credentials. -             ![](readme_images/workspace_launch.png) + ![](readme_images/workspace_launch.png) -3 Download the [exported JSON file](src/main/resources/workspace.json) that contains the Workspace contents. +3. Download the [exported JSON file](src/main/resources/workspace.json) that contains the Workspace contents. -4 Select the import icon: ![](readme_images/importGA.PNG). Browse to (or drag and drop) the JSON file that you downloaded in Step 3. Choose to import **Everything(Intents, Entities, and Dialog)**. Then select **Import** to finish importing the workspace. +4. Select the import icon: ![](readme_images/importGA.PNG). Browse to (or drag and drop) the JSON file that you downloaded in Step 3. Choose to import **Everything(Intents, Entities, and Dialog)**. Then select **Import** to finish importing the workspace. -5 Refresh your browser. A new workspace tile is created within the tooling. Select the _menu_ button within the workspace tile, then select **View details**: +5. Refresh your browser. A new workspace tile is created within the tooling. Select the _menu_ button within the workspace tile, then select **View details**: -            ![Workpsace Details](readme_images/details.PNG) + ![Workpsace Details](readme_images/details.PNG) - -In the Details UI, copy the 36 character UNID **ID** field. This is the **Workspace ID**. - + + In the Details UI, copy the 36 character UNID **ID** field. This is the **Workspace ID**. + -             ![](readme_images/workspaceid.PNG) + ![](readme_images/workspaceid.PNG) -7 Return to the deploy steps that you were following: -- For Local - [return to step 1](#returnlocal) -- For Bluemix - [return to step 6](#returnbluemix) +6. Return to the deploy steps that you were following: + - For Local - [return to step 1](#returnlocal) + - For Bluemix - [return to step 6](#returnbluemix) @@ -201,44 +181,28 @@ In the Details UI, copy the 36 character UNID **ID** field. This is the **Worksp # Adding environment variables in Bluemix -1 In Bluemix, open the application from the Dashboard. Select **Runtime** and then **Environment Variables**. +1. In Bluemix, open the application from the Dashboard. Select **Runtime** and then **Environment Variables**. -             ![](readme_images/env_var_tab.png) + ![](readme_images/env_var_tab.png) -2 In the **User Defined** section, add a variable with the name **WORKSPACE_ID**. For the value, paste in the Workspace ID you [copied earlier](#workspaceID). Select **SAVE**. +2. In the **User Defined** section, add a variable with the name **WORKSPACE_ID**. For the value, paste in the Workspace ID you [copied earlier](#workspaceID). Select **SAVE**. -             ![](readme_images/env_var_text.png) + ![](readme_images/env_var_text.png) -3 Restart your application. +3. Restart your application. # Troubleshooting in Bluemix -#### In the Classic Experience: - Log in to Bluemix, you'll be taken to the dashboard. - Navigate to the the application you previously created. - Select **Logs**. -            ![](readme_images/logs_new.png) + ![](readme_images/logs_new.png) - If you want, filter the LOG TYPE by "APP". -            ![](readme_images/filter_app_new.png) - -#### In the new Bluemix: -- Log in to Bluemix, you'll be taken to the dashboard. -- Select **Console** > **Compute** - -            ![](readme_images/console.PNG) - -- Select the application you previously created. -- Select **Logs**. - -            ![](readme_images/logs1.PNG) - -- If you want, filter the Log Type by selecting the drop-down and selecting **Application(APP)**. - -            ![](readme_images/filter_app.PNG) + ![](readme_images/filter_app_new.png) # Troubleshooting with CLI diff --git a/readme_images/compute.PNG b/readme_images/compute.PNG deleted file mode 100644 index 5a31a76..0000000 Binary files a/readme_images/compute.PNG and /dev/null differ diff --git a/readme_images/console.PNG b/readme_images/console.PNG deleted file mode 100644 index 5a31a76..0000000 Binary files a/readme_images/console.PNG and /dev/null differ diff --git a/readme_images/credentials.PNG b/readme_images/credentials.PNG index a032ec5..fb4beeb 100644 Binary files a/readme_images/credentials.PNG and b/readme_images/credentials.PNG differ diff --git a/readme_images/logs.PNG b/readme_images/logs.PNG deleted file mode 100644 index 36c2c0d..0000000 Binary files a/readme_images/logs.PNG and /dev/null differ diff --git a/readme_images/logs1.PNG b/readme_images/logs1.PNG deleted file mode 100644 index 4f67e14..0000000 Binary files a/readme_images/logs1.PNG and /dev/null differ diff --git a/readme_images/services.PNG b/readme_images/services.PNG index 67888d0..e54e9ec 100644 Binary files a/readme_images/services.PNG and b/readme_images/services.PNG differ