A conversational chat bot that automatically takes details from a job seeker and takes necessary actions.
- NPM
- Node.js
- API.AI
- AngularJS + HTML
- Postgres
- Docker
- Simple chat bot implementation that connects to API AI instance at the backend (which takes care of job related conversation) and messenger instance, while acting as a mediator between those requests.
- Now logs chat to file
- Database connectivity to store data
- Very basic UI Interface to view data
- Deployment methods available
- The server on which the application will run must be reachable by facebook server.
- Setup facebook page and app
- Define your api.ai rules
- Fetch api.ai tokens
and then follow the steps below
| Constant Name | Description | Required | Default Value |
|---|---|---|---|
| APIAI_ACCESS_TOKEN | Your api.ai Client Access Token | ✔ | |
| FB_PAGE_ACCESS_TOKEN | Facebook Page Access Token | ✔ | |
| FB_VERIFY_TOKEN | Verification Token for Facebook | ✔ | |
| APIAI_LANG | Language for API AI | 'en' | |
| REST_PORT | Port on which application listens | 5000 | |
| DATABASE_ENABLE | Enable save data on Postgres Database | true | |
| DATABASE_URL | Postgres Database URL | ✔ | |
| TABLE_NAME | Table Name to Store Data | JOB_SEEKERS |
Set APIAI_ACCESS_TOKEN as 81b16a51d421459d8227fb2c6fceb913 to link to a JobAssistant already configured.
Make sure the TABLE_NAME doesn't exist before the application first run, as it might result in an error due to schema mismatch
When you are done setting these variables, go to the root of the project and
npm install
npm test
npm start
and you are done!
- To use the application a user has to follow the steps to run the application, and then simply start a facebook chat with the respective Facebook Page
- The UI is available at root of the app.
| Column Name | Data Type | Nullability |
|---|---|---|
| ID | Auto Generated BIGSERIAL | NOT NULL |
| NAME | CHAR(50) | NOT NULL |
| CHAR(50) | NOT NULL | |
| CONTACT_NUMBER | CHAR(50) | NOT NULL |
| STREAM | CHAR(50) | NOT NULL |
| PREFERRED_LOCATION | CHAR(50) | NOT NULL |
| CURRENT_COMPANY | CHAR(50) | NOT NULL |
| CURRENT_CTC | CHAR(50) | NOT NULL |
| EXPECTED_CTC | CHAR(50) | NOT NULL |
Make sure that API AI parameters and the table column names are consistent
#Alternative Deployment Methods
Dockerfile at the root of project is used to run app through docker.
From the root of the source code, execute to build image
bash docker build -t chatbot .
and execute this to start it up!
docker run -it --name chatbot_instance \
-p <REST_PORT>:5000 \
-e APIAI_ACCESS_TOKEN="api.ai client access token" \
-e FB_PAGE_ACCESS_TOKEN="Fb Page Access Token" \
-e FB_VERIFY_TOKEN="Fb Verify Token" \
-e APIAI_LANG="en" \
-e DATABASE_ENABLE="true" \
-e DATABASE_URL="URL" \
-e TABLE_NAME="JOB_SEEKERS" \
chatbotapp.json at the root of project is used to deploy app on Heroku.
Follow this article for more details on deployment using Heroku.
0.5.0
- UI controls to delete data and acknowledge it
- Store more information like Date of application, fb URL , session id
- Writing tests for asynchronous APIs