chore: add a Config class

Author: lpm0073

CHANGELOG.md

@@ -1,9 +1,8 @@
 ## [1.1.1](https://github.com/lpm0073/netec-llm/compare/v1.1.0...v1.1.1) (2023-12-01)
 
-
 ### Bug Fixes
 
-* had to switch to bm25_encoder so that vector store is searchable ([bad6994](https://github.com/lpm0073/netec-llm/commit/bad699481d217dde81877d85124395529652dabe))
+- had to switch to bm25_encoder so that vector store is searchable ([bad6994](https://github.com/lpm0073/netec-llm/commit/bad699481d217dde81877d85124395529652dabe))
 
 # [1.1.0](https://github.com/lpm0073/netec-llm/compare/v1.0.0...v1.1.0) (2023-12-01)
 

models/const.py

@@ -15,11 +15,20 @@
     OPENAI_API_ORGANIZATION = os.environ["OPENAI_API_ORGANIZATION"]
     PINECONE_API_KEY = os.environ["PINECONE_API_KEY"]
     PINECONE_ENVIRONMENT = os.environ["PINECONE_ENVIRONMENT"]
-    PINECONE_INDEX_NAME = os.environ["PINECONE_INDEX_NAME"]
+    PINECONE_INDEX_NAME = os.environ.get("PINECONE_INDEX_NAME", "hsr")
+    OPENAI_CHAT_MODEL_NAME = os.environ.get("OPENAI_CHAT_MODEL_NAME", "gpt-3.5-turbo")
+    OPENAI_PROMPT_MODEL_NAME = os.environ.get("OPENAI_PROMPT_MODEL_NAME", "text-davinci-003")
 else:
     raise FileNotFoundError("No .env file found in root directory of repository")
 
 
+class Config:
+    """Configuration parameters."""
+
+    OPENAI_CHAT_MODEL_NAME = OPENAI_CHAT_MODEL_NAME
+    OPENAI_PROMPT_MODEL_NAME = OPENAI_PROMPT_MODEL_NAME
+
+
 class Credentials:
     """Credentials."""
 

models/hybrid_search_retreiver.py

@@ -44,25 +44,23 @@
 from pinecone_text.sparse import BM25Encoder
 
 # this project
-from models.const import Credentials
+from models.const import Config, Credentials
 
 
 ###############################################################################
 # initializations
 ###############################################################################
-DEFAULT_MODEL_NAME = "text-davinci-003"
+DEFAULT_MODEL_NAME = Config.OPENAI_PROMPT_MODEL_NAME
 pinecone.init(api_key=Credentials.PINECONE_API_KEY, environment=Credentials.PINECONE_ENVIRONMENT)
 set_llm_cache(InMemoryCache())
 
 
 class TextSplitter:
     """
-    Custom text splitter that add metadata to the Document object
+    Custom text splitter that adds metadata to the Document object
     which is required by PineconeHybridSearchRetriever.
     """
 
-    # ...
-
     def create_documents(self, texts):
         """Create documents"""
         documents = []
@@ -74,15 +72,15 @@ def create_documents(self, texts):
 
 
 class HybridSearchRetriever:
-    """Sales Support Model (SSM)."""
+    """Hybrid Search Retriever (OpenAI + Pinecone)"""
 
     # prompting wrapper
     chat = ChatOpenAI(
         api_key=Credentials.OPENAI_API_KEY,
         organization=Credentials.OPENAI_API_ORGANIZATION,
         cache=True,
         max_retries=3,
-        model="gpt-3.5-turbo",
+        model=Config.OPENAI_CHAT_MODEL_NAME,
         temperature=0.0,
     )
 
@@ -201,9 +199,9 @@ def rag(self, prompt: str):
         document_texts = [doc.page_content for doc in documents]
         leader = textwrap.dedent(
             """\
-            You can assume that the following is true,
-            and you should attempt to incorporate these facts
-            in your response:
+            \n\nYou can assume that the following is true.
+            You should attempt to incorporate these facts
+            into your response:\n\n
         """
         )