Alexis-Jacob/pywit

Python library for Wit.ai

pywit

pywit is the Python SDK for Wit.ai.

Install

Using pip:

pip install wit

From source:

git clone https://github.com/wit-ai/pywit
python setup.py install

Usage

See the examples folder for examples.

API

Versioning

The default API version is 20160516. You can target a specific version by setting the env variable WIT_API_VERSION.

Overview

pywit provides a Wit class with the following methods:

• message - the Wit message API
• converse - the low-level Wit converse API
• run_actions - a higher-level method to the Wit converse API
• interactive - starts an interactive conversation with your bot

Wit class

The Wit constructor takes the following parameters:

• access_token - the access token of your Wit instance
• actions - (optional if you only use message()) the dictionary with your actions

actions has action names as keys and action implementations as values.

A minimal example looks like this:

from wit import Wit

def send(request, response):
    print('Sending to user...', response['text'])
def my_action(request):
    print('Received from user...', request['text'])

actions = {
    'send': send,
    'my_action': my_action,
}

client = Wit(access_token=access_token, actions=actions)

.message()

The Wit message API.

Takes the following parameters:

• msg - the text you want Wit.ai to extract the information from
• verbose - (optional) if set, calls the API with verbose=true

Example:

resp = client.message('what is the weather in London?')
print('Yay, got Wit.ai response: ' + str(resp))

.run_actions()

A higher-level method to the Wit converse API.

Takes the following parameters:

• session_id - a unique identifier describing the user session
• message - the text received from the user
• context - the dict representing the session state
• max_steps - (optional) the maximum number of actions to execute (defaults to 5)
• verbose - (optional) if set, calls the API with verbose=true

Example:

session_id = 'my-user-session-42'
context0 = {}
context1 = client.run_actions(session_id, 'what is the weather in London?', context0)
print('The session state is now: ' + str(context1))
context2 = client.run_actions(session_id, 'and in Brussels?', context1)
print('The session state is now: ' + str(context2))

.converse()

The low-level Wit converse API.

Takes the following parameters:

• session_id - a unique identifier describing the user session
• message - the text received from the user
• context - the dict representing the session state
• verbose - (optional) if set, sets the API parameter verbose to true

Example:

resp = client.converse('my-user-session-42', 'what is the weather in London?', {})
print('Yay, got Wit.ai response: ' + str(resp))

See the docs for more information.

.interactive()

Starts an interactive conversation with your bot.

Example:

client.interactive()

See the docs for more information.

Logging

Default logging is to STDOUT with INFO level.

You can set your logging level as follows:

from wit import Wit
import logging
client = Wit(token, actions)
client.logger.setLevel(logging.WARNING)

You can also specify a custom logger object in the Wit constructor:

from wit import Wit
client = Wit(access_token=access_token, actions=actions, logger=custom_logger)

See the logging module and logging.config docs for more information.