Replace ChatterBot's "sessions" with "Conversations"

chatterbot/chatterbot.py

@@ -12,15 +12,13 @@ class ChatBot(object):
  """
 
  def __init__(self, name, **kwargs):
- from .conversation.session import ConversationSessionManager
  from .logic import MultiLogicAdapter
 
  self.name = name
  kwargs['name'] = name
  kwargs['chatbot'] = self
 
- self.conversation_sessions = ConversationSessionManager()
- self.default_session = self.conversation_sessions.new()
+ self.default_session = None
 
  storage_adapter = kwargs.get('storage_adapter', 'chatterbot.storage.SQLStorageAdapter')
 
@@ -76,6 +74,8 @@ def __init__(self, name, **kwargs):
  self.trainer = TrainerClass(self.storage, **kwargs)
  self.training_data = kwargs.get('training_data')
 
+ self.default_conversation_id = None
+
  self.logger = kwargs.get('logger', logging.getLogger(__name__))
 
  # Allow the bot to save input it receives so that it can learn
@@ -90,41 +90,42 @@ def initialize(self):
  """
  self.logic.initialize()
 
- def get_response(self, input_item, session_id=None):
+ def get_response(self, input_item, conversation_id=None):
  """
  Return the bot's response based on the input.
 
  :param input_item: An input value.
  :returns: A response to the input.
  :rtype: Statement
  """
- if not session_id:
- session_id = str(self.default_session.uuid)
+ if not conversation_id:
+ if not self.default_conversation_id:
+ self.default_conversation_id = self.storage.create_conversation()
+ conversation_id = self.default_conversation_id
 
  input_statement = self.input.process_input_statement(input_item)
 
  # Preprocess the input statement
  for preprocessor in self.preprocessors:
  input_statement = preprocessor(self, input_statement)
 
- statement, response = self.generate_response(input_statement, session_id)
+ statement, response = self.generate_response(input_statement, conversation_id)
 
  # Learn that the user's input was a valid response to the chat bot's previous output
- previous_statement = self.conversation_sessions.get(
- session_id
- ).conversation.get_last_response_statement()
- self.learn_response(statement, previous_statement)
+ previous_statement = self.storage.get_latest_response(conversation_id)
 
- self.conversation_sessions.update(session_id, (statement, response, ))
+ if not self.read_only:
+ self.learn_response(statement, previous_statement)
+ self.storage.add_to_converation(conversation_id, statement, response)
 
  # Process the response output with the output adapter
- return self.output.process_response(response, session_id)
+ return self.output.process_response(response, conversation_id)
 
- def generate_response(self, input_statement, session_id):
+ def generate_response(self, input_statement, conversation_id):
  """
  Return a response based on a given input statement.
  """
- self.storage.generate_base_query(self, session_id)
+ self.storage.generate_base_query(self, conversation_id)
 
  # Select a response to the input statement
  response = self.logic.process(input_statement)
@@ -147,8 +148,7 @@ def learn_response(self, statement, previous_statement):
  ))
 
  # Save the statement after selecting a response
- if not self.read_only:
- self.storage.update(statement)
+ self.storage.update(statement)
 
  def set_trainer(self, training_class, **kwargs):
  """

chatterbot/conversation/statement.py

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 from .response import Response
-from datetime import datetime
 
 
 class Statement(object):
@@ -20,9 +19,6 @@ def __init__(self, text, **kwargs):
  self.text = text
  self.in_response_to = kwargs.pop('in_response_to', [])
 
- # The date and time that this statement was created at
- self.created_at = kwargs.pop('created_at', datetime.now())
-
  self.extra_data = kwargs.pop('extra_data', {})
 
  # This is the confidence with which the chat bot believes
@@ -139,7 +135,6 @@ def serialize(self):
 
  data['text'] = self.text
  data['in_response_to'] = []
- data['created_at'] = self.created_at
  data['extra_data'] = self.extra_data
 
  for response in self.in_response_to:

chatterbot/ext/django_chatterbot/migrations/0008_update_conversations.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11 on 2017-07-18 11:25
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('django_chatterbot', '0007_response_created_at'),
+ ]
+
+ operations = [
+ migrations.RemoveField(
+ model_name='conversation',
+ name='statements',
+ ),
+ migrations.RemoveField(
+ model_name='response',
+ name='occurrence',
+ ),
+ migrations.RemoveField(
+ model_name='statement',
+ name='created_at',
+ ),
+ migrations.AddField(
+ model_name='conversation',
+ name='responses',
+ field=models.ManyToManyField(help_text='The responses in this conversation.', related_name='conversations', to='django_chatterbot.Response'),
+ ),
+ ]

chatterbot/ext/django_chatterbot/models.py

@@ -16,11 +16,6 @@ class AbstractBaseStatement(models.Model):
  max_length=255
  )
 
- created_at = models.DateTimeField(
- default=timezone.now,
- help_text='The date and time that this statement was created at.'
- )
-
  extra_data = models.CharField(max_length=500)
 
  # This is the confidence with which the chat bot believes
@@ -98,11 +93,7 @@ def get_response_count(self, statement):
  :returns: Return the number of times the statement has been used as a response.
  :rtype: int
  """
