title: Susi - Docs
SUSI AI is an intelligent Open Source personal assistant. It is capable of chat and voice interaction and 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 a desired outcome. The core of the assistant is the SUSI AI server that holds the "ingelligence" and "personality" of SUSI. 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/loklak
Our chat channel is on gitter here: https://gitter.im/fossasia/susi_server
How do I install Susi: Download, Build, Run
Note: You must be logged in to Docker Cloud for the button to work correctly. If you are not logged in, you’ll see a 404 error instead.
At this time, Susi 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 with:
> git clone https://github.com/fossasia/susi_server.git > cd susi_server > ant > 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 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, 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:
Where can I download ready-built releases of Susi?
No-where, you must clone the git repository of Susi and built it yourself. That's easy, just do
git clone https://github.com/fossasia/susi_server.git
- then see below ("How do I run Susi")
How do I install Susi with Docker?
To install Susi with Docker please refer to the Susi Docker installation readme.
How do I deploy Susi with Heroku?
You can easily deploy to Heroku by clicking the Deploy to Heroku button above. To install Susi using Heroku Toolbelt, please refer to the Susi Heroku installation readme.
How do I deploy Susi with cloud9?
To install Susi with cloud9 please refer to the Susi cloud9 installation readme.
How do I setup Susi on Eclipse?
To install Susi on Eclipes, please refer to the Susi Eclipse readme.
How do I run Susi?
- build Susi (you need to do this only once, see above)
http://localhost:4000in your browser
- to shut down Susi, run
How do I analyze data acquired by Susi
Susi stores data into an elasticsearch index. There is a front-end
for the index available in elasticsearch-head. To install this, do:
sudo npm install -g grunt-cli
cdinto the parent directly of Susi_server
git clone git://github.com/mobz/elasticsearch-head.git
Run elasticsearch-head with:
..which opens the administration page at
How do I configure Susi?
The basis configuration file is in
conf/config.properties. To customize these settings place a file
customized_config.properties to the path
How to compile using Gradle?
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
How do I develop Skills (AI Conversation Rules) for Susi?
The Susi skill language is described in the Skill Development Tutorial.
Why should I use Susi?
If you like to create your own AI, then you may consider Susi.
Where can I get the latest news about Susi?
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)
Where can I find documentation?
The application has built-in documentation web pages, you will see them when you opened the application web pages or you can simply open
html/index.html or just use http://api.asksusi.com as reference.
Where can I find showcases and tutorials?
Articles and tutorials are also on our blog at http://blog.loklak.net.
Where do I find the javadocs?
At http://susi.github.io/susi_server/ or by building them via 'ant javadoc'
Where can I report bugs and make feature requests?
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.
What is the software license?
Step 1: Pick an issue to fix
After selecting the issue
1.Comment on the issue saying you are working on the issue.
2.We except you to discuuss the approach either by commenting or in the gitter.
3.Updates or progress on the issue would be nice.
Step 2: Branch policy<br>
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 only.<br>
git pull upstream development
If you have not added upstream follow the steps given here.
Step 3: Coding Policy
Please help us follow the best practice to make it easy for the reviewer as well as the contributor.
We want to focus on the code quality more than on managing pull request ethics.
Single commit per pull request
Reference the issue numbers in the commit message. Follow the pattern Fixes #
Follow uniform design practices. The design language must be consistent throughout the app.
The pull request will not get merged until and unless the commits are squashed.
In case there are multiple commits on the PR, the commit author needs to squash them and
not the maintainers cherrypicking and merging squashes.
If you don't know what does squashing of commits is read from here.
If the PR is related to any front end change, please attach relevant screenshots in the pull request description
Step 4: Submitting a PR
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.
Step 5: Code Review
Your code will be reviewed, in this sequence, by:
- Travis CI: by building and running tests.<br>
If there are failed tests, the build will be marked as a failure.
You can consult the CI log to find which tests.<br>
Ensure that all tests pass before triggering another build.
- The CI log will also contain the command that will enable running the failed tests locally.<br>
- Reviewer: A core team member will be assigned to the PR as its reviewer, who will approve your PR or he will suggest changes.