Skip to main content

ChatterBot: Machine learning in Python

ChatterBot

ChatterBot is a machine-learning based conversational dialog engine built in Python which makes it possible to generate responses based on collections of known conversations. The language independent design of ChatterBot allows it to be trained to speak any language.

Package Version Python 3.12 Coverage Status Follow on Bluesky Join the chat at https://gitter.im/chatterbot/Lobby

An example of typical input would be something like this:

user: Good morning! How are you doing?
bot: I am doing very well, thank you for asking.
user: You're welcome.
bot: Do you like hats?

How it works

An untrained instance of ChatterBot starts off with no knowledge of how to communicate. Each time a user enters a statement, the library saves the text that they entered and the text that the statement was in response to. As ChatterBot receives more input the number of responses that it can reply to, and the accuracy of each response in relation to the input statement increases. The program selects the closest matching response by searching for the closest matching known statement that matches the input, it then returns the most likely response to that statement based on how frequently each response is issued by the people the bot communicates with.

Documentation

View the documentation for ChatterBot.

Installation

This package can be installed from PyPi by running:

pip install chatterbot

Basic Usage

from chatterbot import ChatBot
from chatterbot.trainers import ChatterBotCorpusTrainer

chatbot = ChatBot('Ron Obvious')

# Create a new trainer for the chatbot
trainer = ChatterBotCorpusTrainer(chatbot)

# Train the chatbot based on the english corpus
trainer.train("chatterbot.corpus.english")

# Get a response to an input statement
chatbot.get_response("Hello, how are you today?")

Training data

ChatterBot comes with a data utility module that can be used to train chat bots. At the moment there is training data for over a dozen languages in this module. Contributions of additional training data or training data in other languages would be greatly appreciated. Take a look at the data files in the chatterbot-corpus package if you are interested in contributing.

from chatterbot.trainers import ChatterBotCorpusTrainer

# Create a new trainer for the chatbot
trainer = ChatterBotCorpusTrainer(chatbot)

# Train based on the english corpus
trainer.train("chatterbot.corpus.english")

# Train based on english greetings corpus
trainer.train("chatterbot.corpus.english.greetings")

# Train based on the english conversations corpus
trainer.train("chatterbot.corpus.english.conversations")

Corpus contributions are welcome! Please make a pull request.

Examples

For examples, see the examples section of the documentation.

History

See release notes for changes https://github.com/gunthercox/ChatterBot/releases

Contributing

Contributions are welcomed, to help ensure a smooth process please start with the contributing guidelines in our documentation: https://docs.chatterbot.us/contributing/

Sponsors

ChatterBot is sponsored by:

License

ChatterBot is licensed under the BSD 3-clause license.

Metadata

Release files for ChatterBot 1.2.16

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ChatterBot 1.2.16
File Size Uploaded Provenance Actions
chatterbot-1.2.16.tar.gz 87.8 kB Without provenance Details for chatterbot-1.2.16.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ChatterBot 1.2.16
File Interpreter ABI Platform Actions
chatterbot-1.2.16-py3-none-any.whl Python 3 none any Details for chatterbot-1.2.16-py3-none-any.whl

Total release size: 185.9 kB

Release files / chatterbot-1.2.16.tar.gz

Download URL chatterbot-1.2.16.tar.gz
Size 87.8 kB
Tags Source
SHA-256 checksum
How to use checksums
3066b6479a691fafcc3c359767c25102c3edce883c6d7fe56fd4e98085cb825a
BLAKE2b-256 checksum
How to use checksums
7792a0774a3baaebc13b232edf51b41ec68bfbd5090ad30644136ca3be32f63d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.21

Release files / chatterbot-1.2.16-py3-none-any.whl

Download URL chatterbot-1.2.16-py3-none-any.whl
Size 98.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
84568b79bccd5ca25a13a4eda96a585c771965876ad4c625660450a5d79b1a7a
BLAKE2b-256 checksum
How to use checksums
e699461873d07771da3a44ed54537241cccb29b964e06b55a9dc06d9a7cb765a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.21

Security for ChatterBot 1.2.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.2.16 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page