https://github.com/intentional-ai/intentional
Intentional is an open-source framework to build reliable LLM chatbots that actually talk and behave as you expect.
https://github.com/intentional-ai/intentional
chatbot genai llm
Last synced: 3 months ago
JSON representation
Intentional is an open-source framework to build reliable LLM chatbots that actually talk and behave as you expect.
- Host: GitHub
- URL: https://github.com/intentional-ai/intentional
- Owner: intentional-ai
- License: agpl-3.0
- Created: 2024-10-03T17:31:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-31T18:00:16.000Z (over 1 year ago)
- Last Synced: 2025-12-16T00:41:09.595Z (7 months ago)
- Topics: chatbot, genai, llm
- Language: Python
- Homepage: https://intentional-ai.github.io/intentional/
- Size: 1.31 MB
- Stars: 13
- Watchers: 1
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Intentional
Intentional is an open-source framework to build reliable, multimodal and multi-channel LLM chatbots that actually talk and behave as you expect.
NOTE: Intentional is still in its very early stages, and there are a lot of rough edges to it. To give any feedback or contribute, [get in touch](https://github.com/intentional-ai/intentional/issues/new)!
## Getting Started
First, install Intentional:
```
pip install intentional
```
**NOTE**: you may also need to install `portaudio` with `sudo apt install portaudio19-dev`.
Next, get a configuration file. For your first test run you should pick [this file](https://github.com/intentional-ai/intentional/blob/main/examples/cli_text_chat.yml), which needs no additional plugins, but you can find a few other examples [here](https://github.com/intentional-ai/intentional/tree/main/examples).
**NOTE**: The example here also requires an OpenAI key. Export it as an environment variable called `OPENAI_API_KEY` before proceeding.
Assuming your configuration file is called `intentional_bot.yml`, you can now launch your bot by doing:
```
intentional intentional_bot.yml
```
The output should look like:
```
==> Chat is ready!
User:
```
Type in your message and the bot is going to respond.
### Draw the conversation
To see the graph of the conversation defined by this configuration file, run:
```
intentional example.yml --draw
```
The graph will be saved next to your configuration file as `example.png`.
## Documentation
You can find all the documentation [here](https://intentional-ai.github.io/intentional/), including the API reference for the core packages and all the plugins hosted in this repository.
## License
All the content of this repository is distributed under the terms of the [AGPL](LICENSE) license. If that doesn't work for you, [get in touch](mailto:github@zansara.dev).