itsabot

command module
Version: v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 1, 2016 License: MIT Imports: 29 Imported by: 0

README

Abot

Website | Getting Started | Contributing | Mailing List

GoDoc Travis CI

Abot (pronounced Eh-Bot, like the Canadians) is a digital assistant framework that enables anyone to easily build a digital assistant similar to Apple's Siri, Microsoft's Cortana, Google Now, or Amazon Alexa. Further, Abot supports a human-aided training backend enabling anyone to build services like Facebook M.

Unlike those proprietary systems, Abot is open-sourced and extensible. By providing an extensible platform onto which anyone can easily add functionality, Abot is the first A.I. framework that aims to be available everywhere and— ultimately—to do everything.

Note: This is being developed heavily. There may be breaking API changes in each release until we hit v1.0. Follow our progress on the Roadmap.

Installation

Dependencies: Abot requires that the following programs are installed:

Fetch Abot via go get

$ go get github.com/itsabot/abot
$ cd $GOPATH/src/github.com/itsabot/abot

Run the setup script, passing in your Postgres credentials/host if needed.

$ cmd/setup.sh [username[:password]@host[:port]]

If you don't pass anything to the script, the Postgres parameters will default to host = 127.0.0.1, port = 5432, and username = postgres. You may need to edit your pg_hba.conf file if you want to use this password-less default.

During setup, if the psql binary is unavailable, the script will skip the database setup. To setup the database on an different machine, you can run cmd/dbsetup.sh on the host that has Postgres / psql available. This script takes the same arguments as cmd/setup.sh.

Once the script completes, launch the server

$ abot server

Then visit Abot at localhost:4200.

Usage

First configure the plugins you want to import, such as weather. Add them to your plugin.json like so:

{
	"Version": 0.2,
	"Dependencies": {
		"github.com/itsabot/plugin_weather": "*"
	}
}

Then run the following in your terminal to download the plugins:

$ abot plugin install
Fetching 1 plugin...
Installing plugin...
Success!

That will download the plugins into your $GOPATH and install them into Abot. Once you've installed the plugins, run Abot again: abot server. You can use the included Abot console to communicate with Abot locally:

$ abot console +13105555555
> Hi
Hello there!

You can learn more in our Getting Started guide.

Goals

We believe that A.I. will impact every business worldwide and dramatically change our lives. While Apple, Google and others rush to build proprietary digital assistants, there's a great need for an open approach that can be made to run anywhere and be customized to do anything you need.

Abot enables any person or business to build digital assistants like Siri using plugins that are as easy to install and run as WordPress. Soon it'll be as easy to leverage A.I. in your business as it is to start a blog or an online store. Imagine setting up an AI assistant to answer your phones, schedule meetings, and book travel for your company in 30 seconds or less. The future's almost here, and Abot's going to lead the way.

We have a long road ahead of us, but "nothing ever comes to one that is worth having except as a result of hard work." -- Booker T. Washington

Follow our progress on our Roadmap or learn how you can get involved with our Contributor's Guide.

License

MIT, a copy of which you can find in the repo.

This project uses a Bayesian classifier library (github.com/jbrukh/bayesian), whose BSD-style license you can find in /core/training/LICENSE.md.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package core handles the internal logic of Abot.
Package core handles the internal logic of Abot.
log
Package log is a logger used by Abot core and plugins.
Package log is a logger used by Abot core and plugins.
template
Package template builds commonly used emails filled in with custom information.
Package template builds commonly used emails filled in with custom information.
websocket
Package websocket manages websocket connections and notifications for Abot clients.
Package websocket manages websocket connections and notifications for Abot clients.
data
ner
shared
datatypes
Package dt offers a collection of commonly used datatypes.
Package dt offers a collection of commonly used datatypes.
helpers/address
Package address provides address extraction and validation tools.
Package address provides address extraction and validation tools.
helpers/timeparse
Package timeparse parses times in strings in a wide variety of formats to corresponding time.Times.
Package timeparse parses times in strings in a wide variety of formats to corresponding time.Times.
interface/cal
Package cal enables control over arbitrary 3rd party calendars.
Package cal enables control over arbitrary 3rd party calendars.
interface/cal/driver
Package driver defines interfaces to be implemented by calendar drivers as used by package cal.
Package driver defines interfaces to be implemented by calendar drivers as used by package cal.
interface/email
Package email enables interaction with arbitrary email providers.
Package email enables interaction with arbitrary email providers.
interface/email/driver
Package driver defines interfaces to be implemented by email drivers as used by package email.
Package driver defines interfaces to be implemented by email drivers as used by package email.
interface/emailsender
Package emailsender enables Abot to send email through any external service.
Package emailsender enables Abot to send email through any external service.
interface/emailsender/driver
Package driver defines interfaces to be implemented by email_sender drivers as used by package emailsender.
Package driver defines interfaces to be implemented by email_sender drivers as used by package emailsender.
interface/payment
Package payment enables interaction with arbitrary payment providers.
Package payment enables interaction with arbitrary payment providers.
interface/payment/driver
Package driver defines interfaces to be implemented by payment drivers as used by package payment.
Package driver defines interfaces to be implemented by payment drivers as used by package payment.
interface/sms
Package sms enables interaction with arbitrary SMS providers.
Package sms enables interaction with arbitrary SMS providers.
interface/sms/driver
Package driver defines interfaces to be implemented by SMS drivers as used by package sms.
Package driver defines interfaces to be implemented by SMS drivers as used by package sms.
language
Package language makes it easier to build plugins and natural-sounding responses.
Package language makes it easier to build plugins and natural-sounding responses.
plugin
Package plugin enables plugins to register with Abot and connect to the database.
Package plugin enables plugins to register with Abot and connect to the database.
prefs
Package prefs manages global preferences that plugins frequently share with one another.
Package prefs manages global preferences that plugins frequently share with one another.
task
Package task defines commonly used tasks across plugins.
Package task defines commonly used tasks across plugins.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL