https://github.com/dariowho/intents
A framework to define and operate Dialogflow Agents with a simple, code-first, approach 🔧
https://github.com/dariowho/intents
bot-framework bots chatbot conversational-agents dialogflow
Last synced: 5 months ago
JSON representation
A framework to define and operate Dialogflow Agents with a simple, code-first, approach 🔧
- Host: GitHub
- URL: https://github.com/dariowho/intents
- Owner: dariowho
- License: apache-2.0
- Created: 2021-01-31T22:02:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-26T10:44:31.000Z (over 3 years ago)
- Last Synced: 2025-07-20T06:44:55.136Z (11 months ago)
- Topics: bot-framework, bots, chatbot, conversational-agents, dialogflow
- Language: Python
- Homepage: https://intents.readthedocs.io/
- Size: 520 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Intents ⛺
[](https://intents.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/dariowho/intents)
[](https://img.shields.io/badge/head-v0.3.0-blue.svg)
[](https://badge.fury.io/py/intents)
**Intents** is a Python framework to define and operate
Conversational Agents with a simple, code-first approach. *Intents* comes with
built-in support for Dialogflow ES and experimental Alexa and Snips connectors. Its main benefits are:
* **Agents are Python projects**. You will develop with autocomplete, static type checking
and everything you are already used to.
* **Versioning and CI**. Agents can be versioned on Git, and programmatically
deployed just like software.
* **Human-friendly Connectors**. Intents are classes, predictions are their
instances. Support can be extended beyond Dialogflow by implementing custom connectors.
A detailed view of the available features can be found in
[STATUS.md](STATUS.md). Also, check out the
[Projects](https://github.com/dariowho/intents/projects) page to keep track of
recent developments.
## Install
```sh
pip install intents
```
## Usage
Intents are defined like standard Python **dataclasses**:
```python
@dataclass
class HelloIntent(Intent):
"""A little docstring for my Intent class"""
user_name: Sys.Person = "Guido"
MyAgent.register(HelloIntent)
```
Their **language** resources are stored in separate YAML files:
```yaml
utterances:
- Hi! My name is $user_name{Guido}
- Hello there, I'm $user_name{Mario}
responses:
default:
- text:
- Hi $user_name
- Hello $user_name, this is Bot!
```
Agents can be **uploaded** as Dialogflow ES projects directly from code:
```python
df = DialogflowEsConnector('/path/to/service-account.json', MyAgent)
df.upload() # You will find it in your Dialogflow Console
```
*Intents* will act transparently as a **prediction** client:
```python
predicted = df.predict("Hi there, my name is Mario")
predicted.intent # HelloIntent(user_name="Mario")
predicted.intent.user_name # "Mario"
predicted.fulfillment_text # "Hello Mario, this is Bot!"
```
For a complete working example, check out the included [Example Agent](example_agent/). Also, *Intents* **documentation** is published at https://intents.readthedocs.io/ 📚
## Disclaimer
*This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Dialogflow. The names Dialogflow, Google, as well as related names, marks, emblems and images are registered trademarks of their respective owners.*