ChatterBot 1.2.8__tar.gz → 1.2.10__tar.gz

{chatterbot-1.2.8 → chatterbot-1.2.10}/ChatterBot.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ChatterBot
-Version: 1.2.8
+Version: 1.2.10
 Summary: ChatterBot is a machine learning, conversational dialog engine
 Author: Gunther Cox
 License-Expression: BSD-3-Clause
@@ -47,16 +47,16 @@ Provides-Extra: dev
 Requires-Dist: pint>=0.8.1; extra == "dev"
 Requires-Dist: pyyaml<7.0,>=6.0; extra == "dev"
 Requires-Dist: chatterbot-corpus<1.3.0,>=1.2.2; extra == "dev"
-Requires-Dist: ollama<1.0,>=0.4.7; extra == "dev"
+Requires-Dist: ollama<1.0,>=0.6.0; extra == "dev"
 Requires-Dist: openai; extra == "dev"
 Provides-Extra: redis
-Requires-Dist: redis[hiredis]<5.3; extra == "redis"
+Requires-Dist: redis[hiredis]<7.0; extra == "redis"
 Requires-Dist: langchain-redis<=0.2.5; extra == "redis"
 Requires-Dist: langchain-huggingface<=0.1.2; extra == "redis"
 Requires-Dist: accelerate<=1.6.0; extra == "redis"
 Requires-Dist: sentence-transformers<=4.0.2; extra == "redis"
 Provides-Extra: mongodb
