Skip to main content

Create webhook services for Dialogflow using Python

Project description

dialogflow-fulfillment

PyPI version Tests status Documentation status Maintainability GitHub license

dialogflow-fulfillment is a package for Python that helps developers to create webhook services for Dialogflow.

The package provides an API for creating and manipulating response messages, output contexts and follow-up events in conversations.

A simple example

from dialogflow_fulfillment import QuickReplies, WebhookClient


# Define a custom handler function
def handler(agent: WebhookClient) -> None:
    """
    This handler sends a text message along with a quick replies message
    back to Dialogflow, which uses the messages to build the final response
    to the user.
    """
    agent.add('How are you feeling today?')
    agent.add(QuickReplies(quick_replies=['Happy :)', 'Sad :(']))


# Create an instance of the WebhookClient
agent = WebhookClient(request)

# Handle the request using the handler function
agent.handle_request(handler)

# Get the response
response = agent.response

Installation

The preferred way to install dialogflow-fulfillment is from PyPI with pip:

pip install dialogflow-fulfillment

Features

dialogflow-fulfillment's key features are:

  • Webhook Client: handle webhook requests using a custom handler function or a map of handlers for each intent
  • Contexts: process input contexts and add, set or delete output contexts
  • Events: trigger follow-up events with optional parameters
  • Rich Responses: create and send the following types of rich response messages:
    • Text
    • Image
    • Card
    • Quick Replies
    • Payload

More examples

Documentation

For more information about the package, guides and examples of usage, see the documentation.

Contribute

All kinds of contributions are welcome!

For an overview about how to contribute to dialogflow-fulfillment, see the contributing guide.

License

This project is licensed under the Apache 2.0 license.

For more details about the license, see the LICENSE file.

Acknowledgments

Thanks to the Dialogflow development team!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for dialogflow-fulfillment, version 0.4.4
Filename, size File type Python version Upload date Hashes
Filename, size dialogflow-fulfillment-0.4.4.tar.gz (17.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page