Git Product home page Git Product logo

voiceflow-python's Introduction

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: [email protected]
Website: https://daiangan.com

voiceflow-python's People

Contributors

daiangan avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Forkers

tactilenews

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.