- try:
- response = self.in_response.get(response__text=statement.text)
- return response.occurrence
- except Response.DoesNotExist:
- return 0
+ return self.in_response.filter(response__text=statement.text).count()
 
  def serialize(self):
  """
@@ -117,7 +108,6 @@ def serialize(self):
 
  data['text'] = self.text
  data['in_response_to'] = []
- data['created_at'] = self.created_at
  data['extra_data'] = json.loads(self.extra_data)
 
  for response in self.in_response.all():
@@ -143,9 +133,10 @@ class AbstractBaseResponse(models.Model):
  related_name='responses'
  )
 
- unique_together = (('statement', 'response'),)
-
- occurrence = models.PositiveIntegerField(default=1)
+ created_at = models.DateTimeField(
+ default=timezone.now,
+ help_text='The date and time that this statement was created at.'
+ )
 
  created_at = models.DateTimeField(
  default=timezone.now,
@@ -155,6 +146,20 @@ class AbstractBaseResponse(models.Model):
  class Meta:
  abstract = True
 
+ @property
+ def occurrence(self):
+ """
+ Return a count of the number of times this response has occurred.
+ """
+ from django.apps import apps
+
+ response = apps.get_model('django_chatterbot', self.__class__.__name__)
+
+ return response.objects.filter(
+ statement__text=self.statement.text,
+ response__text=self.response.text
+ ).count()
+
  def __str__(self):
  statement = self.statement.text
  response = self.response.text
@@ -184,10 +189,10 @@ class AbstractBaseConversation(models.Model):
  default models.
  """
 
- statements = models.ManyToManyField(
- 'Statement',
- related_name='conversation',
- help_text='The statements in this conversation.'
+ responses = models.ManyToManyField(
+ 'Response',
+ related_name='conversations',
+ help_text='The responses in this conversation.'
  )
 
  class Meta:

chatterbot/ext/django_chatterbot/views.py

@@ -23,37 +23,48 @@ def validate(self, data):
  if 'text' not in data:
  raise ValidationError('The attribute "text" is required.')
 
- def get_chat_session(self, request):
+ def get_conversation(self, request):
  """
- Return the current session for the chat if one exists.
- Create a new session if one does not exist.
+ Return the conversation for the session if one exists.
+ Create a new conversation if one does not exist.
  """
- chat_session_id = request.session.get('chat_session_id', None)
- chat_session = self.chatterbot.conversation_sessions.get(chat_session_id, None)
+ from chatterbot.ext.django_chatterbot.models import Conversation, Response
 
- if not chat_session:
- chat_session = self.chatterbot.conversation_sessions.new()
- request.session['chat_session_id'] = chat_session.id_string
+ class Obj(object):
+ def __init__(self):
+ self.id = None
+ self.statements = []
 
- return chat_session
+ conversation = Obj()
 
+ conversation.id = request.session.get('conversation_id', 0)
+ existing_conversation = False
+ try:
+ Conversation.objects.get(id=conversation.id)
+ existing_conversation = True
 
-class ChatterBotView(ChatterBotViewMixin, View):
- """
- Provide an API endpoint to interact with ChatterBot.
- """
-
- def _serialize_conversation(self, session):
- if session.conversation.empty():
- return []
+ except Conversation.DoesNotExist:
+ conversation_id = self.chatterbot.storage.create_conversation()
+ request.session['conversation_id'] = conversation_id
+ conversation.id = conversation_id
 
- conversation = []
+ if existing_conversation:
+ responses = Response.objects.filter(
+ conversations__id=conversation.id
+ )
 
- for statement, response in session.conversation:
- conversation.append([statement.serialize(), response.serialize()])
+ for response in responses:
+ conversation.statements.append(response.statement.serialize())
+ conversation.statements.append(response.response.serialize())
 
  return conversation
 
+
+class ChatterBotView(ChatterBotViewMixin, View):
+ """
+ Provide an API endpoint to interact with ChatterBot.
+ """
+
  def post(self, request, *args, **kwargs):
  """
  Return a response to the statement in the posted data.
@@ -62,9 +73,9 @@ def post(self, request, *args, **kwargs):
 
  self.validate(input_data)
 
- chat_session = self.get_chat_session(request)
+ conversation = self.get_conversation(request)
 
- response = self.chatterbot.get_response(input_data, chat_session.id_string)
+ response = self.chatterbot.get_response(input_data, conversation.id)
  response_data = response.serialize()
 
  return JsonResponse(response_data, status=200)
@@ -73,12 +84,12 @@ def get(self, request, *args, **kwargs):
  """
  Return data corresponding to the current conversation.
  """
- chat_session = self.get_chat_session(request)
+ conversation = self.get_conversation(request)
 
  data = {
  'detail': 'You should make a POST request to this endpoint.',
  'name': self.chatterbot.name,
- 'conversation': self._serialize_conversation(chat_session)
+ 'conversation': conversation.statements
  }
 
  # Return a method not allowed response