-Requires-Dist: pymongo<4.12,>=4.11; extra == "mongodb"
+Requires-Dist: pymongo<4.16,>=4.11; extra == "mongodb"
 Dynamic: license-file
 
 ![ChatterBot: Machine learning in Python](https://i.imgur.com/b3SCmGT.png)
@@ -153,16 +153,20 @@ section of the documentation.
 
 See release notes for changes https://github.com/gunthercox/ChatterBot/releases
 
-# Development pattern for contributors
+# Contributing
 
-1. [Create a fork](https://help.github.com/articles/fork-a-repo/) of
-   the [main ChatterBot repository](https://github.com/gunthercox/ChatterBot) on GitHub.
-2. Make your changes in a branch named something different from `master`, e.g. create
-   a new branch `my-pull-request`.
-3. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/).
-4. Please follow the [Python style guide for PEP-8](https://www.python.org/dev/peps/pep-0008/).
-5. Use the projects [built-in automated testing](https://docs.chatterbot.us/testing/).
-   to help make sure that your contribution is free from errors.
+Contributions are welcomed, to help ensure a smooth process please start with the contributing guidelines in our documentation:
+https://docs.chatterbot.us/contributing/
+
+# Sponsors
+
+ChatterBot is sponsored by:
+
+<p style="font-size:21px; color:black;">Browser testing via 
+   <a href="https://www.lambdatest.com/?utm_source=chatterbot&utm_medium=sponsor" target="_blank">
+      <img src="https://www.lambdatest.com/blue-logo.png" style="vertical-align: middle;" width="250" height="45" />
+   </a>
+</p>
 
 # License
 

{chatterbot-1.2.8 → chatterbot-1.2.10}/ChatterBot.egg-info/requires.txt

@@ -8,14 +8,14 @@ tqdm
 pint>=0.8.1
 pyyaml<7.0,>=6.0
 chatterbot-corpus<1.3.0,>=1.2.2
-ollama<1.0,>=0.4.7
+ollama<1.0,>=0.6.0
 openai
 
 [mongodb]
-pymongo<4.12,>=4.11
+pymongo<4.16,>=4.11
 
 [redis]
-redis[hiredis]<5.3
+redis[hiredis]<7.0
 langchain-redis<=0.2.5
 langchain-huggingface<=0.1.2
 accelerate<=1.6.0

{chatterbot-1.2.8 → chatterbot-1.2.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ChatterBot
-Version: 1.2.8
+Version: 1.2.10
 Summary: ChatterBot is a machine learning, conversational dialog engine
 Author: Gunther Cox
 License-Expression: BSD-3-Clause
@@ -47,16 +47,16 @@ Provides-Extra: dev
 Requires-Dist: pint>=0.8.1; extra == "dev"
 Requires-Dist: pyyaml<7.0,>=6.0; extra == "dev"
 Requires-Dist: chatterbot-corpus<1.3.0,>=1.2.2; extra == "dev"
-Requires-Dist: ollama<1.0,>=0.4.7; extra == "dev"
+Requires-Dist: ollama<1.0,>=0.6.0; extra == "dev"
 Requires-Dist: openai; extra == "dev"
 Provides-Extra: redis
-Requires-Dist: redis[hiredis]<5.3; extra == "redis"
+Requires-Dist: redis[hiredis]<7.0; extra == "redis"
 Requires-Dist: langchain-redis<=0.2.5; extra == "redis"
 Requires-Dist: langchain-huggingface<=0.1.2; extra == "redis"
 Requires-Dist: accelerate<=1.6.0; extra == "redis"
 Requires-Dist: sentence-transformers<=4.0.2; extra == "redis"
 Provides-Extra: mongodb
-Requires-Dist: pymongo<4.12,>=4.11; extra == "mongodb"
+Requires-Dist: pymongo<4.16,>=4.11; extra == "mongodb"
 Dynamic: license-file
 
 ![ChatterBot: Machine learning in Python](https://i.imgur.com/b3SCmGT.png)
@@ -153,16 +153,20 @@ section of the documentation.
 
 See release notes for changes https://github.com/gunthercox/ChatterBot/releases
 
-# Development pattern for contributors
+# Contributing
 
-1. [Create a fork](https://help.github.com/articles/fork-a-repo/) of
-   the [main ChatterBot repository](https://github.com/gunthercox/ChatterBot) on GitHub.
-2. Make your changes in a branch named something different from `master`, e.g. create
-   a new branch `my-pull-request`.
-3. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/).
-4. Please follow the [Python style guide for PEP-8](https://www.python.org/dev/peps/pep-0008/).
-5. Use the projects [built-in automated testing](https://docs.chatterbot.us/testing/).
-   to help make sure that your contribution is free from errors.
+Contributions are welcomed, to help ensure a smooth process please start with the contributing guidelines in our documentation:
+https://docs.chatterbot.us/contributing/
+
+# Sponsors
+
+ChatterBot is sponsored by:
+
+<p style="font-size:21px; color:black;">Browser testing via 
+   <a href="https://www.lambdatest.com/?utm_source=chatterbot&utm_medium=sponsor" target="_blank">
+      <img src="https://www.lambdatest.com/blue-logo.png" style="vertical-align: middle;" width="250" height="45" />
+   </a>
+</p>
 
 # License
 

{chatterbot-1.2.8 → chatterbot-1.2.10}/README.md

@@ -92,16 +92,20 @@ section of the documentation.
 
 See release notes for changes https://github.com/gunthercox/ChatterBot/releases
 
-# Development pattern for contributors
-
-1. [Create a fork](https://help.github.com/articles/fork-a-repo/) of
-   the [main ChatterBot repository](https://github.com/gunthercox/ChatterBot) on GitHub.
-2. Make your changes in a branch named something different from `master`, e.g. create
-   a new branch `my-pull-request`.
-3. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/).
-4. Please follow the [Python style guide for PEP-8](https://www.python.org/dev/peps/pep-0008/).
-5. Use the projects [built-in automated testing](https://docs.chatterbot.us/testing/).
-   to help make sure that your contribution is free from errors.
+# Contributing
+
+Contributions are welcomed, to help ensure a smooth process please start with the contributing guidelines in our documentation:
+https://docs.chatterbot.us/contributing/
+
+# Sponsors
+
+ChatterBot is sponsored by:
+
+<p style="font-size:21px; color:black;">Browser testing via 
+   <a href="https://www.lambdatest.com/?utm_source=chatterbot&utm_medium=sponsor" target="_blank">
+      <img src="https://www.lambdatest.com/blue-logo.png" style="vertical-align: middle;" width="250" height="45" />
+   </a>
+</p>
 
 # License
 

{chatterbot-1.2.8 → chatterbot-1.2.10}/chatterbot/__init__.py

@@ -4,7 +4,7 @@ ChatterBot is a machine learning, conversational dialog engine.
 from .chatterbot import ChatBot
 
 
-__version__ = '1.2.8'
+__version__ = '1.2.10'
 
 __all__ = (
     'ChatBot',

{chatterbot-1.2.8 → chatterbot-1.2.10}/chatterbot/chatterbot.py

@@ -2,7 +2,7 @@ import logging
 from typing import Union
 from chatterbot.storage import StorageAdapter
 from chatterbot.logic import LogicAdapter
-from chatterbot.search import TextSearch, IndexedTextSearch
+from chatterbot.search import TextSearch, IndexedTextSearch, SemanticVectorSearch
 from chatterbot.tagging import PosLemmaTagger
 from chatterbot.conversation import Statement
 from chatterbot import languages
@@ -74,41 +74,60 @@ class ChatBot(object):
 
         tagger_language = kwargs.get('tagger_language', languages.ENG)
 
-        try:
-            Tagger = kwargs.get('tagger', PosLemmaTagger)
-
-            # Allow instances to be provided for performance optimization
-            # (Example: a pre-loaded model in a tagger when unit testing)
-            if not isinstance(Tagger, type):
-                self.tagger = Tagger
-            else:
-                self.tagger = Tagger(language=tagger_language)
-        except IOError as io_error:
-            # Return a more helpful error message if possible
-            if "Can't find model" in str(io_error):
-                model_name = utils.get_model_for_language(tagger_language)
-                if hasattr(tagger_language, 'ENGLISH_NAME'):
-                    language_name = tagger_language.ENGLISH_NAME
+        # Check if storage adapter has a preferred tagger
+        PreferredTagger = self.storage.get_preferred_tagger()
+
+        if PreferredTagger is not None:
+            # Storage adapter specifies its own tagger
+            self.tagger = PreferredTagger(language=tagger_language)
+        else:
+            # Use default or user-specified tagger
+            try:
+                Tagger = kwargs.get('tagger', PosLemmaTagger)
+
+                # Allow instances to be provided for performance optimization
+                # (Example: a pre-loaded model in a tagger when unit testing)
+                if not isinstance(Tagger, type):
+                    self.tagger = Tagger
                 else:
-                    language_name = tagger_language
-                raise self.ChatBotException(
-                    'Setup error:\n'
-                    f'The Spacy model for "{language_name}" language is missing.\n'
-                    'Please install the model using the command:\n\n'
-                    f'python -m spacy download {model_name}\n\n'
-                    'See https://spacy.io/usage/models for more information about available models.'
-                ) from io_error
-            else:
-                raise io_error
+                    self.tagger = Tagger(language=tagger_language)
+            except IOError as io_error:
+                # Return a more helpful error message if possible
+                if "Can't find model" in str(io_error):
+                    model_name = utils.get_model_for_language(tagger_language)
+                    if hasattr(tagger_language, 'ENGLISH_NAME'):
+                        language_name = tagger_language.ENGLISH_NAME
+                    else:
+                        language_name = tagger_language
+                    raise self.ChatBotException(
+                        'Setup error:\n'
+                        f'The Spacy model for "{language_name}" language is missing.\n'
+                        'Please install the model using the command:\n\n'
+                        f'python -m spacy download {model_name}\n\n'
+                        'See https://spacy.io/usage/models for more information about available models.'
+                    ) from io_error
+                else:
+                    raise io_error
 
+        # Initialize search algorithms
         primary_search_algorithm = IndexedTextSearch(self, **kwargs)
         text_search_algorithm = TextSearch(self, **kwargs)
+        semantic_vector_search_algorithm = SemanticVectorSearch(self, **kwargs)
 
         self.search_algorithms = {
             primary_search_algorithm.name: primary_search_algorithm,
-            text_search_algorithm.name: text_search_algorithm
+            text_search_algorithm.name: text_search_algorithm,
+            semantic_vector_search_algorithm.name: semantic_vector_search_algorithm
         }
 
+        # Check if storage adapter has a preferred search algorithm
+        preferred_search_algorithm = self.storage.get_preferred_search_algorithm()
+        if preferred_search_algorithm and preferred_search_algorithm in self.search_algorithms:
+            # Set as default for logic adapters that don't specify their own search algorithm
+            # This ensures BestMatch and other adapters use the optimal search method
+            self.logger.info(f'Storage adapter prefers search algorithm: {preferred_search_algorithm}')
+            kwargs.setdefault('search_algorithm_name', preferred_search_algorithm)
+
         for adapter in logic_adapters:
             utils.validate_adapter_class(adapter, LogicAdapter)
             logic_adapter = utils.initialize_class(adapter, self, **kwargs)
@@ -191,15 +210,22 @@ class ChatBot(object):
                 input_statement.in_response_to = previous_statement.text
 
         # Make sure the input statement has its search text saved
-
-        if not input_statement.search_text:
-            _search_text = self.tagger.get_text_index_string(input_statement.text)
-            input_statement.search_text = _search_text
-
-        if not input_statement.search_in_response_to and input_statement.in_response_to:
-            input_statement.search_in_response_to = self.tagger.get_text_index_string(
-                input_statement.in_response_to
-            )
+        if not self.tagger.needs_text_indexing():
+            # Tagger doesn't transform text, use it directly
+            if not input_statement.search_text:
+                input_statement.search_text = input_statement.text
+            if not input_statement.search_in_response_to and input_statement.in_response_to:
+                input_statement.search_in_response_to = input_statement.in_response_to
+        else:
+            # Use tagger for text indexing or transformations
+            if not input_statement.search_text:
+                _search_text = self.tagger.get_text_index_string(input_statement.text)
+                input_statement.search_text = _search_text
+
+            if not input_statement.search_in_response_to and input_statement.in_response_to:
+                input_statement.search_in_response_to = self.tagger.get_text_index_string(
+                    input_statement.in_response_to
+                )
 
         response = self.generate_response(
             input_statement,

{chatterbot-1.2.8 → chatterbot-1.2.10}/chatterbot/components.py

@@ -29,6 +29,9 @@ def chatterbot_bigram_indexer(document):
             token for token in document if not (token.is_punct)
         ]
 
+    # Pairs consist of the part-of-speech of the first token and the
+    # lemma of the second token in the bigram. This provides a good
+    # balance of generalization and specificity for matching.
     bigram_pairs = [
         f"{tokens[i - 1].pos_}:{tokens[i].lemma_.lower()}"
         for i in range(1, len(tokens))

{chatterbot-1.2.8 → chatterbot-1.2.10}/chatterbot/logic/specific_response.py

@@ -20,7 +20,19 @@ class SpecificResponseAdapter(LogicAdapter):
     def __init__(self, chatbot, **kwargs):
         super().__init__(chatbot, **kwargs)
 
-        self.input_text = kwargs.get('input_text')
+        try:
+            self.input_text = kwargs['input_text']
+        except KeyError:
+            raise chatbot.ChatBotException(
+                'The SpecificResponseAdapter requires an input_text parameter.'
+            )
+
+        try:
+            self._output_text = kwargs['output_text']
+        except KeyError:
+            raise chatbot.ChatBotException(
+                'The SpecificResponseAdapter requires an output_text parameter.'
+            )
 
         self.matcher = None
 
@@ -33,8 +45,6 @@ class SpecificResponseAdapter(LogicAdapter):
 
             self.matcher.add('SpecificResponse', [self.input_text])
 
-        self._output_text = kwargs.get('output_text')
-
     def _initialize_nlp(self, language):
         model = get_model_for_language(language)
 

{chatterbot-1.2.8 → chatterbot-1.2.10}/chatterbot/parsing.py

@@ -503,7 +503,7 @@ regex = [
 ]
 
 
-def convert_string_to_number(value):
+def convert_string_to_number(value: str) -> int:
     """
     Convert strings to numbers
     """
@@ -517,7 +517,7 @@ def convert_string_to_number(value):
     return sum(num_list)
 
 
-def convert_time_to_hour_minute(hour, minute, convention):
+def convert_time_to_hour_minute(hour: str, minute: str, convention: str) -> dict:
     """
     Convert time to hour, minute
     """
@@ -532,12 +532,19 @@ def convert_time_to_hour_minute(hour, minute, convention):
     minute = int(minute)
 
     if convention.lower() == 'pm':
-        hour += 12
+        # Handle 12 PM (noon) - it stays as 12
+        # Handle 1-11 PM - add 12
+        if hour != 12:
+            hour += 12
+    else:
+        # Handle 12 AM (midnight) - convert to 0
+        if hour == 12:
+            hour = 0
 
     return {'hours': hour, 'minutes': minute}
 
 
-def date_from_quarter(base_date, ordinal, year):
+def date_from_quarter(base_date: datetime, ordinal: int, year: int) -> list[datetime]:
     """
     Extract date from quarter of a year
     """
@@ -554,7 +561,7 @@ def date_from_quarter(base_date, ordinal, year):
     ]
 
 
-def date_from_relative_day(base_date, time, dow):
+def date_from_relative_day(base_date: datetime, time: str, dow: str) -> datetime:
     """
     Converts relative day to time
     Ex: this tuesday, last tuesday
@@ -577,7 +584,7 @@ def date_from_relative_day(base_date, time, dow):
         return next_week_day(base_date, num)
 
 
-def date_from_relative_week_year(base_date, time, dow, ordinal=1):
+def date_from_relative_week_year(base_date: datetime, time: str, dow: str, ordinal: int = 1) -> datetime:
     """
     Converts relative day to time
     Eg. this tuesday, last tuesday
@@ -608,7 +615,10 @@ def date_from_relative_week_year(base_date, time, dow, ordinal=1):
                 day = min(relative_date.day, calendar.monthrange(year, month)[1])
                 return datetime(year, month, day)
             else:
-                return datetime(relative_date.year, relative_date.month + ord, relative_date.day)
+                # Base the day to valid range on the target month
+                target_month = relative_date.month + ord
+                day = min(relative_date.day, calendar.monthrange(relative_date.year, target_month)[1])
+                return datetime(relative_date.year, target_month, day)
         elif time == 'end of the':
             return datetime(
                 relative_date.year,
@@ -636,7 +646,7 @@ def date_from_relative_week_year(base_date, time, dow, ordinal=1):
             return datetime(relative_date.year, relative_date.month, relative_date.day, 23, 59, 59)
 
 
-def date_from_adverb(base_date, name):
+def date_from_adverb(base_date: datetime, name: str) -> datetime:
     """
     Convert Day adverbs to dates
     Tomorrow => Date
@@ -645,14 +655,14 @@ def date_from_adverb(base_date, name):
     # Reset date to start of the day
     adverb_date = datetime(base_date.year, base_date.month, base_date.day)
     if name == 'today' or name == 'tonite' or name == 'tonight':
-        return adverb_date.today().replace(hour=0, minute=0, second=0, microsecond=0)
+        return adverb_date
     elif name == 'yesterday':
         return adverb_date - timedelta(days=1)
     elif name == 'tomorrow' or name == 'tom':
         return adverb_date + timedelta(days=1)
 
 
-def date_from_duration(base_date, number_as_string, unit, duration, base_time=None):
+def date_from_duration(base_date: datetime, number_as_string: str, unit: str, duration: str, base_time: str = None) -> datetime:
     """
     Find dates from duration
     Eg: 20 days from now
@@ -682,7 +692,7 @@ def date_from_duration(base_date, number_as_string, unit, duration, base_time=No
         return base_date + timedelta(**args)
 
 
-def this_week_day(base_date, weekday):
+def this_week_day(base_date: datetime, weekday: int) -> datetime:
     """
     Finds coming weekday
     """
@@ -698,7 +708,7 @@ def this_week_day(base_date, weekday):
     return day
 
 
-def previous_week_day(base_date, weekday):
+def previous_week_day(base_date: datetime, weekday: int) -> datetime:
     """
     Finds previous weekday
     """
@@ -708,9 +718,9 @@ def previous_week_day(base_date, weekday):
     return day
 
 
-def next_week_day(base_date, weekday):
+def next_week_day(base_date: datetime, weekday: int) -> datetime:
     """
-    Finds next weekday
+    Finds the next weekday.
     """
     day_of_week = base_date.weekday()
     end_of_this_week = base_date + timedelta(days=6 - day_of_week)
@@ -720,7 +730,7 @@ def next_week_day(base_date, weekday):
     return day
 
 
-def datetime_parsing(text, base_date=datetime.now()):
+def datetime_parsing(text: str, base_date: datetime = datetime.now()) -> list[tuple[str, datetime, tuple[int, int]]]:
     """
     Extract datetime objects from a string of text.
     """

{chatterbot-1.2.8 → chatterbot-1.2.10}/chatterbot/search.py

@@ -157,3 +157,73 @@ class TextSearch:
                 if confidence >= 1.0:
                     self.chatbot.logger.info('Exact match found, stopping search')
                     break
+
+
+class SemanticVectorSearch:
+    """
+    Semantic vector search for storage adapters that use vector embeddings.
+    Does not require a tagger or comparison function - relies on the storage
+    adapter's native vector similarity search capabilities.
+
+    :param search_page_size:
+        The maximum number of records to load into memory at a time when searching.
+        Defaults to 1000
+    """
+
+    name = 'semantic_vector_search'
+
+    def __init__(self, chatbot, **kwargs):
+        self.chatbot = chatbot
+
+        self.search_page_size = kwargs.get(
+            'search_page_size', 1000
+        )
+
+    def search(self, input_statement, **additional_parameters):
+        """
+        Search for semantically similar statements using vector similarity.
+        Confidence scores are calculated by the storage adapter based on
+        vector distances and returned in the results.
+
+        :param input_statement: A statement.
+        :type input_statement: chatterbot.conversation.Statement
+
+        :param **additional_parameters: Additional parameters to be passed
+            to the ``filter`` method of the storage adapter when searching.
+
+        :rtype: Generator yielding one closest matching statement at a time.
+        """
+        self.chatbot.logger.info('Beginning semantic vector search')
+
+        search_parameters = {
+            'search_in_response_to_contains': input_statement.text,
+            'persona_not_startswith': 'bot:',
+            'page_size': self.search_page_size
+        }
+
+        if additional_parameters:
+            search_parameters.update(additional_parameters)
+
+        statement_list = self.chatbot.storage.filter(**search_parameters)
+
+        best_confidence_so_far = 0
+
+        self.chatbot.logger.info('Processing search results')
+
+        # Yield statements with confidence scores from vector similarity
+        for statement in statement_list:
+            # Confidence should already be set by the storage adapter
+            confidence = getattr(statement, 'confidence', 0.0)
+
+            if confidence > best_confidence_so_far:
+                best_confidence_so_far = confidence
+
+                self.chatbot.logger.info('Similar statement found: {} {}'.format(
+                    statement.in_response_to, confidence
+                ))
+
+                yield statement
+
+                if confidence >= 1.0:
+                    self.chatbot.logger.info('Exact match found, stopping search')
+                    break