A Python package for Voiceflow API.
Project description
Voiceflow Python Package
This is an unofficial Python package for an easy use of the Voiceflow API.
Basic usage
In your virtual environment:
pip install voiceflow
Then in your Python code:
import os
from voiceflow import Voiceflow
vf = Voiceflow(
api_key=os.getenv('VOICEFLOW_API_KEY'),
user_id='abc123'
)
# Launch the agent
vf_response = vf.interact.launch()
# Send a simple text input
vf_response = vf.interact.text(user_input='hello')
Pass the version of your Voiceflow project to contact. It can be development (default) or production.
vf = Voiceflow(
api_key=os.getenv('VOICEFLOW_API_KEY'),
user_id='abc123',
version_id='production'
)
You can also call launch() or text() with your custom config:
vf_response = vf.interact.launch(config={'stripSSML': False})
Default config values:
{
'tts': False,
'stripSSML': True,
'stopAll': True,
'stopTypes': [],
'excludeTypes': [
'block',
'debug',
'flow',
]
}
User State:
# Fetch the user's current state
vf_response = vf.user_state.fetch()
# Delete all state and session data for user.
vf_response = vf.user_state.delete()
# NotImplemented:
# Update the user's current state.
Variables:
variables = {
'test1': 'one',
'test2': 2,
}
vf_response = vf.variables.update(variables=variables)
About this project
This project is created and maintained by:
Daian Gan
Github: daiangan
E-mail: daian@ganmedia.com
Website: https://daiangan.com
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
voiceflow-1.0.6.tar.gz
(4.6 kB
view hashes)
Built Distribution
Close
Hashes for voiceflow-1.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45e7dd0eff3c0d6e9e643f177f03ff11963199c442b384ebb5cd61f0feb25db0 |
|
MD5 | ba07c9201d176be9d9043fa0d9511073 |
|
BLAKE2b-256 | a7a1ac4077eb986a4a56b2ff7d0027c06e95bb81d589b134183404dac9ed127a |