https://github.com/esri-es/gis-talk-bot
It help anyone to search content within an ArcGIS organization
https://github.com/esri-es/gis-talk-bot
arcgis arcgis-rest-api dialogflow esri
Last synced: about 2 months ago
JSON representation
It help anyone to search content within an ArcGIS organization
- Host: GitHub
- URL: https://github.com/esri-es/gis-talk-bot
- Owner: esri-es
- Created: 2018-01-25T09:43:11.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-01T15:00:06.000Z (over 7 years ago)
- Last Synced: 2025-02-08T16:45:16.312Z (3 months ago)
- Topics: arcgis, arcgis-rest-api, dialogflow, esri
- Language: JavaScript
- Homepage: https://web.telegram.org/#/im?p=@GISTalkBot
- Size: 14 MB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gis-talk-bot
We heard about [Sonar](https://github.com/Esri/sonar) last year on Andrew Turner presentation and we though that we could build a bot that could be setup to work within an organization, so any Esri Customer could launch it own bot easily ([more about this project](https://devpost.com/software/gis-talk-bot)).
**Table of Contents**
- [Pre-Requisites](#pre-requisites)
- [Live Demo](#live-demo)
- [Build your own Bot](#build-your-own-bot)
- [Deploy your Webhook](#deploy-your-webhook)
# Pre-Requisites
- Telegram Account
- [dialogFlow bot](https://console.dialogflow.com/api-client/). (If you want to build your own Bot)
# Live Demo
Bot versions:
* Telegram (**Recommended**)
1. If you don't have a **Telegram Account**, create one
2. If you already have a Telegram Account you can start to talk to [GISTalkBot](https://web.telegram.org/#/im?p=%40hackEsriBot)
* [HTML5](https://bot.dialogflow.com/566c61ef-9ebc-44d4-b947-3f7e3a77e254) (*under construction*)
> The HTML5 doesn't support multiple messages, enriched text (so links won't be clickable), etc.
You can also see how it works on this video presentation:
[](https://www.youtube.com/watch?v=almoQqJiuq4)
## Knowledge
By default this bot is able to help users to:
* **Search items** | Sample sentences:
* have you published anything about `Web AppBuilder`
* I'm looking for `PDF` files
* I want `Image Service` items
* which `basemaps` have you published?
* give me some `CSV` from `geogeeks` (search within [geogeeks.maps.arcgis.com](https://geogeeks.maps.arcgis.com/home/index.html))
* **See attachments from a feature service** | Sample sentence:
* I would like to see the attachments from https://services.arcgis.com/0ZRg6WRC7mxSLyKX/arcgis/rest/services/harveyDamagePhotos/FeatureServer/0
> Note: you can ask for any [keyword](https://github.com/esri-es/gis-talk-bot/blob/master/raw_data/dialogFlow/keywords.json) or any other [custom term](https://github.com/esri-es/gis-talk-bot/blob/master/bot_webhook/lib/utils.js#L5).
# Build your own Bot
Steps:
1. Create a [dialogFlow agent](https://github.com/esri-es/gis-talk-bot/blob/master/docs/videos/create_dialogflow_bot.webmsd.webm) . For importing all configuration, you can find bot backups [here](https://github.com/esri-es/gis-talk-bot/tree/master/raw_data/backup_bot_conf)
2. Create your own [Telegram bot](https://github.com/esri-es/gis-talk-bot/blob/master/docs/videos/create_telegram_bot.webmsd.webm) (using the [Telegram @BotFather](https://web.telegram.org/#/im?p=@BotFather))
3. Take note of the **API_TOKEN** of your brand new bot. You'll need it on the next step.
4. Configure Telegram integration on dialogFlow. Watch this video **PENDING**
5. Install on your computer our **Telegram Webhook** . Follow this [video instructions](https://asciinema.org/a/ebc6H7tCId7vZMH3ZOhisJRVn)
6. Test Locally
For the sake of speed , please install [ngrok](https://ngrok.com/download) in your computer. **ngrok** let's your machine be Internet reachable thru a tunneled connection , just with one command :
```bash
ngrok http 3000
```
This command outputs something like:
```bash
ngrok by @inconshreveable (Ctrl+C to quit)
Session Status online
Account --------- ---- --- (Plan: Free)
Version 2.2.8
Region United States (us)
Web Interface http://127.0.0.1:4040
Forwarding http://e117e6ea.ngrok.io -> localhost:3000
Forwarding https://e117e6ea.ngrok.io -> localhost:3000
Connections ttl opn rt1 rt5 p50 p90
1 0 0.00 0.00 5.04 5.04
```
You can also log, replay & check the status of all connections in [http://localhost:4040](http://localhost:4040)
> TIP
Once you've downloaded it , unzip it , and move **ngrok** to **/usr/local/bin** folder , letting you run this command from anywhere
7. Enable **fullfillment** on **fullfillment session** in **dialogflow** in your agent.
8. Fill in **URL**. Taking the **ngrok** setup above as an example , the **URL** field would be:
```bash
https://e117e6ea.ngrok.io/ask
```
> Notice that we append **/ask** at the end of the **URL**, and use the **https** url.
9. Test it!
Open **your telegram chat url** in a Browser and start a conversation!!
10. If the bot doesn't answer , review your setup , and check twice that **dialogflow** intents has fullfillment option check (web-hook)
# Deploy your Webhook
You can use [now.sh](https://zeit.co/now). You can create an account for free!
Once you have created your **now.sh** account , Download **Now Desktop**.
When you have installed **Now Desktop** , open a terminal and go to the folder where you cloned this repo.
At this point , type the following
```bash
cd bot_webhook/
now -e BOT_MODE="prod" -e BOT_SECRET="comeon" -e BOT_HEADER="esri-chat"
```
You will see a similar output like the following:
```bash
Machineitor in ~/esri/hackathon/gis-talk-bot/bot_webhook
± |master U:1 ✗| → now -e BOT_MODE="prod" -e BOT_SECRET="comeon" -e BOT_HEADER="esri-chat"
> Deploying ~/esri/hackathon/gis-talk-bot/bot_webhook under
> Using Node.js 8.9.4 (default)
> Ready! https://gis-talk-bot-v2-dmqsafdomn.now.sh (copied to clipboard) [4s]
> You () are on the OSS plan. Your code and logs will be made public.
> NOTE: You can use `now --public` to skip this prompt
> Synced 1 file (1.55KB) [8s]
> Initializing…
```
Update **URL** in **FullFillment** section of **dialogFlow**. The **URL** in this example would be :
```bash
https://gis-talk-bot-v2-dmqsafdomn.now.sh/ask
```
Et voila!