fix issues with _should_we_send_to_voice and add a test

streaming_chat_service.py

@@ -26,16 +26,30 @@ class StreamingChatService:
 
     def _should_we_send_to_voice(self, sentence):
         sentence_termination_characters = [".", "?", "!"]
+        close_brackets = ['"', ')', ']']
+
         temination_charicter_present = any(c in sentence for c in sentence_termination_characters)
-        if temination_charicter_present and sentence[-1] not in sentence_termination_characters:
-            # text_to_speak = sentence up until the last sentence termination character
-            termination_indices = [sentence.rfind(char) for char in sentence_termination_characters]
-            last_termination_index = max(termination_indices)
-            text_to_speak = sentence[:last_termination_index+1]
-            return text_to_speak
-        if temination_charicter_present:
-            return False
-        return False
+ 
+        # early exit if we don't have a termination character
+        if not temination_charicter_present:
+            return None
+
+        # early exit the last char is a termination character
+        if sentence[-1] in sentence_termination_characters:
+            return None
+        
+        # early exit the last char is a close bracket
+        if sentence[-1] in close_brackets:
+            return None
+        
+        termination_indices = [sentence.rfind(char) for char in sentence_termination_characters]
+        last_termination_index = max(termination_indices)
+        # handle case of close bracket
+        while last_termination_index+1 < len(sentence) and sentence[last_termination_index+1] in close_brackets:
+            last_termination_index += 1
+
+        text_to_speak = sentence[:last_termination_index+1]
+        return text_to_speak
 
     def respond_to(self, prompt):
         self._messages.append({"role": "user", "content": prompt})

tests/test_streaming_chat_service.py

@@ -0,0 +1,50 @@
+import unittest
+import sys
+import os
+sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+
+from streaming_chat_service import StreamingChatService
+
+
+class TestShouldWeSendToVoice(unittest.TestCase):
+    def setUp(self):
+        self.chat_service = StreamingChatService()
+
+    def test_should_we_send_to_voice(self):
+        test_cases = [
+            ('This is a simple sentence.', None),
+            ('This is a simple sentence?', None),
+            ('This is a simple sentence!', None),
+            ('This is a simple sentence. ', 'This is a simple sentence.'),
+            ('This is a simple sentence? ', 'This is a simple sentence?'),
+            ('This is a simple sentence! ', 'This is a simple sentence!'),
+            ('This is a simple sentence; ', None),
+            ('This is a simple sentence: ', None),
+
+            ('This sentence contains a quote: "Hello, world!".', None),
+            ('This sentence contains a quote: "Hello, world!"..', None),
+            ('This sentence contains a quote: "Hello, world!"...', None),
+            ('This sentence contains a quote: "Hello, world!". ', 'This sentence contains a quote: "Hello, world!".'),
+            ('This sentence contains a quote: "Hello, world!".\n', 'This sentence contains a quote: "Hello, world!".'),
+            ('This sentence contains a quote with a question: "How are you?"', None),
+            ('This sentence contains a quote with a question: "How are you?" Hello', 'This sentence contains a quote with a question: "How are you?"'),
+            ('This sentence has nested quotes: "She said, \'Hello, world!\'".', None),
+            ('This sentence has nested quotes: "She said, \'Hello, world!\'". Hello', 'This sentence has nested quotes: "She said, \'Hello, world!\'".'),
+            ('This sentence has nested parentheses: (This is (a test).)', None),
+            ('This sentence has nested parentheses: (This is (a test).) Hello', 'This sentence has nested parentheses: (This is (a test).)'),
+            ('This sentence has nested brackets: [This is [a test].]', None),
+            ('This sentence has nested brackets: [This is [a test].] Hello', 'This sentence has nested brackets: [This is [a test].]'),
+            ('This sentence has multiple consecutive termination characters: "What!?".', None),
+            ('This sentence has multiple consecutive termination characters: "What!?". ', 'This sentence has multiple consecutive termination characters: "What!?".'),
+            ('This sentence has multiple consecutive termination characters and a quote: "What!?"', None),
+            ('This sentence has multiple consecutive termination characters and a quote: "What!?" ', 'This sentence has multiple consecutive termination characters and a quote: "What!?"'),
+            ('This sentence has multiple consecutive termination characters and a quote: "What!?" H', 'This sentence has multiple consecutive termination characters and a quote: "What!?"'),
+        ]
+
+        for sentence, expected_output in test_cases:
+            with self.subTest(sentence=sentence):
+                actual_output = self.chat_service._should_we_send_to_voice(sentence)
+                self.assertEqual(actual_output, expected_output)
+
+if __name__ == '__main__':
+    unittest.main()