Merge pull request #7 from lpm0073/next

add more unit tests

Author: lpm0073

models/ssm.py

@@ -10,6 +10,7 @@
 import os
 from typing import List  # ClassVar
 
+# pinecone integration
 import pinecone
 from langchain.cache import InMemoryCache
 
@@ -64,7 +65,7 @@ class SalesSupportModel:
         chunk_overlap=0,
     )
     openai_embedding = OpenAIEmbeddings()
-    pinecone_search = Pinecone.from_existing_index(
+    pinecone_index = Pinecone.from_existing_index(
         Credentials.PINECONE_INDEX_NAME,
         embedding=openai_embedding,
     )
@@ -76,14 +77,16 @@ def cached_chat_request(self, system_message: str, human_message: str) -> System
             HumanMessage(content=human_message),
         ]
         # pylint: disable=not-callable
-        return self.chat(messages)
+        retval = self.chat(messages).content
+        return retval
 
     def prompt_with_template(self, prompt: PromptTemplate, concept: str, model: str = DEFAULT_MODEL_NAME) -> str:
         """Prompt with template."""
         llm = OpenAI(model=model)
         retval = llm(prompt.format(concept=concept))
         return retval
 
+    # FIX NOTE: DEPRECATED
     def split_text(self, text: str) -> List[Document]:
         """Split text."""
         text_splitter = RecursiveCharacterTextSplitter(
@@ -115,7 +118,7 @@ def load(self, filepath: str):
                 k += 1
                 print(k * "-", end="\r")
                 texts_splitter_results = self.text_splitter.create_documents([doc.page_content])
-                self.pinecone_search.from_existing_index(
+                self.pinecone_index.from_existing_index(
                     index_name=Credentials.PINECONE_INDEX_NAME,
                     embedding=self.openai_embedding,
                     text_key=texts_splitter_results,
@@ -137,7 +140,7 @@ def format_docs(docs):
             """Format docs."""
             return "\n\n".join(doc.page_content for doc in docs)
 
-        retriever = self.pinecone_search.as_retriever()
+        retriever = self.pinecone_index.as_retriever()
 
         # Use the retriever to get relevant documents
         documents = retriever.get_relevant_documents(query=prompt)

models/tests/test_prompt_templates.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+# flake8: noqa: F401
+# pylint: disable=too-few-public-methods
+"""
+Test integrity of base class.
+"""
+import pytest  # pylint: disable=unused-import
+from langchain.prompts import PromptTemplate
+
+from ..prompt_templates import NetecPromptTemplates
+
+
+class TestPromptTemplates:
+    """Test SalesSupportModel class."""
+
+    def test_01_prompt_with_template(self):
+        """Ensure that all properties of the template class are PromptTemplate instances."""
+        templates = NetecPromptTemplates()
+        for prop_name in templates.get_properties():
+            prop = getattr(templates, prop_name)
+            assert isinstance(prop, PromptTemplate)

models/tests/test_base.py renamed to models/tests/test_prompts.py

@@ -10,17 +10,12 @@
 from ..ssm import SalesSupportModel
 
 
-class TestSalesSupportModel:
+class TestPrompts:
     """Test SalesSupportModel class."""
 
     ssm = SalesSupportModel()
     templates = NetecPromptTemplates()
 
-    def test_01_basic(self):
-        """Test a basic request"""
-
-        SalesSupportModel()
-
     def test_oracle_training_services(self):
         """Test a prompt with the Oracle training services template"""
 

models/tests/test_ssm.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+# flake8: noqa: F401
+# pylint: disable=too-few-public-methods
+"""
+Test integrity of base class.
+"""
+import pinecone
+import pytest  # pylint: disable=unused-import
+from langchain.chat_models import ChatOpenAI
+from langchain.embeddings import OpenAIEmbeddings
+from langchain.text_splitter import RecursiveCharacterTextSplitter
+from langchain.vectorstores.pinecone import Pinecone
+
+from ..const import Credentials
+from ..ssm import SalesSupportModel
+
+
+class TestSalesSupportModel:
+    """Test SalesSupportModel class."""
+
+    def test_01_basic(self):
+        """Ensure that we can instantiate the class."""
+
+        SalesSupportModel()
+
+    def test_02_class_aatribute_types(self):
+        """ensure that class attributes are of the correct type"""
+
+        ssm = SalesSupportModel()
+        assert isinstance(ssm.chat, ChatOpenAI)
+        assert isinstance(ssm.pinecone_index, Pinecone)
+        assert isinstance(ssm.text_splitter, RecursiveCharacterTextSplitter)
+        assert isinstance(ssm.openai_embedding, OpenAIEmbeddings)
+
+    def test_03_test_openai_connectivity(self):
+        """Ensure that we have connectivity to OpenAI."""
+
+        ssm = SalesSupportModel()
+        retval = ssm.cached_chat_request(
+            "your are a helpful assistant", "please return the value 'CORRECT' in all upper case."
+        )
+        assert retval == "CORRECT"
+
+    def test_04_test_pinecone_connectivity(self):
+        """Ensure that we have connectivity to Pinecone."""
+        # pylint: disable=broad-except
+        try:
+            pinecone.init(api_key=Credentials.PINECONE_API_KEY, environment=Credentials.PINECONE_ENVIRONMENT)
+        except Exception as e:
+            assert False, f"pinecone.init() failed with exception: {e}"

models/yt.py

@@ -2,9 +2,10 @@
 """
     LangChain Quickstart
     ~~~~~~~~~~~~~~~~~~~~
+    LangChain Explained in 13 Minutes | QuickStart Tutorial for Beginners
 
     see: https://www.youtube.com/watch?v=aywZrzNaKjs
-        https://github.com/rabbitmetrics/langchain-13-min
+         https://github.com/rabbitmetrics/langchain-13-min
 """
 import os