Features

• Tighter Django integration [https://github.com/gunthercox/ChatterBot/pull/471]
• Add save method to statements [https://github.com/gunthercox/ChatterBot/pull/515]
• Add created_at field to statements [https://github.com/gunthercox/ChatterBot/pull/536]
• Add ordering parameter to filter method [https://github.com/gunthercox/ChatterBot/pull/535]

Deprecation

• Deprecate get_default and update_default session methods [https://github.com/gunthercox/ChatterBot/pull/541]

Bug fixes

• Remove tested constraint for response objects in filter method [https://github.com/gunthercox/ChatterBot/pull/511]
• Correct unicode characters in German corpus [https://github.com/gunthercox/ChatterBot/pull/521]

Maintenance

• Move adapter type exception to adapter class [https://github.com/gunthercox/ChatterBot/pull/512]
• Rename SessionManager to ConversationSessionManager [https://github.com/gunthercox/ChatterBot/pull/519]
• Add warnings about module rename [https://github.com/gunthercox/ChatterBot/pull/538]

Documentation

• Add link to ChatterBot live example created by @vkosuri [https://github.com/gunthercox/ChatterBot/pull/517]

Bug fixes

• Change default occurrence count to from 0 to 1 in Response model [https://github.com/gunthercox/ChatterBot/pull/491]
• wsgi should point example_app (via @vkosuri) [https://github.com/gunthercox/ChatterBot/pull/505]
• Convert response unicode into JSON object (via @vkosuri) [https://github.com/gunthercox/ChatterBot/pull/498]

Maintenance

• Remove 'has_storage' method [https://github.com/gunthercox/ChatterBot/pull/492]
• Deprecate OutputFormatAdapter [https://github.com/gunthercox/ChatterBot/pull/500]
• Run json database in-memory when testing [https://github.com/gunthercox/ChatterBot/pull/496]
• Do not update extra data from kwargs [https://github.com/gunthercox/ChatterBot/pull/499]
• Update migration documentation (via @rajasimon) [https://github.com/gunthercox/ChatterBot/pull/501]
• Remove the deprecated approximate sentence match adapter [https://github.com/gunthercox/ChatterBot/pull/502]
• Remove the deprecated sentiment adapter class [https://github.com/gunthercox/ChatterBot/pull/503]
• Update bootstrap version to 4-alpha in example app [https://github.com/gunthercox/ChatterBot/pull/506]

Increasing Integration with Django

Several changes have been made to help make Django a first class citizen in ChatterBot. These changes improve both the performance of ChtterBot when using the popular Python web framework. The changes also help to make it more convenient for developers to use Django and ChatterBot together.

• Give Django Statement & Response models the same attributes as ChatterBot Statements & Responses [https://github.com/gunthercox/ChatterBot/pull/488]
• Make sure default Django input and output adapters work with the Statement & Response models [https://github.com/gunthercox/ChatterBot/pull/490]

Efficiency

• Cache results from can_process method in math adapter [https://github.com/gunthercox/ChatterBot/pull/461]

Bug fixes

• Fix grammar issues in russian conversation corups (via @alxmamaev) [https://github.com/gunthercox/ChatterBot/pull/462]
• Handle the case that a chat session does not exist [https://github.com/gunthercox/ChatterBot/pull/480]
• Fix Hipchat session management (via @vkosuri) [https://github.com/gunthercox/ChatterBot/pull/485]

Testing

• Move Django tests out of the example app [https://github.com/gunthercox/ChatterBot/pull/481]

Features

• Additional mathematical operation support thanks to @le-corentin [https://github.com/gunthercox/ChatterBot/pull/449]

Bug fixes

• Fixed unicode characters in the spanish corpus (via @luksireiku) [https://github.com/gunthercox/ChatterBot/pull/440]

Deprecation

• Deprecate matching logic adapters [https://github.com/gunthercox/ChatterBot/pull/456]

ChatterBot 0.5 Release Notes (Major Release)

Backwards incompatible changes

• Split utils folder into a single file [https://github.com/gunthercox/ChatterBot/pull/418]
• Rename 'context' to 'chatbot' [https://github.com/gunthercox/ChatterBot/pull/419]
• Clean up or remove NLTK wrapper classes [https://github.com/gunthercox/ChatterBot/pull/420]
• Change adapter import paths [https://github.com/gunthercox/ChatterBot/pull/422]

Bug fixes

• Update scope of external package imports [https://github.com/gunthercox/ChatterBot/pull/426]
• Remove check for ajax request in Django view [https://github.com/gunthercox/ChatterBot/pull/428]
• Prevent possible edge case when adding inserting logic adapters [https://github.com/gunthercox/ChatterBot/pull/434]

Features

• Add session management [https://github.com/gunthercox/ChatterBot/pull/424]
• Remove dependency on Textblob [https://github.com/gunthercox/ChatterBot/pull/435]

Bug fixes

• Handel the case that a Mongo DB statement does not have an in_response_to attribute [https://github.com/gunthercox/ChatterBot/pull/415]

Features

• Add training class for Ubuntu corpus [https://github.com/gunthercox/ChatterBot/pull/405]

Features

• Add support for integration with the Microsoft Bot Framework [https://github.com/gunthercox/ChatterBot/pull/381]
  • (A huge thanks to @vkosuri for working to add support for integration with Microsoft's Bot Framework).
• Add Django management command to train chat bot [https://github.com/gunthercox/ChatterBot/pull/401]
• Add a logic adapter to return a specific response to a specific input. [https://github.com/gunthercox/ChatterBot/pull/409]
• Add a logic adapter to return a default response when no good response is known [https://github.com/gunthercox/ChatterBot/pull/409]
• Remove dependency on fuzzywuzzy [https://github.com/gunthercox/ChatterBot/pull/410]

Bug fixes

• Fix adapter issue with unicode literals [https://github.com/gunthercox/ChatterBot/pull/411]

Simplification of matching-type logic adapters

This is a cool internal change that occurred for this release. By pulling several statement comparison methods out into their own module, much of the code for several matching style logic adapters became nearly identical. This made it possible to reduce a large amount of repeated code.

In a future release, all of the matching style logic adapers (ClosestMatch, ClosestMeaning, SentimentAnalysis, ApproximateSentenceMatch) will be replaced by a single MatchingAdapter class that will allow the comparison function to be set as a parameter.

• Modify synset_distance comparison function [https://github.com/gunthercox/ChatterBot/pull/385]
• The comparison function now returns a percent so it can be easily compared to other comparison methods.
• This change allowed the codebase for the closest match adapter and the closest meaning adapter to be combined.
• Move sentiment matching to it's own function [https://github.com/gunthercox/ChatterBot/pull/386]
• Don't override get method on ApproximateSentenceMatchAdapter [https://github.com/gunthercox/ChatterBot/pull/387]
• Add check for if logic adapter string parameters need to be imported [https://github.com/gunthercox/ChatterBot/pull/395]

Additional updates

Bug fixes

• Add check to prevent nltk_data download loop (via @vkosuri) [https://github.com/gunthercox/ChatterBot/pull/369]
• Correct JSON formatting in corpora [https://github.com/gunthercox/ChatterBot/pull/394]
• Datetime parser updates [https://github.com/gunthercox/ChatterBot/pull/397]

Features

• Support extra_data passed to django API view [https://github.com/gunthercox/ChatterBot/pull/374]
• Split up response generation and learning parts of get_response so that the learning process can be externally controlled if needed [https://github.com/gunthercox/ChatterBot/pull/365]
• Add check for logic adapter agreement [https://github.com/gunthercox/ChatterBot/pull/375]
• Add Mailgun input adapter [https://github.com/gunthercox/ChatterBot/pull/376]
• Remove twitter storage adapter in favor of trainer [https://github.com/gunthercox/ChatterBot/pull/378]
• Add ability to set per-adapter parameters [https://github.com/gunthercox/ChatterBot/pull/389]
• Add math words to Italian corpus (via @davideboschetto) [https://github.com/gunthercox/ChatterBot/pull/393]

Maintenance

• Update logic methods and documentation [https://github.com/gunthercox/ChatterBot/pull/364]

Corpus data

• Add German language (via @ThomasKoscheck) [https://github.com/gunthercox/ChatterBot/pull/370]

Features

• Added date parsing utility (via @rmdort) [https://github.com/gunthercox/ChatterBot/pull/321]
• Add methods for adding and removing logic adapters [https://github.com/gunthercox/ChatterBot/pull/316]
• Add a sentiment selection based logic adapter [https://github.com/gunthercox/ChatterBot/pull/291]
• Move logic adapter statement comparison methods to their own module [https://github.com/gunthercox/ChatterBot/pull/327, https://github.com/gunthercox/ChatterBot/pull/333]
• Add Gitter input and output adapters [https://github.com/gunthercox/ChatterBot/pull/330]
• Pass logic adapter confidence to the output adapter [https://github.com/gunthercox/ChatterBot/pull/332]
• Allow chat bot to be created from json config file [https://github.com/gunthercox/ChatterBot/pull/340]
• Add command line ability to get chatterbot version [https://github.com/gunthercox/ChatterBot/commit/673bf358b99d8329ebf754c8b28d898218725126]

Bug fixes

Force training even if read_only is True (via @rmdort) [https://github.com/gunthercox/ChatterBot/pull/337]

Maintenance

• Support queries in storage adapters by default [https://github.com/gunthercox/ChatterBot/pull/305]

Testing

• Test that response history is maintained in Django API view [https://github.com/gunthercox/ChatterBot/pull/303]
• Clean up integration tests [https://github.com/gunthercox/ChatterBot/pull/328]
• Clean up nltk-based language utils and tests [https://github.com/gunthercox/ChatterBot/pull/361]

Corpus

• Add Marathi corpus (via @mohan08p) [https://github.com/gunthercox/ChatterBot/pull/335, https://github.com/gunthercox/ChatterBot/pull/338, https://github.com/gunthercox/ChatterBot/pull/344]
• Add French math words [https://github.com/gunthercox/ChatterBot/pull/346]

Documentation

• Add a section on installing ChatterBot http://chatterbot.readthedocs.io/en/latest/setup.html

Bug fixes

• Change ChatBot filters parameter to import classes from the string path [https://github.com/gunthercox/ChatterBot/issues/285]

Features

• Add __str__ method to models via @hobson [https://github.com/gunthercox/ChatterBot/pull/293]
• Allow flag to be set to silence file storage performance warning (https://github.com/gunthercox/ChatterBot/pull/297)

Maintenance

• Remove deprecated training module [https://github.com/gunthercox/ChatterBot/commit/4ee37d340a23f6bf2a3b0bf65649eb4db1c9506d]

Documentation

• Add documentation for tie breaking methods [https://github.com/gunthercox/ChatterBot/issues/283]

Filters [https://github.com/gunthercox/ChatterBot/pull/230]

Filters are a new feature designed to complement ChatterBot's storage adapters by enabling more efficient control over the what data is returned. Check out the documentation on filters for more information: http://chatterbot.readthedocs.io/en/latest/filters.html

Other changes

Bug fixes

• Avoid problems using format strings with unicode characters (via @davizucon) [https://github.com/gunthercox/ChatterBot/pull/269]
• All Django settings are now passed to the ChatBot constructor [https://github.com/gunthercox/ChatterBot/commit/adc1ed8b4cfa55591dd3c05ca3f8fee6964f3c15]

Features

• Raise an exception if an invalid tie breaking method is used [https://github.com/gunthercox/ChatterBot/commit/1c437dcce148f8eb5b6d3456f3228120f582f44e]
• The training class can now be set as a string passed to the ChatBot constructor [https://github.com/gunthercox/ChatterBot/commit/be6c22ad1e4fd56aa1acdc30ecf92c3babb2a9c4]

Tests

• The base test case is now set to return object type responses instead of strings [https://github.com/gunthercox/ChatterBot/pull/279]

Documentation

• Improved Django documentation [https://github.com/gunthercox/ChatterBot/commit/dedca51105f020f8f8fb84d37ede476400f63901]
• Added documentation on setting logging levels
• Added documentation on ChatBot parameters

Support for Django integration [https://github.com/gunthercox/ChatterBot/pull/266]

I am excited to announce ChatterBot's new support for direct integration with Django. Django plays a huge role in the Python community and a tremendous number of developers choose to use it for their projects and applications. I believe that enabling developers to use ChatterBot easily in their Django applications will open numerous new doors for what we can create.
~ @GuntherCox

• Getting started with Django and ChatterBot: chatterbot.readthedocs.io/en/latest/django
• ChatterBot Django example app: ChatterBot/examples/django_app

Other changes

Logic Adapters

• Addition of a new logic adapter using Jaccard index (via @sumn2u) [https://github.com/gunthercox/ChatterBot/pull/272]
• Languages can now be specified for the mathematical evaluation adapter [https://github.com/gunthercox/ChatterBot/pull/273]

Data corpus

• All data files in the project are now stored within the corpus module [https://github.com/gunthercox/ChatterBot/pull/273]

Logging

• Add logging for logic adapter results [https://github.com/gunthercox/ChatterBot/commit/4cc25d17563cf8aba3873171bea8ec46300ddab6]

Documentation

• Improved documentation on creating new logic adapters

Bug fixes

• Fix some formatting issues in Portuguese corpus [https://github.com/gunthercox/ChatterBot/commit/1ed1afad690ee5c4e10d81f285dcb5ddb2a4bad1]
• Remove empty file from French corpus [https://github.com/gunthercox/ChatterBot/commit/db2f758bc0d7d1632e5f9dfaab2b48721518af88]
• Return a confidence of zero if a random response is selected [https://github.com/gunthercox/ChatterBot/pull/244]
• Check count variable in Mongo DB adapter before it is used (via @navyad) [https://github.com/gunthercox/ChatterBot/pull/253]
• Pass correct arguments to tie breaking methods (via @davizucon ) [https://github.com/gunthercox/ChatterBot/pull/268]

Features

• Add ability to export database as ChatterBot training corpus [https://github.com/gunthercox/ChatterBot/pull/239]
• Add info level logging [https://github.com/gunthercox/ChatterBot/pull/245]
• Pass existing extra data from input through to processed response (via @gsingers) [https://github.com/gunthercox/ChatterBot/pull/263]

Documentation

• Added a program flow diagram [https://github.com/gunthercox/ChatterBot/issues/246]

Deprecation

• Rename JsonDatabaseAdapter to JsonFileStorageAdapter to more accurately describe the adapter [https://github.com/gunthercox/ChatterBot/commit/3f626eceb50ffe3b579d1606c92c335d50684fb8]

Bug fixes

• Correct issue with statement response serialization [https://github.com/gunthercox/ChatterBot/pull/224]
• Correct unicode equality issue in python 2.7 [https://github.com/gunthercox/ChatterBot/pull/222]
• Add new list_corpus_files method to corpus class [https://github.com/gunthercox/ChatterBot/pull/229]

Maintenance

• Simplify import for the chatterbot.training.trainers module [https://github.com/gunthercox/ChatterBot/pull/228]

Training data additions

• Addition of French training data thanks to @alekaizer
• Addition of Chinese training data thanks to @wwj718

Examples

• Tkinter example is now compatible with python3 [https://github.com/gunthercox/ChatterBot/pull/225] thanks to @wwj718

• Use bulk operations in mongo update method [https://github.com/gunthercox/ChatterBot/pull/211]
• Add Indonesian corpus data [https://github.com/gunthercox/ChatterBot/pull/212]
• Added UTF-8 support in corpus [https://github.com/gunthercox/ChatterBot/pull/216]

• Removed signature objects [https://github.com/gunthercox/ChatterBot/pull/196]
• Added a HipChat input and output adapter [https://github.com/gunthercox/ChatterBot/pull/176]
• Updated format of Exceptions [https://github.com/gunthercox/ChatterBot/commit/227f21350bdd9e7daedac2220ab2869b2aaac650]

• Testing updates
• Correct issue in mongo adapter [https://github.com/gunthercox/ChatterBot/commit/f5fa90697e2151d8e521bcf1b833adb4ef2aef1e] via @TimPchelintsev

• Increased efficiency in the MongoDB storage adapter https://github.com/gunthercox/ChatterBot/pull/173
  • Storage adapters can now override the get_response_statements method to provide a more efficient implementation.
  • An efficient version of the get_response_statements method has been implemented on the MongoDB storage adapter.
• Additions to the Italian language training corpus thanks to @0x8b30cc
• Various updates to ChatterBot's documentation http://chatterbot.readthedocs.io/en/latest/

• Changed default input and output adapters. The defaults have been changed from the TerminalAdapter to:

    input_adapter="chatterbot.adapters.input.VariableInputTypeAdapter",
    output_adapter="chatterbot.adapters.output.OutputFormatAdapter",

• The recent_statements variable now holds the entire current conversation [https://github.com/gunthercox/ChatterBot/pull/170]
• Increase flexibility of training [https://github.com/gunthercox/ChatterBot/pull/171]
  • The set_trainer method should now be called to set the training method for the chat bot see examples.
• Added sentiment logic adapter [https://github.com/gunthercox/ChatterBot/pull/167].

ChatterBot 0.4

This is a fairly major release with many changes breaking backwards compatibility.

Introducing Input & Output adapters

IO adapters have been divided into two new modules (input adapters and output adapters).
This change makes it possible to write less code by being able to mix and match different
types of inputs with different types of outputs.

Improved documentation

Lots of new documentation has been added. Check it out! http://chatterbot.readthedocs.io/

Other changes

• Removed the weather adapter [https://github.com/gunthercox/ChatterBot/commit/8856bce1fad2ae387e4bfc5eccd7ac256f4b0081]
• Added output adapter for the Mailgun api [https://github.com/gunthercox/ChatterBot/commit/4e9ef44f1fc1db32e2bdcaa67073068979813df0]
• Renamed EvaluateMathematically logic adapter to MathematicalEvaluation [https://github.com/gunthercox/ChatterBot/commit/d62771b0777580fa05d69c125c042b7590dbbae3]
• Removed optional logic_adapter parameter. Only logic_adapters is now allowed.