💬Chat application

From start to finish, set up a chat-based application in minutes with NLX

Checklist

You'll complete the following to successfully launch your chat application:

Pre-setup: Integration

Est. time to complete: ~5 minutes

A one-time integration of a Natural Language Processing (NLP) engine must be completed in your workspace:

Step 1: Create an intent

Est. time to complete: ~4 minutes

Begin by identifying the tasks your conversational AI application will automate and organize them into individual topics called intents.

Each intent is invoked when your chosen AI model matches a user's query ("I want to order room service") to an intent you've created (OrderRoomService). This match is done based on the training data you provide for your AI model.

  • Select Intents from workspace menu > Choose New intent

  • Enter a descriptive name (no spaces or special characters) > Select Save

  • Click + Add new training phrase > Create 5 phrases that users might say to invoke the intent

  • Select Attached slots > Attach custom and/or built-in slots that will be resolved in your workflow

  • Click Save

  • Select + Add flow > Click Create flow (ensure API is set as the Primary)

  • Click Save

Repeat for any additional intents your application will help automate.

🧠 Looking for more? See Set up intents

Step 2: Construct a workflow

Est. time to complete: ~15 minutes

Determine the sequence of steps and messaging that the conversational application follows to assist a user with the task. The conversation workflow is assembled in an intent's canvas builder with a pattern of nodes similar to a flow diagram:

  • Select API flow card created in Step 1

  • Add nodes by right-clicking on the canvas & choosing New node (see available node types)

  • Connect first node to Start node > Connect sequential nodes via node edges or stacking

  • Add bot messages to nodes by selecting + Add message on a node's side panel

  • Click Save

🧠 Looking for more? See Construct flows

Step 3: Set up application

Est. time to complete: ~3 minutes

Now you'll create the conversational application users will interface with. This step involves attaching all intent workflows you want your application to access, defining flows to handle certain behaviors, and setting up the channel your application supports.

  • Select Applications from workspace menu > Choose New application

  • Enter a descriptive name > Click Save

  • Click Intents tab of application > Select + Add intents > Attach one or more intents you've created to make available to your application

  • Select Default behaviors tab of application > Assign any attached intents to the application's behaviors > Click Save

  • Select Channels tab of application > Expand API option > Click + Create channel

  • Click + Add domain under Whitelisted domains > Add your webpage's URL and https://developers.nlx.ai

  • Click Create channel

🧠 Looking for more? See Manage channels

Step 4: Build & deploy

Est. time to complete: ~5 minutes

A build constructs the array of workflows that make up your application and updates any changes made to your flows, while deploying makes a successful build live:

  • Click Deployment tab of application > Select Create or Review & build

  • Wait for validation to complete > Select Create build*

  • When satisfied with a successful build, click Deploy

*After a build status appears as 🟢 Built, you may use the Test feature to test the conversation with your application using the latest build.

🔧 Need to troubleshoot your build? See how to troubleshoot build errors

Step. 5: Install SDK

Est. time to complete: ~5 minutes

To make your application available through your frontend and adjust the look, feel, and chat experience with theming and custom UI components, install the NLX chat SDK:

  • From Deployment tab of application, select Details next to the Deployed status

  • Expand the API section under Setup instructions in the pop-up modal

  • Expand the API section under Setup instructions in the pop-up > Select Open chat widget configurator

  • Make adjustments to the theming > Copy Setup snippet > Install on your site

🧠 Looking for more? See Developer SDK

Optional: Retrieve data

To pull in and reference information from an external system, you may first set up a data request integration and invoke it in a workflow using the Data request node.

  • Select Data requests in workspace menu > Choose + New data request > Provide a name

  • Switch to External implementation under the Implementation tab > Choose the appropriate HTTPS method

  • Expand Production endpoint > Enter the URL and any applicable Header(s)*

  • Download the provided AWS CloudFormation template listed in the Instructions section

  • Select the Response model tab > Choose <> Auto-generate option > Enter a snippet of your schema

Optional: If you require sending a payload when the API call is made in a workflow, select the Request model tab > Click Create from example JSON > Enter a snippet of the payload schema

  • Click Save

Now that your integration is set up, trigger your API call during an intent flow using a Data request node

Last updated