Skip to main content

A framework to design, train, and deploy AI chatbots.

Project description

ChatBot Studio

ChatBot Studio is a versatile Python framework designed to simplify the process of designing, training, and deploying AI-powered chatbots. Whether you're a business, an NLP developer, or a chatbot enthusiast, ChatBot Studio provides all the tools you need to create robust conversational agents.

Key Features

  • Prebuilt Conversational Flows: Quickly build conversational flows with reusable templates for customer support, FAQs, and more.
  • Integration with Popular NLP Models: Leverage Hugging Face Transformers and other popular NLP frameworks.
  • Multi-Platform Deployment: Seamlessly deploy your chatbot to Telegram, Slack, WhatsApp, and other platforms.
  • Custom Dataset Training: Easily train chatbots with your own datasets to suit specific use cases.
  • Extensive Documentation: Clear and concise documentation with examples to help you get started quickly.

Installation

Install ChatBot Studio via pip:

pip install ChatBot_Studio

Quick Start

1. Creating a Conversational Flow

from ChatBot_Studio.core.flow_builder import create_conversational_flow

steps = [
    {"question": "How can I assist you today?", "responses": ["Billing", "Technical Support"]},
    {"question": "Can you provide more details?", "responses": ["Yes", "No"]},
]

flow = create_conversational_flow("Customer Support", steps)
print(flow)

2. Integrating an NLP Model

from ChatBot_Studio.core.model_integration import integrate_model

model = integrate_model("distilbert-base-uncased", task="text-classification")
print(model("I love this product!"))

3. Training the Bot

from ChatBot_Studio.core.training import train_bot

trained_model = train_bot("path/to/dataset.json", "mock_model")

4. Deploying the Bot

from ChatBot_Studio.core.deployment import deploy_bot

status = deploy_bot("Telegram", {"api_key": "your_api_key"}, "my_bot")
print(status)

Directory Structure

ChatBot_Studio/
|-- __init__.py
|-- core/
    |-- __init__.py
    |-- flow_builder.py
    |-- model_integration.py
    |-- training.py
    |-- deployment.py
|-- examples/
    |-- customer_support_flow.py
|-- tests/
    |-- test_flow_builder.py
    |-- test_model_integration.py
    |-- test_training.py
    |-- test_deployment.py
setup.py

Running Tests

Run the test suite to verify that everything is working as expected:

pytest tests/

Contributing

Contributions are welcome! Feel free to submit issues or pull requests to enhance ChatBot Studio.

  1. Fork the repository
  2. Create your feature branch: git checkout -b feature-name
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin feature-name
  5. Open a pull request

License

This project is licensed under the MIT License. See the LICENSE file for details.


Authors

Created by Gopalakrishnan Arjunan.

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

chatbot_studio-1.0.1.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ChatBot_Studio-1.0.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file chatbot_studio-1.0.1.tar.gz.

File metadata

  • Download URL: chatbot_studio-1.0.1.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.0

File hashes

Hashes for chatbot_studio-1.0.1.tar.gz
Algorithm Hash digest
SHA256 33c8ed0b19f070fc15d5fe04f1841955170efdcac589a5cebfd523e1bce28d8f
MD5 4b13f2a58e77bf76bbe28a9849081051
BLAKE2b-256 da71a5d30869e138e07c90be7bb3ca5450aadc73304f52efb6c50b9ba11827d7

See more details on using hashes here.

File details

Details for the file ChatBot_Studio-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: ChatBot_Studio-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.0

File hashes

Hashes for ChatBot_Studio-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 54bcfdc7cee7341ccfc33322610c68436ea5854f658a9a98429d10c4513510fc
MD5 d27dc260b5c0fc0790fde3116636e032
BLAKE2b-256 a121e157e9d60b60d7293d2988522a232e0b1b25cb6a0d3f029f99643739b744

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page