Skip to content

responder

Utility module for generating chatbot responses to text queries

Also support classification of text queries.

Responder

Generates chatbot responses and statement classifications

Neatly exposes chat functionality.

Parameters:

Name Type Description Default
chat_backend str

generative bot to talk to. Defaults to "gpt".

 'gpt'
classifier_backend str

backend for classifying user input. Defaults to "llm".

 'llm'

Attributes:

Name Type Description
bot obj

has get_bot_response functionality and a conversation attribute
classifier obj

has classify functionality.
Source code in backend/app/utils/chatbot/responder.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class Responder():
    """Generates chatbot responses and statement classifications

        Neatly exposes chat functionality.

        Args:
            chat_backend (str, optional): generative bot to talk to. Defaults to "gpt".
            classifier_backend (str, optional): backend for classifying user input.
                Defaults to "llm".

        Attributes:
            bot (obj): has get_bot_response functionality and a conversation attribute
            classifier (obj): has classify functionality.

        """

    def __init__(self, chat_backend: str="gpt", classifier_backend: str="llm") -> None:
        self.default_prompt = ("The following is a conversation with an AI assistant "
                               "that can have meaningful conversations with users. "
                               "The assistant is helpful, empathic, and friendly. "
                               "Its objective is to make the user feel better by feeling heard. "
                               "With each response, the AI assistant prompts the user to continue "
                               "the conversation naturally.")
        self.chat_backend = chat_backend
        self.classifier_backend = classifier_backend

        if chat_backend == "gpt":
            self.bot = ChatGPT(prompt=self.default_prompt)
        if chat_backend == "llm":
            self.bot = ChatLLM(prompt=self.default_prompt)

        if classifier_backend == "gpt":
            self.classifier = ChatGPT()
        if classifier_backend == "llm":
            self.classifier = ClassifyLLM()


    def get_classifications(self, human_input: str, classes: list) -> list:
        """Classify human input by list of classes

        Args:
            human_input (str): Text to classify
            classes (list): classes to choose from

        Returns:
            list: top n classes in order of rating. n defaults to 1.
        """
        if self.classifier_backend == "llm":
            classifications_list = self.classifier.classify(human_input,
                                                            classes,
                                                            question="This is an example of {}")
        if self.classifier_backend == "gpt":
            classifications_list = self.classifier.classify(human_input, classes)
        return classifications_list

    def get_response(self, human_input, speaker="Human", reset_conversation=False):
        """Gets bot response to input statement"""
        response = self.bot.get_bot_response(
            human_input, speaker_id=speaker, reset_conversation=reset_conversation)
        return response

    def accept_response(self, response):
        """Keep the bot response in the conversation history"""
        if self.chat_backend == "gpt":
            self.bot.conversation[-1] = "AI: " + response
        if self.chat_backend == "llm":
            self.bot.conversation[-1] = ("AI:", response)

    def reject_response(self):
        """Remove the bot response from the conversation history"""
        self.bot.conversation.pop(-1)

    def get_conversation(self):
        """Returns conversation seen so far"""
        return self.bot.conversation

accept_response(response)

Keep the bot response in the conversation history

Source code in backend/app/utils/chatbot/responder.py 
72
73
74
75
76
77
def accept_response(self, response):
    """Keep the bot response in the conversation history"""
    if self.chat_backend == "gpt":
        self.bot.conversation[-1] = "AI: " + response
    if self.chat_backend == "llm":
        self.bot.conversation[-1] = ("AI:", response)

get_classifications(human_input, classes)

Classify human input by list of classes

Parameters:

Name Type Description Default
human_input str

Text to classify

 required
classes list

classes to choose from

 required

Returns:

Name Type Description
list list

top n classes in order of rating. n defaults to 1.
Source code in backend/app/utils/chatbot/responder.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def get_classifications(self, human_input: str, classes: list) -> list:
    """Classify human input by list of classes

    Args:
        human_input (str): Text to classify
        classes (list): classes to choose from

    Returns:
        list: top n classes in order of rating. n defaults to 1.
    """
    if self.classifier_backend == "llm":
        classifications_list = self.classifier.classify(human_input,
                                                        classes,
                                                        question="This is an example of {}")
    if self.classifier_backend == "gpt":
        classifications_list = self.classifier.classify(human_input, classes)
    return classifications_list

get_conversation()

Returns conversation seen so far

Source code in backend/app/utils/chatbot/responder.py 
83
84
85
def get_conversation(self):
    """Returns conversation seen so far"""
    return self.bot.conversation

get_response(human_input, speaker='Human', reset_conversation=False)

Gets bot response to input statement

Source code in backend/app/utils/chatbot/responder.py 
66
67
68
69
70
def get_response(self, human_input, speaker="Human", reset_conversation=False):
    """Gets bot response to input statement"""
    response = self.bot.get_bot_response(
        human_input, speaker_id=speaker, reset_conversation=reset_conversation)
    return response

reject_response()

Remove the bot response from the conversation history

Source code in backend/app/utils/chatbot/responder.py 
79
80
81
def reject_response(self):
    """Remove the bot response from the conversation history"""
    self.bot.conversation.pop(-1)

cmd_line_interaction()

Test Responder

Source code in backend/app/utils/chatbot/responder.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
def cmd_line_interaction():
    """Test Responder"""

    bot = Responder(chat_backend="gpt", classifier_backend="llm")

    print(bot.default_prompt)
    print("What would you like to start your conversation with?")
    while True:
        prompt_input = input("Speaker: ")

        if prompt_input == "debug":
            print(bot.bot.conversation)
            continue

        user_input = input("Says: ")
        classifications = bot.get_classifications(user_input, ["positive", "negative", "neutral"])
        bot_response = bot.get_response(user_input, prompt_input)
        print(f"Bot: {bot_response} ({classifications})")

        keep = input("keep response? (n/y)")
        if "n" in keep:
            bot.reject_response()
        if "y" in keep:
            bot.accept_response(bot_response)