Merge pull request #4 from lpm0073/next

chore: add oracle example

Author: lpm0073

.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
     hooks:
       - id: codespell
         args: ["--ignore-words=codespell.txt"]
-        exclude: '\.svg$'
+        exclude: 'codespell.txt|\.svg$'
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v3.1.0
     hooks:

CHANGELOG.md

@@ -1,6 +1,5 @@
 # 1.0.0 (2023-11-30)
 
-
 ### Features
 
-* first commit ([9fe5fbb](https://github.com/lpm0073/netec-llm/commit/9fe5fbbd03d278a90a7351a4d907a74783e48684))
+- first commit ([9fe5fbb](https://github.com/lpm0073/netec-llm/commit/9fe5fbbd03d278a90a7351a4d907a74783e48684))

README.md

@@ -1,12 +1,12 @@
-# Netec Catalogue LLM
+# Netec Large Language Models
 
 A Python [LangChain](https://www.langchain.com/) - [Pinecone](https://docs.pinecone.io/docs/python-client) proof of concept LLM to manage sales support inquiries on the Netec course catalogue.
 
 ## Installation
 
 ```console
-git clone https://github.com/lpm0073/langchain-workflows.git
-cd langchain-workflows
+git clone https://github.com/lpm0073/netec-llm.git
+cd netec-llm
 make init
 make activate
 ```
@@ -25,6 +25,9 @@ python3 -m models.examples.prompt "You are an expert on businesses located in Me
 
 # example 3 - prompted assistant
 python3 -m models.examples.training_services "Microsoft certified Azure AI engineer associate"
+
+# example 4 - prompted assistant
+python3 -m models.examples.training_services_oracle "Oracle database administrator"
 ```
 
 ## Requirements

codespell.txt

@@ -0,0 +1 @@
+OCE

models/examples/training_services.py

@@ -2,16 +2,17 @@
 """Sales Support Model (SSM) for the LangChain project."""
 import argparse
 
-from ..ssm import SalesSupportModel
+from ..ssm import NetecPromptTemplates, SalesSupportModel
 
 
 ssm = SalesSupportModel()
-
+templates = NetecPromptTemplates()
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(description="SSM examples")
     parser.add_argument("concept", type=str, help="A kind of training that Netec provides.")
     args = parser.parse_args()
 
-    result = ssm.prompt_with_template(concept=args.concept)
+    prompt = templates.training_services
+    result = ssm.prompt_with_template(prompt=prompt, concept=args.concept)
     print(result)

models/examples/training_services_oracle.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+"""Sales Support Model (SSM) for the LangChain project."""
+import argparse
+
+from ..ssm import NetecPromptTemplates, SalesSupportModel
+
+
+ssm = SalesSupportModel()
+templates = NetecPromptTemplates()
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="SSM Oracle examples")
+    parser.add_argument("concept", type=str, help="An Oracle certification exam prep")
+    args = parser.parse_args()
+
+    prompt = templates.oracle_training_services
+    result = ssm.prompt_with_template(prompt=prompt, concept=args.concept)
+    print(result)

models/ssm.py

@@ -9,25 +9,14 @@
 from dotenv import find_dotenv, load_dotenv
 from langchain.chat_models import ChatOpenAI
 from langchain.embeddings import OpenAIEmbeddings
-
-# 1.) wrappers
 from langchain.llms.openai import OpenAI
-
-# 3.) prompt templates
 from langchain.prompts import PromptTemplate
-
-# 2.) models and messages
 from langchain.schema import HumanMessage, SystemMessage  # AIMessage (not used)
-
-# 6.) embeddings
 from langchain.text_splitter import Document, RecursiveCharacterTextSplitter
-
-# 7.) pinecode client
 from langchain.vectorstores.pinecone import Pinecone
 from pydantic import BaseModel, ConfigDict, Field  # ValidationError
 
 
-# Load environment variables from .env file in all folders
 # pylint: disable=duplicate-code
 dotenv_path = find_dotenv()
 if os.path.exists(dotenv_path):
@@ -41,22 +30,48 @@
     raise FileNotFoundError("No .env file found in root directory of repository")
 
 DEFAULT_MODEL_NAME = "text-davinci-003"
-pinecone.init(api_key=PINECONE_API_KEY, environment=PINECONE_ENVIRONMENT)  # minute 10:43
+pinecone.init(api_key=PINECONE_API_KEY, environment=PINECONE_ENVIRONMENT)
 
 
 class NetecPromptTemplates:
     """Netec Prompt Templates."""
 
+    sales_role: str = """You are a helpful sales assistant at Netec who sells
+        specialized training and exam preparation services to existing customers.
+        You provide concise explanations of the services that Netec offers in 100
+        words or less."""
+
+    @classmethod
+    def get_properties(cls):
+        """return a list of properties of this class."""
+        return [attr for attr in dir(cls) if isinstance(getattr(cls, attr), property)]
+
     @property
     def training_services(self) -> PromptTemplate:
         """Get prompt."""
-        template = """
-        You are a sales assistant at Netec who sells specialized training and exam prep services to existing customers.
+        template = (
+            self.sales_role
+            + """
         Explain the training services that Netec offers about {concept}
-        in no more than 100 words.
         """
-        prompt = PromptTemplate(input_variables=["concept"], template=template)
-        return prompt
+        )
+        return PromptTemplate(input_variables=["concept"], template=template)
+
+    @property
+    def oracle_training_services(self) -> PromptTemplate:
+        """Get prompt."""
+        template = (
+            self.sales_role
+            + """
+        Note that Netec is the exclusive provide of Oracle training services
+        for the 6 levels of Oracle Certification credentials: Oracle Certified Junior Associate (OCJA),
+        Oracle Certified Associate (OCA), Oracle Certified Professional (OCP),
+        Oracle Certified Master (OCM), Oracle Certified Expert (OCE) and
+        Oracle Certified Specialist (OCS).
+        Summarize their programs for {concept}
+        """
+        )
+        return PromptTemplate(input_variables=["concept"], template=template)
 
 
 class SalesSupportModel(BaseModel):
@@ -98,10 +113,9 @@ def cached_chat_request(self, system_message: str, human_message: str) -> System
         # pylint: disable=not-callable
         return self.chat(messages)
 
-    def prompt_with_template(self, concept: str, model: str = DEFAULT_MODEL_NAME) -> str:
+    def prompt_with_template(self, prompt: PromptTemplate, concept: str, model: str = DEFAULT_MODEL_NAME) -> str:
         """Prompt with template."""
         llm = OpenAI(model=model)
-        prompt = NetecPromptTemplates().training_services
         retval = llm(prompt.format(concept=concept))
         return retval
 

pyproject.toml

@@ -32,3 +32,7 @@ max-complexity = 10
 exclude = "venv"
 extend-exclude = "*__init__.py,*__version__.py,venv"
 select = "C101"
+
+[tool.codespell]
+skip = '*.svg,models/ssm.py'
+ignore-words = 'codespell.txt'