Giter VIP home page Giter VIP logo

kathmandulivinglabs / osm-chatbot Goto Github PK

View Code? Open in Web Editor NEW
14.0 2.0 1.0 142.21 MB

Chatbot that answers OpenStreetMap-related queries powered by Rasa Open Source.

Home Page: https://osmchatbot.klldev.org

License: MIT License

Python 97.41% Shell 0.84% Dockerfile 1.75%
osm openstreetmap nlp rasa rasa-x chatbot osm-chatbot openstreetmap-chatbot openstreetmap-faq openstreetmap-queries

osm-chatbot's Introduction

OSM Chatbot

A chatbot that answers OpenStreetMap related queries. It is powered by Rasa Open Source.

๐Ÿ™Œ ๐Ÿ™Œ Now OSM Chatbot is also integrated on OSM Nepal Tasking Manager .

Have a look at our blog post: https://blog.kathmandulivinglabs.org/introducing-a-new-member-to-the-openstreetmap-community/

Have a conversation with chatbot at: https://www.facebook.com/osmchatbot

Acknowledgements

RASA

Missing Maps

Tag Finder

Contributing

Contributions are always welcome!

To contribute to this project you can add/update Natural Language Understanding Data and bot responses.

Clone this project

git clone https://github.com/KathmanduLivingLabs/OSM-chatbot.git

Go to the project directory

cd OSM-chatbot

Rasa Open Source uses YAML as a unified and extendable way to manage all training data, including NLU data, stories and rules. You can split the training data over any number of YAML files, and each file can contain any combination of NLU(Natural Language Understanding) data, stories, and rules. The training data parser determines the training data type using top level keys.

To add training data you must have to add intent on one of the nlu files inside data folder. For example if i want to add chatbot support for iD editor info:

  • Open faq.yml located inside data folder
  • Add intent as faq/iDeditor_info where faq is our retrieval intent. What is retreival intent?
  • Add at least 5 examples for this intent. This is where our model learns to predict user intent (e.g. What is iDeditor?)
  • Add response for this intent on responses.yml present inside /data/resposnes and on domain.yml file.

Run Locally

Clone the project

  git clone https://github.com/KathmanduLivingLabs/OSM-chatbot.git

Go to the project directory

  cd OSM-chatbot

Create virtual environment

    python3 -m venv ./venv

Activate environment

    source venv/bin/activate

Install dependencies

    pip install -r requirements.txt

To train model

    rasa train

To chat with bot on command line

    rasa shell

To start rasa server

    rasa run

or to run rasa with api enabled

    rasa run --enable-api

Custom action server are required to fetch dynamic response from api's or web scrapping. We have used custom actions to fetch user statistics and tag information in this project.

To run custom action server

  cd actions
  pip install -r requirements.txt
  rasa run actions

To run on interactive mode on web browser:

  • Make sure you have RasaX installed on your environment, Then run
rasa x

TO DO:

  • Currently the chatbot only supports English language, we want to extend its support for as many languages as possible.
  • This chatbot model is trained on a very limited set of training data. We want to add support for more user queries.
  • We want to add support for more OSM tools like running an Overpass query in natural language through chatbot, generating before-after maps, connecting users to local OSM-communities by accessing their location and others.

osm-chatbot's People

Contributors

aadesh-baral avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

aadesh-baral

osm-chatbot's Issues

Examples missing for some intents

Some of the intents are missing example data which might cause issue if Response selector is selected on training pipleline.

  • faq/osm_contributor_counts
  • faq/osmf
  • faq/tasking-manager-projects
  • chitchat/status

Different retreival intents for easy data creation

Retrieval intents allow easy data separation, and addition and can also improve model performance.
Add new retrieval intents and move related intents into it for the following:

  • Id editor
  • JOSM
  • Faqs about Maps in general, also linked to #33
  • Faqs about OSM
  • HOT Tasking Manager

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.