apiai_assistant 0.1.1

Create API.ai agents in a heartbeat

API.ai Assistant

apiai_assistant aims to offer developers the easiest and most intuitive way to create smart assistants through API.ai

---

Table of contents

• Installation

  • Latest PyPI stable release

  • Latest development release on github

  • Running tests

• Changelog

• Usage

  • Sample project

  • Further reading

• FAQ and Known Issues

• To do

• Documentation

• Contributions

• LICENCE

• Authors

Installation

Latest PyPI stable release

pip install apiai-assistant

Latest development release on github

Pull and install in the current directory:

pip install -e git+https://github.com/toasterco/apiai_assistant.git@master#egg=apiai_assistant

Running tests

python -m unittest discover tests/

Or

nosetests --with-coverage --cover-package=apiai_assistant

Changelog

The list of all changes is available either on GitHub’s Releases: or on crawlers such as allmychanges.com.

Usage

Sample project

See the apiai_assistant-sample project.

Further reading

• Declaring an Assistant

• Registering an intent

• Writing intents

  • Accessing parameters

  • Accessing context parameters

  • Telling the user

  • Asking the user

  • Showing the user

  • Suggesting options to the user

  • Adding contexts

  • Requesting permissions

  • Aborting

FAQ and Known Issues

• Can I use my agent for all API.ai supported integrations ?

  Only Actions on Google is supported as of yet in Alpha.

If you come across any other difficulties, browse/open issues here.

To do

• Better error support (all error code, not only 400, and include error message)

• Add follow up intents support

• Support other smart assistant platforms (Alexa, Messenger, Slack as priorities)

• Assist account linking

Documentation

All the doc can be found over here.

Contributions

All source code is hosted on GitHub. Contributions are welcome.

LICENCE

Open Source :

Authors

Ranked by contributions.

• Zack Dibe (Zack–) *

• Dominic Santos (dominicglenn)

* Original author