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.


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.2.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.2-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for chatbot_studio-1.0.2.tar.gz
Algorithm Hash digest
SHA256 9273ca2e38a268606e9659382ad28689c201f317da720d62e8fe29739dcd182a
MD5 3bd6ac7567ef927c20366b07b7098e3e
BLAKE2b-256 be4015fbae60bffedf1d38dd92844be186bb58e787338dae496fbd3fab508cda

See more details on using hashes here.

File details

Details for the file chatbot_studio-1.0.2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for chatbot_studio-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2a961ba94315ec113b26e08ff2834acaac592cb28bffb21c07b5633d24b1d383
MD5 58dc3f705d4c3c3357c71630c80650c9
BLAKE2b-256 3288cb2644acb676ef75911c96cd730bdd5cab5cd21fcc47af9d5bf6d3ce68e8

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