Skip to content

Latest commit

ย 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Interactive Chat Simulation Template

A generic, plug-and-play template for creating AI-powered interactive chat simulations for any learning domain - from sales training to technical troubleshooting, customer service to medical consultations.

๐Ÿš€ Quick Start

  1. Open the Template: Open index.html in your web browser
  2. Choose Scenario: Select from automatically loaded scenarios (Sales, Technical, Customer Service)
  3. Configure AI (Optional): Enter your AI endpoint and API key for enhanced features
  4. Start Learning: Begin the interactive simulation with pre-assessment and conversation phases!

๐Ÿ“ Project Structure

interactive-chat-simulation-template/
โ”œโ”€โ”€ index.html                          # Main template application (auto-loads scenarios)
โ”œโ”€โ”€ README.md                           # This file
โ”œโ”€โ”€ GETTING_STARTED.md                  # Quick start guide
โ”œโ”€โ”€ docs/
โ”‚   โ”œโ”€โ”€ Interactive_Chat_Simulation_Guide.md  # Comprehensive setup guide
โ”‚   โ””โ”€โ”€ Quick_Scenario_Reference.md           # Quick reference for creating scenarios
โ””โ”€โ”€ example_scenarios/
    โ”œโ”€โ”€ sales_training.json             # Enterprise software sales simulation
    โ”œโ”€โ”€ technical_troubleshooting.json  # Network troubleshooting lab
    โ”œโ”€โ”€ customer_service.json           # Customer service training
    โ””โ”€โ”€ network_automation.json         # Network automation sales (legacy)

๐ŸŽฏ What This Template Provides

Universal Learning Platform

  • Any Domain: Sales, technical support, healthcare, education, customer service
  • Any Role: Practice conversations from any professional perspective
  • Structured Learning: Phase-based progression with clear objectives
  • AI-Powered Feedback: Automated analysis and coaching after each phase

Key Features

  • โœ… Auto-Loading Scenarios: Automatically loads JSON scenarios from example_scenarios/
  • โœ… Pre-Assessment: Strategic approach selection before conversations
  • โœ… Phase-Based Conversations: 3-5 structured phases per scenario
  • โœ… AIpersona Interactions: Dynamic AI character responses
  • โœ… AIcoach Feedback: Real-time coaching and performance analysis
  • โœ… Response Limits: Focused interactions (3-5 exchanges per phase)
  • โœ… Progress Tracking: Visual progress indicators
  • โœ… Generic Interface: Works with any scenario type

๐Ÿ› ๏ธ Creating Your Own Scenarios

Option 1: Use Example Templates

  1. Copy one of the files from example_scenarios/
  2. Modify the content for your specific use case
  3. Save in the example_scenarios/ directory
  4. Refresh the page to automatically load your scenario

Option 2: Build from Scratch

  1. Follow the format in docs/Quick_Scenario_Reference.md
  2. Use the comprehensive guide in docs/Interactive_Chat_Simulation_Guide.md
  3. Include required pre_assessment and ai_mode nodes
  4. Test thoroughly with your target AI model

๐Ÿ“‹ Example Use Cases

Business & Sales Training

  • Enterprise Sales: Complex B2B software sales conversations
  • Customer Service: Handle difficult customer situations
  • Negotiation: Practice deal-making and conflict resolution
  • Management: Leadership and team interaction scenarios

Technical Training

  • IT Support: Troubleshoot system and network issues
  • Software Development: Code reviews and technical discussions
  • System Administration: Handle operational challenges
  • Engineering: Problem-solving and design conversations

Healthcare & Medical

  • Patient Consultations: Practice bedside manner and history taking
  • Diagnostic Interviews: Symptom assessment and evaluation
  • Medical Education: Clinical reasoning and communication
  • Emergency Response: High-pressure medical scenarios

Education & Professional Development

  • Interview Preparation: Job interview practice
  • Language Learning: Conversational practice in target languages
  • Presentation Skills: Q&A and audience interaction
  • Academic Discussions: Thesis defense and peer review

๐Ÿ”ง AI Model Compatibility

