Merge pull request #10 from lpm0073/next

style: rename main class to HybridSearchRetriever

Author: lpm0073

models/examples/load.py

@@ -2,10 +2,10 @@
 """Sales Support Model (SSM) Retrieval Augmented Generation (RAG)"""
 import argparse
 
-from ..ssm import SalesSupportModel
+from models.hybrid_search_retreiver import HybridSearchRetriever
 
 
-ssm = SalesSupportModel()
+ssm = HybridSearchRetriever()
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(description="RAG example")

models/examples/prompt.py

@@ -2,10 +2,10 @@
 """Sales Support Model (SSM)"""
 import argparse
 
-from ..ssm import SalesSupportModel
+from models.hybrid_search_retreiver import HybridSearchRetriever
 
 
-ssm = SalesSupportModel()
+ssm = HybridSearchRetriever()
 
 
 if __name__ == "__main__":

models/examples/rag.py

@@ -2,10 +2,10 @@
 """Sales Support Model (SSM) Retrieval Augmented Generation (RAG)"""
 import argparse
 
-from ..ssm import SalesSupportModel
+from models.hybrid_search_retreiver import HybridSearchRetriever
 
 
-ssm = SalesSupportModel()
+ssm = HybridSearchRetriever()
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(description="RAG example")

models/examples/training_services.py

@@ -2,11 +2,11 @@
 """Sales Support Model (SSM) for the LangChain project."""
 import argparse
 
-from ..prompt_templates import NetecPromptTemplates
-from ..ssm import SalesSupportModel
+from models.hybrid_search_retreiver import HybridSearchRetriever
+from models.prompt_templates import NetecPromptTemplates
 
 
-ssm = SalesSupportModel()
+ssm = HybridSearchRetriever()
 templates = NetecPromptTemplates()
 
 if __name__ == "__main__":

models/examples/training_services_oracle.py

@@ -2,11 +2,11 @@
 """Sales Support Model (SSM) for the LangChain project."""
 import argparse
 
-from ..prompt_templates import NetecPromptTemplates
-from ..ssm import SalesSupportModel
+from models.hybrid_search_retreiver import HybridSearchRetriever
+from models.prompt_templates import NetecPromptTemplates
 
 
-ssm = SalesSupportModel()
+ssm = HybridSearchRetriever()
 templates = NetecPromptTemplates()
 
 if __name__ == "__main__":

models/ssm.py renamed to models/hybrid_search_retreiver.py

@@ -64,7 +64,7 @@ def create_documents(self, texts):
         return documents
 
 
-class SalesSupportModel:
+class HybridSearchRetriever:
     """Sales Support Model (SSM)."""
 
     # prompting wrapper

models/tests/test_ssm.py renamed to models/tests/test_hsr.py

@@ -8,25 +8,25 @@
 from langchain.embeddings import OpenAIEmbeddings
 from pinecone import Index
 
-from models.ssm import SalesSupportModel, TextSplitter
+from models.hybrid_search_retreiver import HybridSearchRetriever, TextSplitter
 
 
 class TestSalesSupportModel:
-    """Test SalesSupportModel class."""
+    """Test HybridSearchRetriever class."""
 
     def test_01_basic(self):
         """Ensure that we can instantiate the class."""
 
         # pylint: disable=broad-except
         try:
-            SalesSupportModel()
+            HybridSearchRetriever()
         except Exception as e:
-            assert False, f"initialization of SalesSupportModel() failed with exception: {e}"
+            assert False, f"initialization of HybridSearchRetriever() failed with exception: {e}"
 
     def test_02_class_aatribute_types(self):
         """ensure that class attributes are of the correct type"""
 
-        ssm = SalesSupportModel()
+        ssm = HybridSearchRetriever()
         assert isinstance(ssm.chat, ChatOpenAI)
         assert isinstance(ssm.pinecone_index, Index)
         assert isinstance(ssm.text_splitter, TextSplitter)

models/tests/test_openai.py

@@ -6,16 +6,16 @@
 """
 import pytest  # pylint: disable=unused-import
 
-from ..ssm import SalesSupportModel
+from models.hybrid_search_retreiver import HybridSearchRetriever
 
 
 class TestOpenAI:
-    """Test SalesSupportModel class."""
+    """Test HybridSearchRetriever class."""
 
     def test_03_test_openai_connectivity(self):
         """Ensure that we have connectivity to OpenAI."""
 
-        ssm = SalesSupportModel()
+        ssm = HybridSearchRetriever()
         retval = ssm.cached_chat_request(
             "your are a helpful assistant", "please return the value 'CORRECT' in all upper case."
         )

models/tests/test_pinecone.py

@@ -13,7 +13,7 @@
 
 
 class TestPinecone:
-    """Test SalesSupportModel class."""
+    """Test HybridSearchRetriever class."""
 
     def test_01_test_pinecone_connectivity(self):
         """Ensure that we have connectivity to Pinecone."""

models/tests/test_prompt_templates.py

@@ -11,7 +11,7 @@
 
 
 class TestPromptTemplates:
-    """Test SalesSupportModel class."""
+    """Test HybridSearchRetriever class."""
 
     def test_01_prompt_with_template(self):
         """Ensure that all properties of the template class are PromptTemplate instances."""