Susi AI is an intelligent Open Source personal assistant. It is capable of chat and voice interaction by using APIS to perform actions such as music playback, making to-do lists, setting alarms, streaming podcasts, playing audiobooks, and providing weather, traffic, and other real time information. Additional functionalities can be added as console services using external APIs. Susi AI is able to answer questions and depending on the context will ask for additional information in order to perform the desired outcome. The core of the assistant is the Susi AI server that holds the "intelligence" and "personality" of Susi AI. The Android and web applications make use of the APIs to access information from a hosted server.
An automatic deployment from the development branch at GitHub is available for tests here https://susi-server.herokuapp.com
Please join our mailing list to discuss questions regarding the project: https://groups.google.com/forum/#!forum/opntec-dev/
Our chat channel is on gitter here: https://gitter.im/fossasia/susi_server
At this time, Susi AI is not provided in compiled form, you easily build it yourself. It's not difficult and done in one minute! The source code is hosted at https://github.com/fossasia/susi_server, you can download it and run Susi AI with:
> git clone https://github.com/fossasia/susi_server.git > cd susi_server > git submodule update --recursive --remote > git submodule update --init --recursive > ./gradlew build > bin/start.sh
For Windows Users (who are using GitBash/Cygwin or any terminal):
> git clone https://github.com/fossasia/susi_server.git > cd susi_server > git checkout master > ant jar > java -jar dist/susiserver.jar > git checkout development > ant jar > java -jar dist/susiserver.jar
To stop: > Press Ctrl+C
After all server processes are running, Susi AI tries to open a browser page itself. If that does not happen, just open http://localhost:4000; if you made the installation on a headless or remote server, then replace 'localhost' with your server name.
To stop Susi AI, run: (this will block until the server has actually terminated)
A self-upgrading process is available which must be triggered by a shell command. Just run:
No-where, you must clone the git repository of Susi AI and built it yourself. That's easy, just do
git clone https://github.com/fossasia/susi_server.git
To install Susi AI with Docker on Google Cloud please refer to the Susi Docker installation readme.
To install Susi AI with Docker on AWS please refer to the Susi Docker installation readme.
To install Susi AI with Docker on Bluemix please refer to the Susi Docker installation readme.
To install Susi AI with Docker on Digital Ocean please refer to the Susi Docker installation readme.
You can easily deploy to Heroku by clicking the Deploy to Heroku button above. To install Susi AI using Heroku Toolbelt, please refer to the Susi Heroku installation readme.
To install Susi AI with cloud9 please refer to the Susi cloud9 installation readme.
To install Susi AI on Eclipes, please refer to the Susi Eclipse readme.
http://localhost:4000in your browser
The basis configuration file is in
customize these settings place a file
to the path
To install Gradle on Ubuntu:
$ sudo add-apt-repository ppa:cwchien/gradle $ sudo apt-get update $ sudo apt-get install gradle
To install Gradle on Mac OS X with homebrew
brew install gradle
To compile, first, create dir necessary for Gradle
Compile the source to classes and a jar file
Compiled file can be found in build dir Last, clean up so that we can still build the project using Ant
The Susi AI skill language is described in the Skill Development Tutorial.
If you like to create your own AI, then you may consider Susi AI.
Hey, this is the tool for that! Just put http://loklak.org/api/search.rss?q=%23susi into your rss reader. Oh wait.. you will get a lot of information about tasty Cambodian food with that as well. Alternatively you may also read the authors timeline using http://loklak.org/api/search.rss?q=0rb1t3r or just follow @0rb1t3r (that's a zero after the at sign)
The Doumentation can be found at https://github.com/fossasia/susi_server/tree/development/docs/api/api.md
You can build them via 'ant javadoc'
This project is considered a community work. The development crew consist of you too. I am very thankful for pull request. So if you discovered that something can be enhanced, please do it yourself and make a pull request. If you find a bug, please try to fix it. If you report a bug to me I will possibly consider it but at the very end of a giant, always growing heap of work. The best chance for you to get things done is to try it yourself. Our issue tracker is here.
After selecting the issue
1.Comment on the issue saying you are working on the issue.
2.We expect you to discuss the approach either by commenting or in the gitter.
3.Updates or progress on the issue would be nice.
Start off from your
development branch and make sure it is
up-to-date with the latest version of the committer repo's
development branch. Make sure you are working in development branch
git pull upstream development
If you have not added upstream follow the steps given here.
Once a PR is opened, try and complete it within 2 weeks, or at least stay actively working on it. Inactivity for a long period may necessitate a closure of the PR. As mentioned earlier updates would be nice.
Your code will be reviewed, in this sequence, by:
Have fun! @0rb1t3r