Recommended Models

  • OpenAI GPT-3.5/GPT-4: Excellent performance and consistency
  • Red Hat Granite: Good for enterprise environments (granite-3-3-8b-instruct)
  • Anthropic Claude: Excellent for nuanced conversations
  • Local Models: Varies by model - test thoroughly

Configuration Requirements

  • Endpoint: OpenAI-compatible API endpoint
  • Authentication: API key or bearer token
  • Model: Specific model name (e.g., "gpt-3.5-turbo", "granite-3-3-8b-instruct")

๐Ÿ“š Documentation

Getting Started

  • Read docs/Quick_Scenario_Reference.md for immediate scenario creation
  • Review the example scenarios in example_scenarios/ for inspiration

Advanced Usage

  • Consult docs/Interactive_Chat_Simulation_Guide.md for comprehensive guidance
  • Learn about AI prompt engineering, success criteria design, and deployment options

๐ŸŽฎ How It Works

1. Scenario Loading

  • Automatically loads JSON scenarios from example_scenarios/ directory
  • Normalizes different JSON formats to common structure
  • Supports multiple scenario types (sales, technical, customer service, etc.)

2. Pre-Assessment

  • Learners choose strategic approach before conversations
  • Choices influence AIpersona behavior throughout the scenario
  • Sets context for the learning experience

3. Interactive Simulation

  • Learners progress through structured conversation phases with AIpersona
  • AI responds dynamically based on phase-specific prompts and chosen approach
  • Response limits keep conversations focused and productive

4. Performance Analysis

  • AIcoach analyzes learner responses against success criteria
  • Provides confidence levels (High/Medium/Low) and specific feedback
  • Offers suggestions for improvement and alternative approaches

5. Learning Reinforcement

  • Phase-by-phase coaching and analysis
  • Final comprehensive performance summary
  • Option to retry phases or restart scenarios

๐Ÿš€ Deployment Options

Standalone Deployment

  • Single HTML file - no server required
  • Automatically loads scenarios from JSON files
  • Users configure their own AI connections (optional)
  • Perfect for individual use or small teams

LMS Integration

  • Package as SCORM for learning management systems
  • Integrate with course gradebooks and completion tracking
  • Centralized configuration management

Enterprise Deployment

  • Custom backend to hide API keys from users
  • Centralized scenario library management
  • User progress tracking and analytics
  • Enhanced security and compliance

๐Ÿ›ก๏ธ Security & Privacy

Data Handling

  • Conversations are sent to configured AI endpoints
  • No data is stored locally by the template
  • Users control their own AI service connections

Best Practices

  • Use enterprise AI endpoints for sensitive training content
  • Review AI service privacy policies and data handling
  • Consider local AI models for highly confidential scenarios

๐Ÿค Contributing

This template is designed to be extended and customized. Consider:

  • Creating Scenario Libraries: Build collections for specific industries or skills
  • UI Enhancements: Customize the interface for specific use cases
  • Integration Development: Build connectors for popular LMS platforms
  • AI Model Optimization: Develop model-specific prompt templates

๐Ÿ“„ License

This template is provided as-is for educational and training purposes. Customize and adapt as needed for your specific use cases.

๐Ÿ†˜ Support & Troubleshooting

Common Issues

  1. Scenarios Not Loading: Check JSON format and ensure files are in example_scenarios/ directory
  2. AI Connection Fails: Verify endpoint URL, API key, and model name
  3. Responses Too Long: Adjust AI prompts to specify shorter responses
  4. Inconsistent Character: Add more specific behavioral guidelines to AI prompts
  5. Poor Analysis Quality: Use lower temperature settings for evaluation responses

Getting Help

  • Review the comprehensive guide in docs/Interactive_Chat_Simulation_Guide.md
  • Check example scenarios for proper formatting
  • Ensure JSON files include required pre_assessment and ai_mode nodes
  • Test with built-in scenarios first to verify functionality

Ready to create engaging, interactive learning experiences? Open index.html and start with the built-in scenarios, then create your own using the provided examples and documentation!

About

Generic AI-powered interactive chat simulation template for any learning domain

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages