Add financial profiles and conversation prompts for retail banking

Author: peremartra

Usage_Examples/basic_usage.py

@@ -5,7 +5,7 @@
 import sys
 import json
 from dotenv import load_dotenv
-
+TEMPLATE_NAME= "templates/financial_retail_banking/"
 # Add parent directory to path to import the library
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 
@@ -26,12 +26,12 @@ def main():
     # Configure the library
     missing = wsd.set_config(
         API_KEY=api_key,  # Use API key from environment variable
-        template_client_prompt="templates/financial01/prompts/financial_client_01.j2",
-        template_advisor_prompt="templates/financial01/prompts/financial_advisor_01.j2",
-        file_profiles="templates/financial01/profiles/financial_sample01_5.json",
-        file_output="templates/financial01/outputs/test_dataset01_5.json",
-        model_client="gpt-4o-mini",
-        model_advisor="gpt-4o-mini",
+        template_client_prompt=TEMPLATE_NAME + "prompts/financial_client_01.j2",
+        template_advisor_prompt=TEMPLATE_NAME + "prompts/financial_advisor_01.j2",
+        file_profiles=TEMPLATE_NAME + "profiles/retail_banking_5.json",
+        file_output=TEMPLATE_NAME + "outputs/test_dataset01_5b.json",
+        model_client="gpt-4o",
+        model_advisor="gpt-4o",
         # Optional parameters with custom values
         temperature_client=0.8,
         max_recommended_questions=10

templates/financial01/outputs/test_dataset01_5.json

@@ -0,0 +1,111 @@
+"""
+Create a Retail Banking Conversation Dataset
+===========================================
+
+This module demonstrates how to use the WizardSData library to generate
+synthetic conversational datasets for retail banking scenarios.
+
+Example:
+    To run this script directly::
+
+        $ python create_dataset.py
+
+Notes:
+    - Requires an OPENAI_API_KEY in config.env
+    - Uses the financial retail banking templates
+    - Creates a dataset based on the retail_banking_160.json profiles
+"""
+import os
+import sys
+import json
+from dotenv import load_dotenv
+
+# Define the template directory
+TEMPLATE_NAME = "templates/financial_retail_banking/"
+
+# Add parent directory to path to import the library
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+
+import wizardsdata as wsd
+
+def main():
+    """
+    Generate a retail banking conversation dataset using WizardSData.
+    
+    This function demonstrates the complete workflow from configuration to generation
+    of financial conversations between clients and advisors.
+    
+    Steps:
+        1. Load API credentials from environment
+        2. Configure the WizardSData library
+        3. Validate the configuration
+        4. Generate conversations
+        5. Report results
+        
+    Returns:
+        None
+    
+    Raises:
+        EnvironmentError: If the OPENAI_API_KEY is not found in environment variables
+    """
+    # Load environment variables from config.env
+    env_path = os.path.join(os.path.dirname(__file__), '../..', 'config.env')
+    load_dotenv(env_path)
+    
+    # Get API key from environment
+    api_key = os.getenv("OPENAI_API_KEY")
+    if not api_key:
+        print("ERROR: OPENAI_API_KEY not found in environment variables. Check your config.env file.")
+        return
+    
+    # Configure the library with required parameters
+    missing = wsd.set_config(
+        # Authentication settings
+        API_KEY=api_key,  
+        
+        # Template paths define conversation behavior
+        template_client_prompt=TEMPLATE_NAME + "prompts/financial_client_01.j2",
+        template_advisor_prompt=TEMPLATE_NAME + "prompts/financial_advisor_01.j2",
+        
+        # Input/Output file paths
+        file_profiles=TEMPLATE_NAME + "profiles/retail_banking_1.json",
+        file_output=TEMPLATE_NAME + "outputs/retail_banking_dataset_11.json",
+        
+        # Model configuration
+        model_client="gpt-4o",
+        model_advisor="gpt-4o",
+        
+        # Conversation parameters
+        temperature_client=0.8,
+        max_recommended_questions=4
+    )
+    
+    # Check for missing parameters
+    if missing:
+        print(f"Missing configuration parameters: {', '.join(missing)}")
+        return
+    
+    # Display current configuration
+    config = wsd.get_config()
+    print("Current configuration:")
+    # Mask API key for security when printing
+    masked_config = {**config, "API_KEY": "********" if "API_KEY" in config else None}
+    print(json.dumps(masked_config, indent=2))
+    
+    # Check if configuration is valid
+    if not wsd.is_config_valid():
+        print("Configuration is not valid.")
+        return
+    
+    # Start generating conversations
+    print("Starting conversation generation...")
+    success = wsd.start_generation()
+    
+    if success:
+        print("Conversations generated successfully!")
+    else:
+        print("Failed to generate conversations.")
+
+
+if __name__ == "__main__":
+    main()

templates/financial_retail_banking/create_dataset.py

@@ -0,0 +1,23 @@
+[
+    {
+        "id_conversation": "c27ad6cc-363a-4036-ac5b-57df17495f1f",
+        "topic": "Pay off mortgage within the next 5 years",
+        "sequence": 0,
+        "rol1": "Hi there!",
+        "rol2": "Hello! It's great to meet you. How can I assist you today with your mortgage or financial planning needs? Are you looking to buy a home, refinance, or something else?"
+    },
+    {
+        "id_conversation": "c27ad6cc-363a-4036-ac5b-57df17495f1f",
+        "topic": "Pay off mortgage within the next 5 years",
+        "sequence": 2,
+        "rol1": "I'm looking to pay off my mortgage within the next 5 years. Any tips?",
+        "rol2": "That's a great goal! Paying off your mortgage early can save you a lot in interest payments and give you financial freedom. To better tailor my advice, could you tell me a bit more about your current mortgage situation? For example, what's the remaining balance, interest rate, and monthly payment? Also, do you have any other financial commitments or goals that I should consider when giving advice?"
+    },
+    {
+        "id_conversation": "c27ad6cc-363a-4036-ac5b-57df17495f1f",
+        "topic": "Pay off mortgage within the next 5 years",
+        "sequence": 4,
+        "rol1": "Sure! I have about \u20ac150,000 left on my mortgage with a 3% interest rate. My monthly payment is around \u20ac1,000. Besides paying off the mortgage, I'm mainly focused on maintaining my savings and tech stocks.",
+        "rol2": ""
+    }
+]

templates/financial_retail_banking/outputs/.DS_Store

@@ -0,0 +1,30 @@
+[
+    {
+        "id_conversation": "80467d7f-6b59-4814-ac22-3447d19f5348",
+        "topic": "Pay off mortgage within the next 5 years",
+        "sequence": 0,
+        "rol1": "Hi there!",
+        "rol2": "Hello! It's great to meet you. How can I assist you with your mortgage needs today? Are you looking to buy a home, refinance, or something else?"
+    },
+    {
+        "id_conversation": "80467d7f-6b59-4814-ac22-3447d19f5348",
+        "topic": "Pay off mortgage within the next 5 years",
+        "sequence": 2,
+        "rol1": "I'm looking to pay off my mortgage in the next 5 years. Any advice on how I can improve my saving and investment strategy to achieve that?",
+        "rol2": "That sounds like a great goal! Paying off your mortgage early can save you a lot in interest and give you financial freedom. To give you the best advice, I need to understand a bit more about your current financial situation. Could you tell me about your current mortgage balance, interest rate, and any other financial commitments you have? Additionally, how much are you currently saving or investing each month?"
+    },
+    {
+        "id_conversation": "80467d7f-6b59-4814-ac22-3447d19f5348",
+        "topic": "Pay off mortgage within the next 5 years",
+        "sequence": 4,
+        "rol1": "Sure! My current mortgage balance is about \u20ac120,000 with a 3% interest rate. I don't have any other major financial commitments right now. I save around \u20ac500 monthly and also have some tech stocks.",
+        "rol2": "Thanks for sharing that information. Here are a few steps you might consider to help pay off your mortgage in the next 5 years:\n\n1. **Increase Monthly Payments:** If possible, increase your monthly mortgage payments. Even a small increase can significantly reduce the term of your loan and the interest paid over time. You might want to allocate some of your monthly savings towards this.\n\n2. **Lump Sum Payments:** Consider making lump sum payments whenever you have extra cash, such as bonuses or tax refunds. This can directly reduce your principal balance.\n\n3. **Investment Strategy:** Assess your tech stocks' performance and risk. If they are performing well, you might consider selling a portion to pay down your mortgage, especially if the returns are lower than the interest saved by paying off the mortgage early.\n\n4. **Budget Review:** Review your budget to identify areas where you can cut back and redirect those funds to your mortgage.\n\n5. **Emergency Fund:** Ensure you maintain an emergency fund to avoid financial strain if unexpected expenses arise. This will prevent you from having to take on new debt.\n\n6. **Consult Your Lender:** Check if there are any penalties for early repayment on your mortgage. Some lenders charge fees for paying off a mortgage early, which could affect your strategy.\n\n7. **Automate Payments:** Set up automatic transfers to ensure you're consistently making higher payments without having to think about it each month.\n\nWould you like more details on any of these steps, or is there anything else you're considering?"
+    },
+    {
+        "id_conversation": "80467d7f-6b59-4814-ac22-3447d19f5348",
+        "topic": "Pay off mortgage within the next 5 years",
+        "sequence": 6,
+        "rol1": "Increasing monthly payments sounds like a good start. I'm also curious about how to manage my tech stocks. Should I sell some to pay off the mortgage faster?",
+        "rol2": ""
+    }
+]