Home

Quick Start

Create a new chat bot

from chatterbot import ChatBot
chatbot = ChatBot("Ron Obvious")

Note: The only required parameter for the ChatBot is a name. This can be any anything you want.

Training

After creating a new ChatterBot instance it is also possible to train the bot. Training is a good way to ensure that the bot starts off with knowledge about specific responses. The current training method takes a list of statements that represent a conversation. Additional notes on training can be found here.

Note: Training is not required but it is recommended.

conversation = [
    "Hello",
    "Hi there!",
    "How are you doing?",
    "I'm doing great.",
    "That is good to hear",
    "Thank you.",
    "You're welcome."
]

chatbot.train(conversation)

Get a response

response = chatbot.get_response("Good morning!")
print(response)

Read only mode

Your ChatterBot will learn based on each new input statement it receives. If you want to disable this learning feature after your bot has been trained, you can set read_only=True as a parameter when initializing the bot.

chatbot = ChatBot("Johnny Five", read_only=True)

Adapters

ChatterBot uses adapter modules to control the behavior of specific types of tasks. There are three distinct types of adapters that ChatterBot uses, these are storage adapters, IO adapters, and logic adapters.

Storage adapters provide an interface for ChatterBot to connect to various storage systems such as MongoDB or local file storage.

IO adapters prove methods that allow ChatterBot to get input from a defined data source and return a response as output.

Logic adapters define the logic that ChatterBot uses to respond to input it receives.

Read more about the various adapters that are available.

• Storage adapters
• IO adapters
• Logic adapters

By default, ChatterBot uses the JsonDatabaseAdapter adapter for storage, the ClosestMatchAdapter for logic, and the TerminalAdapter for IO.

Each adapter can be set by passing in the dot-notated import path to the constructor as shown.

bot = ChatBot("My ChatterBot",
    storage_adapter="chatterbot.adapters.storage.JsonDatabaseAdapter",
    logic_adapter="chatterbot.adapters.logic.ClosestMatchAdapter",
    io_adapter="chatterbot.adapters.io.TerminalAdapter",
    database="../database.db")