Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kengz/aiva
AIVA (A.I. Virtual Assistant): General-purpose virtual assistant for developers.
https://github.com/kengz/aiva
bot fb nlp nodejs slack telegram
Last synced: 11 days ago
JSON representation
AIVA (A.I. Virtual Assistant): General-purpose virtual assistant for developers.
- Host: GitHub
- URL: https://github.com/kengz/aiva
- Owner: kengz
- License: mit
- Created: 2015-08-10T04:21:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-04-16T15:50:17.000Z (over 4 years ago)
- Last Synced: 2024-05-05T21:22:45.529Z (6 months ago)
- Topics: bot, fb, nlp, nodejs, slack, telegram
- Language: JavaScript
- Homepage: http://kengz.me/aiva/
- Size: 7.03 MB
- Stars: 813
- Watchers: 59
- Forks: 588
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-chatbots - AIVA - General-purpose virtual assistant for developers. (Open Source Projects)
README
# AIVA [](http://badge.fury.io/gh/kengz%2Faiva) [](https://circleci.com/gh/kengz/poly-socketio) [](https://www.codacy.com/app/kengzwl/aiva?utm_source=github.com&utm_medium=referral&utm_content=kengz/aiva&utm_campaign=Badge_Grade) [](https://www.codacy.com/app/kengzwl/aiva?utm_source=github.com&utm_medium=referral&utm_content=kengz/aiva&utm_campaign=Badge_Coverage) [](https://gemnasium.com/kengz/aiva) [](https://raw.githubusercontent.com/hyperium/hyper/master/LICENSE) [](https://github.com/kengz/aiva) [](https://github.com/kengz/aiva)
**AIVA** (A.I. Virtual Assistant): General-purpose virtual assistant for developers. [https://kengz.github.io/aiva-doc/](https://kengz.github.io/aiva-doc/)
*This project is under extension - to build a [Contextual Graph Knowledge Base](https://kengz.github.io/aiva-doc/#contextual-graph-knowledge-base) for knowledge encoding. Check [Roadmap](#roadmap) for more.*
It is a **bot-generalization**: you can implement any features, use with major AI tools, deploy across platforms, and code in multiple languages.
| AIVA is | Details |
|:---|---|
| general-purpose | An app interface, AI assistant, anything! |
| cross-platform | Deploy simultaneously on **Slack, Telegram, Facebook**, or any [hubot adapters](https://github.com/github/hubot/blob/master/docs/adapters.md) |
| multi-language | Cross-interaction among `Node.js`, `Python`, `Ruby`, etc. using `SocketIO`. |
| built-in with AI tools (not preinstalled since v4) | Tensorflow, SkFlow, Scikit, Pandas, Indico.ml, spaCy, Watson, Google APIs |
| hackable | It extends [Hubot](https://github.com/github/hubot). Add your own modules! |
| powerful, easy to use | Check out [setup](https://kengz.github.io/aiva-doc/#setup) and [features](https://kengz.github.io/aiva-doc/#features) |
>To see what they mean, say you have a todo-list feature for AIVA, written in Node.js and leverages NLP and ML from Python. Set your todo list earlier from Slack on desktop? You can access it from Telegram or Facebook on mobile.
>Deepdream in AIVA (checkout v3.2.1), only took a few hours on the Deepdream module, and deployed it in AIVA in just minutes. Runs on Fb and Telegram simulteneously: 
We see people spending a lot of time building bots instead of focusing on what they want to do. It still requires much effort to just get a bot up and running. Moreover, the bot built is often confined to a single language, single platform, and without AI capabilities.
Why restrict when you can have all of it? Why build multiple bots when you can have one that plugs into all platforms and runs all languages?
AIVA exists to help with that - we do the heavy-lifting and build a ready-to-use bot; it is general purpose, multi-language, cross-platform, with robust design and tests, to suite your needs.
AIVA gives you powerful bot tools, saves you the time to build from scratch, and allows you to focus on what you want to do. Morever, you can **build once, run everywhere** with AIVA's multi-adapter [(Slack, Telegram, Fb)](https://kengz.github.io/aiva-doc/#adapters).
## Installation
1\. Fork this repo so you can pull the new releases later:
[](https://github.com/kengz/aiva) [](https://github.com/kengz/aiva)
2\. Clone **your forked repository**:
```shell
git clone https://github.com/YOURUSERNAME/aiva.git
```
To sync the latest release of AIVA to your fork:
```shell
git remote add upstream https://github.com/kengz/aiva.git
git fetch upstream
git merge upstream/master
```
The line below runs `bin/setup && bin/copy-config && npm install`:
```shell
npm run setup
```
Then edit `config/` files: `default.json`(development), `production.json`(production, optional), `db.json`(mysql)
The command installs the dependencies via `bin/install && npm install`, and prepare the database for aiva to run on. The dependencies are minimal: `nodejs>=6`, `python3`, and `mysql`.
See `bin/install` for the full list, and customize your own. This also runs the same sequence as the CircleCI build in `circle.yml`.
**Docker**. We also offer a Docker image [kengz/aiva](https://hub.docker.com/r/kengz/aiva/). It runs the same except with an extra layer of Docker. See [Docker installation](https://kengz.github.io/aiva-doc/#docker-installation) for more.
```shell
npm start # runs 'aivadev' in development mode
```
```shell
# Add flags for more modes
npm start --debug # activate debug logger
npm start production # runs 'aiva' in production mode
```
See [Commands](https://kengz.github.io/aiva-doc/#commands) for more. This will start AIVA with the default hubot adapters: Slack, Telegram, Facebook (only if activated). See [**Adapters**](https://kengz.github.io/aiva-doc/#adapters) for connecting to different chat platforms.
>AIVA saying hi, translating, running deep neural net; on Slack, Telegram, Facebook:
Check [**Setup tips**](https://kengz.github.io/aiva-doca/#setup-tips) for help.
## Legacy Releases
AIVA was known as Jarvis in version 2. It is now deprecated, but if you need to reference stuff from Jarvis, do `git checkout tags/v2.0` or checkout [the releases](https://github.com/kengz/aiva/releases).
AIVA v3 was last released at [v3.2.1](https://github.com/kengz/aiva/releases/tag/v3.2.1), which was full featured, but quite heavy. We retire it in favor of a lighter, more developer-friendly and extendible version.
## Roadmap
- a built in graph brain for ad-hoc knowledge encoding, using [CGKB](https://kengz.github.io/aiva-doc/#cgkb) and [HTMI](https://kengz.github.io/aiva-doc/#htmi)
- a built in NLP intent-parsing engine
## Contributing
We'd love for you to contribute and make AIVA even better for all developers. We're mainly interested in something generic and foundational, e.g. adding client for a new language, improving the NLP, adding a useful generic module, adding more adapters like Skype or Twilio.