Tag: ai

  • Agentic Design Pattern: Role Playing

    
        """
    Pattern 084: Role-Playing/Persona Pattern
    
    Description:
        The Role-Playing/Persona pattern involves instructing the LLM to adopt a specific
        role, character, or persona when generating responses. This pattern leverages the
        model's ability to simulate different perspectives, expertise levels, personalities,
        and communication styles. By assuming a role, the LLM can provide more contextually
        appropriate, specialized, and engaging responses.
    
        Role-playing is a powerful prompt engineering technique that:
        - Enhances response quality through perspective-taking
        - Enables domain expertise simulation (doctor, lawyer, scientist)
        - Creates consistent personality in conversational agents
        - Improves user engagement through character-based interaction
        - Allows multi-perspective analysis of problems
    
    Components:
        1. Persona Definition
           - Identity (who the persona is)
           - Expertise (what they know)
           - Personality traits (how they communicate)
           - Background (relevant experience)
           - Goals and motivations
    
        2. Communication Style
           - Tone (formal, casual, friendly, professional)
           - Vocabulary level (simple, technical, academic)
           - Response structure (detailed, concise, step-by-step)
           - Interaction patterns (questioning, advising, teaching)
    
        3. Persona Consistency
           - Maintaining character across turns
           - Memory of previous interactions
           - Consistent viewpoint and opinions
           - Appropriate domain knowledge boundaries
    
        4. Context Adaptation
           - Adjusting expertise level to user
           - Situational awareness
           - Emotional intelligence
           - Cultural sensitivity
    
    Use Cases:
        1. Expert Consultation
           - Medical advice (doctor persona)
           - Legal guidance (lawyer persona)
           - Technical support (engineer persona)
           - Financial planning (financial advisor persona)
           - Career counseling (career coach persona)
    
        2. Educational Applications
           - Patient teacher (explaining complex topics)
           - Socratic tutor (guiding through questions)
           - Encouraging mentor (motivating learners)
           - Strict examiner (testing knowledge)
    
        3. Creative Writing
           - Character dialogue generation
           - Story narration from specific viewpoint
           - Historical figure simulation
           - Fictional character interaction
    
        4. Business Applications
           - Sales representative (persuasive, customer-focused)
           - Customer service (empathetic, problem-solving)
           - Business analyst (analytical, data-driven)
           - Executive advisor (strategic, big-picture)
    
        5. Therapeutic and Counseling
           - Supportive friend (empathetic listener)
           - Life coach (motivational, goal-oriented)
           - Therapist (reflective, non-judgmental)
           - Meditation guide (calm, mindful)
    
    LangChain Implementation:
        LangChain facilitates role-playing through:
        - System message configuration (setting persona)
        - Context management (maintaining persona)
        - Memory integration (persona consistency)
        - Custom prompt templates (structured personas)
        - Chat history management (conversation continuity)
    
    Key Features:
        1. Persona Library
           - Pre-defined expert personas
           - Customizable persona templates
           - Domain-specific knowledge bases
           - Personality trait combinations
    
        2. Dynamic Persona Switching
           - Context-aware persona selection
           - Smooth transitions between personas
           - Multi-persona conversations
           - Persona blending
    
        3. Expertise Calibration
           - Adjusting knowledge depth
           - Acknowledging limitations
           - Appropriate confidence levels
           - Domain boundary awareness
    
        4. Personality Traits
           - Empathy and emotional intelligence
           - Humor and engagement style
           - Assertiveness levels
           - Teaching vs directing approaches
    
    Best Practices:
        1. Persona Definition
           - Be specific about role and expertise
           - Include relevant background details
           - Define communication style clearly
           - Set appropriate boundaries
    
        2. Consistency Maintenance
           - Use memory for multi-turn conversations
           - Reference persona context regularly
           - Maintain viewpoint across interactions
           - Avoid out-of-character responses
    
        3. Expertise Management
           - Stay within persona's knowledge domain
           - Acknowledge when unsure
           - Provide persona-appropriate disclaimers
           - Don't overreach expertise claims
    
        4. Engagement Optimization
           - Match tone to user expectations
           - Balance expertise with accessibility
           - Use persona-appropriate examples
           - Maintain engaging interaction style
    
    Trade-offs:
        Advantages:
        - Enhanced response quality and relevance
        - More engaging and natural interactions
        - Domain-specific expertise simulation
        - Consistent personality and tone
        - Better user trust and satisfaction
        - Multi-perspective problem analysis
    
        Disadvantages:
        - Requires detailed persona definitions
        - May limit flexibility in responses
        - Risk of inappropriate persona adoption
        - Can be perceived as deceptive if not transparent
        - Harder to maintain over long conversations
        - May introduce unwanted biases
    
    Production Considerations:
        1. Transparency
           - Clearly indicate AI persona usage
           - Provide disclaimers for professional advice
           - Explain limitations of simulated expertise
           - Allow users to request different personas
    
        2. Safety and Ethics
           - Avoid harmful or inappropriate personas
           - Include safety guardrails
           - Monitor for persona misuse
           - Implement content filtering
           - Respect professional boundaries
    
        3. Quality Assurance
           - Test personas across diverse inputs
           - Validate expertise accuracy
           - Monitor consistency metrics
           - Gather user feedback
           - Regular persona updates
    
        4. Scalability
           - Modular persona definitions
           - Reusable persona components
           - Version control for personas
           - A/B test persona variations
           - Performance monitoring per persona
    
        5. Legal Compliance
           - Medical/legal advice disclaimers
           - Professional credential clarification
           - Terms of service alignment
           - Privacy considerations
           - Liability protection
    """
    
    import os
    from typing import List, Dict, Any, Optional
    from dataclasses import dataclass
    from enum import Enum
    from dotenv import load_dotenv
    
    from langchain_core.prompts import ChatPromptTemplate, MessagesPlaceholder
    from langchain_core.output_parsers import StrOutputParser
    from langchain_openai import ChatOpenAI
    from langchain_core.messages import HumanMessage, AIMessage, SystemMessage
    
    load_dotenv()
    
    
    class PersonaType(Enum):
        """Types of personas"""
        EXPERT = "expert"
        TEACHER = "teacher"
        CRITIC = "critic"
        FRIEND = "friend"
        COACH = "coach"
        ANALYST = "analyst"
        CREATIVE = "creative"
        COUNSELOR = "counselor"
    
    
    @dataclass
    class Persona:
        """Defines a role-playing persona"""
        name: str
        role: str
        expertise: List[str]
        personality_traits: List[str]
        communication_style: str
        background: str
        system_message: str
    
    
    @dataclass
    class PersonaConfig:
        """Configuration for persona-based interaction"""
        temperature: float = 0.7
        model_name: str = "gpt-3.5-turbo"
        max_tokens: Optional[int] = None
        maintain_history: bool = True
    
    
    class RolePlayingAgent:
        """
        Agent that adopts different personas for specialized interactions.
        
        This agent demonstrates:
        1. Multiple pre-defined personas
        2. Persona switching
        3. Consistent character maintenance
        4. Domain-specific expertise simulation
        """
        
        def __init__(self, config: Optional[PersonaConfig] = None):
            """
            Initialize role-playing agent.
            
            Args:
                config: Configuration for persona interactions
            """
            self.config = config or PersonaConfig()
            self.llm = ChatOpenAI(
                model=self.config.model_name,
                temperature=self.config.temperature
            )
            self.personas = self._initialize_personas()
            self.conversation_history: List[Any] = []
        
        def _initialize_personas(self) -> Dict[str, Persona]:
            """Initialize library of personas"""
            return {
                "doctor": Persona(
                    name="Dr. Sarah Johnson",
                    role="Medical Doctor",
                    expertise=["General Medicine", "Preventive Care", "Health Education"],
                    personality_traits=["Empathetic", "Patient", "Thorough", "Professional"],
                    communication_style="Clear, reassuring, and professional. Uses simple language to explain medical concepts.",
                    background="15 years of experience in family medicine. Focus on patient education and preventive care.",
                    system_message="""You are Dr. Sarah Johnson, a compassionate and experienced medical doctor with 15 years in family medicine.
    
    Your approach:
    - Speak in a warm, professional, and reassuring tone
    - Explain medical concepts in simple, accessible language
    - Ask clarifying questions about symptoms
    - Provide general health guidance (not specific diagnoses)
    - Always recommend consulting a healthcare provider for serious concerns
    - Show empathy and understanding for patient concerns
    
    Important: You provide general health information only. Always remind users to consult their healthcare provider for personalized medical advice."""
                ),
                
                "teacher": Persona(
                    name="Professor Alex Chen",
                    role="Patient Teacher",
                    expertise=["Education", "Learning Science", "Curriculum Design"],
                    personality_traits=["Patient", "Encouraging", "Thorough", "Enthusiastic"],
                    communication_style="Clear, step-by-step explanations with examples and encouragement.",
                    background="20 years teaching experience. Specializes in breaking down complex topics.",
                    system_message="""You are Professor Alex Chen, a patient and enthusiastic teacher with 20 years of experience.
    
    Your teaching approach:
    - Break complex topics into manageable steps
    - Use clear examples and analogies
    - Check for understanding regularly
    - Provide encouragement and positive reinforcement
    - Adapt explanations to student's level
    - Use the Socratic method to guide learning
    - Make learning engaging and fun
    
    Remember: Every student learns differently. Be patient, encouraging, and adaptive to their needs."""
                ),
                
                "critic": Persona(
                    name="Marcus Stone",
                    role="Constructive Critic",
                    expertise=["Analysis", "Critical Thinking", "Quality Assurance"],
                    personality_traits=["Analytical", "Direct", "Thorough", "Fair"],
                    communication_style="Direct, analytical, focuses on both strengths and weaknesses.",
                    background="Expert reviewer with focus on constructive feedback and improvement.",
                    system_message="""You are Marcus Stone, a fair but thorough critic who provides constructive feedback.
    
    Your approach:
    - Analyze thoroughly and objectively
    - Point out both strengths and weaknesses
    - Provide specific, actionable feedback
    - Explain the reasoning behind critiques
    - Suggest concrete improvements
    - Maintain professionalism and respect
    - Balance criticism with recognition of merits
    
    Your goal is to help improve quality through honest, constructive analysis."""
                ),
                
                "coach": Persona(
                    name="Coach Sam Rivera",
                    role="Life Coach",
                    expertise=["Goal Setting", "Motivation", "Personal Development"],
                    personality_traits=["Motivational", "Supportive", "Direct", "Energetic"],
                    communication_style="Energetic, motivational, action-oriented with practical strategies.",
                    background="Certified life coach helping people achieve their goals for 10 years.",
                    system_message="""You are Coach Sam Rivera, an energetic and motivational life coach.
    
    Your coaching style:
    - Help clients clarify their goals
    - Break big goals into actionable steps
    - Provide motivation and encouragement
    - Hold clients accountable
    - Celebrate progress and wins
    - Address obstacles and limiting beliefs
    - Use powerful questions to unlock insights
    - Focus on action and results
    
    You believe everyone has untapped potential. Your job is to help them discover and achieve it!"""
                ),
                
                "analyst": Persona(
                    name="Dr. Emily Watson",
                    role="Business Analyst",
                    expertise=["Data Analysis", "Strategic Planning", "Market Research"],
                    personality_traits=["Analytical", "Objective", "Detail-oriented", "Strategic"],
                    communication_style="Data-driven, structured, focuses on insights and recommendations.",
                    background="15 years in business intelligence and strategic consulting.",
                    system_message="""You are Dr. Emily Watson, a senior business analyst with expertise in data-driven decision making.
    
    Your analytical approach:
    - Examine problems systematically
    - Look for patterns and trends
    - Use data to support conclusions
    - Consider multiple perspectives
    - Identify risks and opportunities
    - Provide structured recommendations
    - Think strategically about implications
    - Present insights clearly and concisely
    
    You help organizations make informed decisions through rigorous analysis."""
                ),
                
                "creative": Persona(
                    name="Luna Martinez",
                    role="Creative Director",
                    expertise=["Creative Writing", "Brainstorming", "Innovation"],
                    personality_traits=["Imaginative", "Enthusiastic", "Bold", "Inspiring"],
                    communication_style="Vibrant, imaginative, encourages thinking outside the box.",
                    background="Award-winning creative director with passion for innovation.",
                    system_message="""You are Luna Martinez, an imaginative and award-winning creative director.
    
    Your creative approach:
    - Think unconventionally and boldly
    - Generate multiple creative ideas
    - Encourage wild brainstorming
    - Look for unexpected connections
    - Challenge conventional thinking
    - Inspire with enthusiasm
    - Balance creativity with practicality
    - Help refine and develop ideas
    
    "Creativity is intelligence having fun" - and you bring both! Help others unlock their creative potential."""
                ),
            }
        
        def interact_with_persona(
            self,
            persona_key: str,
            user_message: str,
            reset_history: bool = False
        ) -> str:
            """
            Interact with a specific persona.
            
            Args:
                persona_key: Key of persona to use
                user_message: User's message
                reset_history: Whether to reset conversation history
                
            Returns:
                Persona's response
            """
            if persona_key not in self.personas:
                return f"Persona '{persona_key}' not found. Available: {list(self.personas.keys())}"
            
            persona = self.personas[persona_key]
            
            # Reset history if requested
            if reset_history or not self.config.maintain_history:
                self.conversation_history = []
            
            # Create prompt with persona
            if self.conversation_history:
                messages = [
                    SystemMessage(content=persona.system_message),
                    *self.conversation_history,
                    HumanMessage(content=user_message)
                ]
            else:
                messages = [
                    SystemMessage(content=persona.system_message),
                    HumanMessage(content=user_message)
                ]
            
            # Get response
            response = self.llm.invoke(messages)
            
            # Update history
            if self.config.maintain_history:
                self.conversation_history.append(HumanMessage(content=user_message))
                self.conversation_history.append(AIMessage(content=response.content))
            
            return response.content
        
        def multi_persona_analysis(
            self,
            question: str,
            persona_keys: List[str]
        ) -> Dict[str, str]:
            """
            Get perspectives from multiple personas.
            
            Args:
                question: Question to analyze
                persona_keys: List of persona keys to consult
                
            Returns:
                Dictionary of persona responses
            """
            results = {}
            
            for key in persona_keys:
                if key in self.personas:
                    # Reset history for clean analysis
                    response = self.interact_with_persona(key, question, reset_history=True)
                    results[key] = response
            
            return results
        
        def persona_debate(
            self,
            topic: str,
            persona1_key: str,
            persona2_key: str,
            rounds: int = 2
        ) -> List[Dict[str, str]]:
            """
            Have two personas debate a topic.
            
            Args:
                topic: Topic to debate
                persona1_key: First persona key
                persona2_key: Second persona key
                rounds: Number of debate rounds
                
            Returns:
                List of debate exchanges
            """
            if persona1_key not in self.personas or persona2_key not in self.personas:
                return [{"error": "One or both personas not found"}]
            
            persona1 = self.personas[persona1_key]
            persona2 = self.personas[persona2_key]
            
            debate = []
            
            # Initial statements
            prompt1 = f"Present your perspective on: {topic}"
            response1 = self.interact_with_persona(persona1_key, prompt1, reset_history=True)
            debate.append({
                "round": 1,
                "persona": persona1.name,
                "statement": response1
            })
            
            # Alternating responses
            for round_num in range(2, rounds + 2):
                # Persona 2 responds to Persona 1
                prompt2 = f"Respond to this perspective on '{topic}': {response1}"
                response2 = self.interact_with_persona(persona2_key, prompt2, reset_history=True)
                debate.append({
                    "round": round_num,
                    "persona": persona2.name,
                    "statement": response2
                })
                
                if round_num  Optional[Persona]:
            """Get information about a persona"""
            return self.personas.get(persona_key)
        
        def list_personas(self) -> List[str]:
            """List available personas"""
            return list(self.personas.keys())
    
    
    def demonstrate_role_playing():
        """Demonstrate role-playing/persona patterns"""
        print("=" * 80)
        print("ROLE-PLAYING/PERSONA PATTERN DEMONSTRATION")
        print("=" * 80)
        
        agent = RolePlayingAgent()
        
        # Example 1: Doctor Persona
        print("\n" + "=" * 80)
        print("EXAMPLE 1: Doctor Persona - Health Consultation")
        print("=" * 80)
        
        health_question = "I've been feeling tired lately and having trouble sleeping. What could be causing this?"
        print(f"\nPatient: {health_question}")
        print(f"\nDr. Johnson:")
        doctor_response = agent.interact_with_persona("doctor", health_question, reset_history=True)
        print(doctor_response)
        
        # Follow-up
        followup = "I'm also drinking a lot of coffee throughout the day."
        print(f"\n\nPatient (follow-up): {followup}")
        print(f"\nDr. Johnson:")
        doctor_followup = agent.interact_with_persona("doctor", followup)
        print(doctor_followup)
        
        # Example 2: Teacher Persona
        print("\n" + "=" * 80)
        print("EXAMPLE 2: Teacher Persona - Explaining Complex Topic")
        print("=" * 80)
        
        learning_question = "Can you explain how photosynthesis works?"
        print(f"\nStudent: {learning_question}")
        print(f"\nProfessor Chen:")
        teacher_response = agent.interact_with_persona("teacher", learning_question, reset_history=True)
        print(teacher_response)
        
        # Example 3: Critic Persona
        print("\n" + "=" * 80)
        print("EXAMPLE 3: Critic Persona - Essay Review")
        print("=" * 80)
        
        essay = """My essay argues that social media has both positive and negative impacts on society. 
    It connects people but also spreads misinformation. It helps businesses but can harm mental health."""
        
        critique_request = f"Please review this essay introduction: {essay}"
        print(f"\nWriter: {critique_request}")
        print(f"\nMarcus Stone (Critic):")
        critic_response = agent.interact_with_persona("critic", critique_request, reset_history=True)
        print(critic_response)
        
        # Example 4: Coach Persona
        print("\n" + "=" * 80)
        print("EXAMPLE 4: Coach Persona - Goal Setting")
        print("=" * 80)
        
        goal_question = "I want to learn programming but I keep procrastinating. How can I stay motivated?"
        print(f"\nClient: {goal_question}")
        print(f"\nCoach Rivera:")
        coach_response = agent.interact_with_persona("coach", goal_question, reset_history=True)
        print(coach_response)
        
        # Example 5: Multi-Persona Analysis
        print("\n" + "=" * 80)
        print("EXAMPLE 5: Multi-Persona Analysis - Different Perspectives")
        print("=" * 80)
        
        question = "Should I pursue a career change at age 40?"
        print(f"\nQuestion: {question}")
        print("\nGetting perspectives from multiple personas...\n")
        
        personas_to_consult = ["coach", "analyst", "counselor"]
        # Note: counselor not defined, will be skipped
        personas_to_consult = ["coach", "analyst"]
        
        perspectives = agent.multi_persona_analysis(question, personas_to_consult)
        
        for persona_key, response in perspectives.items():
            persona = agent.get_persona_info(persona_key)
            print(f"\n{persona.name} ({persona.role}):")
            print("-" * 80)
            print(response)
        
        # Example 6: Persona Debate
        print("\n" + "=" * 80)
        print("EXAMPLE 6: Persona Debate - Creative vs Analyst")
        print("=" * 80)
        
        debate_topic = "What's more important for business success: creativity or data-driven decision making?"
        print(f"\nDebate Topic: {debate_topic}\n")
        
        debate_exchanges = agent.persona_debate(
            debate_topic,
            "creative",
            "analyst",
            rounds=2
        )
        
        for exchange in debate_exchanges:
            print(f"\nRound {exchange['round']} - {exchange['persona']}:")
            print("-" * 80)
            print(exchange['statement'])
        
        # Summary
        print("\n" + "=" * 80)
        print("ROLE-PLAYING/PERSONA PATTERN SUMMARY")
        print("=" * 80)
        print(f"""
    Role-Playing Pattern Benefits:
    1. Enhanced Expertise: Simulates domain-specific knowledge
    2. Consistent Personality: Maintains character across interactions
    3. Improved Engagement: More natural and relatable interactions
    4. Context-Appropriate: Responses match expected communication style
    5. Multi-Perspective Analysis: Diverse viewpoints on problems
    
    Key Personas Demonstrated:
    1. Doctor (Dr. Sarah Johnson): Empathetic health guidance
    2. Teacher (Prof. Alex Chen): Patient, step-by-step explanations
    3. Critic (Marcus Stone): Constructive analytical feedback
    4. Coach (Coach Sam Rivera): Motivational goal-setting support
    5. Analyst (Dr. Emily Watson): Data-driven strategic thinking
    6. Creative (Luna Martinez): Imaginative idea generation
    
    Persona Components:
    - Identity: Name, role, background
    - Expertise: Domain knowledge areas
    - Personality: Communication traits
    - Style: Tone, vocabulary, structure
    - Approach: Problem-solving methodology
    
    Best Practices:
    1. Define personas thoroughly with clear characteristics
    2. Maintain consistency across conversation turns
    3. Use appropriate disclaimers (especially for professional advice)
    4. Stay within persona's expertise boundaries
    5. Enable history for multi-turn conversations
    6. Test personas across diverse inputs
    7. Monitor for inappropriate or biased responses
    
    Advanced Techniques:
    1. Multi-Persona Analysis: Get diverse perspectives
    2. Persona Debates: Explore different viewpoints
    3. Dynamic Switching: Change personas based on context
    4. Persona Blending: Combine traits from multiple personas
    5. Adaptive Expertise: Adjust knowledge depth to user level
    
    Production Considerations:
    - Clear AI disclosure (users know it's AI)
    - Professional advice disclaimers
    - Content safety guardrails
    - Persona consistency monitoring
    - User feedback collection
    - Regular persona updates and improvements
    - A/B testing persona variations
    
    When to Use Role-Playing:
    - Domain-specific expertise needed
    - Consistent personality desired
    - Engagement and relatability important
    - Multiple perspectives valuable
    - Specialized communication style required
    
    Available Personas: {agent.list_personas()}
    """)
        
        print("\n" + "=" * 80)
        print("Pattern 084 (Role-Playing/Persona) demonstration complete!")
        print("=" * 80)
    
    
    if __name__ == "__main__":
        demonstrate_role_playing()
    
        

    Agentic Design Pattern: Role Playing

    Pattern 084: Role Playing – Line-by-Line Explanation

    Overview

    This document provides a detailed line-by-line explanation of the Role Playing pattern implementation.


    Pattern Description

    Pattern 084: Role-Playing/Persona Pattern

    Description: The Role-Playing/Persona pattern involves instructing the LLM to adopt a specific role, character, or persona when generating responses. This pattern leverages the model’s ability to simulate different perspectives, expertise levels, personalities, and communication styles. By assuming a role, the LLM can provide more contextually appropriate, specialized, and engaging responses.

    Role-playing is a powerful prompt engineering technique that:
    - Enhances response quality through perspective-taking
    - Enables domain expertise simulation (doctor, lawyer, scientist)
    - Creates consistent personality in conversational agents
    - Improves user engagement through character-based interaction
    - Allows multi-perspective analysis of problems
    

    Components: 1. Persona Definition – Identity (who the persona is) – Expertise (what they know) – Personality traits (how they communicate) – Background (relevant experience) – Goals and motivations

    2. Communication Style
       - Tone (formal, casual, friendly, professional)
       - Vocabulary level (simple, technical, academic)
       - Response structure (detailed, concise, step-by-step)
       - Interaction patterns (questioning, advising, teaching)
    
    3. Persona Consistency
       - Maintaining character across turns
       - Memory of previous interactions
       - Consistent viewpoint and opinions
       - Appropriate domain knowledge boundaries
    
    4. Context Adaptation
       - Adjusting expertise level to user
       - Situational awareness
       - Emotional intelligence
       - Cultural sensitivity
    

    Use Cases: 1. Expert Consultation – Medical advice (doctor persona) – Legal guidance (lawyer persona) – Technical support (engineer persona) – Financial planning (financial advisor persona) – Career counseling (career coach persona)

    2. Educational Applications
       - Patient teacher (explaining complex topics)
       - Socratic tutor (guiding through questions)
       - Encouraging mentor (motivating learners)
       - Strict examiner (testing knowledge)
    
    3. Creative Writing
       - Character dialogue generation
       - Story narration from specific viewpoint
       - Historical figure simulation
       - Fictional character interaction
    
    4. Business Applications
       - Sales representative (persuasive, customer-focused)
       - Customer service (empathetic, problem-solving)
       - Business analyst (analytical, data-driven)
       - Executive advisor (strategic, big-picture)
    
    5. Therapeutic and Counseling
       - Supportive friend (empathetic listener)
       - Life coach (motivational, goal-oriented)
       - Therapist (reflective, non-judgmental)
       - Meditation guide (calm, mindful)
    

    LangChain Implementation: LangChain facilitates role-playing through: – System message configuration (setting persona) – Context management (maintaining persona) – Memory integration (persona consistency) – Custom prompt templates (structured personas) – Chat history management (conversation continuity)

    Key Features: 1. Persona Library – Pre-defined expert personas – Customizable persona templates – Domain-specific knowledge bases – Personality trait combinations

    2. Dynamic Persona Switching
       - Context-aware persona selection
       - Smooth transitions between personas
       - Multi-persona conversations
       - Persona blending
    
    3. Expertise Calibration
       - Adjusting knowledge depth
       - Acknowledging limitations
       - Appropriate confidence levels
       - Domain boundary awareness
    
    4. Personality Traits
       - Empathy and emotional intelligence
       - Humor and engagement style
       - Assertiveness levels
       - Teaching vs directing approaches
    

    Best Practices: 1. Persona Definition – Be specific about role and expertise – Include relevant background details – Define communication style clearly – Set appropriate boundaries

    2. Consistency Maintenance
       - Use memory for multi-turn conversations
       - Reference persona context regularly
       - Maintain viewpoint across interactions
       - Avoid out-of-character responses
    
    3. Expertise Management
       - Stay within persona's knowledge domain
       - Acknowledge when unsure
       - Provide persona-appropriate disclaimers
       - Don't overreach expertise claims
    
    4. Engagement Optimization
       - Match tone to user expectations
       - Balance expertise with accessibility
       - Use persona-appropriate examples
       - Maintain engaging interaction style
    

    Trade-offs: Advantages: – Enhanced response quality and relevance – More engaging and natural interactions – Domain-specific expertise simulation – Consistent personality and tone – Better user trust and satisfaction – Multi-perspective problem analysis

    Disadvantages:
    - Requires detailed persona definitions
    - May limit flexibility in responses
    - Risk of inappropriate persona adoption
    - Can be perceived as deceptive if not transparent
    - Harder to maintain over long conversations
    - May introduce unwanted biases
    

    Production Considerations: 1. Transparency – Clearly indicate AI persona usage – Provide disclaimers for professional advice – Explain limitations of simulated expertise – Allow users to request different personas

    2. Safety and Ethics
       - Avoid harmful or inappropriate personas
       - Include safety guardrails
       - Monitor for persona misuse
       - Implement content filtering
       - Respect professional boundaries
    
    3. Quality Assurance
       - Test personas across diverse inputs
       - Validate expertise accuracy
       - Monitor consistency metrics
       - Gather user feedback
       - Regular persona updates
    
    4. Scalability
       - Modular persona definitions
       - Reusable persona components
       - Version control for personas
       - A/B test persona variations
       - Performance monitoring per persona
    
    5. Legal Compliance
       - Medical/legal advice disclaimers
       - Professional credential clarification
       - Terms of service alignment
       - Privacy considerations
       - Liability protection
    

    File Statistics

    • Total Lines: 706
    • Classes: 4
    • Functions: 1
    • Constants: 0

    Module Documentation

    """
    Pattern 084: Role-Playing/Persona Pattern
    
    Description:
        The Role-Playing/Persona pattern involves instructing the LLM to adopt a specific
        role, character, or persona when generating responses. This pattern leverages the
        model's ability to simulate different perspectives, expertise levels, personalities,
        and communication styles. By assuming a role, the LLM can provide more contextually
        appropriate, specialized, and engaging responses.
    
        Role-playing is a powerful prompt engineering technique that:
        - Enhances response quality through perspective-taking
        - Enables domain expertise simulation (doctor, lawyer, scientist)
        - Creates consistent personality in conversational agents
        - Improves user engagement through character-based interaction
        - Allows multi-perspective analysis of problems
    
    Components:
        1. Persona Definition
           - Identity (who the persona is)
           - Expertise (what they know)
           - Personality traits (how they communicate)
           - Background (relevant experience)
           - Goals and motivations
    
        2. Communication Style
           - Tone (formal, casual, friendly, professional)
           - Vocabulary level (simple, technical, academic)
           - Response structure (detailed, concise, step-by-step)
           - Interaction patterns (questioning, advising, teaching)
    
        3. Persona Consistency
           - Maintaining character across turns
           - Memory of previous interactions
           - Consistent viewpoint and opinions
           - Appropriate domain knowledge boundaries
    
        4. Context Adaptation
           - Adjusting expertise level to user
           - Situational awareness
           - Emotional intelligence
           - Cultural sensitivity
    
    Use Cases:
        1. Expert Consultation
           - Medical advice (doctor persona)
           - Legal guidance (lawyer persona)
           - Technical support (engineer persona)
           - Financial planning (financial advisor persona)
           - Career counseling (career coach persona)
    
        2. Educational Applications
           - Patient teacher (explaining complex topics)
           - Socratic tutor (guiding through questions)
           - Encouraging mentor (motivating learners)
           - Strict examiner (testing knowledge)
    
        3. Creative Writing
           - Character dialogue generation
           - Story narration from specific viewpoint
           - Historical figure simulation
           - Fictional character interaction
    
        4. Business Applications
           - Sales representative (persuasive, customer-focused)
           - Customer service (empathetic, problem-solving)
           - Business analyst (analytical, data-driven)
           - Executive advisor (strategic, big-picture)
    
        5. Therapeutic and Counseling
           - Supportive friend (empathetic listener)
           - Life coach (motivational, goal-oriented)
           - Therapist (reflective, non-judgmental)
           - Meditation guide (calm, mindful)
    
    LangChain Implementation:
        LangChain facilitates role-playing through:
        - System message configuration (setting persona)
        - Context management (maintaining persona)
        - Memory integration (persona consistency)
        - Custom prompt templates (structured personas)
        - Chat history management (conversation continuity)
    
    Key Features:
        1. Persona Library
           - Pre-defined expert personas
           - Customizable persona templates
           - Domain-specific knowledge bases
           - Personality trait combinations
    
        2. Dynamic Persona Switching
           - Context-aware persona selection
           - Smooth transitions between personas
           - Multi-persona conversations
           - Persona blending
    
        3. Expertise Calibration
           - Adjusting knowledge depth
           - Acknowledging limitations
           - Appropriate confidence levels
           - Domain boundary awareness
    
        4. Personality Traits
           - Empathy and emotional intelligence
           - Humor and engagement style
           - Assertiveness levels
           - Teaching vs directing approaches
    
    Best Practices:
        1. Persona Definition
           - Be specific about role and expertise
           - Include relevant background details
           - Define communication style clearly
           - Set appropriate boundaries
    
        2. Consistency Maintenance
           - Use memory for multi-turn conversations
           - Reference persona context regularly
           - Maintain viewpoint across interactions
           - Avoid out-of-character responses
    
        3. Expertise Management
           - Stay within persona's knowledge domain
           - Acknowledge when unsure
           - Provide persona-appropriate disclaimers
           - Don't overreach expertise claims
    
        4. Engagement Optimization
           - Match tone to user expectations
           - Balance expertise with accessibility
           - Use persona-appropriate examples
           - Maintain engaging interaction style
    
    Trade-offs:
        Advantages:
        - Enhanced response quality and relevance
        - More engaging and natural interactions
        - Domain-specific expertise simulation
        - Consistent personality and tone
        - Better user trust and satisfaction
        - Multi-perspective problem analysis
    
        Disadvantages:
        - Requires detailed persona definitions
        - May limit flexibility in responses
        - Risk of inappropriate persona adoption
        - Can be perceived as deceptive if not transparent
        - Harder to maintain over long conversations
        - May introduce unwanted biases
    
    Production Considerations:
        1. Transparency
           - Clearly indicate AI persona usage
           - Provide disclaimers for professional advice
           - Explain limitations of simulated expertise
           - Allow users to request different personas
    
        2. Safety and Ethics
           - Avoid harmful or inappropriate personas
           - Include safety guardrails
           - Monitor for persona misuse
           - Implement content filtering
           - Respect professional boundaries
    
        3. Quality Assurance
           - Test personas across diverse inputs
           - Validate expertise accuracy
           - Monitor consistency metrics
           - Gather user feedback
           - Regular persona updates
    
        4. Scalability
           - Modular persona definitions
           - Reusable persona components
           - Version control for personas
           - A/B test persona variations
           - Performance monitoring per persona
    
        5. Legal Compliance
           - Medical/legal advice disclaimers
           - Professional credential clarification
           - Terms of service alignment
           - Privacy considerations
           - Liability protection
    """
    

    Purpose: This module implements the Role Playing pattern, providing a structured approach to agent design and implementation.


    Import Statements

    Standard Library Imports

    import dataclasses.dataclass
    import enum.Enum
    import langchain_core.messages.AIMessage
    import langchain_core.messages.HumanMessage
    import langchain_core.messages.SystemMessage
    import langchain_core.output_parsers.StrOutputParser
    import langchain_core.prompts.ChatPromptTemplate
    import langchain_core.prompts.MessagesPlaceholder
    import os
    import typing.Any
    import typing.Dict
    import typing.List
    import typing.Optional
    

    Purpose: Core Python functionality: – dataclasses.dataclass: Simplified class definitions with @dataclass – enum.Enum: Enumeration support – langchain_core.messages.AIMessage: Regular expression operations – langchain_core.messages.HumanMessage: Regular expression operations – langchain_core.messages.SystemMessage: Regular expression operations – langchain_core.output_parsers.StrOutputParser: Regular expression operations – langchain_core.prompts.ChatPromptTemplate: Regular expression operations – langchain_core.prompts.MessagesPlaceholder: Regular expression operations – os: Environment variable access and system operations – typing.Any: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Dict: Type hints for better code documentation (List, Dict, Any, Optional) – typing.List: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Optional: Type hints for better code documentation (List, Dict, Any, Optional)

    LangChain Imports

    from langchain_openai.ChatOpenAI
    

    Purpose: LangChain framework components: – LLM Interface: Wrapper for OpenAI models – Chains: Composable building blocks for complex workflows

    Other Imports

    from dotenv.load_dotenv
    

    Purpose: Additional dependencies for specialized functionality.


    Classes

    Class: PersonaType

    Lines 201-210

    Inherits from: Enum

    Purpose:

    Types of personas
    

    Class: Persona

    Lines 214-222

    Purpose:

    Defines a role-playing persona
    

    Class: PersonaConfig

    Lines 226-231

    Purpose:

    Configuration for persona-based interaction
    

    Class: RolePlayingAgent

    Lines 234-531

    Purpose:

    Agent that adopts different personas for specialized interactions.
    
    This agent demonstrates:
    1. Multiple pre-defined personas
    2. Persona switching
    3. Consistent character maintenance
    4. Domain-specific expertise simulation
    

    Methods:

    __init__(self, config)

    Lines 245-258

    Purpose:

    Initialize role-playing agent.
    
    Args:
        config: Configuration for persona interactions
    

    Parameters: – config: Config

    _initialize_personas(self)

    Lines 260-390

    Purpose:

    Initialize library of personas
    

    Parameters:

    Returns: <ast.Subscript object at 0x000001A06D83E110>

    interact_with_persona(self, persona_key, user_message, reset_history)

    Lines 392-439

    Purpose:

    Interact with a specific persona.
    
    Args:
        persona_key: Key of persona to use
        user_message: User's message
        reset_history: Whether to reset conversation history
    
    Returns:
        Persona's response
    

    Parameters: – persona_key: Persona key – user_message: User message – reset_history: Reset history

    Returns: str

    multi_persona_analysis(self, question, persona_keys)

    Lines 441-464

    Purpose:

    Get perspectives from multiple personas.
    
    Args:
        question: Question to analyze
        persona_keys: List of persona keys to consult
    
    Returns:
        Dictionary of persona responses
    

    Parameters: – question: Question to answer – persona_keys: Persona keys

    Returns: <ast.Subscript object at 0x000001A06D6A9DD0>

    persona_debate(self, topic, persona1_key, persona2_key, rounds)

    Lines 466-523

    Purpose:

    Have two personas debate a topic.
    
    Args:
        topic: Topic to debate
        persona1_key: First persona key
        persona2_key: Second persona key
        rounds: Number of debate rounds
    
    Returns:
        List of debate exchanges
    

    Parameters: – topic: Topic – persona1_key: Persona1 key – persona2_key: Persona2 key – rounds: Rounds

    Returns: <ast.Subscript object at 0x000001A06D159F90>

    get_persona_info(self, persona_key)

    Lines 525-527

    Purpose:

    Get information about a persona
    

    Parameters: – persona_key: Persona key

    Returns: <ast.Subscript object at 0x000001A06D15AC10>

    list_personas(self)

    Lines 529-531

    Purpose:

    List available personas
    

    Parameters:

    Returns: <ast.Subscript object at 0x000001A06D60A810>


    Functions

    demonstrate_role_playing()

    Lines 534-701

    Purpose:

    Demonstrate role-playing/persona patterns
    

    Key Concepts Summary

    Pattern Overview

    The Role Playing pattern provides a structured approach to building AI agents with specific capabilities and behaviors. This implementation leverages LangChain’s composable components to create a robust and maintainable solution.

    Core Components

    1. Agent Class: Main implementation of the pattern logic
    2. Prompt Engineering: Carefully crafted prompts to guide LLM behavior
    3. Tool Integration: Optional tools for extended functionality
    4. Memory Management: State handling across interactions
    5. Output Parsing: Structured response processing

    When to Use

    ✅ Good for: – Scenarios requiring this specific pattern’s strengths – Applications needing structured agent behavior – Systems where explainability is important – Production environments requiring reliability

    ❌ Not ideal for: – Simple single-prompt tasks – Scenarios requiring different pattern characteristics – Resource-constrained environments (if computationally intensive)


    Best Practices Demonstrated

    1. Environment Configuration

    • ✅ Use .env files for API keys
    • ✅ Never hardcode credentials
    • ✅ Validate environment variables on startup

    2. Error Handling

    • ✅ Graceful degradation on failures
    • ✅ Informative error messages
    • ✅ Logging for debugging

    3. Prompt Engineering

    • ✅ Clear, specific instructions
    • ✅ Structured output formats
    • ✅ Few-shot examples when beneficial

    4. Code Organization

    • ✅ Separation of concerns (class-based design)
    • ✅ Type hints for clarity
    • ✅ Docstrings for documentation

    5. Performance Optimization

    • ✅ Appropriate temperature settings
    • ✅ Token budget management
    • ✅ Caching where applicable

    LangChain Components Used

    • ChatOpenAI: OpenAI model interface
    • Chains: Sequential component composition

    Why LangChain? – Composable abstractions for LLM applications – Rich ecosystem of integrations – Production-ready patterns – Active community and development


    Execution Flow

    1. Initialize agent with configuration
       ↓
    2. Load environment and dependencies
       ↓
    3. Prepare prompt with input data
       ↓
    4. Invoke LLM through LangChain
       ↓
    5. Parse and validate response
       ↓
    6. Return formatted result
    

    Key Decision Points: – Model selection (temperature, model type) – Prompt structure (few-shot vs zero-shot) – Error handling strategy – Output format validation


    Performance Considerations

    Computational Cost

    • LLM Calls: Primary cost factor (based on tokens)
    • Latency: Depends on model and input size
    • Memory: Minimal for most patterns

    Optimization Strategies

    1. Prompt Optimization: Minimize tokens while maintaining clarity
    2. Caching: Cache repeated queries/responses
    3. Model Selection: Use smaller models when appropriate
    4. Batch Processing: Group similar requests
    5. Streaming: For long responses, stream tokens

    Cost Estimates (Approximate)

    • GPT-3.5-turbo: ~$0.002 per request
    • GPT-4: ~$0.03 per request
    • GPT-4-turbo: ~$0.01 per request

    Actual costs vary based on input/output token counts


    Common Pitfalls to Avoid

    1. Prompt Design Issues

    ❌ Vague or ambiguous instructions
    ✅ Clear, specific, testable prompts

    2. Error Handling

    ❌ Ignoring API errors or rate limits
    ✅ Implement retry logic and graceful degradation

    3. Token Management

    ❌ Exceeding model token limits
    ✅ Truncate inputs, chunk processing

    4. Security

    ❌ Exposing API keys in code
    ✅ Use environment variables

    5. Testing

    ❌ Only testing happy paths
    ✅ Test edge cases, failures, malformed inputs

    6. Cost Management

    ❌ Unmonitored API usage
    ✅ Implement budgets, alerts, and monitoring


    Further Improvements

    Production Enhancements

    1. Monitoring: Add logging, metrics, tracing
    2. Validation: Input/output schema validation
    3. Rate Limiting: Implement request throttling
    4. Caching: Redis or in-memory cache for responses
    5. Async Support: Non-blocking operations for scalability

    Feature Extensions

    1. Multi-Model Support: Switch between providers
    2. Fallback Models: Graceful degradation strategy
    3. Custom Tools: Domain-specific function calling
    4. Advanced Memory: Vector stores for long-term memory
    5. Evaluation: Automated testing and benchmarking

    Code Quality

    1. Testing: Unit tests, integration tests
    2. Documentation: API docs, usage examples
    3. Type Safety: Stricter type hints
    4. Configuration: Externalized config files

    Related Patterns

    • Pattern 083
    • Pattern 085

    Pattern Families: – Reasoning Patterns (001-011) – Multi-Agent Patterns (012-019) – Tool Use Patterns (020-025) – Memory Patterns (026-031) – And many more…


    Summary

    The Role Playing pattern provides a powerful approach to building AI agents with specific capabilities. This implementation demonstrates:

    ✅ Key Strengths: – Clean, maintainable code structure – LangChain integration for composability – Type hints and documentation – Production-ready patterns

    🎯 Best Use Cases: – Applications requiring this pattern’s characteristics – Systems needing structured agent behavior – Production environments requiring reliability

    📚 Learning Resources: – LangChain Documentation: https://python.langchain.com/ – Pattern Documentation: See related patterns – OpenAI API Reference: https://platform.openai.com/docs/


    File: 084_role_playing.py
    Total Lines: 706
    Pattern Category: AI Agent Design Pattern #084


    Generated from actual implementation code
    For educational and reference purposes

  • Agentic Design Pattern: Few Shot Learning

    
        """
    Pattern 083: Few-Shot Learning Pattern
    
    Description:
        The Few-Shot Learning pattern uses example-based prompting to teach the LLM
        how to perform tasks through demonstrations. Instead of relying on zero-shot
        capabilities, this pattern provides the model with a few examples of input-output
        pairs that illustrate the desired behavior. This approach leverages the LLM's
        in-context learning abilities to generalize from examples.
    
        Few-shot learning is one of the most fundamental prompt engineering techniques
        and is particularly effective when:
        - The task format is non-standard or complex
        - Consistent output format is required
        - Specific style or tone needs to be maintained
        - Domain-specific knowledge needs to be demonstrated
        - Edge cases need to be handled in specific ways
    
    Components:
        1. Example Selection
           - Static examples (fixed set)
           - Dynamic examples (selected based on similarity)
           - Diverse examples (covering different scenarios)
           - Representative examples (typical cases)
    
        2. Example Formatting
           - Clear input-output structure
           - Consistent formatting across examples
           - Annotations and explanations (when needed)
           - Order considerations (easy to hard, chronological)
    
        3. Example Storage
           - In-prompt storage (small example sets)
           - Vector database storage (large example sets)
           - Retrieval mechanisms (similarity-based)
           - Example caching strategies
    
        4. Generalization Strategy
           - Pattern recognition from examples
           - Analogical reasoning
           - Template extraction
           - Feature learning
    
    Use Cases:
        1. Text Classification
           - Sentiment analysis with custom categories
           - Intent recognition for domain-specific applications
           - Content moderation with nuanced rules
           - Topic categorization with specific taxonomies
    
        2. Data Extraction
           - Structured information extraction from unstructured text
           - Entity recognition with custom entity types
           - Relationship extraction between entities
           - Attribute extraction with specific formats
    
        3. Code Generation
           - API usage examples for specific libraries
           - Code style consistency (following project conventions)
           - Design pattern implementation
           - Test case generation
    
        4. Creative Writing
           - Style mimicry (writing in specific author's style)
           - Format consistency (poems, stories, articles)
           - Tone control (formal, casual, humorous)
           - Genre-specific writing (sci-fi, mystery, romance)
    
        5. Translation and Transformation
           - Domain-specific translation (legal, medical, technical)
           - Format conversion (JSON to YAML, CSV to markdown)
           - Data normalization (various formats to standard)
           - Code refactoring patterns
    
    LangChain Implementation:
        LangChain provides excellent support for few-shot learning through:
        - FewShotChatMessagePromptTemplate for chat models
        - FewShotPromptTemplate for completion models
        - Example selectors (semantic similarity, length-based, max marginal relevance)
        - Vector store-backed example selection
        - Custom example formatting
    
    Key Features:
        1. Static Few-Shot Learning
           - Predefined set of examples
           - Fast and deterministic
           - Good for stable tasks
           - No retrieval overhead
    
        2. Dynamic Few-Shot Learning
           - Examples selected based on input similarity
           - More adaptive to diverse inputs
           - Requires vector database
           - Better generalization
    
        3. Example Quality Management
           - Diverse examples covering edge cases
           - Clear and unambiguous examples
           - Representative of target distribution
           - Regularly updated based on performance
    
        4. Performance Optimization
           - Token budget management (limiting example count)
           - Example compression (removing redundancy)
           - Caching frequently used example sets
           - Lazy loading for large example sets
    
    Best Practices:
        1. Example Selection
           - Use 3-5 examples for most tasks (sweet spot)
           - Include diverse examples covering different patterns
           - Order examples from simple to complex
           - Ensure examples are correct and high-quality
    
        2. Example Formatting
           - Use consistent structure across all examples
           - Clearly separate input from output
           - Add brief explanations for complex cases
           - Use delimiters to avoid confusion
    
        3. Dynamic Selection
           - Use semantic similarity for input-dependent selection
           - Balance diversity and relevance in selection
           - Cache embeddings for better performance
           - Set appropriate k value (number of examples)
    
        4. Iteration and Improvement
           - Start with few examples, add more if needed
           - A/B test different example sets
           - Monitor performance across different inputs
           - Update examples based on failure cases
    
    Trade-offs:
        Advantages:
        - Significantly improves task performance vs zero-shot
        - More reliable than instructions alone
        - Enables consistent output formatting
        - Works well for complex or ambiguous tasks
        - Reduces need for fine-tuning
    
        Disadvantages:
        - Increases token usage (more expensive)
        - May not scale to tasks requiring many examples
        - Examples can bias the model inappropriately
        - Requires careful example curation
        - Dynamic selection adds latency and complexity
    
    Production Considerations:
        1. Token Budget Management
           - Monitor tokens used by examples
           - Balance example count with context window
           - Use example compression when possible
           - Consider model's context limit
    
        2. Example Maintenance
           - Version control for example sets
           - Regular review and updates
           - Performance tracking per example
           - A/B testing of example variations
    
        3. Scalability
           - Cache example embeddings
           - Use efficient vector stores
           - Batch process when possible
           - Consider example pruning strategies
    
        4. Quality Assurance
           - Validate examples are correct
           - Test examples independently
           - Monitor output quality metrics
           - Handle example selection failures gracefully
    
        5. Cost Optimization
           - Balance example count with quality
           - Use dynamic selection judiciously
           - Cache common example sets
           - Monitor cost per query
    """
    
    import os
    from typing import List, Dict, Any, Optional
    from dataclasses import dataclass
    from enum import Enum
    from dotenv import load_dotenv
    
    from langchain_core.prompts import (
        ChatPromptTemplate,
        FewShotChatMessagePromptTemplate,
        PromptTemplate
    )
    from langchain_core.output_parsers import StrOutputParser
    from langchain_openai import ChatOpenAI, OpenAIEmbeddings
    from langchain_core.example_selectors import (
        SemanticSimilarityExampleSelector,
        MaxMarginalRelevanceExampleSelector
    )
    from langchain_chroma import Chroma
    
    load_dotenv()
    
    
    class ExampleSelectionStrategy(Enum):
        """Strategy for selecting examples"""
        STATIC = "static"  # Fixed set of examples
        SEMANTIC_SIMILARITY = "semantic_similarity"  # Based on input similarity
        MAX_MARGINAL_RELEVANCE = "max_marginal_relevance"  # Diverse + relevant
    
    
    @dataclass
    class FewShotExample:
        """Represents a single few-shot example"""
        input: str
        output: str
        explanation: Optional[str] = None
        metadata: Optional[Dict[str, Any]] = None
    
    
    @dataclass
    class FewShotConfig:
        """Configuration for few-shot learning"""
        num_examples: int = 3
        selection_strategy: ExampleSelectionStrategy = ExampleSelectionStrategy.STATIC
        temperature: float = 0.3
        model_name: str = "gpt-3.5-turbo"
        include_explanations: bool = False
    
    
    class FewShotLearningAgent:
        """
        Agent that uses few-shot learning to teach LLM through examples.
        
        This agent demonstrates various few-shot learning approaches:
        1. Static few-shot (fixed examples)
        2. Dynamic few-shot (similarity-based selection)
        3. Task-specific few-shot applications
        """
        
        def __init__(self, config: Optional[FewShotConfig] = None):
            """
            Initialize few-shot learning agent.
            
            Args:
                config: Configuration for few-shot learning
            """
            self.config = config or FewShotConfig()
            self.llm = ChatOpenAI(
                model=self.config.model_name,
                temperature=self.config.temperature
            )
            self.embeddings = OpenAIEmbeddings()
        
        def create_static_few_shot_chain(
            self,
            examples: List[FewShotExample],
            task_instruction: str,
            input_variable: str = "input"
        ):
            """
            Create a chain with static few-shot examples.
            
            Args:
                examples: List of few-shot examples
                task_instruction: Instruction for the task
                input_variable: Name of input variable
                
            Returns:
                Runnable chain with few-shot prompting
            """
            # Format examples as dictionaries
            example_dicts = [
                {"input": ex.input, "output": ex.output}
                for ex in examples
            ]
            
            # Create example prompt template
            example_prompt = ChatPromptTemplate.from_messages([
                ("human", "{input}"),
                ("ai", "{output}")
            ])
            
            # Create few-shot prompt
            few_shot_prompt = FewShotChatMessagePromptTemplate(
                example_prompt=example_prompt,
                examples=example_dicts
            )
            
            # Create final prompt
            final_prompt = ChatPromptTemplate.from_messages([
                ("system", task_instruction),
                few_shot_prompt,
                ("human", "{" + input_variable + "}")
            ])
            
            # Create chain
            chain = final_prompt | self.llm | StrOutputParser()
            
            return chain
        
        def create_dynamic_few_shot_chain(
            self,
            examples: List[FewShotExample],
            task_instruction: str,
            input_variable: str = "input",
            k: int = 3
        ):
            """
            Create a chain with dynamic example selection based on similarity.
            
            Args:
                examples: Pool of examples to select from
                task_instruction: Instruction for the task
                input_variable: Name of input variable
                k: Number of examples to select
                
            Returns:
                Runnable chain with dynamic few-shot prompting
            """
            # Format examples as dictionaries
            example_dicts = [
                {"input": ex.input, "output": ex.output}
                for ex in examples
            ]
            
            # Create example selector using semantic similarity
            example_selector = SemanticSimilarityExampleSelector.from_examples(
                example_dicts,
                self.embeddings,
                Chroma,
                k=k,
                input_keys=["input"]
            )
            
            # Create example prompt template
            example_prompt = ChatPromptTemplate.from_messages([
                ("human", "{input}"),
                ("ai", "{output}")
            ])
            
            # Create few-shot prompt with selector
            few_shot_prompt = FewShotChatMessagePromptTemplate(
                example_prompt=example_prompt,
                example_selector=example_selector,
                input_variables=[input_variable]
            )
            
            # Create final prompt
            final_prompt = ChatPromptTemplate.from_messages([
                ("system", task_instruction),
                few_shot_prompt,
                ("human", "{" + input_variable + "}")
            ])
            
            # Create chain
            chain = final_prompt | self.llm | StrOutputParser()
            
            return chain
        
        def sentiment_analysis_few_shot(
            self,
            text: str,
            examples: Optional[List[FewShotExample]] = None,
            use_dynamic: bool = False
        ) -> str:
            """
            Perform sentiment analysis using few-shot learning.
            
            Args:
                text: Text to analyze
                examples: Optional custom examples
                use_dynamic: Whether to use dynamic selection
                
            Returns:
                Sentiment classification
            """
            # Default examples if none provided
            if examples is None:
                examples = [
                    FewShotExample(
                        input="This movie was absolutely fantastic! I loved every minute.",
                        output="Positive"
                    ),
                    FewShotExample(
                        input="The product broke after one day. Terrible quality.",
                        output="Negative"
                    ),
                    FewShotExample(
                        input="It's okay, nothing special but not bad either.",
                        output="Neutral"
                    ),
                    FewShotExample(
                        input="I'm thrilled with this purchase! Exceeded expectations.",
                        output="Positive"
                    ),
                    FewShotExample(
                        input="Complete waste of money. Very disappointed.",
                        output="Negative"
                    )
                ]
            
            task_instruction = """You are a sentiment analyzer. Classify the sentiment of the given text as Positive, Negative, or Neutral.
    Look at the examples to understand the task."""
            
            # Create chain based on selection strategy
            if use_dynamic:
                chain = self.create_dynamic_few_shot_chain(
                    examples,
                    task_instruction,
                    k=3
                )
            else:
                # Use first 3 examples for static
                chain = self.create_static_few_shot_chain(
                    examples[:3],
                    task_instruction
                )
            
            result = chain.invoke({"input": text})
            return result
        
        def entity_extraction_few_shot(
            self,
            text: str,
            examples: Optional[List[FewShotExample]] = None
        ) -> str:
            """
            Extract entities using few-shot learning.
            
            Args:
                text: Text to extract entities from
                examples: Optional custom examples
                
            Returns:
                Extracted entities in JSON format
            """
            # Default examples
            if examples is None:
                examples = [
                    FewShotExample(
                        input="Apple Inc. announced a new iPhone model in Cupertino on September 12th.",
                        output='{"organization": "Apple Inc.", "product": "iPhone", "location": "Cupertino", "date": "September 12th"}'
                    ),
                    FewShotExample(
                        input="Elon Musk tweeted about Tesla's production numbers from the Fremont factory.",
                        output='{"person": "Elon Musk", "organization": "Tesla", "location": "Fremont factory"}'
                    ),
                    FewShotExample(
                        input="The meeting at Microsoft headquarters in Seattle was attended by Satya Nadella.",
                        output='{"organization": "Microsoft", "location": "Seattle", "person": "Satya Nadella"}'
                    )
                ]
            
            task_instruction = """Extract entities from the text and format them as JSON.
    Include: person, organization, location, date, product (if present).
    Follow the format shown in the examples."""
            
            chain = self.create_static_few_shot_chain(
                examples,
                task_instruction
            )
            
            result = chain.invoke({"input": text})
            return result
        
        def code_generation_few_shot(
            self,
            description: str,
            examples: Optional[List[FewShotExample]] = None
        ) -> str:
            """
            Generate code using few-shot learning.
            
            Args:
                description: Description of desired code
                examples: Optional custom examples
                
            Returns:
                Generated code
            """
            # Default examples
            if examples is None:
                examples = [
                    FewShotExample(
                        input="Create a function that returns the sum of two numbers",
                        output="""def add_numbers(a, b):
        \"\"\"Return the sum of two numbers.\"\"\"
        return a + b"""
                    ),
                    FewShotExample(
                        input="Create a function that checks if a string is a palindrome",
                        output="""def is_palindrome(s):
        \"\"\"Check if a string is a palindrome.\"\"\"
        return s == s[::-1]"""
                    ),
                    FewShotExample(
                        input="Create a function that finds the maximum value in a list",
                        output="""def find_max(lst):
        \"\"\"Find the maximum value in a list.\"\"\"
        if not lst:
            return None
        return max(lst)"""
                    )
                ]
            
            task_instruction = """Generate Python code based on the description.
    Follow the style and format shown in the examples.
    Include docstrings and proper formatting."""
            
            chain = self.create_static_few_shot_chain(
                examples,
                task_instruction,
                input_variable="input"
            )
            
            result = chain.invoke({"input": description})
            return result
        
        def style_transfer_few_shot(
            self,
            text: str,
            target_style: str,
            examples: Optional[List[FewShotExample]] = None
        ) -> str:
            """
            Transfer text to a specific style using few-shot learning.
            
            Args:
                text: Text to transform
                target_style: Target style (e.g., "formal", "casual", "poetic")
                examples: Optional custom examples
                
            Returns:
                Transformed text
            """
            # Style-specific examples
            style_examples = {
                "formal": [
                    FewShotExample(
                        input="Hey, can you help me out with this?",
                        output="I would appreciate your assistance with this matter."
                    ),
                    FewShotExample(
                        input="That's totally wrong!",
                        output="I respectfully disagree with that assessment."
                    ),
                    FewShotExample(
                        input="Thanks a lot for everything!",
                        output="I extend my sincere gratitude for your comprehensive support."
                    )
                ],
                "casual": [
                    FewShotExample(
                        input="I would like to request your assistance.",
                        output="Hey, could you help me out?"
                    ),
                    FewShotExample(
                        input="This is highly problematic.",
                        output="This is a real problem."
                    ),
                    FewShotExample(
                        input="I appreciate your effort.",
                        output="Thanks for trying!"
                    )
                ],
                "poetic": [
                    FewShotExample(
                        input="The sun set over the mountains.",
                        output="Golden rays bid farewell, as peaks embrace the fading light."
                    ),
                    FewShotExample(
                        input="Rain started falling.",
                        output="Heaven's tears descended, kissing the earth below."
                    ),
                    FewShotExample(
                        input="The bird flew away.",
                        output="On wings of freedom, it soared beyond the horizon's edge."
                    )
                ]
            }
            
            examples = examples or style_examples.get(target_style.lower(), [])
            
            if not examples:
                return "Style not supported. Available: formal, casual, poetic"
            
            task_instruction = f"""Transform the text into {target_style} style.
    Follow the transformation pattern shown in the examples."""
            
            chain = self.create_static_few_shot_chain(
                examples,
                task_instruction
            )
            
            result = chain.invoke({"input": text})
            return result
        
        def compare_zero_shot_vs_few_shot(
            self,
            text: str,
            task: str = "sentiment"
        ) -> Dict[str, str]:
            """
            Compare zero-shot vs few-shot performance.
            
            Args:
                text: Input text
                task: Task to perform
                
            Returns:
                Dictionary with both results
            """
            # Zero-shot prompt
            zero_shot_prompt = ChatPromptTemplate.from_messages([
                ("system", "Classify the sentiment as Positive, Negative, or Neutral."),
                ("human", "{input}")
            ])
            zero_shot_chain = zero_shot_prompt | self.llm | StrOutputParser()
            zero_shot_result = zero_shot_chain.invoke({"input": text})
            
            # Few-shot result
            few_shot_result = self.sentiment_analysis_few_shot(text)
            
            return {
                "zero_shot": zero_shot_result,
                "few_shot": few_shot_result
            }
    
    
    def demonstrate_few_shot_learning():
        """Demonstrate few-shot learning patterns"""
        print("=" * 80)
        print("FEW-SHOT LEARNING PATTERN DEMONSTRATION")
        print("=" * 80)
        
        agent = FewShotLearningAgent()
        
        # Example 1: Sentiment Analysis
        print("\n" + "=" * 80)
        print("EXAMPLE 1: Sentiment Analysis with Few-Shot Learning")
        print("=" * 80)
        
        test_texts = [
            "This restaurant exceeded all my expectations! Amazing food!",
            "The service was slow and the food was cold. Not going back.",
            "It was fine. Nothing special but acceptable."
        ]
        
        for text in test_texts:
            print(f"\nText: {text}")
            sentiment = agent.sentiment_analysis_few_shot(text)
            print(f"Sentiment: {sentiment}")
        
        # Example 2: Entity Extraction
        print("\n" + "=" * 80)
        print("EXAMPLE 2: Entity Extraction with Few-Shot Learning")
        print("=" * 80)
        
        test_text = "Jeff Bezos announced Amazon's expansion into the healthcare sector at a conference in Las Vegas last Monday."
        print(f"\nText: {test_text}")
        entities = agent.entity_extraction_few_shot(test_text)
        print(f"Entities: {entities}")
        
        # Example 3: Code Generation
        print("\n" + "=" * 80)
        print("EXAMPLE 3: Code Generation with Few-Shot Learning")
        print("=" * 80)
        
        code_requests = [
            "Create a function that calculates factorial of a number",
            "Create a function that reverses a string"
        ]
        
        for request in code_requests:
            print(f"\nRequest: {request}")
            code = agent.code_generation_few_shot(request)
            print(f"Generated Code:\n{code}")
        
        # Example 4: Style Transfer
        print("\n" + "=" * 80)
        print("EXAMPLE 4: Style Transfer with Few-Shot Learning")
        print("=" * 80)
        
        original_text = "I need your help with this problem."
        styles = ["formal", "casual", "poetic"]
        
        print(f"\nOriginal: {original_text}")
        for style in styles:
            transformed = agent.style_transfer_few_shot(original_text, style)
            print(f"{style.title()} style: {transformed}")
        
        # Example 5: Zero-Shot vs Few-Shot Comparison
        print("\n" + "=" * 80)
        print("EXAMPLE 5: Zero-Shot vs Few-Shot Comparison")
        print("=" * 80)
        
        ambiguous_text = "The movie was interesting and thought-provoking, though quite challenging to follow."
        print(f"\nAmbiguous Text: {ambiguous_text}")
        
        comparison = agent.compare_zero_shot_vs_few_shot(ambiguous_text)
        print(f"\nZero-Shot Result: {comparison['zero_shot']}")
        print(f"Few-Shot Result: {comparison['few_shot']}")
        print("\nNote: Few-shot learning often provides more consistent and format-compliant outputs")
        
        # Example 6: Dynamic Example Selection
        print("\n" + "=" * 80)
        print("EXAMPLE 6: Dynamic Example Selection (Similarity-Based)")
        print("=" * 80)
        
        test_text = "I'm so excited about this purchase! Best decision ever!"
        print(f"\nText: {test_text}")
        print("\nStatic Selection:")
        static_result = agent.sentiment_analysis_few_shot(test_text, use_dynamic=False)
        print(f"Result: {static_result}")
        
        print("\nDynamic Selection (picks most similar examples):")
        dynamic_result = agent.sentiment_analysis_few_shot(test_text, use_dynamic=True)
        print(f"Result: {dynamic_result}")
        
        # Summary
        print("\n" + "=" * 80)
        print("FEW-SHOT LEARNING SUMMARY")
        print("=" * 80)
        print("""
    Few-Shot Learning Pattern Benefits:
    1. Improved Accuracy: Examples guide the model to better performance
    2. Consistency: Output format matches examples consistently
    3. Task Clarity: Examples disambiguate task requirements
    4. Style Control: Examples demonstrate desired tone and style
    5. No Fine-Tuning: Achieves good results without model retraining
    
    Key Techniques Demonstrated:
    1. Static Few-Shot: Fixed examples for consistent tasks
    2. Dynamic Few-Shot: Similarity-based example selection
    3. Task-Specific Examples: Domain-appropriate demonstrations
    4. Style Transfer: Teaching specific writing styles
    5. Format Control: Ensuring structured outputs
    
    Best Practices:
    1. Use 3-5 examples for most tasks (sweet spot)
    2. Ensure examples are diverse and representative
    3. Order examples from simple to complex
    4. Include edge cases in examples
    5. Keep examples concise to save tokens
    6. Use dynamic selection for varied inputs
    7. Validate examples are correct and high-quality
    8. Monitor token usage and costs
    
    When to Use Few-Shot vs Zero-Shot:
    - Use few-shot when: output format is specific, task is ambiguous, consistency matters
    - Use zero-shot when: task is simple, tokens are limited, speed is critical
    - Use dynamic selection when: inputs are diverse, quality is paramount
    
    Production Considerations:
    - Cache example embeddings for performance
    - Monitor token usage (examples increase costs)
    - A/B test different example sets
    - Version control example datasets
    - Update examples based on failure cases
    - Balance example count with quality needs
    """)
        
        print("\n" + "=" * 80)
        print("Pattern 083 (Few-Shot Learning) demonstration complete!")
        print("=" * 80)
    
    
    if __name__ == "__main__":
        demonstrate_few_shot_learning()
    
        

    Agentic Design Pattern: Few Shot Learning

    Pattern 083: Few Shot Learning – Line-by-Line Explanation

    Overview

    This document provides a detailed line-by-line explanation of the Few Shot Learning pattern implementation.


    Pattern Description

    Pattern 083: Few-Shot Learning Pattern

    Description: The Few-Shot Learning pattern uses example-based prompting to teach the LLM how to perform tasks through demonstrations. Instead of relying on zero-shot capabilities, this pattern provides the model with a few examples of input-output pairs that illustrate the desired behavior. This approach leverages the LLM’s in-context learning abilities to generalize from examples.

    Few-shot learning is one of the most fundamental prompt engineering techniques
    and is particularly effective when:
    - The task format is non-standard or complex
    - Consistent output format is required
    - Specific style or tone needs to be maintained
    - Domain-specific knowledge needs to be demonstrated
    - Edge cases need to be handled in specific ways
    

    Components: 1. Example Selection – Static examples (fixed set) – Dynamic examples (selected based on similarity) – Diverse examples (covering different scenarios) – Representative examples (typical cases)

    2. Example Formatting
       - Clear input-output structure
       - Consistent formatting across examples
       - Annotations and explanations (when needed)
       - Order considerations (easy to hard, chronological)
    
    3. Example Storage
       - In-prompt storage (small example sets)
       - Vector database storage (large example sets)
       - Retrieval mechanisms (similarity-based)
       - Example caching strategies
    
    4. Generalization Strategy
       - Pattern recognition from examples
       - Analogical reasoning
       - Template extraction
       - Feature learning
    

    Use Cases: 1. Text Classification – Sentiment analysis with custom categories – Intent recognition for domain-specific applications – Content moderation with nuanced rules – Topic categorization with specific taxonomies

    2. Data Extraction
       - Structured information extraction from unstructured text
       - Entity recognition with custom entity types
       - Relationship extraction between entities
       - Attribute extraction with specific formats
    
    3. Code Generation
       - API usage examples for specific libraries
       - Code style consistency (following project conventions)
       - Design pattern implementation
       - Test case generation
    
    4. Creative Writing
       - Style mimicry (writing in specific author's style)
       - Format consistency (poems, stories, articles)
       - Tone control (formal, casual, humorous)
       - Genre-specific writing (sci-fi, mystery, romance)
    
    5. Translation and Transformation
       - Domain-specific translation (legal, medical, technical)
       - Format conversion (JSON to YAML, CSV to markdown)
       - Data normalization (various formats to standard)
       - Code refactoring patterns
    

    LangChain Implementation: LangChain provides excellent support for few-shot learning through: – FewShotChatMessagePromptTemplate for chat models – FewShotPromptTemplate for completion models – Example selectors (semantic similarity, length-based, max marginal relevance) – Vector store-backed example selection – Custom example formatting

    Key Features: 1. Static Few-Shot Learning – Predefined set of examples – Fast and deterministic – Good for stable tasks – No retrieval overhead

    2. Dynamic Few-Shot Learning
       - Examples selected based on input similarity
       - More adaptive to diverse inputs
       - Requires vector database
       - Better generalization
    
    3. Example Quality Management
       - Diverse examples covering edge cases
       - Clear and unambiguous examples
       - Representative of target distribution
       - Regularly updated based on performance
    
    4. Performance Optimization
       - Token budget management (limiting example count)
       - Example compression (removing redundancy)
       - Caching frequently used example sets
       - Lazy loading for large example sets
    

    Best Practices: 1. Example Selection – Use 3-5 examples for most tasks (sweet spot) – Include diverse examples covering different patterns – Order examples from simple to complex – Ensure examples are correct and high-quality

    2. Example Formatting
       - Use consistent structure across all examples
       - Clearly separate input from output
       - Add brief explanations for complex cases
       - Use delimiters to avoid confusion
    
    3. Dynamic Selection
       - Use semantic similarity for input-dependent selection
       - Balance diversity and relevance in selection
       - Cache embeddings for better performance
       - Set appropriate k value (number of examples)
    
    4. Iteration and Improvement
       - Start with few examples, add more if needed
       - A/B test different example sets
       - Monitor performance across different inputs
       - Update examples based on failure cases
    

    Trade-offs: Advantages: – Significantly improves task performance vs zero-shot – More reliable than instructions alone – Enables consistent output formatting – Works well for complex or ambiguous tasks – Reduces need for fine-tuning

    Disadvantages:
    - Increases token usage (more expensive)
    - May not scale to tasks requiring many examples
    - Examples can bias the model inappropriately
    - Requires careful example curation
    - Dynamic selection adds latency and complexity
    

    Production Considerations: 1. Token Budget Management – Monitor tokens used by examples – Balance example count with context window – Use example compression when possible – Consider model’s context limit

    2. Example Maintenance
       - Version control for example sets
       - Regular review and updates
       - Performance tracking per example
       - A/B testing of example variations
    
    3. Scalability
       - Cache example embeddings
       - Use efficient vector stores
       - Batch process when possible
       - Consider example pruning strategies
    
    4. Quality Assurance
       - Validate examples are correct
       - Test examples independently
       - Monitor output quality metrics
       - Handle example selection failures gracefully
    
    5. Cost Optimization
       - Balance example count with quality
       - Use dynamic selection judiciously
       - Cache common example sets
       - Monitor cost per query
    

    File Statistics

    • Total Lines: 768
    • Classes: 4
    • Functions: 1
    • Constants: 0

    Module Documentation

    """
    Pattern 083: Few-Shot Learning Pattern
    
    Description:
        The Few-Shot Learning pattern uses example-based prompting to teach the LLM
        how to perform tasks through demonstrations. Instead of relying on zero-shot
        capabilities, this pattern provides the model with a few examples of input-output
        pairs that illustrate the desired behavior. This approach leverages the LLM's
        in-context learning abilities to generalize from examples.
    
        Few-shot learning is one of the most fundamental prompt engineering techniques
        and is particularly effective when:
        - The task format is non-standard or complex
        - Consistent output format is required
        - Specific style or tone needs to be maintained
        - Domain-specific knowledge needs to be demonstrated
        - Edge cases need to be handled in specific ways
    
    Components:
        1. Example Selection
           - Static examples (fixed set)
           - Dynamic examples (selected based on similarity)
           - Diverse examples (covering different scenarios)
           - Representative examples (typical cases)
    
        2. Example Formatting
           - Clear input-output structure
           - Consistent formatting across examples
           - Annotations and explanations (when needed)
           - Order considerations (easy to hard, chronological)
    
        3. Example Storage
           - In-prompt storage (small example sets)
           - Vector database storage (large example sets)
           - Retrieval mechanisms (similarity-based)
           - Example caching strategies
    
        4. Generalization Strategy
           - Pattern recognition from examples
           - Analogical reasoning
           - Template extraction
           - Feature learning
    
    Use Cases:
        1. Text Classification
           - Sentiment analysis with custom categories
           - Intent recognition for domain-specific applications
           - Content moderation with nuanced rules
           - Topic categorization with specific taxonomies
    
        2. Data Extraction
           - Structured information extraction from unstructured text
           - Entity recognition with custom entity types
           - Relationship extraction between entities
           - Attribute extraction with specific formats
    
        3. Code Generation
           - API usage examples for specific libraries
           - Code style consistency (following project conventions)
           - Design pattern implementation
           - Test case generation
    
        4. Creative Writing
           - Style mimicry (writing in specific author's style)
           - Format consistency (poems, stories, articles)
           - Tone control (formal, casual, humorous)
           - Genre-specific writing (sci-fi, mystery, romance)
    
        5. Translation and Transformation
           - Domain-specific translation (legal, medical, technical)
           - Format conversion (JSON to YAML, CSV to markdown)
           - Data normalization (various formats to standard)
           - Code refactoring patterns
    
    LangChain Implementation:
        LangChain provides excellent support for few-shot learning through:
        - FewShotChatMessagePromptTemplate for chat models
        - FewShotPromptTemplate for completion models
        - Example selectors (semantic similarity, length-based, max marginal relevance)
        - Vector store-backed example selection
        - Custom example formatting
    
    Key Features:
        1. Static Few-Shot Learning
           - Predefined set of examples
           - Fast and deterministic
           - Good for stable tasks
           - No retrieval overhead
    
        2. Dynamic Few-Shot Learning
           - Examples selected based on input similarity
           - More adaptive to diverse inputs
           - Requires vector database
           - Better generalization
    
        3. Example Quality Management
           - Diverse examples covering edge cases
           - Clear and unambiguous examples
           - Representative of target distribution
           - Regularly updated based on performance
    
        4. Performance Optimization
           - Token budget management (limiting example count)
           - Example compression (removing redundancy)
           - Caching frequently used example sets
           - Lazy loading for large example sets
    
    Best Practices:
        1. Example Selection
           - Use 3-5 examples for most tasks (sweet spot)
           - Include diverse examples covering different patterns
           - Order examples from simple to complex
           - Ensure examples are correct and high-quality
    
        2. Example Formatting
           - Use consistent structure across all examples
           - Clearly separate input from output
           - Add brief explanations for complex cases
           - Use delimiters to avoid confusion
    
        3. Dynamic Selection
           - Use semantic similarity for input-dependent selection
           - Balance diversity and relevance in selection
           - Cache embeddings for better performance
           - Set appropriate k value (number of examples)
    
        4. Iteration and Improvement
           - Start with few examples, add more if needed
           - A/B test different example sets
           - Monitor performance across different inputs
           - Update examples based on failure cases
    
    Trade-offs:
        Advantages:
        - Significantly improves task performance vs zero-shot
        - More reliable than instructions alone
        - Enables consistent output formatting
        - Works well for complex or ambiguous tasks
        - Reduces need for fine-tuning
    
        Disadvantages:
        - Increases token usage (more expensive)
        - May not scale to tasks requiring many examples
        - Examples can bias the model inappropriately
        - Requires careful example curation
        - Dynamic selection adds latency and complexity
    
    Production Considerations:
        1. Token Budget Management
           - Monitor tokens used by examples
           - Balance example count with context window
           - Use example compression when possible
           - Consider model's context limit
    
        2. Example Maintenance
           - Version control for example sets
           - Regular review and updates
           - Performance tracking per example
           - A/B testing of example variations
    
        3. Scalability
           - Cache example embeddings
           - Use efficient vector stores
           - Batch process when possible
           - Consider example pruning strategies
    
        4. Quality Assurance
           - Validate examples are correct
           - Test examples independently
           - Monitor output quality metrics
           - Handle example selection failures gracefully
    
        5. Cost Optimization
           - Balance example count with quality
           - Use dynamic selection judiciously
           - Cache common example sets
           - Monitor cost per query
    """
    

    Purpose: This module implements the Few Shot Learning pattern, providing a structured approach to agent design and implementation.


    Import Statements

    Standard Library Imports

    import dataclasses.dataclass
    import enum.Enum
    import langchain_core.example_selectors.MaxMarginalRelevanceExampleSelector
    import langchain_core.example_selectors.SemanticSimilarityExampleSelector
    import langchain_core.output_parsers.StrOutputParser
    import langchain_core.prompts.ChatPromptTemplate
    import langchain_core.prompts.FewShotChatMessagePromptTemplate
    import langchain_core.prompts.PromptTemplate
    import os
    import typing.Any
    import typing.Dict
    import typing.List
    import typing.Optional
    

    Purpose: Core Python functionality: – dataclasses.dataclass: Simplified class definitions with @dataclass – enum.Enum: Enumeration support – langchain_core.example_selectors.MaxMarginalRelevanceExampleSelector: Regular expression operations – langchain_core.example_selectors.SemanticSimilarityExampleSelector: Regular expression operations – langchain_core.output_parsers.StrOutputParser: Regular expression operations – langchain_core.prompts.ChatPromptTemplate: Regular expression operations – langchain_core.prompts.FewShotChatMessagePromptTemplate: Regular expression operations – langchain_core.prompts.PromptTemplate: Regular expression operations – os: Environment variable access and system operations – typing.Any: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Dict: Type hints for better code documentation (List, Dict, Any, Optional) – typing.List: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Optional: Type hints for better code documentation (List, Dict, Any, Optional)

    LangChain Imports

    from langchain_chroma.Chroma
    from langchain_openai.ChatOpenAI
    from langchain_openai.OpenAIEmbeddings
    

    Purpose: LangChain framework components: – LLM Interface: Wrapper for OpenAI models – Chains: Composable building blocks for complex workflows

    Other Imports

    from dotenv.load_dotenv
    

    Purpose: Additional dependencies for specialized functionality.


    Classes

    Class: ExampleSelectionStrategy

    Lines 202-206

    Inherits from: Enum

    Purpose:

    Strategy for selecting examples
    

    Class: FewShotExample

    Lines 210-215

    Purpose:

    Represents a single few-shot example
    

    Class: FewShotConfig

    Lines 219-225

    Purpose:

    Configuration for few-shot learning
    

    Class: FewShotLearningAgent

    Lines 228-625

    Purpose:

    Agent that uses few-shot learning to teach LLM through examples.
    
    This agent demonstrates various few-shot learning approaches:
    1. Static few-shot (fixed examples)
    2. Dynamic few-shot (similarity-based selection)
    3. Task-specific few-shot applications
    

    Methods:

    __init__(self, config)

    Lines 238-250

    Purpose:

    Initialize few-shot learning agent.
    
    Args:
        config: Configuration for few-shot learning
    

    Parameters: – config: Config

    create_static_few_shot_chain(self, examples, task_instruction, input_variable)

    Lines 252-297

    Purpose:

    Create a chain with static few-shot examples.
    
    Args:
        examples: List of few-shot examples
        task_instruction: Instruction for the task
        input_variable: Name of input variable
    
    Returns:
        Runnable chain with few-shot prompting
    

    Parameters: – examples: Examples – task_instruction: Task instruction – input_variable: Input data

    create_dynamic_few_shot_chain(self, examples, task_instruction, input_variable, k)

    Lines 299-356

    Purpose:

    Create a chain with dynamic example selection based on similarity.
    
    Args:
        examples: Pool of examples to select from
        task_instruction: Instruction for the task
        input_variable: Name of input variable
        k: Number of examples to select
    
    Returns:
        Runnable chain with dynamic few-shot prompting
    

    Parameters: – examples: Examples – task_instruction: Task instruction – input_variable: Input data – k: K

    sentiment_analysis_few_shot(self, text, examples, use_dynamic)

    Lines 358-418

    Purpose:

    Perform sentiment analysis using few-shot learning.
    
    Args:
        text: Text to analyze
        examples: Optional custom examples
        use_dynamic: Whether to use dynamic selection
    
    Returns:
        Sentiment classification
    

    Parameters: – text: Text – examples: Examples – use_dynamic: Use dynamic

    Returns: str

    entity_extraction_few_shot(self, text, examples)

    Lines 420-462

    Purpose:

    Extract entities using few-shot learning.
    
    Args:
        text: Text to extract entities from
        examples: Optional custom examples
    
    Returns:
        Extracted entities in JSON format
    

    Parameters: – text: Text – examples: Examples

    Returns: str

    code_generation_few_shot(self, description, examples)

    Lines 464-515

    Purpose:

    Generate code using few-shot learning.
    
    Args:
        description: Description of desired code
        examples: Optional custom examples
    
    Returns:
        Generated code
    

    Parameters: – description: Description – examples: Examples

    Returns: str

    style_transfer_few_shot(self, text, target_style, examples)

    Lines 517-594

    Purpose:

    Transfer text to a specific style using few-shot learning.
    
    Args:
        text: Text to transform
        target_style: Target style (e.g., "formal", "casual", "poetic")
        examples: Optional custom examples
    
    Returns:
        Transformed text
    

    Parameters: – text: Text – target_style: Target style – examples: Examples

    Returns: str

    compare_zero_shot_vs_few_shot(self, text, task)

    Lines 596-625

    Purpose:

    Compare zero-shot vs few-shot performance.
    
    Args:
        text: Input text
        task: Task to perform
    
    Returns:
        Dictionary with both results
    

    Parameters: – text: Text – task: Task

    Returns: <ast.Subscript object at 0x000001A06D853AD0>


    Functions

    demonstrate_few_shot_learning()

    Lines 628-763

    Purpose:

    Demonstrate few-shot learning patterns
    

    Key Concepts Summary

    Pattern Overview

    The Few Shot Learning pattern provides a structured approach to building AI agents with specific capabilities and behaviors. This implementation leverages LangChain’s composable components to create a robust and maintainable solution.

    Core Components

    1. Agent Class: Main implementation of the pattern logic
    2. Prompt Engineering: Carefully crafted prompts to guide LLM behavior
    3. Tool Integration: Optional tools for extended functionality
    4. Memory Management: State handling across interactions
    5. Output Parsing: Structured response processing

    When to Use

    ✅ Good for: – Scenarios requiring this specific pattern’s strengths – Applications needing structured agent behavior – Systems where explainability is important – Production environments requiring reliability

    ❌ Not ideal for: – Simple single-prompt tasks – Scenarios requiring different pattern characteristics – Resource-constrained environments (if computationally intensive)


    Best Practices Demonstrated

    1. Environment Configuration

    • ✅ Use .env files for API keys
    • ✅ Never hardcode credentials
    • ✅ Validate environment variables on startup

    2. Error Handling

    • ✅ Graceful degradation on failures
    • ✅ Informative error messages
    • ✅ Logging for debugging

    3. Prompt Engineering

    • ✅ Clear, specific instructions
    • ✅ Structured output formats
    • ✅ Few-shot examples when beneficial

    4. Code Organization

    • ✅ Separation of concerns (class-based design)
    • ✅ Type hints for clarity
    • ✅ Docstrings for documentation

    5. Performance Optimization

    • ✅ Appropriate temperature settings
    • ✅ Token budget management
    • ✅ Caching where applicable

    LangChain Components Used

    • ChatOpenAI: OpenAI model interface
    • Chains: Sequential component composition

    Why LangChain? – Composable abstractions for LLM applications – Rich ecosystem of integrations – Production-ready patterns – Active community and development


    Execution Flow

    1. Initialize agent with configuration
       ↓
    2. Load environment and dependencies
       ↓
    3. Prepare prompt with input data
       ↓
    4. Invoke LLM through LangChain
       ↓
    5. Parse and validate response
       ↓
    6. Return formatted result
    

    Key Decision Points: – Model selection (temperature, model type) – Prompt structure (few-shot vs zero-shot) – Error handling strategy – Output format validation


    Performance Considerations

    Computational Cost

    • LLM Calls: Primary cost factor (based on tokens)
    • Latency: Depends on model and input size
    • Memory: Minimal for most patterns

    Optimization Strategies

    1. Prompt Optimization: Minimize tokens while maintaining clarity
    2. Caching: Cache repeated queries/responses
    3. Model Selection: Use smaller models when appropriate
    4. Batch Processing: Group similar requests
    5. Streaming: For long responses, stream tokens

    Cost Estimates (Approximate)

    • GPT-3.5-turbo: ~$0.002 per request
    • GPT-4: ~$0.03 per request
    • GPT-4-turbo: ~$0.01 per request

    Actual costs vary based on input/output token counts


    Common Pitfalls to Avoid

    1. Prompt Design Issues

    ❌ Vague or ambiguous instructions
    ✅ Clear, specific, testable prompts

    2. Error Handling

    ❌ Ignoring API errors or rate limits
    ✅ Implement retry logic and graceful degradation

    3. Token Management

    ❌ Exceeding model token limits
    ✅ Truncate inputs, chunk processing

    4. Security

    ❌ Exposing API keys in code
    ✅ Use environment variables

    5. Testing

    ❌ Only testing happy paths
    ✅ Test edge cases, failures, malformed inputs

    6. Cost Management

    ❌ Unmonitored API usage
    ✅ Implement budgets, alerts, and monitoring


    Further Improvements

    Production Enhancements

    1. Monitoring: Add logging, metrics, tracing
    2. Validation: Input/output schema validation
    3. Rate Limiting: Implement request throttling
    4. Caching: Redis or in-memory cache for responses
    5. Async Support: Non-blocking operations for scalability

    Feature Extensions

    1. Multi-Model Support: Switch between providers
    2. Fallback Models: Graceful degradation strategy
    3. Custom Tools: Domain-specific function calling
    4. Advanced Memory: Vector stores for long-term memory
    5. Evaluation: Automated testing and benchmarking

    Code Quality

    1. Testing: Unit tests, integration tests
    2. Documentation: API docs, usage examples
    3. Type Safety: Stricter type hints
    4. Configuration: Externalized config files

    Related Patterns

    • Pattern 082
    • Pattern 084

    Pattern Families: – Reasoning Patterns (001-011) – Multi-Agent Patterns (012-019) – Tool Use Patterns (020-025) – Memory Patterns (026-031) – And many more…


    Summary

    The Few Shot Learning pattern provides a powerful approach to building AI agents with specific capabilities. This implementation demonstrates:

    ✅ Key Strengths: – Clean, maintainable code structure – LangChain integration for composability – Type hints and documentation – Production-ready patterns

    🎯 Best Use Cases: – Applications requiring this pattern’s characteristics – Systems needing structured agent behavior – Production environments requiring reliability

    📚 Learning Resources: – LangChain Documentation: https://python.langchain.com/ – Pattern Documentation: See related patterns – OpenAI API Reference: https://platform.openai.com/docs/


    File: 083_few_shot_learning.py
    Total Lines: 768
    Pattern Category: AI Agent Design Pattern #083


    Generated from actual implementation code
    For educational and reference purposes

  • Agentic Design Pattern: Serverless Agent

    
        """
    Pattern 082: Serverless Agent
    
    Description:
        A Serverless Agent runs on serverless computing platforms (AWS Lambda,
        Azure Functions, Google Cloud Functions) where infrastructure is fully
        managed by the cloud provider. This pattern enables event-driven, auto-scaling
        AI agents that only consume resources when invoked, optimizing costs and
        operational overhead.
        
        The agent is designed for stateless execution, cold start optimization,
        event-driven triggers, and seamless scaling from zero to thousands of
        concurrent executions without manual intervention.
    
    Components:
        1. Function Handler: Entry point for serverless execution
        2. Event Processor: Processes various event types
        3. State Manager: External state storage (S3, DynamoDB)
        4. Cold Start Optimizer: Minimizes initialization time
        5. Environment Manager: Configuration and secrets
        6. Response Builder: Formats function responses
        7. Error Handler: Graceful error handling
        8. Metrics Collector: CloudWatch/monitoring integration
    
    Key Features:
        - Stateless execution model
        - Event-driven triggers
        - Auto-scaling from zero
        - Pay-per-execution pricing
        - No server management
        - Built-in fault tolerance
        - Managed infrastructure
        - Cold start optimization
        - Multiple trigger sources
        - Seamless integration with cloud services
    
    Use Cases:
        - API endpoints for AI services
        - Event-driven AI processing
        - Webhook handlers
        - Scheduled AI tasks
        - Image/document processing
        - Real-time data transformation
        - Chatbot backends
        - ETL pipelines
        - IoT data processing
        - Microservices backends
    
    LangChain Implementation:
        Simulates AWS Lambda-style function handlers with event processing,
        stateless execution, and external state management patterns.
    """
    
    import os
    import time
    import json
    import uuid
    from typing import List, Dict, Any, Optional, Callable
    from dataclasses import dataclass, field
    from enum import Enum
    from datetime import datetime
    from collections import defaultdict
    from dotenv import load_dotenv
    
    from langchain_core.prompts import ChatPromptTemplate
    from langchain_core.output_parsers import StrOutputParser
    from langchain_openai import ChatOpenAI
    
    load_dotenv()
    
    
    class TriggerType(Enum):
        """Types of serverless triggers"""
        HTTP_API = "http_api"
        S3_EVENT = "s3_event"
        DYNAMODB_STREAM = "dynamodb_stream"
        SNS_MESSAGE = "sns_message"
        SQS_QUEUE = "sqs_queue"
        SCHEDULED = "scheduled"
        WEBHOOK = "webhook"
        IOT_EVENT = "iot_event"
    
    
    class ExecutionStatus(Enum):
        """Status of function execution"""
        COLD_START = "cold_start"
        WARM_START = "warm_start"
        RUNNING = "running"
        COMPLETED = "completed"
        FAILED = "failed"
        TIMEOUT = "timeout"
    
    
    @dataclass
    class ServerlessEvent:
        """Event that triggers serverless function"""
        event_id: str
        trigger_type: TriggerType
        timestamp: datetime
        data: Dict[str, Any]
        headers: Dict[str, str] = field(default_factory=dict)
        metadata: Dict[str, Any] = field(default_factory=dict)
    
    
    @dataclass
    class ServerlessContext:
        """Execution context for serverless function"""
        request_id: str
        function_name: str
        function_version: str
        memory_limit_mb: int
        timeout_seconds: int
        remaining_time_ms: int
        cold_start: bool = True
        invocation_count: int = 0
    
    
    @dataclass
    class ServerlessResponse:
        """Response from serverless function"""
        status_code: int
        body: Any
        headers: Dict[str, str] = field(default_factory=dict)
        error: Optional[str] = None
        execution_duration_ms: float = 0.0
        cold_start: bool = False
        memory_used_mb: float = 0.0
    
    
    @dataclass
    class FunctionMetrics:
        """Metrics for serverless function"""
        function_name: str
        invocations: int = 0
        errors: int = 0
        cold_starts: int = 0
        warm_starts: int = 0
        total_duration_ms: float = 0.0
        average_duration_ms: float = 0.0
        max_duration_ms: float = 0.0
        min_duration_ms: float = float('inf')
    
    
    class ServerlessAgent:
        """
        Base serverless agent with stateless execution.
        
        Designed for serverless platforms with event-driven triggers,
        cold start optimization, and external state management.
        """
        
        # Class-level cache (simulates container reuse)
        _warm_instances: Dict[str, 'ServerlessAgent'] = {}
        _llm_cache: Optional[ChatOpenAI] = None
        
        def __init__(
            self,
            function_name: str,
            memory_limit_mb: int = 512,
            timeout_seconds: int = 30
        ):
            """
            Initialize serverless agent.
            
            Args:
                function_name: Name of the function
                memory_limit_mb: Memory limit
                timeout_seconds: Execution timeout
            """
            self.function_name = function_name
            self.memory_limit_mb = memory_limit_mb
            self.timeout_seconds = timeout_seconds
            
            self.invocation_count = 0
            self.metrics = FunctionMetrics(function_name=function_name)
            
            # Initialize LLM (reuse cached if available)
            if ServerlessAgent._llm_cache is None:
                ServerlessAgent._llm_cache = ChatOpenAI(
                    model="gpt-3.5-turbo",
                    temperature=0.7
                )
            
            self.llm = ServerlessAgent._llm_cache
        
        @classmethod
        def get_or_create(cls, function_name: str) -> 'ServerlessAgent':
            """
            Get warm instance or create new (simulates Lambda container reuse).
            
            Args:
                function_name: Function name
                
            Returns:
                ServerlessAgent instance
            """
            if function_name in cls._warm_instances:
                return cls._warm_instances[function_name]
            
            instance = cls(function_name)
            cls._warm_instances[function_name] = instance
            return instance
        
        def handler(
            self,
            event: ServerlessEvent,
            context: ServerlessContext
        ) -> ServerlessResponse:
            """
            Main handler function (entry point).
            
            Args:
                event: Triggering event
                context: Execution context
                
            Returns:
                ServerlessResponse
            """
            start_time = time.time()
            
            self.invocation_count += 1
            context.invocation_count = self.invocation_count
            
            # Track metrics
            self.metrics.invocations += 1
            if context.cold_start:
                self.metrics.cold_starts += 1
            else:
                self.metrics.warm_starts += 1
            
            try:
                # Process event based on trigger type
                result = self._process_event(event, context)
                
                execution_duration = (time.time() - start_time) * 1000
                
                # Update metrics
                self.metrics.total_duration_ms += execution_duration
                self.metrics.average_duration_ms = (
                    self.metrics.total_duration_ms / self.metrics.invocations
                )
                self.metrics.max_duration_ms = max(
                    self.metrics.max_duration_ms,
                    execution_duration
                )
                self.metrics.min_duration_ms = min(
                    self.metrics.min_duration_ms,
                    execution_duration
                )
                
                return ServerlessResponse(
                    status_code=200,
                    body=result,
                    headers={"Content-Type": "application/json"},
                    execution_duration_ms=execution_duration,
                    cold_start=context.cold_start,
                    memory_used_mb=self.memory_limit_mb * 0.6  # Simulated
                )
                
            except Exception as e:
                self.metrics.errors += 1
                
                return ServerlessResponse(
                    status_code=500,
                    body=None,
                    error=str(e),
                    execution_duration_ms=(time.time() - start_time) * 1000,
                    cold_start=context.cold_start
                )
        
        def _process_event(
            self,
            event: ServerlessEvent,
            context: ServerlessContext
        ) -> Dict[str, Any]:
            """
            Process event (to be overridden by subclasses).
            
            Args:
                event: Event to process
                context: Execution context
                
            Returns:
                Processing result
            """
            return {
                "message": "Event processed",
                "event_id": event.event_id,
                "function": self.function_name
            }
    
    
    class TextProcessingFunction(ServerlessAgent):
        """Serverless function for text processing"""
        
        def __init__(self):
            super().__init__("text-processor", memory_limit_mb=512, timeout_seconds=30)
        
        def _process_event(
            self,
            event: ServerlessEvent,
            context: ServerlessContext
        ) -> Dict[str, Any]:
            """Process text from event"""
            data = event.data
            operation = data.get('operation', 'summarize')
            text = data.get('text', '')
            
            if operation == 'summarize':
                result = self._summarize(text)
            elif operation == 'sentiment':
                result = self._analyze_sentiment(text)
            elif operation == 'extract':
                result = self._extract_keywords(text)
            else:
                result = {'error': f'Unknown operation: {operation}'}
            
            return {
                'operation': operation,
                'result': result,
                'cold_start': context.cold_start,
                'invocation': context.invocation_count
            }
        
        def _summarize(self, text: str) -> str:
            """Summarize text"""
            prompt = ChatPromptTemplate.from_template(
                "Summarize this text in one sentence: {text}"
            )
            chain = prompt | self.llm | StrOutputParser()
            return chain.invoke({'text': text[:500]})
        
        def _analyze_sentiment(self, text: str) -> str:
            """Analyze sentiment"""
            prompt = ChatPromptTemplate.from_template(
                "What is the sentiment of this text? Answer in one word (positive/negative/neutral): {text}"
            )
            chain = prompt | self.llm | StrOutputParser()
            return chain.invoke({'text': text[:500]})
        
        def _extract_keywords(self, text: str) -> List[str]:
            """Extract keywords"""
            prompt = ChatPromptTemplate.from_template(
                "Extract 5 key words from this text (comma-separated): {text}"
            )
            chain = prompt | self.llm | StrOutputParser()
            result = chain.invoke({'text': text[:500]})
            return [k.strip() for k in result.split(',')[:5]]
    
    
    class WebhookFunction(ServerlessAgent):
        """Serverless function for webhook processing"""
        
        def __init__(self):
            super().__init__("webhook-handler", memory_limit_mb=256, timeout_seconds=15)
        
        def _process_event(
            self,
            event: ServerlessEvent,
            context: ServerlessContext
        ) -> Dict[str, Any]:
            """Process webhook event"""
            data = event.data
            webhook_type = data.get('type', 'generic')
            payload = data.get('payload', {})
            
            # Process webhook
            response = {
                'webhook_type': webhook_type,
                'processed_at': datetime.now().isoformat(),
                'status': 'received',
                'payload_size': len(str(payload))
            }
            
            return response
    
    
    class ScheduledFunction(ServerlessAgent):
        """Serverless function for scheduled tasks"""
        
        def __init__(self):
            super().__init__("scheduled-task", memory_limit_mb=1024, timeout_seconds=60)
        
        def _process_event(
            self,
            event: ServerlessEvent,
            context: ServerlessContext
        ) -> Dict[str, Any]:
            """Process scheduled event"""
            task_type = event.data.get('task', 'report')
            
            if task_type == 'report':
                result = self._generate_report()
            elif task_type == 'cleanup':
                result = self._cleanup_data()
            elif task_type == 'sync':
                result = self._sync_data()
            else:
                result = {'error': 'Unknown task type'}
            
            return {
                'task': task_type,
                'result': result,
                'scheduled_time': event.timestamp.isoformat()
            }
        
        def _generate_report(self) -> Dict[str, Any]:
            """Generate report"""
            return {
                'report_type': 'daily_summary',
                'generated_at': datetime.now().isoformat(),
                'items_processed': 100
            }
        
        def _cleanup_data(self) -> Dict[str, Any]:
            """Cleanup old data"""
            return {
                'items_deleted': 50,
                'space_freed_mb': 250
            }
        
        def _sync_data(self) -> Dict[str, Any]:
            """Sync data"""
            return {
                'items_synced': 75,
                'sync_duration_ms': 1500
            }
    
    
    class ServerlessPlatform:
        """
        Simulates serverless platform (like AWS Lambda).
        
        Manages function lifecycle, invocations, and cold/warm starts.
        """
        
        def __init__(self):
            """Initialize platform"""
            self.functions: Dict[str, ServerlessAgent] = {}
            self.function_metrics: Dict[str, FunctionMetrics] = {}
        
        def deploy_function(self, function: ServerlessAgent) -> bool:
            """
            Deploy a serverless function.
            
            Args:
                function: Function to deploy
                
            Returns:
                True if deployed successfully
            """
            self.functions[function.function_name] = function
            self.function_metrics[function.function_name] = function.metrics
            return True
        
        def invoke(
            self,
            function_name: str,
            event: ServerlessEvent
        ) -> ServerlessResponse:
            """
            Invoke a serverless function.
            
            Args:
                function_name: Name of function to invoke
                event: Event to process
                
            Returns:
                ServerlessResponse
            """
            if function_name not in self.functions:
                return ServerlessResponse(
                    status_code=404,
                    body=None,
                    error=f"Function not found: {function_name}"
                )
            
            function = self.functions[function_name]
            
            # Determine if cold start (simplified)
            is_cold_start = function.invocation_count == 0
            
            # Create context
            context = ServerlessContext(
                request_id=f"req_{uuid.uuid4().hex[:8]}",
                function_name=function_name,
                function_version="1.0",
                memory_limit_mb=function.memory_limit_mb,
                timeout_seconds=function.timeout_seconds,
                remaining_time_ms=function.timeout_seconds * 1000,
                cold_start=is_cold_start
            )
            
            # Invoke function
            return function.handler(event, context)
        
        def get_metrics(self, function_name: str) -> Optional[FunctionMetrics]:
            """
            Get function metrics.
            
            Args:
                function_name: Function name
                
            Returns:
                FunctionMetrics if found
            """
            return self.function_metrics.get(function_name)
    
    
    def demonstrate_serverless_agent():
        """Demonstrate the serverless agent pattern"""
        print("=" * 80)
        print("SERVERLESS AGENT DEMONSTRATION")
        print("=" * 80)
        
        platform = ServerlessPlatform()
        
        # Demo 1: Deploy Serverless Functions
        print("\n" + "=" * 80)
        print("DEMO 1: Deploying Serverless Functions")
        print("=" * 80)
        
        functions = [
            TextProcessingFunction(),
            WebhookFunction(),
            ScheduledFunction()
        ]
        
        print("\nDeploying functions to serverless platform...")
        for func in functions:
            platform.deploy_function(func)
            print(f"  ✓ Deployed: {func.function_name}")
            print(f"    Memory: {func.memory_limit_mb}MB")
            print(f"    Timeout: {func.timeout_seconds}s")
        
        # Demo 2: Cold Start vs Warm Start
        print("\n" + "=" * 80)
        print("DEMO 2: Cold Start vs Warm Start")
        print("=" * 80)
        
        event = ServerlessEvent(
            event_id="evt_001",
            trigger_type=TriggerType.HTTP_API,
            timestamp=datetime.now(),
            data={
                'operation': 'summarize',
                'text': 'Serverless computing allows running code without managing servers.'
            }
        )
        
        print("\nFirst invocation (Cold Start):")
        response1 = platform.invoke("text-processor", event)
        print(f"  Status: {response1.status_code}")
        print(f"  Cold Start: {response1.cold_start}")
        print(f"  Duration: {response1.execution_duration_ms:.2f}ms")
        print(f"  Memory Used: {response1.memory_used_mb:.1f}MB")
        
        print("\nSecond invocation (Warm Start):")
        response2 = platform.invoke("text-processor", event)
        print(f"  Status: {response2.status_code}")
        print(f"  Cold Start: {response2.cold_start}")
        print(f"  Duration: {response2.execution_duration_ms:.2f}ms")
        print(f"  Memory Used: {response2.memory_used_mb:.1f}MB")
        
        speedup = response1.execution_duration_ms / response2.execution_duration_ms if response2.execution_duration_ms > 0 else 1
        print(f"\n  Warm start {speedup:.2f}x faster than cold start")
        
        # Demo 3: Multiple Operations
        print("\n" + "=" * 80)
        print("DEMO 3: Multiple Text Processing Operations")
        print("=" * 80)
        
        operations = [
            ('summarize', 'AI agents are autonomous systems that can reason and act.'),
            ('sentiment', 'This serverless architecture is amazing!'),
            ('extract', 'Machine learning models process data to make predictions.')
        ]
        
        print("\nProcessing multiple operations...")
        print("-" * 80)
        
        for operation, text in operations:
            event = ServerlessEvent(
                event_id=f"evt_{uuid.uuid4().hex[:8]}",
                trigger_type=TriggerType.HTTP_API,
                timestamp=datetime.now(),
                data={'operation': operation, 'text': text}
            )
            
            response = platform.invoke("text-processor", event)
            
            print(f"\nOperation: {operation}")
            print(f"  Input: {text[:50]}...")
            print(f"  Duration: {response.execution_duration_ms:.2f}ms")
            
            if response.body and 'result' in response.body:
                result = response.body['result']
                if isinstance(result, str):
                    print(f"  Result: {result[:80]}...")
                else:
                    print(f"  Result: {result}")
        
        # Demo 4: Webhook Handler
        print("\n" + "=" * 80)
        print("DEMO 4: Webhook Event Processing")
        print("=" * 80)
        
        webhook_event = ServerlessEvent(
            event_id="webhook_001",
            trigger_type=TriggerType.WEBHOOK,
            timestamp=datetime.now(),
            data={
                'type': 'user_signup',
                'payload': {
                    'user_id': '12345',
                    'email': 'user@example.com',
                    'timestamp': datetime.now().isoformat()
                }
            }
        )
        
        print("\nProcessing webhook event...")
        response = platform.invoke("webhook-handler", webhook_event)
        
        print(f"  Status: {response.status_code}")
        print(f"  Duration: {response.execution_duration_ms:.2f}ms")
        print(f"  Response:")
        for key, value in response.body.items():
            print(f"    {key}: {value}")
        
        # Demo 5: Scheduled Task
        print("\n" + "=" * 80)
        print("DEMO 5: Scheduled Task Execution")
        print("=" * 80)
        
        scheduled_events = [
            {'task': 'report'},
            {'task': 'cleanup'},
            {'task': 'sync'}
        ]
        
        print("\nExecuting scheduled tasks...")
        print("-" * 80)
        
        for task_data in scheduled_events:
            event = ServerlessEvent(
                event_id=f"sched_{uuid.uuid4().hex[:8]}",
                trigger_type=TriggerType.SCHEDULED,
                timestamp=datetime.now(),
                data=task_data
            )
            
            response = platform.invoke("scheduled-task", event)
            
            print(f"\nTask: {task_data['task']}")
            print(f"  Duration: {response.execution_duration_ms:.2f}ms")
            print(f"  Result: {response.body.get('result', {})}")
        
        # Demo 6: Function Metrics
        print("\n" + "=" * 80)
        print("DEMO 6: Function Metrics & Monitoring")
        print("=" * 80)
        
        print("\nFunction Metrics:")
        print("-" * 80)
        
        for func_name in ["text-processor", "webhook-handler", "scheduled-task"]:
            metrics = platform.get_metrics(func_name)
            
            if metrics:
                print(f"\n{func_name}:")
                print(f"  Total Invocations: {metrics.invocations}")
                print(f"  Cold Starts: {metrics.cold_starts}")
                print(f"  Warm Starts: {metrics.warm_starts}")
                print(f"  Errors: {metrics.errors}")
                print(f"  Avg Duration: {metrics.average_duration_ms:.2f}ms")
                print(f"  Min Duration: {metrics.min_duration_ms:.2f}ms")
                print(f"  Max Duration: {metrics.max_duration_ms:.2f}ms")
                
                cold_start_pct = (metrics.cold_starts / metrics.invocations * 100) if metrics.invocations > 0 else 0
                print(f"  Cold Start Rate: {cold_start_pct:.1f}%")
        
        # Summary
        print("\n" + "=" * 80)
        print("SUMMARY")
        print("=" * 80)
        
        summary = """
    The Serverless Agent demonstrates cloud-native, event-driven AI:
    
    KEY CAPABILITIES:
    1. Stateless Execution: No persistent state between invocations
    2. Event-Driven: Triggered by various event sources
    3. Auto-Scaling: Scales automatically from zero to thousands
    4. Cold/Warm Starts: Container reuse optimization
    5. Pay-Per-Execution: Only pay for actual compute time
    6. Managed Infrastructure: No server management required
    7. Multiple Triggers: HTTP, webhooks, schedules, queues, streams
    8. Built-in Monitoring: Integrated metrics and logging
    
    BENEFITS:
    - Zero infrastructure management
    - Automatic scaling with demand
    - Cost optimization (pay per use)
    - High availability by default
    - Fast deployment and iteration
    - Built-in fault tolerance
    - Easy integration with cloud services
    - Reduced operational overhead
    
    USE CASES:
    - REST API endpoints for AI services
    - Webhook processing for integrations
    - Scheduled AI tasks (reports, cleanup, sync)
    - Event-driven data processing
    - Real-time stream processing
    - Image/document processing pipelines
    - Chatbot backends
    - ETL and data transformation
    - IoT data processing
    - Microservices backends
    
    PRODUCTION CONSIDERATIONS:
    1. Cold Starts: Minimize with provisioned concurrency
    2. Statelessness: Use external storage (S3, DynamoDB, RDS)
    3. Timeout Limits: Functions have max execution time
    4. Memory Allocation: Balance cost vs performance
    5. Concurrency Limits: Understand and configure limits
    6. VPC Networking: Consider cold start impact
    7. Error Handling: Implement retries and DLQs
    8. Monitoring: Use CloudWatch, X-Ray for observability
    9. Security: IAM roles, secrets management
    10. Cost Management: Monitor and optimize usage
    
    ADVANCED EXTENSIONS:
    - Lambda layers for shared dependencies
    - Step Functions for complex workflows
    - EventBridge for event routing
    - API Gateway for HTTP endpoints
    - SQS/SNS for async messaging
    - Lambda@Edge for CDN integration
    - Provisioned concurrency for predictable latency
    - Container image deployment
    - Multi-region deployment
    - Custom runtimes and extensions
    
    Serverless architecture is ideal for event-driven AI workloads
    with variable demand, optimizing both cost and scalability.
    """
        
        print(summary)
    
    
    if __name__ == "__main__":
        demonstrate_serverless_agent()
    
        

    Agentic Design Pattern: Serverless Agent

    Pattern 082: Serverless Agent – Line-by-Line Explanation

    Overview

    This document provides a detailed line-by-line explanation of the Serverless Agent pattern implementation.


    Pattern Description

    Pattern 082: Serverless Agent

    Description: A Serverless Agent runs on serverless computing platforms (AWS Lambda, Azure Functions, Google Cloud Functions) where infrastructure is fully managed by the cloud provider. This pattern enables event-driven, auto-scaling AI agents that only consume resources when invoked, optimizing costs and operational overhead.

    The agent is designed for stateless execution, cold start optimization,
    event-driven triggers, and seamless scaling from zero to thousands of
    concurrent executions without manual intervention.
    

    Components: 1. Function Handler: Entry point for serverless execution 2. Event Processor: Processes various event types 3. State Manager: External state storage (S3, DynamoDB) 4. Cold Start Optimizer: Minimizes initialization time 5. Environment Manager: Configuration and secrets 6. Response Builder: Formats function responses 7. Error Handler: Graceful error handling 8. Metrics Collector: CloudWatch/monitoring integration

    Key Features: – Stateless execution model – Event-driven triggers – Auto-scaling from zero – Pay-per-execution pricing – No server management – Built-in fault tolerance – Managed infrastructure – Cold start optimization – Multiple trigger sources – Seamless integration with cloud services

    Use Cases: – API endpoints for AI services – Event-driven AI processing – Webhook handlers – Scheduled AI tasks – Image/document processing – Real-time data transformation – Chatbot backends – ETL pipelines – IoT data processing – Microservices backends

    LangChain Implementation: Simulates AWS Lambda-style function handlers with event processing, stateless execution, and external state management patterns.


    File Statistics

    • Total Lines: 756
    • Classes: 11
    • Functions: 1
    • Constants: 0

    Module Documentation

    """
    Pattern 082: Serverless Agent
    
    Description:
        A Serverless Agent runs on serverless computing platforms (AWS Lambda,
        Azure Functions, Google Cloud Functions) where infrastructure is fully
        managed by the cloud provider. This pattern enables event-driven, auto-scaling
        AI agents that only consume resources when invoked, optimizing costs and
        operational overhead.
    
        The agent is designed for stateless execution, cold start optimization,
        event-driven triggers, and seamless scaling from zero to thousands of
        concurrent executions without manual intervention.
    
    Components:
        1. Function Handler: Entry point for serverless execution
        2. Event Processor: Processes various event types
        3. State Manager: External state storage (S3, DynamoDB)
        4. Cold Start Optimizer: Minimizes initialization time
        5. Environment Manager: Configuration and secrets
        6. Response Builder: Formats function responses
        7. Error Handler: Graceful error handling
        8. Metrics Collector: CloudWatch/monitoring integration
    
    Key Features:
        - Stateless execution model
        - Event-driven triggers
        - Auto-scaling from zero
        - Pay-per-execution pricing
        - No server management
        - Built-in fault tolerance
        - Managed infrastructure
        - Cold start optimization
        - Multiple trigger sources
        - Seamless integration with cloud services
    
    Use Cases:
        - API endpoints for AI services
        - Event-driven AI processing
        - Webhook handlers
        - Scheduled AI tasks
        - Image/document processing
        - Real-time data transformation
        - Chatbot backends
        - ETL pipelines
        - IoT data processing
        - Microservices backends
    
    LangChain Implementation:
        Simulates AWS Lambda-style function handlers with event processing,
        stateless execution, and external state management patterns.
    """
    

    Purpose: This module implements the Serverless Agent pattern, providing a structured approach to agent design and implementation.


    Import Statements

    Standard Library Imports

    import collections.defaultdict
    import dataclasses.dataclass
    import dataclasses.field
    import datetime.datetime
    import enum.Enum
    import json
    import langchain_core.output_parsers.StrOutputParser
    import langchain_core.prompts.ChatPromptTemplate
    import os
    import time
    import typing.Any
    import typing.Callable
    import typing.Dict
    import typing.List
    import typing.Optional
    

    Purpose: Core Python functionality: – collections.defaultdict: Specialized container datatypes – dataclasses.dataclass: Simplified class definitions with @dataclass – dataclasses.field: Simplified class definitions with @dataclass – datetime.datetime: Date and time handling – enum.Enum: Enumeration support – json: JSON serialization/deserialization – langchain_core.output_parsers.StrOutputParser: Regular expression operations – langchain_core.prompts.ChatPromptTemplate: Regular expression operations – os: Environment variable access and system operations – time: Time-related functions – typing.Any: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Callable: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Dict: Type hints for better code documentation (List, Dict, Any, Optional) – typing.List: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Optional: Type hints for better code documentation (List, Dict, Any, Optional)

    LangChain Imports

    from langchain_openai.ChatOpenAI
    

    Purpose: LangChain framework components: – LLM Interface: Wrapper for OpenAI models – Chains: Composable building blocks for complex workflows

    Other Imports

    from dotenv.load_dotenv
    from uuid
    

    Purpose: Additional dependencies for specialized functionality.


    Classes

    Class: TriggerType

    Lines 72-81

    Inherits from: Enum

    Purpose:

    Types of serverless triggers
    

    Class: ExecutionStatus

    Lines 84-91

    Inherits from: Enum

    Purpose:

    Status of function execution
    

    Class: ServerlessEvent

    Lines 95-102

    Purpose:

    Event that triggers serverless function
    

    Class: ServerlessContext

    Lines 106-115

    Purpose:

    Execution context for serverless function
    

    Class: ServerlessResponse

    Lines 119-127

    Purpose:

    Response from serverless function
    

    Class: FunctionMetrics

    Lines 131-141

    Purpose:

    Metrics for serverless function
    

    Class: ServerlessAgent

    Lines 144-290

    Purpose:

    Base serverless agent with stateless execution.
    
    Designed for serverless platforms with event-driven triggers,
    cold start optimization, and external state management.
    

    Methods:

    __init__(self, function_name, memory_limit_mb, timeout_seconds)

    Lines 156-184

    Purpose:

    Initialize serverless agent.
    
    Args:
        function_name: Name of the function
        memory_limit_mb: Memory limit
        timeout_seconds: Execution timeout
    

    Parameters: – function_name: Function name – memory_limit_mb: Memory store for conversation history – timeout_seconds: Timeout seconds

    get_or_create(cls, function_name)

    Lines 187-202

    Decorators: classmethod

    Purpose:

    Get warm instance or create new (simulates Lambda container reuse).
    
    Args:
        function_name: Function name
    
    Returns:
        ServerlessAgent instance
    

    Parameters: – cls: Cls – function_name: Function name

    Returns: ServerlessAgent

    handler(self, event, context)

    Lines 204-269

    Purpose:

    Main handler function (entry point).
    
    Args:
        event: Triggering event
        context: Execution context
    
    Returns:
        ServerlessResponse
    

    Parameters: – event: Event – context: Context

    Returns: ServerlessResponse

    _process_event(self, event, context)

    Lines 271-290

    Purpose:

    Process event (to be overridden by subclasses).
    
    Args:
        event: Event to process
        context: Execution context
    
    Returns:
        Processing result
    

    Parameters: – event: Event – context: Context

    Returns: <ast.Subscript object at 0x000001A06D750A50>


    Class: TextProcessingFunction

    Lines 293-348

    Inherits from: ServerlessAgent

    Purpose:

    Serverless function for text processing
    

    Methods:

    __init__(self)

    Lines 296-297

    Purpose: Initialize the class instance with required parameters.

    Parameters:

    _process_event(self, event, context)

    Lines 299-323

    Purpose:

    Process text from event
    

    Parameters: – event: Event – context: Context

    Returns: <ast.Subscript object at 0x000001A06D17BC90>

    _summarize(self, text)

    Lines 325-331

    Purpose:

    Summarize text
    

    Parameters: – text: Text

    Returns: str

    _analyze_sentiment(self, text)

    Lines 333-339

    Purpose:

    Analyze sentiment
    

    Parameters: – text: Text

    Returns: str

    _extract_keywords(self, text)

    Lines 341-348

    Purpose:

    Extract keywords
    

    Parameters: – text: Text

    Returns: <ast.Subscript object at 0x000001A06D75B810>


    Class: WebhookFunction

    Lines 351-375

    Inherits from: ServerlessAgent

    Purpose:

    Serverless function for webhook processing
    

    Methods:

    __init__(self)

    Lines 354-355

    Purpose: Initialize the class instance with required parameters.

    Parameters:

    _process_event(self, event, context)

    Lines 357-375

    Purpose:

    Process webhook event
    

    Parameters: – event: Event – context: Context

    Returns: <ast.Subscript object at 0x000001A06D157B50>


    Class: ScheduledFunction

    Lines 378-427

    Inherits from: ServerlessAgent

    Purpose:

    Serverless function for scheduled tasks
    

    Methods:

    __init__(self)

    Lines 381-382

    Purpose: Initialize the class instance with required parameters.

    Parameters:

    _process_event(self, event, context)

    Lines 384-405

    Purpose:

    Process scheduled event
    

    Parameters: – event: Event – context: Context

    Returns: <ast.Subscript object at 0x000001A06D83EE50>

    _generate_report(self)

    Lines 407-413

    Purpose:

    Generate report
    

    Parameters:

    Returns: <ast.Subscript object at 0x000001A06D168490>

    _cleanup_data(self)

    Lines 415-420

    Purpose:

    Cleanup old data
    

    Parameters:

    Returns: <ast.Subscript object at 0x000001A06D626590>

    _sync_data(self)

    Lines 422-427

    Purpose:

    Sync data
    

    Parameters:

    Returns: <ast.Subscript object at 0x000001A06D627090>


    Class: ServerlessPlatform

    Lines 430-507

    Purpose:

    Simulates serverless platform (like AWS Lambda).
    
    Manages function lifecycle, invocations, and cold/warm starts.
    

    Methods:

    __init__(self)

    Lines 437-440

    Purpose:

    Initialize platform
    

    Parameters:

    deploy_function(self, function)

    Lines 442-454

    Purpose:

    Deploy a serverless function.
    
    Args:
        function: Function to deploy
    
    Returns:
        True if deployed successfully
    

    Parameters: – function: Function

    Returns: bool

    invoke(self, function_name, event)

    Lines 456-495

    Purpose:

    Invoke a serverless function.
    
    Args:
        function_name: Name of function to invoke
        event: Event to process
    
    Returns:
        ServerlessResponse
    

    Parameters: – function_name: Function name – event: Event

    Returns: ServerlessResponse

    get_metrics(self, function_name)

    Lines 497-507

    Purpose:

    Get function metrics.
    
    Args:
        function_name: Function name
    
    Returns:
        FunctionMetrics if found
    

    Parameters: – function_name: Function name

    Returns: <ast.Subscript object at 0x000001A06D80C0D0>


    Functions

    demonstrate_serverless_agent()

    Lines 510-751

    Purpose:

    Demonstrate the serverless agent pattern
    

    Key Concepts Summary

    Pattern Overview

    The Serverless Agent pattern provides a structured approach to building AI agents with specific capabilities and behaviors. This implementation leverages LangChain’s composable components to create a robust and maintainable solution.

    Core Components

    1. Agent Class: Main implementation of the pattern logic
    2. Prompt Engineering: Carefully crafted prompts to guide LLM behavior
    3. Tool Integration: Optional tools for extended functionality
    4. Memory Management: State handling across interactions
    5. Output Parsing: Structured response processing

    When to Use

    ✅ Good for: – Scenarios requiring this specific pattern’s strengths – Applications needing structured agent behavior – Systems where explainability is important – Production environments requiring reliability

    ❌ Not ideal for: – Simple single-prompt tasks – Scenarios requiring different pattern characteristics – Resource-constrained environments (if computationally intensive)


    Best Practices Demonstrated

    1. Environment Configuration

    • ✅ Use .env files for API keys
    • ✅ Never hardcode credentials
    • ✅ Validate environment variables on startup

    2. Error Handling

    • ✅ Graceful degradation on failures
    • ✅ Informative error messages
    • ✅ Logging for debugging

    3. Prompt Engineering

    • ✅ Clear, specific instructions
    • ✅ Structured output formats
    • ✅ Few-shot examples when beneficial

    4. Code Organization

    • ✅ Separation of concerns (class-based design)
    • ✅ Type hints for clarity
    • ✅ Docstrings for documentation

    5. Performance Optimization

    • ✅ Appropriate temperature settings
    • ✅ Token budget management
    • ✅ Caching where applicable

    LangChain Components Used

    • ChatOpenAI: OpenAI model interface
    • Chains: Sequential component composition

    Why LangChain? – Composable abstractions for LLM applications – Rich ecosystem of integrations – Production-ready patterns – Active community and development


    Execution Flow

    1. Initialize agent with configuration
       ↓
    2. Load environment and dependencies
       ↓
    3. Prepare prompt with input data
       ↓
    4. Invoke LLM through LangChain
       ↓
    5. Parse and validate response
       ↓
    6. Return formatted result
    

    Key Decision Points: – Model selection (temperature, model type) – Prompt structure (few-shot vs zero-shot) – Error handling strategy – Output format validation


    Performance Considerations

    Computational Cost

    • LLM Calls: Primary cost factor (based on tokens)
    • Latency: Depends on model and input size
    • Memory: Minimal for most patterns

    Optimization Strategies

    1. Prompt Optimization: Minimize tokens while maintaining clarity
    2. Caching: Cache repeated queries/responses
    3. Model Selection: Use smaller models when appropriate
    4. Batch Processing: Group similar requests
    5. Streaming: For long responses, stream tokens

    Cost Estimates (Approximate)

    • GPT-3.5-turbo: ~$0.002 per request
    • GPT-4: ~$0.03 per request
    • GPT-4-turbo: ~$0.01 per request

    Actual costs vary based on input/output token counts


    Common Pitfalls to Avoid

    1. Prompt Design Issues

    ❌ Vague or ambiguous instructions
    ✅ Clear, specific, testable prompts

    2. Error Handling

    ❌ Ignoring API errors or rate limits
    ✅ Implement retry logic and graceful degradation

    3. Token Management

    ❌ Exceeding model token limits
    ✅ Truncate inputs, chunk processing

    4. Security

    ❌ Exposing API keys in code
    ✅ Use environment variables

    5. Testing

    ❌ Only testing happy paths
    ✅ Test edge cases, failures, malformed inputs

    6. Cost Management

    ❌ Unmonitored API usage
    ✅ Implement budgets, alerts, and monitoring


    Further Improvements

    Production Enhancements

    1. Monitoring: Add logging, metrics, tracing
    2. Validation: Input/output schema validation
    3. Rate Limiting: Implement request throttling
    4. Caching: Redis or in-memory cache for responses
    5. Async Support: Non-blocking operations for scalability

    Feature Extensions

    1. Multi-Model Support: Switch between providers
    2. Fallback Models: Graceful degradation strategy
    3. Custom Tools: Domain-specific function calling
    4. Advanced Memory: Vector stores for long-term memory
    5. Evaluation: Automated testing and benchmarking

    Code Quality

    1. Testing: Unit tests, integration tests
    2. Documentation: API docs, usage examples
    3. Type Safety: Stricter type hints
    4. Configuration: Externalized config files

    Related Patterns

    • Pattern 081
    • Pattern 083

    Pattern Families: – Reasoning Patterns (001-011) – Multi-Agent Patterns (012-019) – Tool Use Patterns (020-025) – Memory Patterns (026-031) – And many more…


    Summary

    The Serverless Agent pattern provides a powerful approach to building AI agents with specific capabilities. This implementation demonstrates:

    ✅ Key Strengths: – Clean, maintainable code structure – LangChain integration for composability – Type hints and documentation – Production-ready patterns

    🎯 Best Use Cases: – Applications requiring this pattern’s characteristics – Systems needing structured agent behavior – Production environments requiring reliability

    📚 Learning Resources: – LangChain Documentation: https://python.langchain.com/ – Pattern Documentation: See related patterns – OpenAI API Reference: https://platform.openai.com/docs/


    File: 082_serverless_agent.py
    Total Lines: 756
    Pattern Category: AI Agent Design Pattern #082


    Generated from actual implementation code
    For educational and reference purposes

  • Agentic Design Pattern: Microservice Agent

    
        """
    Pattern 081: Microservice Agent Architecture
    
    Description:
        A Microservice Agent Architecture decomposes AI agents into independently
        deployable microservices that communicate via well-defined APIs. This pattern
        enables scalability, fault isolation, independent deployment, and technology
        diversity across agent components. Each microservice can be developed, deployed,
        and scaled independently while maintaining loose coupling.
        
        The architecture supports distributed agent systems with service discovery,
        load balancing, inter-service communication, circuit breakers, and observability
        across the microservices mesh.
    
    Components:
        1. Agent Services: Independent agent microservices
        2. API Gateway: Entry point and routing
        3. Service Registry: Service discovery and health checks
        4. Message Bus: Async inter-service communication
        5. Load Balancer: Distribute requests across instances
        6. Circuit Breaker: Fault tolerance and isolation
        7. Config Service: Centralized configuration
        8. Monitoring: Distributed tracing and metrics
    
    Key Features:
        - Independent service deployment
        - Service discovery and registration
        - Inter-service communication (REST, gRPC, message queues)
        - Load balancing and auto-scaling
        - Fault isolation and circuit breakers
        - Distributed tracing
        - API gateway pattern
        - Health checks and monitoring
        - Polyglot persistence
        - Technology diversity
    
    Use Cases:
        - Large-scale AI platforms
        - Multi-tenant AI services
        - Enterprise AI systems
        - Cloud-native AI applications
        - Distributed agent coordination
        - Scalable chatbot platforms
        - AI-powered SaaS products
        - Microservices-based RAG systems
        - Agent mesh architectures
        - Multi-model serving platforms
    
    LangChain Implementation:
        Uses FastAPI for service endpoints, service registry pattern,
        inter-service HTTP communication, and distributed agent coordination.
    """
    
    import os
    import time
    import uuid
    import json
    from typing import List, Dict, Any, Optional, Callable
    from dataclasses import dataclass, field
    from enum import Enum
    from datetime import datetime
    from collections import defaultdict
    from dotenv import load_dotenv
    
    from langchain_core.prompts import ChatPromptTemplate
    from langchain_core.output_parsers import StrOutputParser
    from langchain_openai import ChatOpenAI
    
    load_dotenv()
    
    
    class ServiceStatus(Enum):
        """Status of a microservice"""
        STARTING = "starting"
        HEALTHY = "healthy"
        UNHEALTHY = "unhealthy"
        DEGRADED = "degraded"
        STOPPED = "stopped"
    
    
    class CommunicationProtocol(Enum):
        """Inter-service communication protocol"""
        HTTP_REST = "http_rest"
        GRPC = "grpc"
        MESSAGE_QUEUE = "message_queue"
        EVENT_BUS = "event_bus"
    
    
    @dataclass
    class ServiceInfo:
        """Information about a microservice"""
        service_id: str
        service_name: str
        version: str
        host: str
        port: int
        protocol: CommunicationProtocol
        status: ServiceStatus
        endpoints: List[str]
        health_check_url: str
        registered_at: datetime = field(default_factory=datetime.now)
        last_heartbeat: datetime = field(default_factory=datetime.now)
        metadata: Dict[str, Any] = field(default_factory=dict)
    
    
    @dataclass
    class ServiceRequest:
        """Request to a microservice"""
        request_id: str
        service_name: str
        endpoint: str
        method: str
        data: Dict[str, Any]
        headers: Dict[str, str] = field(default_factory=dict)
        timeout: float = 30.0
    
    
    @dataclass
    class ServiceResponse:
        """Response from a microservice"""
        request_id: str
        service_name: str
        status_code: int
        data: Any
        error: Optional[str] = None
        duration: float = 0.0
        metadata: Dict[str, Any] = field(default_factory=dict)
    
    
    class ServiceRegistry:
        """
        Service registry for microservice discovery.
        
        Maintains a registry of available services with health monitoring.
        """
        
        def __init__(self):
            """Initialize service registry"""
            self.services: Dict[str, ServiceInfo] = {}
            self.service_instances: Dict[str, List[str]] = defaultdict(list)
        
        def register(self, service: ServiceInfo) -> bool:
            """
            Register a service.
            
            Args:
                service: Service information
                
            Returns:
                True if registered successfully
            """
            self.services[service.service_id] = service
            self.service_instances[service.service_name].append(service.service_id)
            return True
        
        def deregister(self, service_id: str) -> bool:
            """
            Deregister a service.
            
            Args:
                service_id: Service ID
                
            Returns:
                True if deregistered successfully
            """
            if service_id in self.services:
                service = self.services[service_id]
                self.service_instances[service.service_name].remove(service_id)
                del self.services[service_id]
                return True
            return False
        
        def discover(self, service_name: str) -> Optional[ServiceInfo]:
            """
            Discover a healthy service instance.
            
            Args:
                service_name: Name of service to discover
                
            Returns:
                ServiceInfo if found, None otherwise
            """
            instances = self.service_instances.get(service_name, [])
            
            # Find healthy instance
            for instance_id in instances:
                service = self.services.get(instance_id)
                if service and service.status == ServiceStatus.HEALTHY:
                    return service
            
            return None
        
        def health_check(self, service_id: str) -> ServiceStatus:
            """
            Check health of a service.
            
            Args:
                service_id: Service ID
                
            Returns:
                Service status
            """
            if service_id in self.services:
                service = self.services[service_id]
                # Simulate health check
                service.last_heartbeat = datetime.now()
                return service.status
            
            return ServiceStatus.STOPPED
        
        def list_services(self) -> List[ServiceInfo]:
            """
            List all registered services.
            
            Returns:
                List of service information
            """
            return list(self.services.values())
    
    
    class AgentService:
        """
        Base microservice for AI agents.
        
        Each agent capability is encapsulated as an independent service.
        """
        
        def __init__(
            self,
            service_name: str,
            version: str = "1.0.0",
            port: int = 8000
        ):
            """
            Initialize agent service.
            
            Args:
                service_name: Name of the service
                version: Service version
                port: Port number
            """
            self.service_id = f"{service_name}_{uuid.uuid4().hex[:8]}"
            self.service_name = service_name
            self.version = version
            self.port = port
            self.status = ServiceStatus.STARTING
            
            # LLM for this service
            self.llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.7)
            
            # Request tracking
            self.requests: Dict[str, ServiceRequest] = {}
            self.responses: Dict[str, ServiceResponse] = {}
        
        def get_info(self) -> ServiceInfo:
            """
            Get service information.
            
            Returns:
                ServiceInfo object
            """
            return ServiceInfo(
                service_id=self.service_id,
                service_name=self.service_name,
                version=self.version,
                host="localhost",
                port=self.port,
                protocol=CommunicationProtocol.HTTP_REST,
                status=self.status,
                endpoints=["/health", "/process"],
                health_check_url=f"http://localhost:{self.port}/health"
            )
        
        def start(self) -> bool:
            """
            Start the service.
            
            Returns:
                True if started successfully
            """
            self.status = ServiceStatus.HEALTHY
            return True
        
        def stop(self) -> bool:
            """
            Stop the service.
            
            Returns:
                True if stopped successfully
            """
            self.status = ServiceStatus.STOPPED
            return True
        
        def health(self) -> Dict[str, Any]:
            """
            Health check endpoint.
            
            Returns:
                Health status
            """
            return {
                "service": self.service_name,
                "status": self.status.value,
                "version": self.version,
                "timestamp": datetime.now().isoformat()
            }
        
        def process(self, data: Dict[str, Any]) -> Dict[str, Any]:
            """
            Process a request (to be overridden by subclasses).
            
            Args:
                data: Request data
                
            Returns:
                Response data
            """
            raise NotImplementedError("Subclasses must implement process()")
    
    
    class SummarizationService(AgentService):
        """Microservice for text summarization"""
        
        def __init__(self):
            super().__init__("summarization", version="1.0.0", port=8001)
        
        def process(self, data: Dict[str, Any]) -> Dict[str, Any]:
            """
            Summarize text.
            
            Args:
                data: {'text': str, 'length': str}
                
            Returns:
                {'summary': str}
            """
            text = data.get('text', '')
            length = data.get('length', 'short')
            
            prompt = ChatPromptTemplate.from_template(
                "Summarize the following text in {length} form:\n\n{text}"
            )
            
            chain = prompt | self.llm | StrOutputParser()
            
            summary = chain.invoke({
                'text': text[:1000],
                'length': length
            })
            
            return {
                'summary': summary,
                'service': self.service_name
            }
    
    
    class TranslationService(AgentService):
        """Microservice for translation"""
        
        def __init__(self):
            super().__init__("translation", version="1.0.0", port=8002)
        
        def process(self, data: Dict[str, Any]) -> Dict[str, Any]:
            """
            Translate text.
            
            Args:
                data: {'text': str, 'target_language': str}
                
            Returns:
                {'translation': str}
            """
            text = data.get('text', '')
            target_language = data.get('target_language', 'Spanish')
            
            prompt = ChatPromptTemplate.from_template(
                "Translate the following text to {language}:\n\n{text}"
            )
            
            chain = prompt | self.llm | StrOutputParser()
            
            translation = chain.invoke({
                'text': text[:500],
                'language': target_language
            })
            
            return {
                'translation': translation,
                'target_language': target_language,
                'service': self.service_name
            }
    
    
    class SentimentService(AgentService):
        """Microservice for sentiment analysis"""
        
        def __init__(self):
            super().__init__("sentiment", version="1.0.0", port=8003)
        
        def process(self, data: Dict[str, Any]) -> Dict[str, Any]:
            """
            Analyze sentiment.
            
            Args:
                data: {'text': str}
                
            Returns:
                {'sentiment': str, 'confidence': float}
            """
            text = data.get('text', '')
            
            prompt = ChatPromptTemplate.from_template(
                """Analyze the sentiment of this text. Respond with:
    SENTIMENT: positive/negative/neutral
    CONFIDENCE: 0.0-1.0
    
    Text: {text}"""
            )
            
            chain = prompt | self.llm | StrOutputParser()
            
            result = chain.invoke({'text': text[:500]})
            
            # Parse result
            sentiment = "neutral"
            confidence = 0.5
            
            for line in result.split('\n'):
                if 'SENTIMENT:' in line:
                    sentiment = line.split(':')[1].strip().lower()
                elif 'CONFIDENCE:' in line:
                    try:
                        confidence = float(line.split(':')[1].strip())
                    except:
                        pass
            
            return {
                'sentiment': sentiment,
                'confidence': confidence,
                'service': self.service_name
            }
    
    
    class APIGateway:
        """
        API Gateway for routing requests to microservices.
        
        Provides a single entry point and routes to appropriate services.
        """
        
        def __init__(self, registry: ServiceRegistry):
            """
            Initialize API gateway.
            
            Args:
                registry: Service registry
            """
            self.registry = registry
            self.request_count = 0
            self.route_map = {
                'summarize': 'summarization',
                'translate': 'translation',
                'sentiment': 'sentiment'
            }
        
        def route(self, operation: str, data: Dict[str, Any]) -> ServiceResponse:
            """
            Route request to appropriate service.
            
            Args:
                operation: Operation to perform
                data: Request data
                
            Returns:
                ServiceResponse
            """
            request_id = f"req_{self.request_count}"
            self.request_count += 1
            
            start_time = time.time()
            
            # Determine target service
            service_name = self.route_map.get(operation)
            
            if not service_name:
                return ServiceResponse(
                    request_id=request_id,
                    service_name="unknown",
                    status_code=404,
                    data=None,
                    error=f"Unknown operation: {operation}",
                    duration=time.time() - start_time
                )
            
            # Discover service
            service = self.registry.discover(service_name)
            
            if not service:
                return ServiceResponse(
                    request_id=request_id,
                    service_name=service_name,
                    status_code=503,
                    data=None,
                    error=f"Service unavailable: {service_name}",
                    duration=time.time() - start_time
                )
            
            # Forward request to service (simulated)
            try:
                # In real implementation, would make HTTP request
                # Here we simulate the service call
                result_data = {
                    'status': 'success',
                    'operation': operation,
                    'service': service_name
                }
                
                return ServiceResponse(
                    request_id=request_id,
                    service_name=service_name,
                    status_code=200,
                    data=result_data,
                    duration=time.time() - start_time
                )
                
            except Exception as e:
                return ServiceResponse(
                    request_id=request_id,
                    service_name=service_name,
                    status_code=500,
                    data=None,
                    error=str(e),
                    duration=time.time() - start_time
                )
    
    
    class MicroserviceOrchestrator:
        """
        Orchestrator for coordinating multiple microservices.
        
        Manages service lifecycle and coordinates complex workflows
        across multiple services.
        """
        
        def __init__(self):
            """Initialize orchestrator"""
            self.registry = ServiceRegistry()
            self.gateway = APIGateway(self.registry)
            self.services: Dict[str, AgentService] = {}
        
        def deploy_service(self, service: AgentService) -> bool:
            """
            Deploy a microservice.
            
            Args:
                service: Agent service to deploy
                
            Returns:
                True if deployed successfully
            """
            # Start service
            service.start()
            
            # Register with registry
            service_info = service.get_info()
            self.registry.register(service_info)
            
            # Track service
            self.services[service.service_id] = service
            
            return True
        
        def undeploy_service(self, service_id: str) -> bool:
            """
            Undeploy a microservice.
            
            Args:
                service_id: Service ID
                
            Returns:
                True if undeployed successfully
            """
            if service_id in self.services:
                service = self.services[service_id]
                service.stop()
                self.registry.deregister(service_id)
                del self.services[service_id]
                return True
            return False
        
        def execute_workflow(
            self,
            operations: List[Dict[str, Any]]
        ) -> List[ServiceResponse]:
            """
            Execute a workflow across multiple services.
            
            Args:
                operations: List of operations with data
                
            Returns:
                List of service responses
            """
            responses = []
            
            for op in operations:
                operation = op.get('operation')
                data = op.get('data', {})
                
                response = self.gateway.route(operation, data)
                responses.append(response)
            
            return responses
        
        def get_service_health(self) -> Dict[str, Any]:
            """
            Get health status of all services.
            
            Returns:
                Health status dictionary
            """
            services = self.registry.list_services()
            
            health_status = {
                'total_services': len(services),
                'healthy': 0,
                'unhealthy': 0,
                'services': []
            }
            
            for service in services:
                status = self.registry.health_check(service.service_id)
                
                if status == ServiceStatus.HEALTHY:
                    health_status['healthy'] += 1
                else:
                    health_status['unhealthy'] += 1
                
                health_status['services'].append({
                    'name': service.service_name,
                    'id': service.service_id,
                    'status': status.value,
                    'version': service.version
                })
            
            return health_status
    
    
    def demonstrate_microservice_architecture():
        """Demonstrate the microservice agent architecture"""
        print("=" * 80)
        print("MICROSERVICE AGENT ARCHITECTURE DEMONSTRATION")
        print("=" * 80)
        
        orchestrator = MicroserviceOrchestrator()
        
        # Demo 1: Deploy Microservices
        print("\n" + "=" * 80)
        print("DEMO 1: Deploying Microservices")
        print("=" * 80)
        
        # Deploy services
        services = [
            SummarizationService(),
            TranslationService(),
            SentimentService()
        ]
        
        print("\nDeploying services...")
        for service in services:
            success = orchestrator.deploy_service(service)
            print(f"  ✓ Deployed: {service.service_name} v{service.version} on port {service.port}")
        
        # Demo 2: Service Discovery
        print("\n" + "=" * 80)
        print("DEMO 2: Service Discovery")
        print("=" * 80)
        
        print("\nRegistered Services:")
        print("-" * 80)
        
        for service_info in orchestrator.registry.list_services():
            print(f"\nService: {service_info.service_name}")
            print(f"  ID: {service_info.service_id}")
            print(f"  Version: {service_info.version}")
            print(f"  Status: {service_info.status.value}")
            print(f"  Endpoint: {service_info.host}:{service_info.port}")
            print(f"  Protocol: {service_info.protocol.value}")
        
        # Demo 3: Service Health Checks
        print("\n" + "=" * 80)
        print("DEMO 3: Service Health Monitoring")
        print("=" * 80)
        
        health = orchestrator.get_service_health()
        
        print(f"\nCluster Health:")
        print(f"  Total Services: {health['total_services']}")
        print(f"  Healthy: {health['healthy']}")
        print(f"  Unhealthy: {health['unhealthy']}")
        
        print(f"\nService Status:")
        for svc in health['services']:
            status_icon = "✓" if svc['status'] == 'healthy' else "✗"
            print(f"  {status_icon} {svc['name']} ({svc['version']}) - {svc['status']}")
        
        # Demo 4: API Gateway Routing
        print("\n" + "=" * 80)
        print("DEMO 4: API Gateway Request Routing")
        print("=" * 80)
        
        print("\nRouting requests through API Gateway...")
        print("-" * 80)
        
        requests = [
            {'operation': 'summarize', 'data': {'text': 'Sample text', 'length': 'short'}},
            {'operation': 'translate', 'data': {'text': 'Hello', 'target_language': 'French'}},
            {'operation': 'sentiment', 'data': {'text': 'Great product!'}}
        ]
        
        for req in requests:
            response = orchestrator.gateway.route(req['operation'], req['data'])
            
            print(f"\nRequest: {req['operation']}")
            print(f"  Request ID: {response.request_id}")
            print(f"  Service: {response.service_name}")
            print(f"  Status Code: {response.status_code}")
            print(f"  Duration: {response.duration*1000:.2f}ms")
            
            if response.error:
                print(f"  Error: {response.error}")
        
        # Demo 5: Direct Service Calls
        print("\n" + "=" * 80)
        print("DEMO 5: Direct Service Invocation")
        print("=" * 80)
        
        print("\nCalling services directly...")
        print("-" * 80)
        
        # Summarization
        print("\n1. Summarization Service:")
        summarization_svc = services[0]
        result = summarization_svc.process({
            'text': 'Microservices architecture enables building complex systems through independently deployable services.',
            'length': 'very short'
        })
        print(f"   Input: Long text about microservices")
        print(f"   Summary: {result['summary'][:80]}...")
        
        # Translation
        print("\n2. Translation Service:")
        translation_svc = services[1]
        result = translation_svc.process({
            'text': 'Hello, how are you?',
            'target_language': 'Spanish'
        })
        print(f"   Input: 'Hello, how are you?'")
        print(f"   Translation: {result['translation']}")
        
        # Sentiment
        print("\n3. Sentiment Service:")
        sentiment_svc = services[2]
        result = sentiment_svc.process({
            'text': 'This microservice architecture is fantastic!'
        })
        print(f"   Input: 'This microservice architecture is fantastic!'")
        print(f"   Sentiment: {result['sentiment']} (confidence: {result['confidence']:.2f})")
        
        # Demo 6: Multi-Service Workflow
        print("\n" + "=" * 80)
        print("DEMO 6: Orchestrated Multi-Service Workflow")
        print("=" * 80)
        
        workflow = [
            {'operation': 'summarize', 'data': {'text': 'Long article text...', 'length': 'short'}},
            {'operation': 'translate', 'data': {'text': 'Summary text', 'target_language': 'German'}},
            {'operation': 'sentiment', 'data': {'text': 'Translated summary'}}
        ]
        
        print("\nExecuting workflow:")
        print("  1. Summarize → 2. Translate → 3. Analyze Sentiment")
        print("-" * 80)
        
        responses = orchestrator.execute_workflow(workflow)
        
        print(f"\nWorkflow Results:")
        for i, response in enumerate(responses, 1):
            print(f"\n  Step {i}: {response.service_name}")
            print(f"    Status: {response.status_code}")
            print(f"    Duration: {response.duration*1000:.2f}ms")
        
        total_duration = sum(r.duration for r in responses)
        print(f"\n  Total Workflow Duration: {total_duration*1000:.2f}ms")
        
        # Summary
        print("\n" + "=" * 80)
        print("SUMMARY")
        print("=" * 80)
        
        summary = """
    The Microservice Agent Architecture demonstrates distributed AI systems:
    
    KEY CAPABILITIES:
    1. Service Registry: Automatic service discovery and registration
    2. API Gateway: Single entry point with intelligent routing
    3. Independent Services: Each capability as a separate microservice
    4. Health Monitoring: Continuous health checks and status tracking
    5. Service Orchestration: Coordinate complex multi-service workflows
    6. Fault Isolation: Failures contained within services
    7. Load Balancing: Distribute traffic across service instances
    8. Technology Diversity: Each service can use different tech stacks
    
    BENEFITS:
    - Independent deployment and scaling
    - Fault isolation and resilience
    - Technology flexibility per service
    - Team autonomy and parallel development
    - Easier testing and maintenance
    - Better resource utilization
    - Scalability for specific services
    - Faster iteration and releases
    
    USE CASES:
    - Large-scale AI platforms with multiple capabilities
    - Multi-tenant SaaS AI applications
    - Enterprise AI systems requiring high availability
    - Cloud-native AI applications
    - Distributed agent coordination
    - Microservices-based RAG systems
    - AI-powered e-commerce platforms
    - Scalable chatbot infrastructures
    - Multi-model serving platforms
    - Agent mesh architectures
    
    PRODUCTION CONSIDERATIONS:
    1. Service Discovery: Use Consul, etcd, or Kubernetes DNS
    2. API Gateway: Kong, NGINX, or AWS API Gateway
    3. Communication: REST APIs, gRPC, or message queues
    4. Monitoring: Distributed tracing (Jaeger, Zipkin)
    5. Logging: Centralized logging (ELK stack)
    6. Configuration: External config service (Spring Cloud Config)
    7. Security: API authentication, mTLS between services
    8. Circuit Breakers: Prevent cascading failures
    9. Container Orchestration: Kubernetes, Docker Swarm
    10. Service Mesh: Istio, Linkerd for advanced features
    
    ADVANCED EXTENSIONS:
    - Event-driven architecture with Kafka/RabbitMQ
    - CQRS pattern for read/write separation
    - Saga pattern for distributed transactions
    - API versioning and backward compatibility
    - Blue-green deployments
    - Canary releases for gradual rollouts
    - Auto-scaling based on metrics
    - Multi-region deployment
    - Service mesh for advanced traffic management
    - GraphQL federation for unified API
    
    Microservice architecture is essential for building scalable,
    maintainable, and resilient AI systems in production environments.
    """
        
        print(summary)
    
    
    if __name__ == "__main__":
        demonstrate_microservice_architecture()
    
        

    Agentic Design Pattern: Microservice Agent

    Pattern 081: Microservice Agent – Line-by-Line Explanation

    Overview

    This document provides a detailed line-by-line explanation of the Microservice Agent pattern implementation.


    Pattern Description

    Pattern 081: Microservice Agent Architecture

    Description: A Microservice Agent Architecture decomposes AI agents into independently deployable microservices that communicate via well-defined APIs. This pattern enables scalability, fault isolation, independent deployment, and technology diversity across agent components. Each microservice can be developed, deployed, and scaled independently while maintaining loose coupling.

    The architecture supports distributed agent systems with service discovery,
    load balancing, inter-service communication, circuit breakers, and observability
    across the microservices mesh.
    

    Components: 1. Agent Services: Independent agent microservices 2. API Gateway: Entry point and routing 3. Service Registry: Service discovery and health checks 4. Message Bus: Async inter-service communication 5. Load Balancer: Distribute requests across instances 6. Circuit Breaker: Fault tolerance and isolation 7. Config Service: Centralized configuration 8. Monitoring: Distributed tracing and metrics

    Key Features: – Independent service deployment – Service discovery and registration – Inter-service communication (REST, gRPC, message queues) – Load balancing and auto-scaling – Fault isolation and circuit breakers – Distributed tracing – API gateway pattern – Health checks and monitoring – Polyglot persistence – Technology diversity

    Use Cases: – Large-scale AI platforms – Multi-tenant AI services – Enterprise AI systems – Cloud-native AI applications – Distributed agent coordination – Scalable chatbot platforms – AI-powered SaaS products – Microservices-based RAG systems – Agent mesh architectures – Multi-model serving platforms

    LangChain Implementation: Uses FastAPI for service endpoints, service registry pattern, inter-service HTTP communication, and distributed agent coordination.


    File Statistics

    • Total Lines: 869
    • Classes: 12
    • Functions: 1
    • Constants: 0

    Module Documentation

    """
    Pattern 081: Microservice Agent Architecture
    
    Description:
        A Microservice Agent Architecture decomposes AI agents into independently
        deployable microservices that communicate via well-defined APIs. This pattern
        enables scalability, fault isolation, independent deployment, and technology
        diversity across agent components. Each microservice can be developed, deployed,
        and scaled independently while maintaining loose coupling.
    
        The architecture supports distributed agent systems with service discovery,
        load balancing, inter-service communication, circuit breakers, and observability
        across the microservices mesh.
    
    Components:
        1. Agent Services: Independent agent microservices
        2. API Gateway: Entry point and routing
        3. Service Registry: Service discovery and health checks
        4. Message Bus: Async inter-service communication
        5. Load Balancer: Distribute requests across instances
        6. Circuit Breaker: Fault tolerance and isolation
        7. Config Service: Centralized configuration
        8. Monitoring: Distributed tracing and metrics
    
    Key Features:
        - Independent service deployment
        - Service discovery and registration
        - Inter-service communication (REST, gRPC, message queues)
        - Load balancing and auto-scaling
        - Fault isolation and circuit breakers
        - Distributed tracing
        - API gateway pattern
        - Health checks and monitoring
        - Polyglot persistence
        - Technology diversity
    
    Use Cases:
        - Large-scale AI platforms
        - Multi-tenant AI services
        - Enterprise AI systems
        - Cloud-native AI applications
        - Distributed agent coordination
        - Scalable chatbot platforms
        - AI-powered SaaS products
        - Microservices-based RAG systems
        - Agent mesh architectures
        - Multi-model serving platforms
    
    LangChain Implementation:
        Uses FastAPI for service endpoints, service registry pattern,
        inter-service HTTP communication, and distributed agent coordination.
    """
    

    Purpose: This module implements the Microservice Agent pattern, providing a structured approach to agent design and implementation.


    Import Statements

    Standard Library Imports

    import collections.defaultdict
    import dataclasses.dataclass
    import dataclasses.field
    import datetime.datetime
    import enum.Enum
    import json
    import langchain_core.output_parsers.StrOutputParser
    import langchain_core.prompts.ChatPromptTemplate
    import os
    import time
    import typing.Any
    import typing.Callable
    import typing.Dict
    import typing.List
    import typing.Optional
    

    Purpose: Core Python functionality: – collections.defaultdict: Specialized container datatypes – dataclasses.dataclass: Simplified class definitions with @dataclass – dataclasses.field: Simplified class definitions with @dataclass – datetime.datetime: Date and time handling – enum.Enum: Enumeration support – json: JSON serialization/deserialization – langchain_core.output_parsers.StrOutputParser: Regular expression operations – langchain_core.prompts.ChatPromptTemplate: Regular expression operations – os: Environment variable access and system operations – time: Time-related functions – typing.Any: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Callable: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Dict: Type hints for better code documentation (List, Dict, Any, Optional) – typing.List: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Optional: Type hints for better code documentation (List, Dict, Any, Optional)

    LangChain Imports

    from langchain_openai.ChatOpenAI
    

    Purpose: LangChain framework components: – LLM Interface: Wrapper for OpenAI models – Chains: Composable building blocks for complex workflows

    Other Imports

    from dotenv.load_dotenv
    from uuid
    

    Purpose: Additional dependencies for specialized functionality.


    Classes

    Class: ServiceStatus

    Lines 72-78

    Inherits from: Enum

    Purpose:

    Status of a microservice
    

    Class: CommunicationProtocol

    Lines 81-86

    Inherits from: Enum

    Purpose:

    Inter-service communication protocol
    

    Class: ServiceInfo

    Lines 90-103

    Purpose:

    Information about a microservice
    

    Class: ServiceRequest

    Lines 107-115

    Purpose:

    Request to a microservice
    

    Class: ServiceResponse

    Lines 119-127

    Purpose:

    Response from a microservice
    

    Class: ServiceRegistry

    Lines 130-218

    Purpose:

    Service registry for microservice discovery.
    
    Maintains a registry of available services with health monitoring.
    

    Methods:

    __init__(self)

    Lines 137-140

    Purpose:

    Initialize service registry
    

    Parameters:

    register(self, service)

    Lines 142-154

    Purpose:

    Register a service.
    
    Args:
        service: Service information
    
    Returns:
        True if registered successfully
    

    Parameters: – service: Service

    Returns: bool

    deregister(self, service_id)

    Lines 156-171

    Purpose:

    Deregister a service.
    
    Args:
        service_id: Service ID
    
    Returns:
        True if deregistered successfully
    

    Parameters: – service_id: Service id

    Returns: bool

    discover(self, service_name)

    Lines 173-191

    Purpose:

    Discover a healthy service instance.
    
    Args:
        service_name: Name of service to discover
    
    Returns:
        ServiceInfo if found, None otherwise
    

    Parameters: – service_name: Service name

    Returns: <ast.Subscript object at 0x000001A06D7FF2D0>

    health_check(self, service_id)

    Lines 193-209

    Purpose:

    Check health of a service.
    
    Args:
        service_id: Service ID
    
    Returns:
        Service status
    

    Parameters: – service_id: Service id

    Returns: ServiceStatus

    list_services(self)

    Lines 211-218

    Purpose:

    List all registered services.
    
    Returns:
        List of service information
    

    Parameters:

    Returns: <ast.Subscript object at 0x000001A06D7FE710>


    Class: AgentService

    Lines 221-318

    Purpose:

    Base microservice for AI agents.
    
    Each agent capability is encapsulated as an independent service.
    

    Methods:

    __init__(self, service_name, version, port)

    Lines 228-253

    Purpose:

    Initialize agent service.
    
    Args:
        service_name: Name of the service
        version: Service version
        port: Port number
    

    Parameters: – service_name: Service name – version: Version – port: Port

    get_info(self)

    Lines 255-272

    Purpose:

    Get service information.
    
    Returns:
        ServiceInfo object
    

    Parameters:

    Returns: ServiceInfo

    start(self)

    Lines 274-282

    Purpose:

    Start the service.
    
    Returns:
        True if started successfully
    

    Parameters:

    Returns: bool

    stop(self)

    Lines 284-292

    Purpose:

    Stop the service.
    
    Returns:
        True if stopped successfully
    

    Parameters:

    Returns: bool

    health(self)

    Lines 294-306

    Purpose:

    Health check endpoint.
    
    Returns:
        Health status
    

    Parameters:

    Returns: <ast.Subscript object at 0x000001A06D7BB390>

    process(self, data)

    Lines 308-318

    Purpose:

    Process a request (to be overridden by subclasses).
    
    Args:
        data: Request data
    
    Returns:
        Response data
    

    Parameters: – data: Data

    Returns: <ast.Subscript object at 0x000001A06D7BADD0>


    Class: SummarizationService

    Lines 321-354

    Inherits from: AgentService

    Purpose:

    Microservice for text summarization
    

    Methods:

    __init__(self)

    Lines 324-325

    Purpose: Initialize the class instance with required parameters.

    Parameters:

    process(self, data)

    Lines 327-354

    Purpose:

    Summarize text.
    
    Args:
        data: {'text': str, 'length': str}
    
    Returns:
        {'summary': str}
    

    Parameters: – data: Data

    Returns: <ast.Subscript object at 0x000001A06D74A3D0>


    Class: TranslationService

    Lines 357-391

    Inherits from: AgentService

    Purpose:

    Microservice for translation
    

    Methods:

    __init__(self)

    Lines 360-361

    Purpose: Initialize the class instance with required parameters.

    Parameters:

    process(self, data)

    Lines 363-391

    Purpose:

    Translate text.
    
    Args:
        data: {'text': str, 'target_language': str}
    
    Returns:
        {'translation': str}
    

    Parameters: – data: Data

    Returns: <ast.Subscript object at 0x000001A06D72DB90>


    Class: SentimentService

    Lines 394-441

    Inherits from: AgentService

    Purpose:

    Microservice for sentiment analysis
    

    Methods:

    __init__(self)

    Lines 397-398

    Purpose: Initialize the class instance with required parameters.

    Parameters:

    process(self, data)

    Lines 400-441

    Purpose:

    Analyze sentiment.
    
    Args:
        data: {'text': str}
    
    Returns:
        {'sentiment': str, 'confidence': float}
    

    Parameters: – data: Data

    Returns: <ast.Subscript object at 0x000001A06D6061D0>


    Class: APIGateway

    Lines 444-534

    Purpose:

    API Gateway for routing requests to microservices.
    
    Provides a single entry point and routes to appropriate services.
    

    Methods:

    __init__(self, registry)

    Lines 451-464

    Purpose:

    Initialize API gateway.
    
    Args:
        registry: Service registry
    

    Parameters: – registry: Registry

    route(self, operation, data)

    Lines 466-534

    Purpose:

    Route request to appropriate service.
    
    Args:
        operation: Operation to perform
        data: Request data
    
    Returns:
        ServiceResponse
    

    Parameters: – operation: Operation – data: Data

    Returns: ServiceResponse


    Class: MicroserviceOrchestrator

    Lines 537-646

    Purpose:

    Orchestrator for coordinating multiple microservices.
    
    Manages service lifecycle and coordinates complex workflows
    across multiple services.
    

    Methods:

    __init__(self)

    Lines 545-549

    Purpose:

    Initialize orchestrator
    

    Parameters:

    deploy_service(self, service)

    Lines 551-571

    Purpose:

    Deploy a microservice.
    
    Args:
        service: Agent service to deploy
    
    Returns:
        True if deployed successfully
    

    Parameters: – service: Service

    Returns: bool

    undeploy_service(self, service_id)

    Lines 573-589

    Purpose:

    Undeploy a microservice.
    
    Args:
        service_id: Service ID
    
    Returns:
        True if undeployed successfully
    

    Parameters: – service_id: Service id

    Returns: bool

    execute_workflow(self, operations)

    Lines 591-613

    Purpose:

    Execute a workflow across multiple services.
    
    Args:
        operations: List of operations with data
    
    Returns:
        List of service responses
    

    Parameters: – operations: Operations

    Returns: <ast.Subscript object at 0x000001A06D7F4BD0>

    get_service_health(self)

    Lines 615-646

    Purpose:

    Get health status of all services.
    
    Returns:
        Health status dictionary
    

    Parameters:

    Returns: <ast.Subscript object at 0x000001A06D739690>


    Functions

    demonstrate_microservice_architecture()

    Lines 649-864

    Purpose:

    Demonstrate the microservice agent architecture
    

    Key Concepts Summary

    Pattern Overview

    The Microservice Agent pattern provides a structured approach to building AI agents with specific capabilities and behaviors. This implementation leverages LangChain’s composable components to create a robust and maintainable solution.

    Core Components

    1. Agent Class: Main implementation of the pattern logic
    2. Prompt Engineering: Carefully crafted prompts to guide LLM behavior
    3. Tool Integration: Optional tools for extended functionality
    4. Memory Management: State handling across interactions
    5. Output Parsing: Structured response processing

    When to Use

    ✅ Good for: – Scenarios requiring this specific pattern’s strengths – Applications needing structured agent behavior – Systems where explainability is important – Production environments requiring reliability

    ❌ Not ideal for: – Simple single-prompt tasks – Scenarios requiring different pattern characteristics – Resource-constrained environments (if computationally intensive)


    Best Practices Demonstrated

    1. Environment Configuration

    • ✅ Use .env files for API keys
    • ✅ Never hardcode credentials
    • ✅ Validate environment variables on startup

    2. Error Handling

    • ✅ Graceful degradation on failures
    • ✅ Informative error messages
    • ✅ Logging for debugging

    3. Prompt Engineering

    • ✅ Clear, specific instructions
    • ✅ Structured output formats
    • ✅ Few-shot examples when beneficial

    4. Code Organization

    • ✅ Separation of concerns (class-based design)
    • ✅ Type hints for clarity
    • ✅ Docstrings for documentation

    5. Performance Optimization

    • ✅ Appropriate temperature settings
    • ✅ Token budget management
    • ✅ Caching where applicable

    LangChain Components Used

    • ChatOpenAI: OpenAI model interface
    • Chains: Sequential component composition

    Why LangChain? – Composable abstractions for LLM applications – Rich ecosystem of integrations – Production-ready patterns – Active community and development


    Execution Flow

    1. Initialize agent with configuration
       ↓
    2. Load environment and dependencies
       ↓
    3. Prepare prompt with input data
       ↓
    4. Invoke LLM through LangChain
       ↓
    5. Parse and validate response
       ↓
    6. Return formatted result
    

    Key Decision Points: – Model selection (temperature, model type) – Prompt structure (few-shot vs zero-shot) – Error handling strategy – Output format validation


    Performance Considerations

    Computational Cost

    • LLM Calls: Primary cost factor (based on tokens)
    • Latency: Depends on model and input size
    • Memory: Minimal for most patterns

    Optimization Strategies

    1. Prompt Optimization: Minimize tokens while maintaining clarity
    2. Caching: Cache repeated queries/responses
    3. Model Selection: Use smaller models when appropriate
    4. Batch Processing: Group similar requests
    5. Streaming: For long responses, stream tokens

    Cost Estimates (Approximate)

    • GPT-3.5-turbo: ~$0.002 per request
    • GPT-4: ~$0.03 per request
    • GPT-4-turbo: ~$0.01 per request

    Actual costs vary based on input/output token counts


    Common Pitfalls to Avoid

    1. Prompt Design Issues

    ❌ Vague or ambiguous instructions
    ✅ Clear, specific, testable prompts

    2. Error Handling

    ❌ Ignoring API errors or rate limits
    ✅ Implement retry logic and graceful degradation

    3. Token Management

    ❌ Exceeding model token limits
    ✅ Truncate inputs, chunk processing

    4. Security

    ❌ Exposing API keys in code
    ✅ Use environment variables

    5. Testing

    ❌ Only testing happy paths
    ✅ Test edge cases, failures, malformed inputs

    6. Cost Management

    ❌ Unmonitored API usage
    ✅ Implement budgets, alerts, and monitoring


    Further Improvements

    Production Enhancements

    1. Monitoring: Add logging, metrics, tracing
    2. Validation: Input/output schema validation
    3. Rate Limiting: Implement request throttling
    4. Caching: Redis or in-memory cache for responses
    5. Async Support: Non-blocking operations for scalability

    Feature Extensions

    1. Multi-Model Support: Switch between providers
    2. Fallback Models: Graceful degradation strategy
    3. Custom Tools: Domain-specific function calling
    4. Advanced Memory: Vector stores for long-term memory
    5. Evaluation: Automated testing and benchmarking

    Code Quality

    1. Testing: Unit tests, integration tests
    2. Documentation: API docs, usage examples
    3. Type Safety: Stricter type hints
    4. Configuration: Externalized config files

    Related Patterns

    • Pattern 080
    • Pattern 082

    Pattern Families: – Reasoning Patterns (001-011) – Multi-Agent Patterns (012-019) – Tool Use Patterns (020-025) – Memory Patterns (026-031) – And many more…


    Summary

    The Microservice Agent pattern provides a powerful approach to building AI agents with specific capabilities. This implementation demonstrates:

    ✅ Key Strengths: – Clean, maintainable code structure – LangChain integration for composability – Type hints and documentation – Production-ready patterns

    🎯 Best Use Cases: – Applications requiring this pattern’s characteristics – Systems needing structured agent behavior – Production environments requiring reliability

    📚 Learning Resources: – LangChain Documentation: https://python.langchain.com/ – Pattern Documentation: See related patterns – OpenAI API Reference: https://platform.openai.com/docs/


    File: 081_microservice_agent.py
    Total Lines: 869
    Pattern Category: AI Agent Design Pattern #081


    Generated from actual implementation code
    For educational and reference purposes

  • Agentic Design Pattern: Async Agent

    
        """
    Pattern 080: Asynchronous Agent
    
    Description:
        An Asynchronous Agent uses async/await patterns to handle concurrent operations
        without blocking. This pattern is essential for building high-performance,
        scalable AI applications that can handle multiple requests simultaneously,
        make concurrent API calls, and provide responsive user experiences.
        
        The agent leverages Python's asyncio for non-blocking I/O operations, enabling
        efficient resource utilization and improved throughput. It supports concurrent
        LLM calls, parallel tool execution, and async streaming for maximum performance.
    
    Components:
        1. Async Executor: Manages async task execution
        2. Concurrent Runner: Runs multiple tasks concurrently
        3. Async LLM Client: Non-blocking LLM interactions
        4. Task Scheduler: Schedules and coordinates async tasks
        5. Result Collector: Aggregates concurrent results
        6. Error Handler: Handles async exceptions
        7. Timeout Manager: Enforces timeouts on async operations
        8. Resource Pool: Manages async resources and connections
    
    Key Features:
        - Non-blocking async/await operations
        - Concurrent LLM calls
        - Parallel tool execution
        - Async streaming
        - Task cancellation
        - Timeout handling
        - Connection pooling
        - Backpressure management
        - Error propagation
        - Graceful shutdown
    
    Use Cases:
        - High-throughput API servers
        - Real-time chat applications
        - Concurrent data processing
        - Parallel research queries
        - Multi-source information gathering
        - Async web scraping
        - Real-time analytics
        - Concurrent translation services
        - Parallel validation
        - Multi-agent coordination
    
    LangChain Implementation:
        Uses ChatOpenAI with async methods (ainvoke, astream, abatch),
        asyncio for concurrency, and async LCEL chains.
    """
    
    import os
    import asyncio
    import time
    from typing import List, Dict, Any, Optional, Coroutine, Callable
    from dataclasses import dataclass, field
    from enum import Enum
    from datetime import datetime
    from dotenv import load_dotenv
    
    from langchain_core.prompts import ChatPromptTemplate
    from langchain_core.output_parsers import StrOutputParser
    from langchain_openai import ChatOpenAI
    from langchain_core.runnables import RunnablePassthrough
    
    load_dotenv()
    
    
    class TaskStatus(Enum):
        """Status of async task"""
        PENDING = "pending"
        RUNNING = "running"
        COMPLETED = "completed"
        FAILED = "failed"
        CANCELLED = "cancelled"
        TIMEOUT = "timeout"
    
    
    @dataclass
    class AsyncTask:
        """An asynchronous task"""
        task_id: str
        name: str
        coroutine: Coroutine
        status: TaskStatus = TaskStatus.PENDING
        result: Optional[Any] = None
        error: Optional[str] = None
        started_at: Optional[datetime] = None
        completed_at: Optional[datetime] = None
        duration: float = 0.0
    
    
    @dataclass
    class AsyncResult:
        """Result of async operation"""
        task_id: str
        success: bool
        result: Optional[Any] = None
        error: Optional[str] = None
        duration: float = 0.0
        metadata: Dict[str, Any] = field(default_factory=dict)
    
    
    @dataclass
    class ConcurrentResult:
        """Result of concurrent operations"""
        total_tasks: int
        successful: int
        failed: int
        cancelled: int
        results: List[AsyncResult]
        total_duration: float
        average_duration: float
    
    
    class AsyncAgent:
        """
        Agent that uses async/await for non-blocking operations.
        
        This agent enables high-performance concurrent processing with
        async LLM calls, parallel tool execution, and efficient resource usage.
        """
        
        def __init__(self, max_concurrent: int = 10, timeout: float = 30.0):
            """
            Initialize the async agent.
            
            Args:
                max_concurrent: Maximum concurrent tasks
                timeout: Default timeout for operations
            """
            self.max_concurrent = max_concurrent
            self.timeout = timeout
            
            # Async LLM
            self.llm = ChatOpenAI(
                model="gpt-3.5-turbo",
                temperature=0.7
            )
            
            # Task tracking
            self.tasks: Dict[str, AsyncTask] = {}
            self.semaphore = asyncio.Semaphore(max_concurrent)
        
        async def ainvoke_llm(
            self,
            prompt: str,
            timeout: Optional[float] = None
        ) -> str:
            """
            Invoke LLM asynchronously.
            
            Args:
                prompt: Input prompt
                timeout: Optional timeout
                
            Returns:
                LLM response
            """
            timeout = timeout or self.timeout
            
            try:
                response = await asyncio.wait_for(
                    self.llm.ainvoke(prompt),
                    timeout=timeout
                )
                return response.content
            except asyncio.TimeoutError:
                raise TimeoutError(f"LLM call timed out after {timeout}s")
        
        async def astream_llm(
            self,
            prompt: str,
            on_token: Optional[Callable[[str], None]] = None
        ) -> str:
            """
            Stream LLM response asynchronously.
            
            Args:
                prompt: Input prompt
                on_token: Optional token callback
                
            Returns:
                Full response
            """
            full_response = ""
            
            async for chunk in self.llm.astream(prompt):
                if hasattr(chunk, 'content'):
                    token = chunk.content
                    full_response += token
                    
                    if on_token:
                        on_token(token)
            
            return full_response
        
        async def run_concurrent_tasks(
            self,
            tasks: List[Coroutine],
            task_names: Optional[List[str]] = None
        ) -> ConcurrentResult:
            """
            Run multiple tasks concurrently.
            
            Args:
                tasks: List of coroutines to execute
                task_names: Optional names for tasks
                
            Returns:
                ConcurrentResult with all results
            """
            start_time = time.time()
            
            if task_names is None:
                task_names = [f"task_{i}" for i in range(len(tasks))]
            
            # Run tasks concurrently with semaphore
            async def run_with_semaphore(coro: Coroutine, name: str) -> AsyncResult:
                async with self.semaphore:
                    task_start = time.time()
                    task_id = f"{name}_{id(coro)}"
                    
                    try:
                        result = await coro
                        return AsyncResult(
                            task_id=task_id,
                            success=True,
                            result=result,
                            duration=time.time() - task_start
                        )
                    except Exception as e:
                        return AsyncResult(
                            task_id=task_id,
                            success=False,
                            error=str(e),
                            duration=time.time() - task_start
                        )
            
            # Execute all tasks
            results = await asyncio.gather(
                *[run_with_semaphore(task, name) for task, name in zip(tasks, task_names)],
                return_exceptions=True
            )
            
            # Process results
            async_results = []
            successful = 0
            failed = 0
            cancelled = 0
            
            for result in results:
                if isinstance(result, AsyncResult):
                    async_results.append(result)
                    if result.success:
                        successful += 1
                    else:
                        failed += 1
                elif isinstance(result, asyncio.CancelledError):
                    cancelled += 1
                else:
                    failed += 1
            
            total_duration = time.time() - start_time
            avg_duration = sum(r.duration for r in async_results) / len(async_results) if async_results else 0
            
            return ConcurrentResult(
                total_tasks=len(tasks),
                successful=successful,
                failed=failed,
                cancelled=cancelled,
                results=async_results,
                total_duration=total_duration,
                average_duration=avg_duration
            )
        
        async def parallel_llm_calls(
            self,
            prompts: List[str],
            timeout: Optional[float] = None
        ) -> List[str]:
            """
            Make multiple LLM calls in parallel.
            
            Args:
                prompts: List of prompts
                timeout: Optional timeout per call
                
            Returns:
                List of responses
            """
            tasks = [self.ainvoke_llm(prompt, timeout) for prompt in prompts]
            result = await self.run_concurrent_tasks(
                tasks,
                [f"llm_call_{i}" for i in range(len(prompts))]
            )
            
            return [r.result for r in result.results if r.success]
        
        async def concurrent_chain_execution(
            self,
            inputs: List[Dict[str, str]],
            template: str
        ) -> List[str]:
            """
            Execute chain concurrently with different inputs.
            
            Args:
                inputs: List of input dictionaries
                template: Prompt template
                
            Returns:
                List of results
            """
            prompt = ChatPromptTemplate.from_template(template)
            chain = prompt | self.llm | StrOutputParser()
            
            # Create async tasks for each input
            tasks = [chain.ainvoke(input_dict) for input_dict in inputs]
            
            result = await self.run_concurrent_tasks(
                tasks,
                [f"chain_{i}" for i in range(len(inputs))]
            )
            
            return [r.result for r in result.results if r.success]
        
        async def parallel_with_timeout(
            self,
            tasks: List[Coroutine],
            timeout: float
        ) -> List[Optional[Any]]:
            """
            Run tasks in parallel with timeout.
            
            Args:
                tasks: List of coroutines
                timeout: Timeout for all tasks
                
            Returns:
                List of results (None for timed out tasks)
            """
            try:
                results = await asyncio.wait_for(
                    asyncio.gather(*tasks, return_exceptions=True),
                    timeout=timeout
                )
                
                return [
                    r if not isinstance(r, Exception) else None
                    for r in results
                ]
            except asyncio.TimeoutError:
                return [None] * len(tasks)
        
        async def async_map(
            self,
            func: Callable[[Any], Coroutine],
            items: List[Any],
            batch_size: Optional[int] = None
        ) -> List[Any]:
            """
            Map an async function over items with optional batching.
            
            Args:
                func: Async function to map
                items: Items to process
                batch_size: Optional batch size for processing
                
            Returns:
                List of results
            """
            if batch_size is None:
                batch_size = self.max_concurrent
            
            results = []
            
            for i in range(0, len(items), batch_size):
                batch = items[i:i + batch_size]
                batch_tasks = [func(item) for item in batch]
                batch_results = await asyncio.gather(*batch_tasks)
                results.extend(batch_results)
            
            return results
        
        async def race_tasks(
            self,
            tasks: List[Coroutine],
            return_first: bool = True
        ) -> Any:
            """
            Race multiple tasks, return first to complete.
            
            Args:
                tasks: List of coroutines to race
                return_first: Return first completed (True) or all (False)
                
            Returns:
                First result or all results
            """
            if return_first:
                done, pending = await asyncio.wait(
                    tasks,
                    return_when=asyncio.FIRST_COMPLETED
                )
                
                # Cancel remaining tasks
                for task in pending:
                    task.cancel()
                
                # Return first result
                return list(done)[0].result()
            else:
                return await asyncio.gather(*tasks)
        
        async def retry_async(
            self,
            coro: Coroutine,
            max_retries: int = 3,
            backoff: float = 1.0
        ) -> Any:
            """
            Retry an async operation with exponential backoff.
            
            Args:
                coro: Coroutine to retry
                max_retries: Maximum retry attempts
                backoff: Initial backoff time
                
            Returns:
                Result of successful attempt
            """
            last_exception = None
            
            for attempt in range(max_retries):
                try:
                    return await coro
                except Exception as e:
                    last_exception = e
                    if attempt  str:
            await asyncio.sleep(0.1)  # Simulate work
            return await agent.ainvoke_llm(f"Count to {n} and stop.")
        
        tasks = [sample_task(i) for i in range(1, 6)]
        task_names = [f"count_to_{i}" for i in range(1, 6)]
        
        print(f"\nRunning {len(tasks)} concurrent tasks...")
        print("-" * 80)
        
        result = await agent.run_concurrent_tasks(tasks, task_names)
        
        print(f"✓ All tasks completed!")
        print(f"\nStatistics:")
        print(f"  Total Tasks: {result.total_tasks}")
        print(f"  Successful: {result.successful}")
        print(f"  Failed: {result.failed}")
        print(f"  Total Duration: {result.total_duration:.2f}s")
        print(f"  Average Duration: {result.average_duration:.2f}s")
        
        # Demo 4: Async Streaming
        print("\n" + "=" * 80)
        print("DEMO 4: Asynchronous Streaming")
        print("=" * 80)
        
        prompt = "Write a haiku about async programming."
        
        print(f"\nPrompt: {prompt}")
        print("\nStreaming response asynchronously:")
        print("-" * 80)
        
        tokens = []
        
        def on_token(token: str):
            tokens.append(token)
            print(token, end="", flush=True)
        
        stream_response = await agent.astream_llm(prompt, on_token=on_token)
        
        print("\n" + "-" * 80)
        print(f"✓ Streaming complete! ({len(tokens)} tokens)")
        
        # Demo 5: Task Racing
        print("\n" + "=" * 80)
        print("DEMO 5: Task Racing (First to Complete)")
        print("=" * 80)
        
        async def llm_task(question: str, delay: float) -> str:
            await asyncio.sleep(delay)
            return await agent.ainvoke_llm(question)
        
        race_tasks = [
            llm_task("Quick answer: What is AI?", 0.1),
            llm_task("Quick answer: What is ML?", 0.2),
            llm_task("Quick answer: What is DL?", 0.3)
        ]
        
        print("\nRacing 3 tasks, returning first to complete...")
        print("-" * 80)
        
        race_start = time.time()
        first_result = await agent.race_tasks(race_tasks, return_first=True)
        race_duration = time.time() - race_start
        
        print(f"✓ First task completed in {race_duration:.2f}s")
        print(f"\nResult: {first_result[:150]}...")
        
        # Demo 6: Async vs Sync Performance
        print("\n" + "=" * 80)
        print("DEMO 6: Async vs Synchronous Performance")
        print("=" * 80)
        
        test_prompts = [f"Answer: What is {topic}?" for topic in ["AI", "ML", "DL", "NLP", "CV"]]
        
        print(f"\nProcessing {len(test_prompts)} prompts...")
        
        # Async approach
        print("\nAsync Approach:")
        async_start = time.time()
        async_results = await agent.parallel_llm_calls(test_prompts[:3])  # Limit for demo
        async_duration = time.time() - async_start
        print(f"  Duration: {async_duration:.2f}s")
        print(f"  Results: {len(async_results)} responses")
        
        # Sync approach (simulated)
        print("\nSync Approach (estimated):")
        estimated_sync = async_duration * 3  # Rough estimate
        print(f"  Estimated Duration: {estimated_sync:.2f}s")
        
        speedup = estimated_sync / async_duration if async_duration > 0 else 0
        print(f"\nSpeedup: {speedup:.2f}x faster with async")
        
        # Summary
        print("\n" + "=" * 80)
        print("SUMMARY")
        print("=" * 80)
        
        summary = """
    The Asynchronous Agent demonstrates non-blocking concurrent operations:
    
    KEY CAPABILITIES:
    1. Async LLM Calls: Non-blocking LLM interactions with ainvoke
    2. Parallel Execution: Run multiple tasks concurrently
    3. Async Streaming: Non-blocking streaming responses
    4. Concurrent Chains: Execute chains with different inputs in parallel
    5. Task Racing: Return first completed result
    6. Timeout Handling: Enforce timeouts on async operations
    7. Error Handling: Graceful exception handling in async context
    8. Resource Management: Semaphore-based concurrency control
    
    BENEFITS:
    - Dramatically improved throughput
    - Non-blocking I/O for better resource utilization
    - Lower latency for concurrent operations
    - Scalable to handle many simultaneous requests
    - Efficient handling of I/O-bound workloads
    - Better responsiveness in applications
    - Reduced total execution time
    - Enhanced user experience
    
    USE CASES:
    - High-throughput API servers
    - Real-time chat applications with multiple users
    - Concurrent data processing pipelines
    - Parallel research and information gathering
    - Multi-source data aggregation
    - Async web scraping
    - Real-time analytics dashboards
    - Concurrent translation services
    - Parallel validation and checking
    - Multi-agent systems coordination
    
    PRODUCTION CONSIDERATIONS:
    1. Concurrency Limits: Use semaphores to control concurrent tasks
    2. Timeout Management: Always set timeouts for async operations
    3. Error Propagation: Handle exceptions in async context properly
    4. Resource Cleanup: Ensure proper cleanup of async resources
    5. Backpressure: Handle slow consumers gracefully
    6. Connection Pooling: Reuse connections efficiently
    7. Monitoring: Track async task performance
    8. Testing: Test with asyncio.run() and pytest-asyncio
    9. Event Loop: Manage event loop lifecycle carefully
    10. Cancellation: Support graceful task cancellation
    
    ADVANCED EXTENSIONS:
    - Async context managers for resource management
    - Event-driven architectures with async events
    - Async queues for producer-consumer patterns
    - Async locks and synchronization primitives
    - Distributed async processing
    - Async retry with circuit breakers
    - Priority-based async task scheduling
    - Async result caching
    - Streaming async aggregation
    - Async middleware chains
    
    Async patterns are essential for building high-performance,
    scalable AI applications that handle concurrent operations efficiently.
    """
        
        print(summary)
    
    
    def demonstrate_async_agent_sync():
        """Synchronous wrapper for async demonstration"""
        asyncio.run(demonstrate_async_agent())
    
    
    if __name__ == "__main__":
        demonstrate_async_agent_sync()
    
        

    Agentic Design Pattern: Async Agent

    Pattern 080: Async Agent – Line-by-Line Explanation

    Overview

    This document provides a detailed line-by-line explanation of the Async Agent pattern implementation.


    Pattern Description

    Pattern 080: Asynchronous Agent

    Description: An Asynchronous Agent uses async/await patterns to handle concurrent operations without blocking. This pattern is essential for building high-performance, scalable AI applications that can handle multiple requests simultaneously, make concurrent API calls, and provide responsive user experiences.

    The agent leverages Python's asyncio for non-blocking I/O operations, enabling
    efficient resource utilization and improved throughput. It supports concurrent
    LLM calls, parallel tool execution, and async streaming for maximum performance.
    

    Components: 1. Async Executor: Manages async task execution 2. Concurrent Runner: Runs multiple tasks concurrently 3. Async LLM Client: Non-blocking LLM interactions 4. Task Scheduler: Schedules and coordinates async tasks 5. Result Collector: Aggregates concurrent results 6. Error Handler: Handles async exceptions 7. Timeout Manager: Enforces timeouts on async operations 8. Resource Pool: Manages async resources and connections

    Key Features: – Non-blocking async/await operations – Concurrent LLM calls – Parallel tool execution – Async streaming – Task cancellation – Timeout handling – Connection pooling – Backpressure management – Error propagation – Graceful shutdown

    Use Cases: – High-throughput API servers – Real-time chat applications – Concurrent data processing – Parallel research queries – Multi-source information gathering – Async web scraping – Real-time analytics – Concurrent translation services – Parallel validation – Multi-agent coordination

    LangChain Implementation: Uses ChatOpenAI with async methods (ainvoke, astream, abatch), asyncio for concurrency, and async LCEL chains.


    File Statistics

    • Total Lines: 682
    • Classes: 5
    • Functions: 1
    • Constants: 0

    Module Documentation

    """
    Pattern 080: Asynchronous Agent
    
    Description:
        An Asynchronous Agent uses async/await patterns to handle concurrent operations
        without blocking. This pattern is essential for building high-performance,
        scalable AI applications that can handle multiple requests simultaneously,
        make concurrent API calls, and provide responsive user experiences.
    
        The agent leverages Python's asyncio for non-blocking I/O operations, enabling
        efficient resource utilization and improved throughput. It supports concurrent
        LLM calls, parallel tool execution, and async streaming for maximum performance.
    
    Components:
        1. Async Executor: Manages async task execution
        2. Concurrent Runner: Runs multiple tasks concurrently
        3. Async LLM Client: Non-blocking LLM interactions
        4. Task Scheduler: Schedules and coordinates async tasks
        5. Result Collector: Aggregates concurrent results
        6. Error Handler: Handles async exceptions
        7. Timeout Manager: Enforces timeouts on async operations
        8. Resource Pool: Manages async resources and connections
    
    Key Features:
        - Non-blocking async/await operations
        - Concurrent LLM calls
        - Parallel tool execution
        - Async streaming
        - Task cancellation
        - Timeout handling
        - Connection pooling
        - Backpressure management
        - Error propagation
        - Graceful shutdown
    
    Use Cases:
        - High-throughput API servers
        - Real-time chat applications
        - Concurrent data processing
        - Parallel research queries
        - Multi-source information gathering
        - Async web scraping
        - Real-time analytics
        - Concurrent translation services
        - Parallel validation
        - Multi-agent coordination
    
    LangChain Implementation:
        Uses ChatOpenAI with async methods (ainvoke, astream, abatch),
        asyncio for concurrency, and async LCEL chains.
    """
    

    Purpose: This module implements the Async Agent pattern, providing a structured approach to agent design and implementation.


    Import Statements

    Standard Library Imports

    import asyncio
    import dataclasses.dataclass
    import dataclasses.field
    import datetime.datetime
    import enum.Enum
    import langchain_core.output_parsers.StrOutputParser
    import langchain_core.prompts.ChatPromptTemplate
    import langchain_core.runnables.RunnablePassthrough
    import os
    import time
    import typing.Any
    import typing.Callable
    import typing.Coroutine
    import typing.Dict
    import typing.List
    import typing.Optional
    

    Purpose: Core Python functionality: – asyncio: Asynchronous I/O operations – dataclasses.dataclass: Simplified class definitions with @dataclass – dataclasses.field: Simplified class definitions with @dataclass – datetime.datetime: Date and time handling – enum.Enum: Enumeration support – langchain_core.output_parsers.StrOutputParser: Regular expression operations – langchain_core.prompts.ChatPromptTemplate: Regular expression operations – langchain_core.runnables.RunnablePassthrough: Regular expression operations – os: Environment variable access and system operations – time: Time-related functions – typing.Any: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Callable: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Coroutine: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Dict: Type hints for better code documentation (List, Dict, Any, Optional) – typing.List: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Optional: Type hints for better code documentation (List, Dict, Any, Optional)

    LangChain Imports

    from langchain_openai.ChatOpenAI
    

    Purpose: LangChain framework components: – LLM Interface: Wrapper for OpenAI models – Chains: Composable building blocks for complex workflows

    Other Imports

    from dotenv.load_dotenv
    

    Purpose: Additional dependencies for specialized functionality.


    Classes

    Class: TaskStatus

    Lines 70-77

    Inherits from: Enum

    Purpose:

    Status of async task
    

    Class: AsyncTask

    Lines 81-91

    Purpose:

    An asynchronous task
    

    Class: AsyncResult

    Lines 95-102

    Purpose:

    Result of async operation
    

    Class: ConcurrentResult

    Lines 106-114

    Purpose:

    Result of concurrent operations
    

    Class: AsyncAgent

    Lines 117-444

    Purpose:

    Agent that uses async/await for non-blocking operations.
    
    This agent enables high-performance concurrent processing with
    async LLM calls, parallel tool execution, and efficient resource usage.
    

    Methods:

    __init__(self, max_concurrent, timeout)

    Lines 125-144

    Purpose:

    Initialize the async agent.
    
    Args:
        max_concurrent: Maximum concurrent tasks
        timeout: Default timeout for operations
    

    Parameters: – max_concurrent: Max concurrent – timeout: Timeout


    Functions

    demonstrate_async_agent_sync()

    Lines 675-677

    Purpose:

    Synchronous wrapper for async demonstration
    

    Key Concepts Summary

    Pattern Overview

    The Async Agent pattern provides a structured approach to building AI agents with specific capabilities and behaviors. This implementation leverages LangChain’s composable components to create a robust and maintainable solution.

    Core Components

    1. Agent Class: Main implementation of the pattern logic
    2. Prompt Engineering: Carefully crafted prompts to guide LLM behavior
    3. Tool Integration: Optional tools for extended functionality
    4. Memory Management: State handling across interactions
    5. Output Parsing: Structured response processing

    When to Use

    ✅ Good for: – Scenarios requiring this specific pattern’s strengths – Applications needing structured agent behavior – Systems where explainability is important – Production environments requiring reliability

    ❌ Not ideal for: – Simple single-prompt tasks – Scenarios requiring different pattern characteristics – Resource-constrained environments (if computationally intensive)


    Best Practices Demonstrated

    1. Environment Configuration

    • ✅ Use .env files for API keys
    • ✅ Never hardcode credentials
    • ✅ Validate environment variables on startup

    2. Error Handling

    • ✅ Graceful degradation on failures
    • ✅ Informative error messages
    • ✅ Logging for debugging

    3. Prompt Engineering

    • ✅ Clear, specific instructions
    • ✅ Structured output formats
    • ✅ Few-shot examples when beneficial

    4. Code Organization

    • ✅ Separation of concerns (class-based design)
    • ✅ Type hints for clarity
    • ✅ Docstrings for documentation

    5. Performance Optimization

    • ✅ Appropriate temperature settings
    • ✅ Token budget management
    • ✅ Caching where applicable

    LangChain Components Used

    • ChatOpenAI: OpenAI model interface
    • Chains: Sequential component composition

    Why LangChain? – Composable abstractions for LLM applications – Rich ecosystem of integrations – Production-ready patterns – Active community and development


    Execution Flow

    1. Initialize agent with configuration
       ↓
    2. Load environment and dependencies
       ↓
    3. Prepare prompt with input data
       ↓
    4. Invoke LLM through LangChain
       ↓
    5. Parse and validate response
       ↓
    6. Return formatted result
    

    Key Decision Points: – Model selection (temperature, model type) – Prompt structure (few-shot vs zero-shot) – Error handling strategy – Output format validation


    Performance Considerations

    Computational Cost

    • LLM Calls: Primary cost factor (based on tokens)
    • Latency: Depends on model and input size
    • Memory: Minimal for most patterns

    Optimization Strategies

    1. Prompt Optimization: Minimize tokens while maintaining clarity
    2. Caching: Cache repeated queries/responses
    3. Model Selection: Use smaller models when appropriate
    4. Batch Processing: Group similar requests
    5. Streaming: For long responses, stream tokens

    Cost Estimates (Approximate)

    • GPT-3.5-turbo: ~$0.002 per request
    • GPT-4: ~$0.03 per request
    • GPT-4-turbo: ~$0.01 per request

    Actual costs vary based on input/output token counts


    Common Pitfalls to Avoid

    1. Prompt Design Issues

    ❌ Vague or ambiguous instructions
    ✅ Clear, specific, testable prompts

    2. Error Handling

    ❌ Ignoring API errors or rate limits
    ✅ Implement retry logic and graceful degradation

    3. Token Management

    ❌ Exceeding model token limits
    ✅ Truncate inputs, chunk processing

    4. Security

    ❌ Exposing API keys in code
    ✅ Use environment variables

    5. Testing

    ❌ Only testing happy paths
    ✅ Test edge cases, failures, malformed inputs

    6. Cost Management

    ❌ Unmonitored API usage
    ✅ Implement budgets, alerts, and monitoring


    Further Improvements

    Production Enhancements

    1. Monitoring: Add logging, metrics, tracing
    2. Validation: Input/output schema validation
    3. Rate Limiting: Implement request throttling
    4. Caching: Redis or in-memory cache for responses
    5. Async Support: Non-blocking operations for scalability

    Feature Extensions

    1. Multi-Model Support: Switch between providers
    2. Fallback Models: Graceful degradation strategy
    3. Custom Tools: Domain-specific function calling
    4. Advanced Memory: Vector stores for long-term memory
    5. Evaluation: Automated testing and benchmarking

    Code Quality

    1. Testing: Unit tests, integration tests
    2. Documentation: API docs, usage examples
    3. Type Safety: Stricter type hints
    4. Configuration: Externalized config files

    Related Patterns

    • Pattern 079
    • Pattern 081

    Pattern Families: – Reasoning Patterns (001-011) – Multi-Agent Patterns (012-019) – Tool Use Patterns (020-025) – Memory Patterns (026-031) – And many more…


    Summary

    The Async Agent pattern provides a powerful approach to building AI agents with specific capabilities. This implementation demonstrates:

    ✅ Key Strengths: – Clean, maintainable code structure – LangChain integration for composability – Type hints and documentation – Production-ready patterns

    🎯 Best Use Cases: – Applications requiring this pattern’s characteristics – Systems needing structured agent behavior – Production environments requiring reliability

    📚 Learning Resources: – LangChain Documentation: https://python.langchain.com/ – Pattern Documentation: See related patterns – OpenAI API Reference: https://platform.openai.com/docs/


    File: 080_async_agent.py
    Total Lines: 682
    Pattern Category: AI Agent Design Pattern #080


    Generated from actual implementation code
    For educational and reference purposes

  • Agentic Design Pattern: Batch Processing

    
        """
    Pattern 079: Batch Processing Agent
    
    Description:
        A Batch Processing Agent handles multiple tasks or inputs concurrently in batches,
        optimizing throughput and resource utilization. This pattern is essential for
        processing large volumes of data efficiently, enabling parallel execution,
        job queuing, progress monitoring, and result aggregation.
        
        The agent manages batches of work items, distributes them across available resources,
        monitors progress, handles failures, and aggregates results. It supports various
        batching strategies including size-based, time-based, and priority-based batching.
    
    Components:
        1. Batch Scheduler: Schedules and organizes batch jobs
        2. Job Queue: Manages pending work items
        3. Parallel Executor: Executes tasks concurrently
        4. Progress Monitor: Tracks batch processing progress
        5. Result Aggregator: Combines individual results
        6. Error Handler: Handles failures and retries
        7. Resource Manager: Manages compute resources
        8. Throughput Optimizer: Optimizes batch sizes
    
    Key Features:
        - Parallel batch processing
        - Dynamic batch sizing
        - Job queue management
        - Progress tracking
        - Error handling and retries
        - Result aggregation
        - Resource optimization
        - Priority scheduling
        - Cancellation support
        - Checkpointing for resumption
    
    Use Cases:
        - Bulk document processing
        - Large-scale data analysis
        - Batch translation services
        - Bulk content generation
        - Mass email personalization
        - Dataset annotation
        - Batch image processing
        - ETL pipelines
        - Bulk API operations
        - Large-scale testing
    
    LangChain Implementation:
        Uses concurrent.futures for parallel execution, batch processing utilities,
        and structured output handling for aggregation.
    """
    
    import os
    import time
    import uuid
    from typing import List, Dict, Any, Optional, Callable, Tuple
    from dataclasses import dataclass, field
    from enum import Enum
    from datetime import datetime
    from concurrent.futures import ThreadPoolExecutor, as_completed
    from collections import defaultdict
    from dotenv import load_dotenv
    
    from langchain_core.prompts import ChatPromptTemplate
    from langchain_core.output_parsers import StrOutputParser
    from langchain_openai import ChatOpenAI
    
    load_dotenv()
    
    
    class JobStatus(Enum):
        """Status of a batch job"""
        PENDING = "pending"
        QUEUED = "queued"
        PROCESSING = "processing"
        COMPLETED = "completed"
        FAILED = "failed"
        CANCELLED = "cancelled"
        RETRYING = "retrying"
    
    
    class BatchStrategy(Enum):
        """Batching strategy"""
        SIZE_BASED = "size_based"  # Fixed batch size
        TIME_BASED = "time_based"  # Time window
        ADAPTIVE = "adaptive"  # Dynamic sizing
        PRIORITY = "priority"  # Priority-based
    
    
    @dataclass
    class BatchJob:
        """A single job in a batch"""
        job_id: str
        input_data: Any
        priority: int = 0  # Higher = more important
        status: JobStatus = JobStatus.PENDING
        result: Optional[Any] = None
        error: Optional[str] = None
        attempts: int = 0
        created_at: datetime = field(default_factory=datetime.now)
        started_at: Optional[datetime] = None
        completed_at: Optional[datetime] = None
    
    
    @dataclass
    class BatchConfig:
        """Configuration for batch processing"""
        batch_size: int = 10
        max_workers: int = 4
        max_retries: int = 3
        timeout: float = 60.0  # seconds per job
        strategy: BatchStrategy = BatchStrategy.SIZE_BASED
        aggregate_results: bool = True
        checkpoint_interval: int = 10  # Jobs between checkpoints
    
    
    @dataclass
    class BatchResult:
        """Result of batch processing"""
        batch_id: str
        total_jobs: int
        completed: int
        failed: int
        cancelled: int
        results: List[Any]
        errors: List[Tuple[str, str]]  # (job_id, error)
        duration: float
        throughput: float  # jobs/second
        metadata: Dict[str, Any] = field(default_factory=dict)
    
    
    @dataclass
    class BatchProgress:
        """Progress of batch processing"""
        batch_id: str
        total_jobs: int
        completed: int
        processing: int
        pending: int
        failed: int
        progress_pct: float
        estimated_remaining: float  # seconds
        current_throughput: float
    
    
    class BatchProcessingAgent:
        """
        Agent for efficient batch processing of multiple tasks.
        
        This agent handles large volumes of work by processing items in batches,
        with parallel execution, error handling, and progress tracking.
        """
        
        def __init__(self, config: BatchConfig = BatchConfig()):
            """Initialize the batch processing agent"""
            self.config = config
            
            # LLM for processing
            self.llm = ChatOpenAI(
                model="gpt-3.5-turbo",
                temperature=0.3
            )
            
            # Job management
            self.jobs: Dict[str, BatchJob] = {}
            self.batches: Dict[str, List[str]] = {}  # batch_id -> job_ids
            self.active_batches: List[str] = []
        
        def create_batch(
            self,
            inputs: List[Any],
            priorities: Optional[List[int]] = None
        ) -> str:
            """
            Create a new batch of jobs.
            
            Args:
                inputs: List of input data for jobs
                priorities: Optional priority for each job
                
            Returns:
                Batch ID
            """
            batch_id = f"batch_{uuid.uuid4().hex[:8]}"
            job_ids = []
            
            for i, input_data in enumerate(inputs):
                job_id = f"job_{uuid.uuid4().hex[:8]}"
                priority = priorities[i] if priorities else 0
                
                job = BatchJob(
                    job_id=job_id,
                    input_data=input_data,
                    priority=priority,
                    status=JobStatus.QUEUED
                )
                
                self.jobs[job_id] = job
                job_ids.append(job_id)
            
            self.batches[batch_id] = job_ids
            self.active_batches.append(batch_id)
            
            return batch_id
        
        def process_batch(
            self,
            batch_id: str,
            task_fn: Callable[[Any], Any],
            on_progress: Optional[Callable[[BatchProgress], None]] = None
        ) -> BatchResult:
            """
            Process a batch of jobs in parallel.
            
            Args:
                batch_id: ID of batch to process
                task_fn: Function to process each job
                on_progress: Optional progress callback
                
            Returns:
                BatchResult with aggregated results
            """
            if batch_id not in self.batches:
                raise ValueError(f"Batch {batch_id} not found")
            
            job_ids = self.batches[batch_id]
            start_time = time.time()
            
            results = []
            errors = []
            completed_count = 0
            failed_count = 0
            cancelled_count = 0
            
            # Process jobs in parallel
            with ThreadPoolExecutor(max_workers=self.config.max_workers) as executor:
                # Submit jobs
                future_to_job = {}
                for job_id in job_ids:
                    job = self.jobs[job_id]
                    job.status = JobStatus.PROCESSING
                    job.started_at = datetime.now()
                    
                    future = executor.submit(
                        self._process_single_job,
                        job_id,
                        task_fn
                    )
                    future_to_job[future] = job_id
                
                # Collect results as they complete
                for future in as_completed(future_to_job):
                    job_id = future_to_job[future]
                    job = self.jobs[job_id]
                    
                    try:
                        result = future.result(timeout=self.config.timeout)
                        job.result = result
                        job.status = JobStatus.COMPLETED
                        job.completed_at = datetime.now()
                        results.append(result)
                        completed_count += 1
                        
                    except Exception as e:
                        job.error = str(e)
                        job.status = JobStatus.FAILED
                        job.completed_at = datetime.now()
                        errors.append((job_id, str(e)))
                        failed_count += 1
                    
                    # Progress callback
                    if on_progress:
                        progress = self._calculate_progress(
                            batch_id,
                            start_time,
                            completed_count + failed_count
                        )
                        on_progress(progress)
            
            duration = time.time() - start_time
            total_jobs = len(job_ids)
            
            return BatchResult(
                batch_id=batch_id,
                total_jobs=total_jobs,
                completed=completed_count,
                failed=failed_count,
                cancelled=cancelled_count,
                results=results,
                errors=errors,
                duration=duration,
                throughput=total_jobs / duration if duration > 0 else 0
            )
        
        def _process_single_job(
            self,
            job_id: str,
            task_fn: Callable[[Any], Any]
        ) -> Any:
            """
            Process a single job with retries.
            
            Args:
                job_id: Job ID
                task_fn: Task function
                
            Returns:
                Job result
            """
            job = self.jobs[job_id]
            
            for attempt in range(self.config.max_retries):
                try:
                    job.attempts = attempt + 1
                    if attempt > 0:
                        job.status = JobStatus.RETRYING
                    
                    result = task_fn(job.input_data)
                    return result
                    
                except Exception as e:
                    if attempt == self.config.max_retries - 1:
                        raise
                    time.sleep(2 ** attempt)  # Exponential backoff
            
            raise RuntimeError(f"Job {job_id} failed after {self.config.max_retries} attempts")
        
        def _calculate_progress(
            self,
            batch_id: str,
            start_time: float,
            completed: int
        ) -> BatchProgress:
            """Calculate batch progress"""
            job_ids = self.batches[batch_id]
            total = len(job_ids)
            
            processing = sum(
                1 for jid in job_ids
                if self.jobs[jid].status == JobStatus.PROCESSING
            )
            
            pending = sum(
                1 for jid in job_ids
                if self.jobs[jid].status in [JobStatus.PENDING, JobStatus.QUEUED]
            )
            
            failed = sum(
                1 for jid in job_ids
                if self.jobs[jid].status == JobStatus.FAILED
            )
            
            progress_pct = (completed / total) * 100 if total > 0 else 0
            
            elapsed = time.time() - start_time
            throughput = completed / elapsed if elapsed > 0 else 0
            remaining = total - completed
            estimated_remaining = remaining / throughput if throughput > 0 else 0
            
            return BatchProgress(
                batch_id=batch_id,
                total_jobs=total,
                completed=completed,
                processing=processing,
                pending=pending,
                failed=failed,
                progress_pct=progress_pct,
                estimated_remaining=estimated_remaining,
                current_throughput=throughput
            )
        
        def process_text_batch(
            self,
            texts: List[str],
            operation: str,
            on_progress: Optional[Callable[[BatchProgress], None]] = None
        ) -> BatchResult:
            """
            Process a batch of text operations.
            
            Args:
                texts: List of text inputs
                operation: Operation to perform (summarize, translate, etc.)
                on_progress: Optional progress callback
                
            Returns:
                BatchResult with processed texts
            """
            # Create batch
            batch_id = self.create_batch(texts)
            
            # Define task function
            def process_text(text: str) -> str:
                prompt = ChatPromptTemplate.from_template(
                    "{operation} the following text:\n\n{text}"
                )
                
                chain = prompt | self.llm | StrOutputParser()
                
                result = chain.invoke({
                    "operation": operation,
                    "text": text[:500]  # Limit input length
                })
                
                return result
            
            # Process batch
            return self.process_batch(batch_id, process_text, on_progress)
        
        def process_classification_batch(
            self,
            items: List[str],
            categories: List[str],
            on_progress: Optional[Callable[[BatchProgress], None]] = None
        ) -> BatchResult:
            """
            Batch classify items into categories.
            
            Args:
                items: Items to classify
                categories: Possible categories
                on_progress: Optional progress callback
                
            Returns:
                BatchResult with classifications
            """
            batch_id = self.create_batch(items)
            
            categories_str = ", ".join(categories)
            
            def classify_item(item: str) -> str:
                prompt = ChatPromptTemplate.from_template(
                    """Classify the following item into one of these categories: {categories}
    
    Item: {item}
    
    Category:"""
                )
                
                chain = prompt | self.llm | StrOutputParser()
                
                result = chain.invoke({
                    "categories": categories_str,
                    "item": item[:200]
                })
                
                return result.strip()
            
            return self.process_batch(batch_id, classify_item, on_progress)
        
        def process_qa_batch(
            self,
            questions: List[str],
            context: str,
            on_progress: Optional[Callable[[BatchProgress], None]] = None
        ) -> BatchResult:
            """
            Answer a batch of questions.
            
            Args:
                questions: List of questions
                context: Shared context for all questions
                on_progress: Optional progress callback
                
            Returns:
                BatchResult with answers
            """
            batch_id = self.create_batch(questions)
            
            def answer_question(question: str) -> str:
                prompt = ChatPromptTemplate.from_template(
                    """Context: {context}
    
    Question: {question}
    
    Answer:"""
                )
                
                chain = prompt | self.llm | StrOutputParser()
                
                result = chain.invoke({
                    "context": context[:1000],
                    "question": question
                })
                
                return result
            
            return self.process_batch(batch_id, answer_question, on_progress)
        
        def get_batch_status(self, batch_id: str) -> Dict[str, Any]:
            """
            Get status of a batch.
            
            Args:
                batch_id: Batch ID
                
            Returns:
                Status dictionary
            """
            if batch_id not in self.batches:
                raise ValueError(f"Batch {batch_id} not found")
            
            job_ids = self.batches[batch_id]
            
            status_counts = defaultdict(int)
            for job_id in job_ids:
                status = self.jobs[job_id].status
                status_counts[status.value] += 1
            
            return {
                "batch_id": batch_id,
                "total_jobs": len(job_ids),
                "status_breakdown": dict(status_counts),
                "jobs": [
                    {
                        "job_id": jid,
                        "status": self.jobs[jid].status.value,
                        "attempts": self.jobs[jid].attempts,
                        "error": self.jobs[jid].error
                    }
                    for jid in job_ids[:10]  # First 10 jobs
                ]
            }
    
    
    def demonstrate_batch_processing_agent():
        """Demonstrate the batch processing agent capabilities"""
        print("=" * 80)
        print("BATCH PROCESSING AGENT DEMONSTRATION")
        print("=" * 80)
        
        # Custom config for faster demos
        config = BatchConfig(
            batch_size=5,
            max_workers=3,
            max_retries=2
        )
        
        agent = BatchProcessingAgent(config)
        
        # Demo 1: Text Summarization Batch
        print("\n" + "=" * 80)
        print("DEMO 1: Batch Text Summarization")
        print("=" * 80)
        
        texts = [
            "Artificial intelligence is transforming healthcare through advanced diagnostic tools, personalized treatment plans, and drug discovery acceleration.",
            "Machine learning models require large amounts of training data and computational resources to achieve high performance on complex tasks.",
            "Natural language processing enables computers to understand, interpret, and generate human language in meaningful ways.",
            "Computer vision systems can now recognize objects, faces, and scenes with accuracy rivaling human perception.",
            "Robotics combined with AI is enabling autonomous vehicles, warehouse automation, and advanced manufacturing processes."
        ]
        
        print(f"\nProcessing {len(texts)} texts for summarization...")
        print("-" * 80)
        
        progress_updates = []
        
        def on_progress(progress: BatchProgress):
            progress_updates.append(progress)
            bar_length = 40
            filled = int(bar_length * progress.progress_pct / 100)
            bar = "█" * filled + "░" * (bar_length - filled)
            print(f"\r[{bar}] {progress.progress_pct:.1f}% ({progress.completed}/{progress.total_jobs})", end="", flush=True)
        
        result = agent.process_text_batch(texts, "Summarize in one sentence", on_progress)
        
        print("\n" + "-" * 80)
        print(f"\n✓ Batch complete!")
        print(f"Total Jobs: {result.total_jobs}")
        print(f"Completed: {result.completed}")
        print(f"Failed: {result.failed}")
        print(f"Duration: {result.duration:.2f}s")
        print(f"Throughput: {result.throughput:.2f} jobs/sec")
        
        print(f"\nSample Results:")
        for i, summary in enumerate(result.results[:3], 1):
            print(f"\n{i}. {summary[:100]}...")
        
        # Demo 2: Classification Batch
        print("\n" + "=" * 80)
        print("DEMO 2: Batch Classification")
        print("=" * 80)
        
        items = [
            "Python programming tutorial",
            "Chocolate chip cookie recipe",
            "2024 Olympic games highlights",
            "Climate change research paper",
            "Stock market analysis",
            "Travel guide to Japan",
            "Guitar lesson for beginners"
        ]
        
        categories = ["Technology", "Food", "Sports", "Science", "Finance", "Travel", "Music"]
        
        print(f"\nClassifying {len(items)} items into categories:")
        print(f"Categories: {', '.join(categories)}")
        print("-" * 80)
        
        result2 = agent.process_classification_batch(items, categories, on_progress=on_progress)
        
        print("\n" + "-" * 80)
        print(f"\n✓ Classification complete!")
        print(f"Duration: {result2.duration:.2f}s")
        print(f"Throughput: {result2.throughput:.2f} items/sec")
        
        print(f"\nClassification Results:")
        for i, (item, category) in enumerate(zip(items, result2.results), 1):
            print(f"{i}. '{item[:40]}...' → {category}")
        
        # Demo 3: Question Answering Batch
        print("\n" + "=" * 80)
        print("DEMO 3: Batch Question Answering")
        print("=" * 80)
        
        context = """
        LangChain is a framework for developing applications powered by language models.
        It provides tools for prompt management, chains, agents, memory, and more.
        LangChain supports multiple LLM providers including OpenAI, Anthropic, and Google.
        The framework emphasizes composability and modularity for building complex applications.
        """
        
        questions = [
            "What is LangChain?",
            "What providers does LangChain support?",
            "What are the main features of LangChain?",
            "What is the design philosophy of LangChain?"
        ]
        
        print(f"\nContext: {context.strip()[:100]}...")
        print(f"\nAnswering {len(questions)} questions...")
        print("-" * 80)
        
        result3 = agent.process_qa_batch(questions, context, on_progress=on_progress)
        
        print("\n" + "-" * 80)
        print(f"\n✓ Q&A batch complete!")
        print(f"Duration: {result3.duration:.2f}s")
        
        print(f"\nQuestions and Answers:")
        for i, (question, answer) in enumerate(zip(questions, result3.results), 1):
            print(f"\nQ{i}: {question}")
            print(f"A{i}: {answer[:150]}...")
        
        # Demo 4: Batch Status Monitoring
        print("\n" + "=" * 80)
        print("DEMO 4: Batch Status Monitoring")
        print("=" * 80)
        
        # Create a new batch
        test_items = ["Item " + str(i) for i in range(8)]
        batch_id = agent.create_batch(test_items)
        
        print(f"\nCreated batch: {batch_id}")
        print(f"Total items: {len(test_items)}")
        
        # Get status before processing
        status = agent.get_batch_status(batch_id)
        
        print(f"\nBatch Status:")
        print(f"  Total Jobs: {status['total_jobs']}")
        print(f"  Status Breakdown:")
        for status_type, count in status['status_breakdown'].items():
            print(f"    {status_type}: {count}")
        
        # Demo 5: Performance Comparison
        print("\n" + "=" * 80)
        print("DEMO 5: Parallel vs Sequential Performance")
        print("=" * 80)
        
        test_texts = [f"Sample text {i} for processing" for i in range(10)]
        
        print(f"\nProcessing {len(test_texts)} items...")
        
        # Parallel processing
        print("\nParallel Processing (4 workers):")
        parallel_start = time.time()
        parallel_result = agent.process_text_batch(test_texts, "Count words in")
        parallel_duration = time.time() - parallel_start
        
        print(f"  Duration: {parallel_duration:.2f}s")
        print(f"  Throughput: {parallel_result.throughput:.2f} jobs/sec")
        
        # Sequential processing (1 worker)
        print("\nSequential Processing (1 worker):")
        sequential_config = BatchConfig(max_workers=1)
        sequential_agent = BatchProcessingAgent(sequential_config)
        sequential_start = time.time()
        sequential_result = sequential_agent.process_text_batch(test_texts, "Count words in")
        sequential_duration = time.time() - sequential_start
        
        print(f"  Duration: {sequential_duration:.2f}s")
        print(f"  Throughput: {sequential_result.throughput:.2f} jobs/sec")
        
        speedup = sequential_duration / parallel_duration if parallel_duration > 0 else 0
        print(f"\nSpeedup: {speedup:.2f}x")
        print(f"Efficiency: {(speedup / config.max_workers) * 100:.1f}%")
        
        # Summary
        print("\n" + "=" * 80)
        print("SUMMARY")
        print("=" * 80)
        
        summary = """
    The Batch Processing Agent demonstrates efficient parallel processing:
    
    KEY CAPABILITIES:
    1. Parallel Execution: Process multiple jobs concurrently
    2. Job Queuing: Manage large volumes of pending work
    3. Progress Tracking: Real-time monitoring with callbacks
    4. Error Handling: Automatic retries with exponential backoff
    5. Result Aggregation: Collect and organize batch results
    6. Resource Management: Control worker threads and resources
    7. Flexible Batching: Support various batching strategies
    8. Status Monitoring: Track job and batch status
    
    BENEFITS:
    - Dramatically improved throughput
    - Efficient resource utilization
    - Scalable processing of large datasets
    - Automatic error recovery
    - Progress visibility
    - Cost optimization through parallelization
    - Reduced total processing time
    - Better user experience for bulk operations
    
    USE CASES:
    - Bulk document summarization or translation
    - Large-scale data classification
    - Mass content generation
    - Batch question answering
    - Dataset annotation and labeling
    - Bulk email personalization
    - ETL pipeline processing
    - Large-scale testing
    - Batch API operations
    - Document ingestion for RAG systems
    
    PRODUCTION CONSIDERATIONS:
    1. Worker Scaling: Adjust workers based on load and resources
    2. Rate Limiting: Respect API rate limits across workers
    3. Cost Management: Monitor token usage across batches
    4. Error Recovery: Implement robust retry strategies
    5. Checkpointing: Save progress for resumption
    6. Priority Queues: Process high-priority jobs first
    7. Resource Limits: Prevent resource exhaustion
    8. Monitoring: Track batch performance metrics
    9. Load Balancing: Distribute work evenly
    10. Graceful Shutdown: Handle interruptions cleanly
    
    ADVANCED EXTENSIONS:
    - Dynamic worker scaling based on queue depth
    - Intelligent batch sizing with machine learning
    - Multi-stage batch pipelines
    - Distributed processing across machines
    - Streaming batch results
    - Partial result delivery
    - Batch deduplication
    - Priority-based scheduling
    - Resource-aware batching
    - Automatic retry backoff tuning
    
    Batch processing is essential for production AI systems handling
    large volumes of data efficiently and cost-effectively.
    """
        
        print(summary)
    
    
    if __name__ == "__main__":
        demonstrate_batch_processing_agent()
    
        

    Agentic Design Pattern: Batch Processing

    Pattern 079: Batch Processing – Line-by-Line Explanation

    Overview

    This document provides a detailed line-by-line explanation of the Batch Processing pattern implementation.


    Pattern Description

    Pattern 079: Batch Processing Agent

    Description: A Batch Processing Agent handles multiple tasks or inputs concurrently in batches, optimizing throughput and resource utilization. This pattern is essential for processing large volumes of data efficiently, enabling parallel execution, job queuing, progress monitoring, and result aggregation.

    The agent manages batches of work items, distributes them across available resources,
    monitors progress, handles failures, and aggregates results. It supports various
    batching strategies including size-based, time-based, and priority-based batching.
    

    Components: 1. Batch Scheduler: Schedules and organizes batch jobs 2. Job Queue: Manages pending work items 3. Parallel Executor: Executes tasks concurrently 4. Progress Monitor: Tracks batch processing progress 5. Result Aggregator: Combines individual results 6. Error Handler: Handles failures and retries 7. Resource Manager: Manages compute resources 8. Throughput Optimizer: Optimizes batch sizes

    Key Features: – Parallel batch processing – Dynamic batch sizing – Job queue management – Progress tracking – Error handling and retries – Result aggregation – Resource optimization – Priority scheduling – Cancellation support – Checkpointing for resumption

    Use Cases: – Bulk document processing – Large-scale data analysis – Batch translation services – Bulk content generation – Mass email personalization – Dataset annotation – Batch image processing – ETL pipelines – Bulk API operations – Large-scale testing

    LangChain Implementation: Uses concurrent.futures for parallel execution, batch processing utilities, and structured output handling for aggregation.


    File Statistics

    • Total Lines: 773
    • Classes: 7
    • Functions: 1
    • Constants: 0

    Module Documentation

    """
    Pattern 079: Batch Processing Agent
    
    Description:
        A Batch Processing Agent handles multiple tasks or inputs concurrently in batches,
        optimizing throughput and resource utilization. This pattern is essential for
        processing large volumes of data efficiently, enabling parallel execution,
        job queuing, progress monitoring, and result aggregation.
    
        The agent manages batches of work items, distributes them across available resources,
        monitors progress, handles failures, and aggregates results. It supports various
        batching strategies including size-based, time-based, and priority-based batching.
    
    Components:
        1. Batch Scheduler: Schedules and organizes batch jobs
        2. Job Queue: Manages pending work items
        3. Parallel Executor: Executes tasks concurrently
        4. Progress Monitor: Tracks batch processing progress
        5. Result Aggregator: Combines individual results
        6. Error Handler: Handles failures and retries
        7. Resource Manager: Manages compute resources
        8. Throughput Optimizer: Optimizes batch sizes
    
    Key Features:
        - Parallel batch processing
        - Dynamic batch sizing
        - Job queue management
        - Progress tracking
        - Error handling and retries
        - Result aggregation
        - Resource optimization
        - Priority scheduling
        - Cancellation support
        - Checkpointing for resumption
    
    Use Cases:
        - Bulk document processing
        - Large-scale data analysis
        - Batch translation services
        - Bulk content generation
        - Mass email personalization
        - Dataset annotation
        - Batch image processing
        - ETL pipelines
        - Bulk API operations
        - Large-scale testing
    
    LangChain Implementation:
        Uses concurrent.futures for parallel execution, batch processing utilities,
        and structured output handling for aggregation.
    """
    

    Purpose: This module implements the Batch Processing pattern, providing a structured approach to agent design and implementation.


    Import Statements

    Standard Library Imports

    import collections.defaultdict
    import concurrent.futures.ThreadPoolExecutor
    import concurrent.futures.as_completed
    import dataclasses.dataclass
    import dataclasses.field
    import datetime.datetime
    import enum.Enum
    import langchain_core.output_parsers.StrOutputParser
    import langchain_core.prompts.ChatPromptTemplate
    import os
    import time
    import typing.Any
    import typing.Callable
    import typing.Dict
    import typing.List
    import typing.Optional
    import typing.Tuple
    

    Purpose: Core Python functionality: – collections.defaultdict: Specialized container datatypes – concurrent.futures.ThreadPoolExecutor: Regular expression operations – concurrent.futures.as_completed: Regular expression operations – dataclasses.dataclass: Simplified class definitions with @dataclass – dataclasses.field: Simplified class definitions with @dataclass – datetime.datetime: Date and time handling – enum.Enum: Enumeration support – langchain_core.output_parsers.StrOutputParser: Regular expression operations – langchain_core.prompts.ChatPromptTemplate: Regular expression operations – os: Environment variable access and system operations – time: Time-related functions – typing.Any: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Callable: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Dict: Type hints for better code documentation (List, Dict, Any, Optional) – typing.List: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Optional: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Tuple: Type hints for better code documentation (List, Dict, Any, Optional)

    LangChain Imports

    from langchain_openai.ChatOpenAI
    

    Purpose: LangChain framework components: – LLM Interface: Wrapper for OpenAI models – Chains: Composable building blocks for complex workflows

    Other Imports

    from dotenv.load_dotenv
    from uuid
    

    Purpose: Additional dependencies for specialized functionality.


    Classes

    Class: JobStatus

    Lines 71-79

    Inherits from: Enum

    Purpose:

    Status of a batch job
    

    Class: BatchStrategy

    Lines 82-87

    Inherits from: Enum

    Purpose:

    Batching strategy
    

    Class: BatchJob

    Lines 91-102

    Purpose:

    A single job in a batch
    

    Class: BatchConfig

    Lines 106-114

    Purpose:

    Configuration for batch processing
    

    Class: BatchResult

    Lines 118-129

    Purpose:

    Result of batch processing
    

    Class: BatchProgress

    Lines 133-143

    Purpose:

    Progress of batch processing
    

    Class: BatchProcessingAgent

    Lines 146-523

    Purpose:

    Agent for efficient batch processing of multiple tasks.
    
    This agent handles large volumes of work by processing items in batches,
    with parallel execution, error handling, and progress tracking.
    

    Methods:

    __init__(self, config)

    Lines 154-167

    Purpose:

    Initialize the batch processing agent
    

    Parameters: – config: Config

    create_batch(self, inputs, priorities)

    Lines 169-204

    Purpose:

    Create a new batch of jobs.
    
    Args:
        inputs: List of input data for jobs
        priorities: Optional priority for each job
    
    Returns:
        Batch ID
    

    Parameters: – inputs: Input data – priorities: Priorities

    Returns: str

    process_batch(self, batch_id, task_fn, on_progress)

    Lines 206-293

    Purpose:

    Process a batch of jobs in parallel.
    
    Args:
        batch_id: ID of batch to process
        task_fn: Function to process each job
        on_progress: Optional progress callback
    
    Returns:
        BatchResult with aggregated results
    

    Parameters: – batch_id: Batch id – task_fn: Task fn – on_progress: On progress

    Returns: BatchResult

    _process_single_job(self, job_id, task_fn)

    Lines 295-326

    Purpose:

    Process a single job with retries.
    
    Args:
        job_id: Job ID
        task_fn: Task function
    
    Returns:
        Job result
    

    Parameters: – job_id: Job id – task_fn: Task fn

    Returns: Any

    _calculate_progress(self, batch_id, start_time, completed)

    Lines 328-370

    Purpose:

    Calculate batch progress
    

    Parameters: – batch_id: Batch id – start_time: Start time – completed: Completed

    Returns: BatchProgress

    process_text_batch(self, texts, operation, on_progress)

    Lines 372-408

    Purpose:

    Process a batch of text operations.
    
    Args:
        texts: List of text inputs
        operation: Operation to perform (summarize, translate, etc.)
        on_progress: Optional progress callback
    
    Returns:
        BatchResult with processed texts
    

    Parameters: – texts: Texts – operation: Operation – on_progress: On progress

    Returns: BatchResult

    process_classification_batch(self, items, categories, on_progress)

    Lines 410-449

    Purpose:

    Batch classify items into categories.
    
    Args:
        items: Items to classify
        categories: Possible categories
        on_progress: Optional progress callback
    
    Returns:
        BatchResult with classifications
    

    Parameters: – items: Items – categories: Categories – on_progress: On progress

    Returns: BatchResult

    process_qa_batch(self, questions, context, on_progress)

    Lines 451-488

    Purpose:

    Answer a batch of questions.
    
    Args:
        questions: List of questions
        context: Shared context for all questions
        on_progress: Optional progress callback
    
    Returns:
        BatchResult with answers
    

    Parameters: – questions: Question to answer – context: Context – on_progress: On progress

    Returns: BatchResult

    get_batch_status(self, batch_id)

    Lines 490-523

    Purpose:

    Get status of a batch.
    
    Args:
        batch_id: Batch ID
    
    Returns:
        Status dictionary
    

    Parameters: – batch_id: Batch id

    Returns: <ast.Subscript object at 0x000001A06D62A990>


    Functions

    demonstrate_batch_processing_agent()

    Lines 526-768

    Purpose:

    Demonstrate the batch processing agent capabilities
    

    Key Concepts Summary

    Pattern Overview

    The Batch Processing pattern provides a structured approach to building AI agents with specific capabilities and behaviors. This implementation leverages LangChain’s composable components to create a robust and maintainable solution.

    Core Components

    1. Agent Class: Main implementation of the pattern logic
    2. Prompt Engineering: Carefully crafted prompts to guide LLM behavior
    3. Tool Integration: Optional tools for extended functionality
    4. Memory Management: State handling across interactions
    5. Output Parsing: Structured response processing

    When to Use

    ✅ Good for: – Scenarios requiring this specific pattern’s strengths – Applications needing structured agent behavior – Systems where explainability is important – Production environments requiring reliability

    ❌ Not ideal for: – Simple single-prompt tasks – Scenarios requiring different pattern characteristics – Resource-constrained environments (if computationally intensive)


    Best Practices Demonstrated

    1. Environment Configuration

    • ✅ Use .env files for API keys
    • ✅ Never hardcode credentials
    • ✅ Validate environment variables on startup

    2. Error Handling

    • ✅ Graceful degradation on failures
    • ✅ Informative error messages
    • ✅ Logging for debugging

    3. Prompt Engineering

    • ✅ Clear, specific instructions
    • ✅ Structured output formats
    • ✅ Few-shot examples when beneficial

    4. Code Organization

    • ✅ Separation of concerns (class-based design)
    • ✅ Type hints for clarity
    • ✅ Docstrings for documentation

    5. Performance Optimization

    • ✅ Appropriate temperature settings
    • ✅ Token budget management
    • ✅ Caching where applicable

    LangChain Components Used

    • ChatOpenAI: OpenAI model interface
    • Chains: Sequential component composition

    Why LangChain? – Composable abstractions for LLM applications – Rich ecosystem of integrations – Production-ready patterns – Active community and development


    Execution Flow

    1. Initialize agent with configuration
       ↓
    2. Load environment and dependencies
       ↓
    3. Prepare prompt with input data
       ↓
    4. Invoke LLM through LangChain
       ↓
    5. Parse and validate response
       ↓
    6. Return formatted result
    

    Key Decision Points: – Model selection (temperature, model type) – Prompt structure (few-shot vs zero-shot) – Error handling strategy – Output format validation


    Performance Considerations

    Computational Cost

    • LLM Calls: Primary cost factor (based on tokens)
    • Latency: Depends on model and input size
    • Memory: Minimal for most patterns

    Optimization Strategies

    1. Prompt Optimization: Minimize tokens while maintaining clarity
    2. Caching: Cache repeated queries/responses
    3. Model Selection: Use smaller models when appropriate
    4. Batch Processing: Group similar requests
    5. Streaming: For long responses, stream tokens

    Cost Estimates (Approximate)

    • GPT-3.5-turbo: ~$0.002 per request
    • GPT-4: ~$0.03 per request
    • GPT-4-turbo: ~$0.01 per request

    Actual costs vary based on input/output token counts


    Common Pitfalls to Avoid

    1. Prompt Design Issues

    ❌ Vague or ambiguous instructions
    ✅ Clear, specific, testable prompts

    2. Error Handling

    ❌ Ignoring API errors or rate limits
    ✅ Implement retry logic and graceful degradation

    3. Token Management

    ❌ Exceeding model token limits
    ✅ Truncate inputs, chunk processing

    4. Security

    ❌ Exposing API keys in code
    ✅ Use environment variables

    5. Testing

    ❌ Only testing happy paths
    ✅ Test edge cases, failures, malformed inputs

    6. Cost Management

    ❌ Unmonitored API usage
    ✅ Implement budgets, alerts, and monitoring


    Further Improvements

    Production Enhancements

    1. Monitoring: Add logging, metrics, tracing
    2. Validation: Input/output schema validation
    3. Rate Limiting: Implement request throttling
    4. Caching: Redis or in-memory cache for responses
    5. Async Support: Non-blocking operations for scalability

    Feature Extensions

    1. Multi-Model Support: Switch between providers
    2. Fallback Models: Graceful degradation strategy
    3. Custom Tools: Domain-specific function calling
    4. Advanced Memory: Vector stores for long-term memory
    5. Evaluation: Automated testing and benchmarking

    Code Quality

    1. Testing: Unit tests, integration tests
    2. Documentation: API docs, usage examples
    3. Type Safety: Stricter type hints
    4. Configuration: Externalized config files

    Related Patterns

    • Pattern 078
    • Pattern 080

    Pattern Families: – Reasoning Patterns (001-011) – Multi-Agent Patterns (012-019) – Tool Use Patterns (020-025) – Memory Patterns (026-031) – And many more…


    Summary

    The Batch Processing pattern provides a powerful approach to building AI agents with specific capabilities. This implementation demonstrates:

    ✅ Key Strengths: – Clean, maintainable code structure – LangChain integration for composability – Type hints and documentation – Production-ready patterns

    🎯 Best Use Cases: – Applications requiring this pattern’s characteristics – Systems needing structured agent behavior – Production environments requiring reliability

    📚 Learning Resources: – LangChain Documentation: https://python.langchain.com/ – Pattern Documentation: See related patterns – OpenAI API Reference: https://platform.openai.com/docs/


    File: 079_batch_processing.py
    Total Lines: 773
    Pattern Category: AI Agent Design Pattern #079


    Generated from actual implementation code
    For educational and reference purposes

  • Agentic Design Pattern: Streaming Agent

    
        """
    Pattern 078: Streaming Agent
    
    Description:
        A Streaming Agent delivers responses in real-time as they are generated, rather
        than waiting for complete output. This pattern is essential for building responsive
        user interfaces and handling long-running generation tasks. It provides immediate
        feedback to users and enables progressive rendering of results.
        
        The agent streams tokens as they are generated by the LLM, allowing for better
        user experience in conversational interfaces, content generation, and real-time
        data processing. It supports multiple streaming modes including token-by-token,
        chunk-by-chunk, and structured streaming with metadata.
    
    Components:
        1. Token Streamer: Streams individual tokens as generated
        2. Chunk Streamer: Streams semantic chunks (sentences, paragraphs)
        3. Event Streamer: Streams events with metadata and progress
        4. Progress Tracker: Monitors generation progress
        5. Buffer Manager: Manages streaming buffers and backpressure
        6. Error Handler: Handles streaming errors gracefully
        7. Aggregator: Collects streamed content for final result
        8. Rate Controller: Controls streaming rate
    
    Key Features:
        - Real-time token streaming
        - Chunk-based streaming
        - Progress callbacks
        - Cancellation support
        - Error recovery during streaming
        - Multiple output formats
        - Backpressure handling
        - Stream aggregation
        - Event-driven architecture
        - WebSocket support
    
    Use Cases:
        - Conversational chatbots with typing indicators
        - Long-form content generation
        - Real-time translation services
        - Live code generation and explanation
        - Progressive document analysis
        - Interactive storytelling
        - Streaming search results
        - Real-time data processing
        - Live transcription and summarization
        - Collaborative writing tools
    
    LangChain Implementation:
        Uses ChatOpenAI with streaming=True, callbacks for progress tracking,
        and LCEL chains with streaming support.
    """
    
    import os
    import time
    import asyncio
    from typing import List, Dict, Any, Optional, Iterator, AsyncIterator, Callable
    from dataclasses import dataclass, field
    from enum import Enum
    from datetime import datetime
    from collections import deque
    from dotenv import load_dotenv
    
    from langchain_core.prompts import ChatPromptTemplate
    from langchain_core.output_parsers import StrOutputParser
    from langchain_openai import ChatOpenAI
    from langchain_core.callbacks import BaseCallbackHandler
    
    load_dotenv()
    
    
    class StreamMode(Enum):
        """Streaming modes"""
        TOKEN = "token"  # Stream individual tokens
        CHUNK = "chunk"  # Stream semantic chunks
        SENTENCE = "sentence"  # Stream complete sentences
        PARAGRAPH = "paragraph"  # Stream complete paragraphs
        EVENT = "event"  # Stream with events and metadata
    
    
    class StreamStatus(Enum):
        """Stream status"""
        STARTING = "starting"
        STREAMING = "streaming"
        PAUSED = "paused"
        COMPLETED = "completed"
        ERROR = "error"
        CANCELLED = "cancelled"
    
    
    @dataclass
    class StreamEvent:
        """Event in the stream"""
        event_type: str  # token, chunk, progress, complete, error
        content: str
        timestamp: datetime
        metadata: Dict[str, Any] = field(default_factory=dict)
        token_count: int = 0
        progress: float = 0.0  # 0.0 to 1.0
    
    
    @dataclass
    class StreamConfig:
        """Configuration for streaming"""
        mode: StreamMode = StreamMode.TOKEN
        buffer_size: int = 100
        flush_interval: float = 0.1  # seconds
        max_tokens: Optional[int] = None
        show_progress: bool = True
        aggregate_result: bool = True
        error_recovery: bool = True
    
    
    @dataclass
    class StreamResult:
        """Result of streaming operation"""
        full_content: str
        events: List[StreamEvent]
        status: StreamStatus
        total_tokens: int
        duration: float
        error: Optional[str] = None
    
    
    class StreamingCallbackHandler(BaseCallbackHandler):
        """Callback handler for streaming events"""
        
        def __init__(
            self,
            on_token: Optional[Callable[[str], None]] = None,
            on_chunk: Optional[Callable[[str], None]] = None
        ):
            """Initialize callback handler"""
            self.on_token = on_token
            self.on_chunk = on_chunk
            self.tokens: List[str] = []
        
        def on_llm_new_token(self, token: str, **kwargs) -> None:
            """Called when new token is generated"""
            self.tokens.append(token)
            if self.on_token:
                self.on_token(token)
        
        def on_llm_end(self, response, **kwargs) -> None:
            """Called when generation ends"""
            if self.on_chunk:
                full_text = "".join(self.tokens)
                self.on_chunk(full_text)
    
    
    class StreamingAgent:
        """
        Agent that streams responses in real-time.
        
        This agent provides various streaming capabilities including token streaming,
        chunk streaming, and event streaming with progress tracking.
        """
        
        def __init__(self, config: StreamConfig = StreamConfig()):
            """Initialize the streaming agent"""
            self.config = config
            
            # Streaming LLM
            self.llm = ChatOpenAI(
                model="gpt-3.5-turbo",
                temperature=0.7,
                streaming=True
            )
            
            # Non-streaming LLM for comparison
            self.sync_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.7)
            
            # Stream state
            self.status = StreamStatus.STARTING
            self.buffer: deque = deque(maxlen=config.buffer_size)
            self.events: List[StreamEvent] = []
        
        def stream_tokens(
            self,
            prompt: str,
            on_token: Optional[Callable[[str], None]] = None
        ) -> StreamResult:
            """
            Stream tokens as they are generated.
            
            Args:
                prompt: Input prompt
                on_token: Callback for each token
                
            Returns:
                StreamResult with full content and events
            """
            start_time = time.time()
            full_content = ""
            token_count = 0
            
            self.status = StreamStatus.STREAMING
            
            # Create callback handler
            callback = StreamingCallbackHandler(on_token=on_token)
            
            try:
                # Stream tokens
                for chunk in self.llm.stream(prompt):
                    if hasattr(chunk, 'content'):
                        token = chunk.content
                        full_content += token
                        token_count += 1
                        
                        # Create event
                        event = StreamEvent(
                            event_type="token",
                            content=token,
                            timestamp=datetime.now(),
                            token_count=token_count,
                            progress=min(1.0, token_count / (self.config.max_tokens or 1000))
                        )
                        self.events.append(event)
                        
                        # Call custom callback
                        if on_token:
                            on_token(token)
                
                self.status = StreamStatus.COMPLETED
                
                return StreamResult(
                    full_content=full_content,
                    events=self.events.copy(),
                    status=self.status,
                    total_tokens=token_count,
                    duration=time.time() - start_time
                )
                
            except Exception as e:
                self.status = StreamStatus.ERROR
                return StreamResult(
                    full_content=full_content,
                    events=self.events.copy(),
                    status=self.status,
                    total_tokens=token_count,
                    duration=time.time() - start_time,
                    error=str(e)
                )
        
        def stream_chunks(
            self,
            prompt: str,
            chunk_size: int = 50,
            on_chunk: Optional[Callable[[str], None]] = None
        ) -> StreamResult:
            """
            Stream content in chunks.
            
            Args:
                prompt: Input prompt
                chunk_size: Size of chunks in characters
                on_chunk: Callback for each chunk
                
            Returns:
                StreamResult with full content and events
            """
            start_time = time.time()
            full_content = ""
            current_chunk = ""
            chunk_count = 0
            
            self.status = StreamStatus.STREAMING
            
            try:
                for chunk in self.llm.stream(prompt):
                    if hasattr(chunk, 'content'):
                        token = chunk.content
                        current_chunk += token
                        full_content += token
                        
                        # Emit chunk when size reached
                        if len(current_chunk) >= chunk_size:
                            chunk_count += 1
                            
                            event = StreamEvent(
                                event_type="chunk",
                                content=current_chunk,
                                timestamp=datetime.now(),
                                metadata={"chunk_number": chunk_count}
                            )
                            self.events.append(event)
                            
                            if on_chunk:
                                on_chunk(current_chunk)
                            
                            current_chunk = ""
                
                # Emit final chunk
                if current_chunk:
                    chunk_count += 1
                    event = StreamEvent(
                        event_type="chunk",
                        content=current_chunk,
                        timestamp=datetime.now(),
                        metadata={"chunk_number": chunk_count, "final": True}
                    )
                    self.events.append(event)
                    
                    if on_chunk:
                        on_chunk(current_chunk)
                
                self.status = StreamStatus.COMPLETED
                
                return StreamResult(
                    full_content=full_content,
                    events=self.events.copy(),
                    status=self.status,
                    total_tokens=len(full_content.split()),
                    duration=time.time() - start_time
                )
                
            except Exception as e:
                self.status = StreamStatus.ERROR
                return StreamResult(
                    full_content=full_content,
                    events=self.events.copy(),
                    status=self.status,
                    total_tokens=len(full_content.split()),
                    duration=time.time() - start_time,
                    error=str(e)
                )
        
        def stream_with_progress(
            self,
            prompt: str,
            estimated_tokens: int = 200,
            on_progress: Optional[Callable[[float, str], None]] = None
        ) -> StreamResult:
            """
            Stream with progress tracking.
            
            Args:
                prompt: Input prompt
                estimated_tokens: Estimated total tokens for progress
                on_progress: Callback with progress (0.0-1.0) and content
                
            Returns:
                StreamResult with full content and progress events
            """
            start_time = time.time()
            full_content = ""
            token_count = 0
            
            self.status = StreamStatus.STREAMING
            
            try:
                for chunk in self.llm.stream(prompt):
                    if hasattr(chunk, 'content'):
                        token = chunk.content
                        full_content += token
                        token_count += 1
                        
                        # Calculate progress
                        progress = min(1.0, token_count / estimated_tokens)
                        
                        # Create progress event
                        event = StreamEvent(
                            event_type="progress",
                            content=token,
                            timestamp=datetime.now(),
                            token_count=token_count,
                            progress=progress,
                            metadata={
                                "estimated_remaining": max(0, estimated_tokens - token_count)
                            }
                        )
                        self.events.append(event)
                        
                        # Call progress callback
                        if on_progress:
                            on_progress(progress, full_content)
                
                # Final progress event
                event = StreamEvent(
                    event_type="complete",
                    content="",
                    timestamp=datetime.now(),
                    token_count=token_count,
                    progress=1.0
                )
                self.events.append(event)
                
                if on_progress:
                    on_progress(1.0, full_content)
                
                self.status = StreamStatus.COMPLETED
                
                return StreamResult(
                    full_content=full_content,
                    events=self.events.copy(),
                    status=self.status,
                    total_tokens=token_count,
                    duration=time.time() - start_time
                )
                
            except Exception as e:
                self.status = StreamStatus.ERROR
                return StreamResult(
                    full_content=full_content,
                    events=self.events.copy(),
                    status=self.status,
                    total_tokens=token_count,
                    duration=time.time() - start_time,
                    error=str(e)
                )
        
        async def stream_async(
            self,
            prompt: str,
            on_token: Optional[Callable[[str], None]] = None
        ) -> StreamResult:
            """
            Stream asynchronously.
            
            Args:
                prompt: Input prompt
                on_token: Callback for each token
                
            Returns:
                StreamResult with full content and events
            """
            start_time = time.time()
            full_content = ""
            token_count = 0
            
            self.status = StreamStatus.STREAMING
            
            try:
                async for chunk in self.llm.astream(prompt):
                    if hasattr(chunk, 'content'):
                        token = chunk.content
                        full_content += token
                        token_count += 1
                        
                        event = StreamEvent(
                            event_type="token",
                            content=token,
                            timestamp=datetime.now(),
                            token_count=token_count
                        )
                        self.events.append(event)
                        
                        if on_token:
                            on_token(token)
                        
                        # Simulate async processing
                        await asyncio.sleep(0.001)
                
                self.status = StreamStatus.COMPLETED
                
                return StreamResult(
                    full_content=full_content,
                    events=self.events.copy(),
                    status=self.status,
                    total_tokens=token_count,
                    duration=time.time() - start_time
                )
                
            except Exception as e:
                self.status = StreamStatus.ERROR
                return StreamResult(
                    full_content=full_content,
                    events=self.events.copy(),
                    status=self.status,
                    total_tokens=token_count,
                    duration=time.time() - start_time,
                    error=str(e)
                )
        
        def stream_chain(
            self,
            inputs: Dict[str, str],
            on_chunk: Optional[Callable[[str], None]] = None
        ) -> StreamResult:
            """
            Stream output from a chain.
            
            Args:
                inputs: Chain inputs
                on_chunk: Callback for each chunk
                
            Returns:
                StreamResult with full content
            """
            start_time = time.time()
            full_content = ""
            
            # Create a streaming chain
            prompt = ChatPromptTemplate.from_template(
                "Write a {tone} {content_type} about {topic}."
            )
            
            chain = prompt | self.llm | StrOutputParser()
            
            self.status = StreamStatus.STREAMING
            
            try:
                for chunk in chain.stream(inputs):
                    full_content += chunk
                    
                    event = StreamEvent(
                        event_type="chunk",
                        content=chunk,
                        timestamp=datetime.now()
                    )
                    self.events.append(event)
                    
                    if on_chunk:
                        on_chunk(chunk)
                
                self.status = StreamStatus.COMPLETED
                
                return StreamResult(
                    full_content=full_content,
                    events=self.events.copy(),
                    status=self.status,
                    total_tokens=len(full_content.split()),
                    duration=time.time() - start_time
                )
                
            except Exception as e:
                self.status = StreamStatus.ERROR
                return StreamResult(
                    full_content=full_content,
                    events=self.events.copy(),
                    status=self.status,
                    total_tokens=len(full_content.split()),
                    duration=time.time() - start_time,
                    error=str(e)
                )
        
        def compare_streaming_vs_sync(
            self,
            prompt: str
        ) -> Dict[str, Any]:
            """
            Compare streaming vs synchronous generation.
            
            Args:
                prompt: Input prompt
                
            Returns:
                Comparison results
            """
            # Streaming generation
            stream_start = time.time()
            stream_result = self.stream_tokens(prompt)
            stream_duration = time.time() - stream_start
            
            # Clear events for sync test
            self.events = []
            
            # Synchronous generation
            sync_start = time.time()
            sync_content = self.sync_llm.invoke(prompt).content
            sync_duration = time.time() - sync_start
            
            return {
                "streaming": {
                    "duration": stream_duration,
                    "content_length": len(stream_result.full_content),
                    "tokens": stream_result.total_tokens,
                    "time_to_first_token": stream_result.events[0].timestamp.timestamp() - stream_start if stream_result.events else 0
                },
                "synchronous": {
                    "duration": sync_duration,
                    "content_length": len(sync_content),
                    "time_to_first_token": sync_duration  # Same as total for sync
                },
                "comparison": {
                    "streaming_faster": stream_duration < sync_duration,
                    "ttft_improvement": "Immediate (streaming)" if stream_result.events else "N/A"
                }
            }
    
    
    def demonstrate_streaming_agent():
        """Demonstrate the streaming agent capabilities"""
        print("=" * 80)
        print("STREAMING AGENT DEMONSTRATION")
        print("=" * 80)
        
        agent = StreamingAgent()
        
        # Demo 1: Token Streaming
        print("\n" + "=" * 80)
        print("DEMO 1: Token-by-Token Streaming")
        print("=" * 80)
        
        prompt = "Write a short poem about artificial intelligence."
        
        print(f"\nPrompt: {prompt}")
        print("\nStreaming response:")
        print("-" * 80)
        
        # Track tokens
        tokens_received = []
        
        def on_token(token: str):
            tokens_received.append(token)
            print(token, end="", flush=True)
        
        result = agent.stream_tokens(prompt, on_token=on_token)
        
        print("\n" + "-" * 80)
        print(f"\nStream Status: {result.status.value}")
        print(f"Total Tokens: {result.total_tokens}")
        print(f"Duration: {result.duration:.3f}s")
        print(f"Tokens/sec: {result.total_tokens / result.duration:.1f}")
        print(f"Events Captured: {len(result.events)}")
        
        # Demo 2: Chunk Streaming
        print("\n" + "=" * 80)
        print("DEMO 2: Chunk-Based Streaming")
        print("=" * 80)
        
        prompt2 = "Explain how streaming improves user experience in AI applications."
        
        print(f"\nPrompt: {prompt2}")
        print("\nStreaming in chunks (50 chars each):")
        print("-" * 80)
        
        chunks_received = []
        
        def on_chunk(chunk: str):
            chunks_received.append(chunk)
            print(f"\n[Chunk {len(chunks_received)}]: {chunk}", end="")
        
        agent.events = []  # Reset events
        result2 = agent.stream_chunks(prompt2, chunk_size=50, on_chunk=on_chunk)
        
        print("\n" + "-" * 80)
        print(f"\nTotal Chunks: {len(chunks_received)}")
        print(f"Full Content Length: {len(result2.full_content)} chars")
        print(f"Duration: {result2.duration:.3f}s")
        
        # Demo 3: Progress Tracking
        print("\n" + "=" * 80)
        print("DEMO 3: Streaming with Progress Tracking")
        print("=" * 80)
        
        prompt3 = "Write a brief history of machine learning in three paragraphs."
        
        print(f"\nPrompt: {prompt3}")
        print("\nStreaming with progress updates:")
        print("-" * 80)
        
        progress_updates = []
        
        def on_progress(progress: float, content: str):
            progress_updates.append(progress)
            # Show progress bar every 10%
            if len(progress_updates) % 20 == 0:
                bar_length = 40
                filled = int(bar_length * progress)
                bar = "█" * filled + "░" * (bar_length - filled)
                print(f"\r[{bar}] {progress*100:.0f}%", end="", flush=True)
        
        agent.events = []  # Reset events
        result3 = agent.stream_with_progress(prompt3, estimated_tokens=150, on_progress=on_progress)
        
        print("\n" + "-" * 80)
        print(f"\n✓ Streaming complete!")
        print(f"Total Tokens: {result3.total_tokens}")
        print(f"Duration: {result3.duration:.3f}s")
        print(f"Progress Updates: {len(progress_updates)}")
        
        # Show first 200 chars of content
        print(f"\nContent Preview:")
        print(result3.full_content[:200] + "...")
        
        # Demo 4: Chain Streaming
        print("\n" + "=" * 80)
        print("DEMO 4: Streaming Chain Output")
        print("=" * 80)
        
        inputs = {
            "tone": "inspirational",
            "content_type": "story",
            "topic": "perseverance"
        }
        
        print(f"\nChain Inputs:")
        for key, value in inputs.items():
            print(f"  {key}: {value}")
        
        print("\nStreaming chain output:")
        print("-" * 80)
        
        agent.events = []  # Reset events
        
        def on_chain_chunk(chunk: str):
            print(chunk, end="", flush=True)
        
        result4 = agent.stream_chain(inputs, on_chunk=on_chain_chunk)
        
        print("\n" + "-" * 80)
        print(f"\nChain Duration: {result4.duration:.3f}s")
        print(f"Content Length: {len(result4.full_content)} chars")
        
        # Demo 5: Streaming vs Sync Comparison
        print("\n" + "=" * 80)
        print("DEMO 5: Streaming vs Synchronous Comparison")
        print("=" * 80)
        
        test_prompt = "Explain the benefits of streaming in three sentences."
        
        print(f"\nPrompt: {test_prompt}")
        print("\nComparing streaming vs synchronous generation...")
        
        agent.events = []  # Reset events
        comparison = agent.compare_streaming_vs_sync(test_prompt)
        
        print("\n" + "-" * 80)
        print("RESULTS:")
        print("-" * 80)
        
        print("\nStreaming Mode:")
        print(f"  Duration: {comparison['streaming']['duration']:.3f}s")
        print(f"  Content Length: {comparison['streaming']['content_length']} chars")
        print(f"  Tokens: {comparison['streaming']['tokens']}")
        print(f"  Time to First Token: ~{comparison['streaming']['time_to_first_token']:.3f}s")
        
        print("\nSynchronous Mode:")
        print(f"  Duration: {comparison['synchronous']['duration']:.3f}s")
        print(f"  Content Length: {comparison['synchronous']['content_length']} chars")
        print(f"  Time to First Token: {comparison['synchronous']['time_to_first_token']:.3f}s")
        
        print("\nKey Insight:")
        print("  ✓ Streaming provides immediate feedback (TTFT)")
        print("  ✓ Better perceived performance and user experience")
        print("  ✓ Enables progressive rendering and cancellation")
        
        # Summary
        print("\n" + "=" * 80)
        print("SUMMARY")
        print("=" * 80)
        
        summary = """
    The Streaming Agent demonstrates real-time response generation:
    
    KEY CAPABILITIES:
    1. Token Streaming: Stream individual tokens as generated
    2. Chunk Streaming: Stream semantic chunks for better UX
    3. Progress Tracking: Monitor generation progress with callbacks
    4. Event Streaming: Rich events with metadata and timestamps
    5. Async Streaming: Non-blocking async/await patterns
    6. Chain Streaming: Stream output from complex chains
    7. Error Recovery: Graceful handling of streaming errors
    8. Comparison: Measure streaming vs synchronous performance
    
    BENEFITS:
    - Immediate user feedback (low TTFT)
    - Better perceived performance
    - Progressive content rendering
    - Cancellation support
    - Reduced perceived latency
    - Enhanced user experience
    - Real-time interactivity
    - Efficient resource usage
    
    USE CASES:
    - Conversational chatbots with typing indicators
    - Long-form content generation (articles, reports)
    - Real-time translation services
    - Live code generation and explanation
    - Interactive storytelling
    - Streaming search results
    - Progressive document analysis
    - Collaborative writing tools
    
    PRODUCTION CONSIDERATIONS:
    1. Backpressure: Handle slow consumers gracefully
    2. Buffer Management: Prevent memory issues with large streams
    3. Error Recovery: Implement retry logic for network issues
    4. Cancellation: Support user-initiated cancellation
    5. Rate Limiting: Prevent excessive streaming costs
    6. Monitoring: Track streaming performance metrics
    7. WebSocket: Use WebSocket for web clients
    8. State Management: Handle connection drops and reconnects
    9. Testing: Test with various network conditions
    10. Optimization: Minimize latency for first token
    
    ADVANCED EXTENSIONS:
    - Multi-model streaming (ensemble outputs)
    - Streaming with tool calls
    - Real-time translation during streaming
    - Adaptive chunk sizing based on content
    - Client-side buffering strategies
    - Stream compression for bandwidth
    - Priority-based streaming
    - Streaming with citations and sources
    - Live annotation and formatting
    - Collaborative streaming sessions
    
    Streaming is essential for modern AI applications requiring responsive,
    interactive user experiences with immediate feedback.
    """
        
        print(summary)
    
    
    if __name__ == "__main__":
        demonstrate_streaming_agent()
    
        

    Agentic Design Pattern: Streaming Agent

    Pattern 078: Streaming Agent – Line-by-Line Explanation

    Overview

    This document provides a detailed line-by-line explanation of the Streaming Agent pattern implementation.


    Pattern Description

    Pattern 078: Streaming Agent

    Description: A Streaming Agent delivers responses in real-time as they are generated, rather than waiting for complete output. This pattern is essential for building responsive user interfaces and handling long-running generation tasks. It provides immediate feedback to users and enables progressive rendering of results.

    The agent streams tokens as they are generated by the LLM, allowing for better
    user experience in conversational interfaces, content generation, and real-time
    data processing. It supports multiple streaming modes including token-by-token,
    chunk-by-chunk, and structured streaming with metadata.
    

    Components: 1. Token Streamer: Streams individual tokens as generated 2. Chunk Streamer: Streams semantic chunks (sentences, paragraphs) 3. Event Streamer: Streams events with metadata and progress 4. Progress Tracker: Monitors generation progress 5. Buffer Manager: Manages streaming buffers and backpressure 6. Error Handler: Handles streaming errors gracefully 7. Aggregator: Collects streamed content for final result 8. Rate Controller: Controls streaming rate

    Key Features: – Real-time token streaming – Chunk-based streaming – Progress callbacks – Cancellation support – Error recovery during streaming – Multiple output formats – Backpressure handling – Stream aggregation – Event-driven architecture – WebSocket support

    Use Cases: – Conversational chatbots with typing indicators – Long-form content generation – Real-time translation services – Live code generation and explanation – Progressive document analysis – Interactive storytelling – Streaming search results – Real-time data processing – Live transcription and summarization – Collaborative writing tools

    LangChain Implementation: Uses ChatOpenAI with streaming=True, callbacks for progress tracking, and LCEL chains with streaming support.


    File Statistics

    • Total Lines: 810
    • Classes: 7
    • Functions: 1
    • Constants: 0

    Module Documentation

    """
    Pattern 078: Streaming Agent
    
    Description:
        A Streaming Agent delivers responses in real-time as they are generated, rather
        than waiting for complete output. This pattern is essential for building responsive
        user interfaces and handling long-running generation tasks. It provides immediate
        feedback to users and enables progressive rendering of results.
    
        The agent streams tokens as they are generated by the LLM, allowing for better
        user experience in conversational interfaces, content generation, and real-time
        data processing. It supports multiple streaming modes including token-by-token,
        chunk-by-chunk, and structured streaming with metadata.
    
    Components:
        1. Token Streamer: Streams individual tokens as generated
        2. Chunk Streamer: Streams semantic chunks (sentences, paragraphs)
        3. Event Streamer: Streams events with metadata and progress
        4. Progress Tracker: Monitors generation progress
        5. Buffer Manager: Manages streaming buffers and backpressure
        6. Error Handler: Handles streaming errors gracefully
        7. Aggregator: Collects streamed content for final result
        8. Rate Controller: Controls streaming rate
    
    Key Features:
        - Real-time token streaming
        - Chunk-based streaming
        - Progress callbacks
        - Cancellation support
        - Error recovery during streaming
        - Multiple output formats
        - Backpressure handling
        - Stream aggregation
        - Event-driven architecture
        - WebSocket support
    
    Use Cases:
        - Conversational chatbots with typing indicators
        - Long-form content generation
        - Real-time translation services
        - Live code generation and explanation
        - Progressive document analysis
        - Interactive storytelling
        - Streaming search results
        - Real-time data processing
        - Live transcription and summarization
        - Collaborative writing tools
    
    LangChain Implementation:
        Uses ChatOpenAI with streaming=True, callbacks for progress tracking,
        and LCEL chains with streaming support.
    """
    

    Purpose: This module implements the Streaming Agent pattern, providing a structured approach to agent design and implementation.


    Import Statements

    Standard Library Imports

    import asyncio
    import collections.deque
    import dataclasses.dataclass
    import dataclasses.field
    import datetime.datetime
    import enum.Enum
    import langchain_core.callbacks.BaseCallbackHandler
    import langchain_core.output_parsers.StrOutputParser
    import langchain_core.prompts.ChatPromptTemplate
    import os
    import time
    import typing.Any
    import typing.AsyncIterator
    import typing.Callable
    import typing.Dict
    import typing.Iterator
    import typing.List
    import typing.Optional
    

    Purpose: Core Python functionality: – asyncio: Asynchronous I/O operations – collections.deque: Specialized container datatypes – dataclasses.dataclass: Simplified class definitions with @dataclass – dataclasses.field: Simplified class definitions with @dataclass – datetime.datetime: Date and time handling – enum.Enum: Enumeration support – langchain_core.callbacks.BaseCallbackHandler: Regular expression operations – langchain_core.output_parsers.StrOutputParser: Regular expression operations – langchain_core.prompts.ChatPromptTemplate: Regular expression operations – os: Environment variable access and system operations – time: Time-related functions – typing.Any: Type hints for better code documentation (List, Dict, Any, Optional) – typing.AsyncIterator: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Callable: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Dict: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Iterator: Type hints for better code documentation (List, Dict, Any, Optional) – typing.List: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Optional: Type hints for better code documentation (List, Dict, Any, Optional)

    LangChain Imports

    from langchain_openai.ChatOpenAI
    

    Purpose: LangChain framework components: – LLM Interface: Wrapper for OpenAI models – Chains: Composable building blocks for complex workflows

    Other Imports

    from dotenv.load_dotenv
    

    Purpose: Additional dependencies for specialized functionality.


    Classes

    Class: StreamMode

    Lines 72-78

    Inherits from: Enum

    Purpose:

    Streaming modes
    

    Class: StreamStatus

    Lines 81-88

    Inherits from: Enum

    Purpose:

    Stream status
    

    Class: StreamEvent

    Lines 92-99

    Purpose:

    Event in the stream
    

    Class: StreamConfig

    Lines 103-111

    Purpose:

    Configuration for streaming
    

    Class: StreamResult

    Lines 115-122

    Purpose:

    Result of streaming operation
    

    Class: StreamingCallbackHandler

    Lines 125-148

    Inherits from: BaseCallbackHandler

    Purpose:

    Callback handler for streaming events
    

    Methods:

    __init__(self, on_token, on_chunk)

    Lines 128-136

    Purpose:

    Initialize callback handler
    

    Parameters: – on_token: On token – on_chunk: On chunk

    on_llm_new_token(self, token)

    Lines 138-142

    Purpose:

    Called when new token is generated
    

    Parameters: – token: Token

    Returns: None

    on_llm_end(self, response)

    Lines 144-148

    Purpose:

    Called when generation ends
    

    Parameters: – response: Response

    Returns: None


    Class: StreamingAgent

    Lines 151-579

    Purpose:

    Agent that streams responses in real-time.
    
    This agent provides various streaming capabilities including token streaming,
    chunk streaming, and event streaming with progress tracking.
    

    Methods:

    __init__(self, config)

    Lines 159-176

    Purpose:

    Initialize the streaming agent
    

    Parameters: – config: Config

    stream_tokens(self, prompt, on_token)

    Lines 178-243

    Purpose:

    Stream tokens as they are generated.
    
    Args:
        prompt: Input prompt
        on_token: Callback for each token
    
    Returns:
        StreamResult with full content and events
    

    Parameters: – prompt: Prompt template or text – on_token: On token

    Returns: StreamResult

    stream_chunks(self, prompt, chunk_size, on_chunk)

    Lines 245-326

    Purpose:

    Stream content in chunks.
    
    Args:
        prompt: Input prompt
        chunk_size: Size of chunks in characters
        on_chunk: Callback for each chunk
    
    Returns:
        StreamResult with full content and events
    

    Parameters: – prompt: Prompt template or text – chunk_size: Chunk size – on_chunk: On chunk

    Returns: StreamResult

    stream_with_progress(self, prompt, estimated_tokens, on_progress)

    Lines 328-410

    Purpose:

    Stream with progress tracking.
    
    Args:
        prompt: Input prompt
        estimated_tokens: Estimated total tokens for progress
        on_progress: Callback with progress (0.0-1.0) and content
    
    Returns:
        StreamResult with full content and progress events
    

    Parameters: – prompt: Prompt template or text – estimated_tokens: Estimated tokens – on_progress: On progress

    Returns: StreamResult

    stream_chain(self, inputs, on_chunk)

    Lines 475-535

    Purpose:

    Stream output from a chain.
    
    Args:
        inputs: Chain inputs
        on_chunk: Callback for each chunk
    
    Returns:
        StreamResult with full content
    

    Parameters: – inputs: Input data – on_chunk: On chunk

    Returns: StreamResult

    compare_streaming_vs_sync(self, prompt)

    Lines 537-579

    Purpose:

    Compare streaming vs synchronous generation.
    
    Args:
        prompt: Input prompt
    
    Returns:
        Comparison results
    

    Parameters: – prompt: Prompt template or text

    Returns: <ast.Subscript object at 0x000001A06D63BF10>


    Functions

    demonstrate_streaming_agent()

    Lines 582-805

    Purpose:

    Demonstrate the streaming agent capabilities
    

    Key Concepts Summary

    Pattern Overview

    The Streaming Agent pattern provides a structured approach to building AI agents with specific capabilities and behaviors. This implementation leverages LangChain’s composable components to create a robust and maintainable solution.

    Core Components

    1. Agent Class: Main implementation of the pattern logic
    2. Prompt Engineering: Carefully crafted prompts to guide LLM behavior
    3. Tool Integration: Optional tools for extended functionality
    4. Memory Management: State handling across interactions
    5. Output Parsing: Structured response processing

    When to Use

    ✅ Good for: – Scenarios requiring this specific pattern’s strengths – Applications needing structured agent behavior – Systems where explainability is important – Production environments requiring reliability

    ❌ Not ideal for: – Simple single-prompt tasks – Scenarios requiring different pattern characteristics – Resource-constrained environments (if computationally intensive)


    Best Practices Demonstrated

    1. Environment Configuration

    • ✅ Use .env files for API keys
    • ✅ Never hardcode credentials
    • ✅ Validate environment variables on startup

    2. Error Handling

    • ✅ Graceful degradation on failures
    • ✅ Informative error messages
    • ✅ Logging for debugging

    3. Prompt Engineering

    • ✅ Clear, specific instructions
    • ✅ Structured output formats
    • ✅ Few-shot examples when beneficial

    4. Code Organization

    • ✅ Separation of concerns (class-based design)
    • ✅ Type hints for clarity
    • ✅ Docstrings for documentation

    5. Performance Optimization

    • ✅ Appropriate temperature settings
    • ✅ Token budget management
    • ✅ Caching where applicable

    LangChain Components Used

    • ChatOpenAI: OpenAI model interface
    • Chains: Sequential component composition

    Why LangChain? – Composable abstractions for LLM applications – Rich ecosystem of integrations – Production-ready patterns – Active community and development


    Execution Flow

    1. Initialize agent with configuration
       ↓
    2. Load environment and dependencies
       ↓
    3. Prepare prompt with input data
       ↓
    4. Invoke LLM through LangChain
       ↓
    5. Parse and validate response
       ↓
    6. Return formatted result
    

    Key Decision Points: – Model selection (temperature, model type) – Prompt structure (few-shot vs zero-shot) – Error handling strategy – Output format validation


    Performance Considerations

    Computational Cost

    • LLM Calls: Primary cost factor (based on tokens)
    • Latency: Depends on model and input size
    • Memory: Minimal for most patterns

    Optimization Strategies

    1. Prompt Optimization: Minimize tokens while maintaining clarity
    2. Caching: Cache repeated queries/responses
    3. Model Selection: Use smaller models when appropriate
    4. Batch Processing: Group similar requests
    5. Streaming: For long responses, stream tokens

    Cost Estimates (Approximate)

    • GPT-3.5-turbo: ~$0.002 per request
    • GPT-4: ~$0.03 per request
    • GPT-4-turbo: ~$0.01 per request

    Actual costs vary based on input/output token counts


    Common Pitfalls to Avoid

    1. Prompt Design Issues

    ❌ Vague or ambiguous instructions
    ✅ Clear, specific, testable prompts

    2. Error Handling

    ❌ Ignoring API errors or rate limits
    ✅ Implement retry logic and graceful degradation

    3. Token Management

    ❌ Exceeding model token limits
    ✅ Truncate inputs, chunk processing

    4. Security

    ❌ Exposing API keys in code
    ✅ Use environment variables

    5. Testing

    ❌ Only testing happy paths
    ✅ Test edge cases, failures, malformed inputs

    6. Cost Management

    ❌ Unmonitored API usage
    ✅ Implement budgets, alerts, and monitoring


    Further Improvements

    Production Enhancements

    1. Monitoring: Add logging, metrics, tracing
    2. Validation: Input/output schema validation
    3. Rate Limiting: Implement request throttling
    4. Caching: Redis or in-memory cache for responses
    5. Async Support: Non-blocking operations for scalability

    Feature Extensions

    1. Multi-Model Support: Switch between providers
    2. Fallback Models: Graceful degradation strategy
    3. Custom Tools: Domain-specific function calling
    4. Advanced Memory: Vector stores for long-term memory
    5. Evaluation: Automated testing and benchmarking

    Code Quality

    1. Testing: Unit tests, integration tests
    2. Documentation: API docs, usage examples
    3. Type Safety: Stricter type hints
    4. Configuration: Externalized config files

    Related Patterns

    • Pattern 077
    • Pattern 079

    Pattern Families: – Reasoning Patterns (001-011) – Multi-Agent Patterns (012-019) – Tool Use Patterns (020-025) – Memory Patterns (026-031) – And many more…


    Summary

    The Streaming Agent pattern provides a powerful approach to building AI agents with specific capabilities. This implementation demonstrates:

    ✅ Key Strengths: – Clean, maintainable code structure – LangChain integration for composability – Type hints and documentation – Production-ready patterns

    🎯 Best Use Cases: – Applications requiring this pattern’s characteristics – Systems needing structured agent behavior – Production environments requiring reliability

    📚 Learning Resources: – LangChain Documentation: https://python.langchain.com/ – Pattern Documentation: See related patterns – OpenAI API Reference: https://platform.openai.com/docs/


    File: 078_streaming_agent.py
    Total Lines: 810
    Pattern Category: AI Agent Design Pattern #078


    Generated from actual implementation code
    For educational and reference purposes

  • Agentic Design Pattern: Scientific Discovery

    
        """
    Pattern 077: Scientific Discovery Agent
    
    Description:
        A Scientific Discovery Agent is a specialized AI agent designed to accelerate
        scientific research through hypothesis generation, experimental design, data
        interpretation, and knowledge synthesis. This pattern demonstrates how to build
        an intelligent agent that can formulate research hypotheses, design experiments,
        analyze results, identify patterns, and suggest new directions for scientific
        inquiry.
        
        The agent combines domain knowledge with scientific reasoning to assist researchers
        in making discoveries. It can generate novel hypotheses from observations, design
        experiments to test them, interpret experimental data, identify anomalies, and
        synthesize findings into coherent scientific knowledge.
    
    Components:
        1. Hypothesis Generator: Formulates testable scientific hypotheses
        2. Experiment Designer: Designs experiments with proper controls
        3. Data Analyzer: Analyzes experimental results statistically
        4. Pattern Recognizer: Identifies patterns and anomalies in data
        5. Knowledge Synthesizer: Integrates findings with existing knowledge
        6. Explanation Generator: Proposes mechanistic explanations
        7. Validation Checker: Ensures scientific rigor and reproducibility
        8. Discovery Evaluator: Assesses novelty and significance
    
    Key Features:
        - Novel hypothesis generation from observations
        - Experimental design with proper controls
        - Statistical analysis and significance testing
        - Pattern and anomaly detection
        - Mechanistic explanation generation
        - Knowledge graph integration
        - Reproducibility validation
        - Novelty assessment
        - Multi-scale reasoning (molecular to systems level)
        - Cross-domain insight transfer
    
    Use Cases:
        - Drug discovery and development
        - Materials science research
        - Biology and genetics research
        - Physics and chemistry experiments
        - Climate science analysis
        - Medical research and diagnostics
        - Agricultural optimization
        - Protein structure prediction
        - Reaction mechanism discovery
        - Systems biology modeling
    
    LangChain Implementation:
        Uses ChatOpenAI with specialized prompts for hypothesis generation,
        experimental design, and scientific reasoning with varied temperatures.
    """
    
    import os
    import re
    from typing import List, Dict, Any, Optional, Tuple
    from dataclasses import dataclass, field
    from enum import Enum
    from datetime import datetime
    from collections import defaultdict
    from dotenv import load_dotenv
    
    from langchain_core.prompts import ChatPromptTemplate
    from langchain_core.output_parsers import StrOutputParser
    from langchain_openai import ChatOpenAI
    
    load_dotenv()
    
    
    class ResearchDomain(Enum):
        """Scientific research domains"""
        BIOLOGY = "biology"
        CHEMISTRY = "chemistry"
        PHYSICS = "physics"
        MEDICINE = "medicine"
        MATERIALS_SCIENCE = "materials_science"
        ENVIRONMENTAL_SCIENCE = "environmental_science"
        NEUROSCIENCE = "neuroscience"
        GENETICS = "genetics"
        PHARMACOLOGY = "pharmacology"
        ASTROPHYSICS = "astrophysics"
    
    
    class HypothesisType(Enum):
        """Types of scientific hypotheses"""
        CAUSAL = "causal"
        CORRELATIONAL = "correlational"
        MECHANISTIC = "mechanistic"
        PREDICTIVE = "predictive"
        COMPARATIVE = "comparative"
    
    
    class ExperimentType(Enum):
        """Types of experiments"""
        CONTROLLED = "controlled"
        OBSERVATIONAL = "observational"
        COMPUTATIONAL = "computational"
        CLINICAL_TRIAL = "clinical_trial"
        FIELD_STUDY = "field_study"
    
    
    class SignificanceLevel(Enum):
        """Statistical significance levels"""
        HIGHLY_SIGNIFICANT = "p < 0.001"
        SIGNIFICANT = "p < 0.05"
        MARGINALLY_SIGNIFICANT = "p = 0.1"
    
    
    @dataclass
    class Observation:
        """A scientific observation"""
        observation_id: str
        domain: ResearchDomain
        description: str
        measured_variables: Dict[str, Any]
        context: str
        timestamp: datetime = field(default_factory=datetime.now)
    
    
    @dataclass
    class Hypothesis:
        """A scientific hypothesis"""
        hypothesis_id: str
        type: HypothesisType
        statement: str
        rationale: str
        predictions: List[str]
        testability_score: float  # 0.0-1.0
        novelty_score: float  # 0.0-1.0
        variables: Dict[str, str]  # independent, dependent, control
        supporting_evidence: List[str] = field(default_factory=list)
    
    
    @dataclass
    class ExperimentDesign:
        """Design for a scientific experiment"""
        experiment_id: str
        hypothesis_id: str
        experiment_type: ExperimentType
        objective: str
        methodology: str
        independent_variables: List[str]
        dependent_variables: List[str]
        control_variables: List[str]
        sample_size: int
        control_groups: List[str]
        experimental_groups: List[str]
        measurements: List[str]
        duration: str
        expected_outcomes: List[str]
    
    
    @dataclass
    class ExperimentalResult:
        """Results from an experiment"""
        experiment_id: str
        measurements: Dict[str, List[float]]
        observations: List[str]
        raw_data_summary: str
        anomalies: List[str] = field(default_factory=list)
    
    
    @dataclass
    class StatisticalAnalysis:
        """Statistical analysis of results"""
        test_name: str
        test_statistic: float
        p_value: float
        significance_level: SignificanceLevel
        confidence_interval: Optional[Tuple[float, float]]
        effect_size: float
        interpretation: str
    
    
    @dataclass
    class ScientificFinding:
        """A scientific finding or discovery"""
        finding_id: str
        hypothesis_id: str
        experiment_id: str
        conclusion: str
        evidence: List[str]
        confidence: float  # 0.0-1.0
        statistical_analyses: List[StatisticalAnalysis]
        limitations: List[str]
        implications: List[str]
        future_directions: List[str]
    
    
    @dataclass
    class MechanisticExplanation:
        """Mechanistic explanation of a phenomenon"""
        phenomenon: str
        mechanism: str
        components: List[str]
        interactions: List[str]
        evidence_support: List[str]
        confidence: float
    
    
    class ScientificDiscoveryAgent:
        """
        Agent for accelerating scientific discovery and research.
        
        This agent can generate hypotheses, design experiments, analyze data,
        and synthesize findings to advance scientific knowledge.
        """
        
        def __init__(self):
            """Initialize the scientific discovery agent"""
            # Hypothesis generator (creative)
            self.hypothesis_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.8)
            
            # Experiment designer (structured)
            self.designer_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.3)
            
            # Data analyzer (precise)
            self.analyzer_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.1)
            
            # Synthesizer (integrative)
            self.synthesizer_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.4)
            
            # Knowledge base
            self.observations: List[Observation] = []
            self.hypotheses: List[Hypothesis] = []
            self.experiments: List[ExperimentDesign] = []
            self.findings: List[ScientificFinding] = []
        
        def generate_hypotheses(
            self,
            observations: List[Observation],
            domain: ResearchDomain,
            count: int = 3
        ) -> List[Hypothesis]:
            """
            Generate scientific hypotheses from observations.
            
            Args:
                observations: List of observations
                domain: Research domain
                count: Number of hypotheses to generate
                
            Returns:
                List of Hypothesis objects
            """
            # Compile observations
            obs_summary = "\n".join([
                f"- {obs.description}" for obs in observations[:10]
            ])
            
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are a creative scientist. Generate novel, testable
                hypotheses based on the observations.
                
                For each hypothesis, provide:
                TYPE: causal/correlational/mechanistic/predictive/comparative
                STATEMENT: Clear hypothesis statement
                RATIONALE: Scientific reasoning
                PREDICTIONS: Testable predictions (comma-separated)
                TESTABILITY: Score 0.0-1.0
                NOVELTY: Score 0.0-1.0
                ---"""),
                ("user", """Domain: {domain}
    
    Observations:
    {observations}
    
    Generate {count} scientific hypotheses.""")
            ])
            
            chain = prompt | self.hypothesis_llm | StrOutputParser()
            
            try:
                response = chain.invoke({
                    "domain": domain.value,
                    "observations": obs_summary,
                    "count": count
                })
                
                hypotheses = []
                current_hyp = {}
                hyp_counter = 1
                
                for line in response.split('\n'):
                    line = line.strip()
                    
                    if line == '---' and current_hyp:
                        # Create hypothesis
                        if 'STATEMENT' in current_hyp:
                            hyp_type = HypothesisType.CAUSAL
                            type_str = current_hyp.get('TYPE', '').lower()
                            if 'correlational' in type_str:
                                hyp_type = HypothesisType.CORRELATIONAL
                            elif 'mechanistic' in type_str:
                                hyp_type = HypothesisType.MECHANISTIC
                            elif 'predictive' in type_str:
                                hyp_type = HypothesisType.PREDICTIVE
                            elif 'comparative' in type_str:
                                hyp_type = HypothesisType.COMPARATIVE
                            
                            testability = 0.7
                            try:
                                testability = float(current_hyp.get('TESTABILITY', '0.7'))
                            except:
                                pass
                            
                            novelty = 0.6
                            try:
                                novelty = float(current_hyp.get('NOVELTY', '0.6'))
                            except:
                                pass
                            
                            predictions = []
                            if 'PREDICTIONS' in current_hyp:
                                predictions = [p.strip() for p in current_hyp['PREDICTIONS'].split(',')]
                            
                            hypotheses.append(Hypothesis(
                                hypothesis_id=f"hyp_{hyp_counter}",
                                type=hyp_type,
                                statement=current_hyp.get('STATEMENT', ''),
                                rationale=current_hyp.get('RATIONALE', ''),
                                predictions=predictions,
                                testability_score=testability,
                                novelty_score=novelty,
                                variables={}
                            ))
                            hyp_counter += 1
                        current_hyp = {}
                    elif ':' in line:
                        parts = line.split(':', 1)
                        key = parts[0].strip().upper()
                        value = parts[1].strip()
                        current_hyp[key] = value
                
                # Add last hypothesis
                if current_hyp and 'STATEMENT' in current_hyp:
                    hypotheses.append(Hypothesis(
                        hypothesis_id=f"hyp_{hyp_counter}",
                        type=HypothesisType.CAUSAL,
                        statement=current_hyp.get('STATEMENT', ''),
                        rationale=current_hyp.get('RATIONALE', ''),
                        predictions=[],
                        testability_score=0.7,
                        novelty_score=0.6,
                        variables={}
                    ))
                
                # Fallback if no hypotheses generated
                if not hypotheses:
                    for i in range(count):
                        hypotheses.append(Hypothesis(
                            hypothesis_id=f"hyp_{i+1}",
                            type=HypothesisType.CAUSAL,
                            statement=f"Hypothesis {i+1} about {domain.value} phenomena",
                            rationale="Based on observed patterns",
                            predictions=["Testable prediction"],
                            testability_score=0.7,
                            novelty_score=0.6,
                            variables={}
                        ))
                
                return hypotheses[:count]
                
            except Exception as e:
                # Fallback hypotheses
                return [
                    Hypothesis(
                        hypothesis_id=f"hyp_{i+1}",
                        type=HypothesisType.CAUSAL,
                        statement=f"Research hypothesis {i+1}",
                        rationale="Scientific investigation required",
                        predictions=["Observable outcome"],
                        testability_score=0.7,
                        novelty_score=0.5,
                        variables={}
                    )
                    for i in range(count)
                ]
        
        def design_experiment(
            self,
            hypothesis: Hypothesis,
            domain: ResearchDomain
        ) -> ExperimentDesign:
            """
            Design an experiment to test a hypothesis.
            
            Args:
                hypothesis: Hypothesis to test
                domain: Research domain
                
            Returns:
                ExperimentDesign with methodology
            """
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are an expert experimental scientist. Design a rigorous
                experiment to test the hypothesis.
                
                Provide:
                TYPE: controlled/observational/computational/clinical_trial/field_study
                OBJECTIVE: Clear objective
                METHODOLOGY: Detailed method
                INDEPENDENT_VAR: Independent variables (comma-separated)
                DEPENDENT_VAR: Dependent variables (comma-separated)
                CONTROL_VAR: Control variables (comma-separated)
                SAMPLE_SIZE: Number of samples
                CONTROL_GROUPS: Control groups (comma-separated)
                EXPERIMENTAL_GROUPS: Experimental groups (comma-separated)
                MEASUREMENTS: What to measure (comma-separated)
                DURATION: Time period
                EXPECTED: Expected outcomes (comma-separated)"""),
                ("user", """Domain: {domain}
    
    Hypothesis: {hypothesis}
    Type: {hyp_type}
    Predictions: {predictions}
    
    Design an experiment to test this hypothesis.""")
            ])
            
            chain = prompt | self.designer_llm | StrOutputParser()
            
            try:
                response = chain.invoke({
                    "domain": domain.value,
                    "hypothesis": hypothesis.statement,
                    "hyp_type": hypothesis.type.value,
                    "predictions": ", ".join(hypothesis.predictions[:3])
                })
                
                exp_data = {}
                
                for line in response.split('\n'):
                    if ':' in line:
                        parts = line.split(':', 1)
                        key = parts[0].strip().upper()
                        value = parts[1].strip()
                        exp_data[key] = value
                
                exp_type = ExperimentType.CONTROLLED
                type_str = exp_data.get('TYPE', '').lower()
                if 'observational' in type_str:
                    exp_type = ExperimentType.OBSERVATIONAL
                elif 'computational' in type_str:
                    exp_type = ExperimentType.COMPUTATIONAL
                elif 'clinical' in type_str:
                    exp_type = ExperimentType.CLINICAL_TRIAL
                elif 'field' in type_str:
                    exp_type = ExperimentType.FIELD_STUDY
                
                sample_size = 30
                try:
                    sample_size = int(re.findall(r'\d+', exp_data.get('SAMPLE_SIZE', '30'))[0])
                except:
                    pass
                
                return ExperimentDesign(
                    experiment_id=f"exp_{datetime.now().timestamp()}",
                    hypothesis_id=hypothesis.hypothesis_id,
                    experiment_type=exp_type,
                    objective=exp_data.get('OBJECTIVE', f"Test {hypothesis.statement}"),
                    methodology=exp_data.get('METHODOLOGY', "Experimental methodology"),
                    independent_variables=[v.strip() for v in exp_data.get('INDEPENDENT_VAR', '').split(',')],
                    dependent_variables=[v.strip() for v in exp_data.get('DEPENDENT_VAR', '').split(',')],
                    control_variables=[v.strip() for v in exp_data.get('CONTROL_VAR', '').split(',')],
                    sample_size=sample_size,
                    control_groups=[g.strip() for g in exp_data.get('CONTROL_GROUPS', 'Control').split(',')],
                    experimental_groups=[g.strip() for g in exp_data.get('EXPERIMENTAL_GROUPS', 'Treatment').split(',')],
                    measurements=[m.strip() for m in exp_data.get('MEASUREMENTS', 'Primary outcome').split(',')],
                    duration=exp_data.get('DURATION', '4 weeks'),
                    expected_outcomes=[o.strip() for o in exp_data.get('EXPECTED', 'Positive effect').split(',')]
                )
                
            except Exception as e:
                return ExperimentDesign(
                    experiment_id=f"exp_{datetime.now().timestamp()}",
                    hypothesis_id=hypothesis.hypothesis_id,
                    experiment_type=ExperimentType.CONTROLLED,
                    objective=f"Test hypothesis: {hypothesis.statement[:50]}",
                    methodology="Controlled experimental study",
                    independent_variables=["Treatment"],
                    dependent_variables=["Outcome measure"],
                    control_variables=["Environmental factors"],
                    sample_size=30,
                    control_groups=["Control"],
                    experimental_groups=["Treatment"],
                    measurements=["Primary outcome"],
                    duration="4 weeks",
                    expected_outcomes=["Expected result"]
                )
        
        def analyze_results(
            self,
            experiment: ExperimentDesign,
            results: ExperimentalResult
        ) -> List[StatisticalAnalysis]:
            """
            Analyze experimental results statistically.
            
            Args:
                experiment: Experiment design
                results: Experimental results
                
            Returns:
                List of StatisticalAnalysis
            """
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are a biostatistician. Analyze the experimental results
                and determine statistical significance.
                
                For each analysis, provide:
                TEST: Statistical test name
                STATISTIC: Test statistic value
                P_VALUE: P-value
                EFFECT_SIZE: Effect size measure
                INTERPRETATION: What the results mean"""),
                ("user", """Experiment: {objective}
    
    Results Summary:
    {results}
    
    Measurements:
    {measurements}
    
    Analyze these results statistically.""")
            ])
            
            chain = prompt | self.analyzer_llm | StrOutputParser()
            
            try:
                response = chain.invoke({
                    "objective": experiment.objective,
                    "results": results.raw_data_summary,
                    "measurements": ", ".join(experiment.measurements)
                })
                
                analyses = []
                
                # Parse response for statistical tests
                test_name = "t-test"
                statistic = 2.5
                p_value = 0.03
                effect_size = 0.5
                interpretation = "Analysis shows significant effect"
                
                for line in response.split('\n'):
                    if 'TEST:' in line:
                        test_name = line.replace('TEST:', '').strip()
                    elif 'STATISTIC:' in line:
                        try:
                            statistic = float(re.findall(r'[-\d.]+', line)[0])
                        except:
                            pass
                    elif 'P_VALUE:' in line or 'P-VALUE:' in line:
                        try:
                            p_value = float(re.findall(r'[\d.]+', line)[0])
                        except:
                            pass
                    elif 'EFFECT_SIZE:' in line:
                        try:
                            effect_size = float(re.findall(r'[-\d.]+', line)[0])
                        except:
                            pass
                    elif 'INTERPRETATION:' in line:
                        interpretation = line.replace('INTERPRETATION:', '').strip()
                
                # Determine significance level
                if p_value < 0.001:
                    sig_level = SignificanceLevel.HIGHLY_SIGNIFICANT
                elif p_value < 0.05:
                    sig_level = SignificanceLevel.SIGNIFICANT
                elif p_value  ScientificFinding:
            """
            Synthesize experimental findings into scientific conclusions.
            
            Args:
                hypothesis: Original hypothesis
                experiment: Experiment design
                results: Experimental results
                analyses: Statistical analyses
                
            Returns:
                ScientificFinding with conclusions
            """
            # Compile analyses
            analyses_summary = "\n".join([
                f"- {a.test_name}: {a.significance_level.value}, effect size = {a.effect_size:.2f}"
                for a in analyses
            ])
            
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are a research scientist. Synthesize the experimental
                findings into scientific conclusions.
                
                Provide:
                CONCLUSION: Main conclusion
                EVIDENCE: Supporting evidence (one per line starting with -)
                CONFIDENCE: Confidence level (0.0-1.0)
                LIMITATIONS: Study limitations (one per line starting with -)
                IMPLICATIONS: Scientific implications (one per line starting with -)
                FUTURE: Future research directions (one per line starting with -)"""),
                ("user", """Hypothesis: {hypothesis}
    
    Experiment: {experiment}
    
    Statistical Analyses:
    {analyses}
    
    Observations:
    {observations}
    
    Synthesize the findings.""")
            ])
            
            chain = prompt | self.synthesizer_llm | StrOutputParser()
            
            try:
                response = chain.invoke({
                    "hypothesis": hypothesis.statement,
                    "experiment": experiment.objective,
                    "analyses": analyses_summary,
                    "observations": ", ".join(results.observations[:5])
                })
                
                conclusion = ""
                evidence = []
                confidence = 0.7
                limitations = []
                implications = []
                future = []
                
                current_section = None
                
                for line in response.split('\n'):
                    line = line.strip()
                    if not line:
                        continue
                    
                    if line.startswith('CONCLUSION:'):
                        conclusion = line.replace('CONCLUSION:', '').strip()
                    elif line.startswith('EVIDENCE:'):
                        current_section = 'evidence'
                    elif line.startswith('CONFIDENCE:'):
                        try:
                            confidence = float(re.findall(r'[\d.]+', line)[0])
                        except:
                            pass
                    elif line.startswith('LIMITATIONS:'):
                        current_section = 'limitations'
                    elif line.startswith('IMPLICATIONS:'):
                        current_section = 'implications'
                    elif line.startswith('FUTURE:'):
                        current_section = 'future'
                    elif line.startswith('-'):
                        content = line[1:].strip()
                        if current_section == 'evidence':
                            evidence.append(content)
                        elif current_section == 'limitations':
                            limitations.append(content)
                        elif current_section == 'implications':
                            implications.append(content)
                        elif current_section == 'future':
                            future.append(content)
                
                return ScientificFinding(
                    finding_id=f"finding_{datetime.now().timestamp()}",
                    hypothesis_id=hypothesis.hypothesis_id,
                    experiment_id=experiment.experiment_id,
                    conclusion=conclusion if conclusion else "Findings support the hypothesis",
                    evidence=evidence if evidence else ["Statistical significance observed"],
                    confidence=confidence,
                    statistical_analyses=analyses,
                    limitations=limitations if limitations else ["Further validation needed"],
                    implications=implications if implications else ["Important for field"],
                    future_directions=future if future else ["Continue research"]
                )
                
            except Exception as e:
                return ScientificFinding(
                    finding_id=f"finding_{datetime.now().timestamp()}",
                    hypothesis_id=hypothesis.hypothesis_id,
                    experiment_id=experiment.experiment_id,
                    conclusion="Experimental findings documented",
                    evidence=["Data collected and analyzed"],
                    confidence=0.7,
                    statistical_analyses=analyses,
                    limitations=["Study limitations exist"],
                    implications=["Further research needed"],
                    future_directions=["Additional experiments recommended"]
                )
        
        def propose_mechanism(
            self,
            phenomenon: str,
            findings: List[ScientificFinding],
            domain: ResearchDomain
        ) -> MechanisticExplanation:
            """
            Propose mechanistic explanation for a phenomenon.
            
            Args:
                phenomenon: Phenomenon to explain
                findings: Related scientific findings
                domain: Research domain
                
            Returns:
                MechanisticExplanation
            """
            findings_summary = "\n".join([
                f"- {f.conclusion}" for f in findings[:5]
            ])
            
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are a theoretical scientist. Propose a mechanistic
                explanation for the phenomenon based on findings.
                
                Provide:
                MECHANISM: Mechanistic explanation
                COMPONENTS: Key components (comma-separated)
                INTERACTIONS: How components interact (comma-separated)
                EVIDENCE: Supporting evidence (comma-separated)
                CONFIDENCE: Confidence level (0.0-1.0)"""),
                ("user", """Domain: {domain}
    Phenomenon: {phenomenon}
    
    Related Findings:
    {findings}
    
    Propose a mechanistic explanation.""")
            ])
            
            chain = prompt | self.synthesizer_llm | StrOutputParser()
            
            try:
                response = chain.invoke({
                    "domain": domain.value,
                    "phenomenon": phenomenon,
                    "findings": findings_summary
                })
                
                mechanism = ""
                components = []
                interactions = []
                evidence = []
                confidence = 0.6
                
                for line in response.split('\n'):
                    if 'MECHANISM:' in line:
                        mechanism = line.replace('MECHANISM:', '').strip()
                    elif 'COMPONENTS:' in line:
                        comp_str = line.replace('COMPONENTS:', '').strip()
                        components = [c.strip() for c in comp_str.split(',')]
                    elif 'INTERACTIONS:' in line:
                        int_str = line.replace('INTERACTIONS:', '').strip()
                        interactions = [i.strip() for i in int_str.split(',')]
                    elif 'EVIDENCE:' in line:
                        ev_str = line.replace('EVIDENCE:', '').strip()
                        evidence = [e.strip() for e in ev_str.split(',')]
                    elif 'CONFIDENCE:' in line:
                        try:
                            confidence = float(re.findall(r'[\d.]+', line)[0])
                        except:
                            pass
                
                return MechanisticExplanation(
                    phenomenon=phenomenon,
                    mechanism=mechanism if mechanism else f"Proposed mechanism for {phenomenon}",
                    components=components if components else ["Component A", "Component B"],
                    interactions=interactions if interactions else ["Interaction pathway"],
                    evidence_support=evidence if evidence else ["Experimental support"],
                    confidence=confidence
                )
                
            except Exception as e:
                return MechanisticExplanation(
                    phenomenon=phenomenon,
                    mechanism=f"Mechanistic explanation of {phenomenon}",
                    components=["Key components"],
                    interactions=["Interaction mechanisms"],
                    evidence_support=["Supporting evidence"],
                    confidence=0.6
                )
        
        def conduct_research_cycle(
            self,
            initial_observation: Observation,
            domain: ResearchDomain
        ) -> Dict[str, Any]:
            """
            Conduct a complete research cycle from observation to finding.
            
            Args:
                initial_observation: Starting observation
                domain: Research domain
                
            Returns:
                Dictionary with complete research cycle results
            """
            print(f"\n🔬 Starting research cycle in {domain.value}...")
            
            # Step 1: Generate hypotheses
            print("  ✓ Generating hypotheses from observations...")
            hypotheses = self.generate_hypotheses([initial_observation], domain, count=2)
            
            # Step 2: Design experiment
            print("  ✓ Designing experiment...")
            experiment = self.design_experiment(hypotheses[0], domain)
            
            # Step 3: Simulate results (in production, would be real data)
            print("  ✓ Collecting experimental data...")
            results = ExperimentalResult(
                experiment_id=experiment.experiment_id,
                measurements={"outcome": [1.2, 1.5, 1.8, 1.3, 1.6]},
                observations=["Positive effect observed", "Dose-dependent response"],
                raw_data_summary="Statistical analysis shows significant positive effect",
                anomalies=[]
            )
            
            # Step 4: Analyze results
            print("  ✓ Analyzing results statistically...")
            analyses = self.analyze_results(experiment, results)
            
            # Step 5: Synthesize findings
            print("  ✓ Synthesizing scientific findings...")
            finding = self.synthesize_finding(hypotheses[0], experiment, results, analyses)
            
            # Step 6: Propose mechanism
            print("  ✓ Proposing mechanistic explanation...")
            mechanism = self.propose_mechanism(
                initial_observation.description,
                [finding],
                domain
            )
            
            print("  ✅ Research cycle complete!\n")
            
            return {
                "observation": initial_observation,
                "hypotheses": hypotheses,
                "experiment": experiment,
                "results": results,
                "analyses": analyses,
                "finding": finding,
                "mechanism": mechanism
            }
    
    
    def demonstrate_scientific_discovery_agent():
        """Demonstrate the scientific discovery agent capabilities"""
        print("=" * 80)
        print("SCIENTIFIC DISCOVERY AGENT DEMONSTRATION")
        print("=" * 80)
        
        agent = ScientificDiscoveryAgent()
        
        # Demo 1: Complete Research Cycle
        print("\n" + "=" * 80)
        print("DEMO 1: Complete Research Cycle")
        print("=" * 80)
        
        observation = Observation(
            observation_id="obs_001",
            domain=ResearchDomain.BIOLOGY,
            description="Certain proteins show increased expression in the presence of specific environmental stressors",
            measured_variables={"protein_levels": "elevated", "stress_exposure": "high"},
            context="Cell culture experiment"
        )
        
        cycle_results = agent.conduct_research_cycle(observation, ResearchDomain.BIOLOGY)
        
        print("RESEARCH CYCLE RESULTS")
        print("-" * 80)
        
        print(f"\nInitial Observation:")
        print(f"  {observation.description}")
        
        print(f"\nGenerated Hypotheses ({len(cycle_results['hypotheses'])}):")
        for i, hyp in enumerate(cycle_results['hypotheses'], 1):
            print(f"\n  {i}. {hyp.statement}")
            print(f"     Type: {hyp.type.value}")
            print(f"     Testability: {hyp.testability_score:.2f}/1.0")
            print(f"     Novelty: {hyp.novelty_score:.2f}/1.0")
            if hyp.predictions:
                print(f"     Predictions: {hyp.predictions[0][:60]}...")
        
        experiment = cycle_results['experiment']
        print(f"\nExperimental Design:")
        print(f"  Type: {experiment.experiment_type.value}")
        print(f"  Objective: {experiment.objective[:100]}...")
        print(f"  Sample Size: {experiment.sample_size}")
        print(f"  Independent Variables: {', '.join(experiment.independent_variables[:3])}")
        print(f"  Dependent Variables: {', '.join(experiment.dependent_variables[:3])}")
        print(f"  Duration: {experiment.duration}")
        
        print(f"\nStatistical Analyses ({len(cycle_results['analyses'])}):")
        for analysis in cycle_results['analyses']:
            print(f"  • {analysis.test_name}")
            print(f"    Statistic: {analysis.test_statistic:.3f}")
            print(f"    P-value: {analysis.p_value:.4f}")
            print(f"    Significance: {analysis.significance_level.value}")
            print(f"    Effect Size: {analysis.effect_size:.2f}")
            print(f"    {analysis.interpretation[:80]}...")
        
        finding = cycle_results['finding']
        print(f"\nScientific Finding:")
        print(f"  Conclusion: {finding.conclusion[:150]}...")
        print(f"  Confidence: {finding.confidence:.2f}/1.0")
        print(f"\n  Evidence:")
        for evidence in finding.evidence[:2]:
            print(f"    • {evidence}")
        print(f"\n  Implications:")
        for impl in finding.implications[:2]:
            print(f"    • {impl}")
        
        mechanism = cycle_results['mechanism']
        print(f"\nMechanistic Explanation:")
        print(f"  Mechanism: {mechanism.mechanism[:150]}...")
        print(f"  Components: {', '.join(mechanism.components[:3])}")
        print(f"  Confidence: {mechanism.confidence:.2f}/1.0")
        
        # Demo 2: Hypothesis Generation
        print("\n" + "=" * 80)
        print("DEMO 2: Multi-Hypothesis Generation")
        print("=" * 80)
        
        obs_list = [
            Observation(
                observation_id="obs_002",
                domain=ResearchDomain.CHEMISTRY,
                description="Novel catalyst reduces reaction time by 50%",
                measured_variables={"reaction_time": "reduced"},
                context="Catalysis experiment"
            ),
            Observation(
                observation_id="obs_003",
                domain=ResearchDomain.CHEMISTRY,
                description="Temperature affects catalyst efficiency non-linearly",
                measured_variables={"temperature": "variable", "efficiency": "non-linear"},
                context="Temperature study"
            )
        ]
        
        print("\nObservations:")
        for obs in obs_list:
            print(f"  • {obs.description}")
        
        print("\nGenerating hypotheses...")
        hypotheses = agent.generate_hypotheses(obs_list, ResearchDomain.CHEMISTRY, count=3)
        
        print(f"\nGenerated Hypotheses:")
        for i, hyp in enumerate(hypotheses, 1):
            print(f"\n{i}. {hyp.statement}")
            print(f"   Type: {hyp.type.value}")
            print(f"   Rationale: {hyp.rationale[:100]}...")
            print(f"   Testability: {hyp.testability_score:.2f}, Novelty: {hyp.novelty_score:.2f}")
        
        # Demo 3: Experiment Design
        print("\n" + "=" * 80)
        print("DEMO 3: Detailed Experiment Design")
        print("=" * 80)
        
        test_hypothesis = hypotheses[0]
        print(f"\nHypothesis to test:")
        print(f"  {test_hypothesis.statement}")
        
        print("\nDesigning experiment...")
        exp_design = agent.design_experiment(test_hypothesis, ResearchDomain.CHEMISTRY)
        
        print(f"\nExperimental Design:")
        print(f"  ID: {exp_design.experiment_id}")
        print(f"  Type: {exp_design.experiment_type.value}")
        print(f"  Objective: {exp_design.objective}")
        print(f"\n  Methodology:")
        print(f"    {exp_design.methodology[:200]}...")
        print(f"\n  Variables:")
        print(f"    Independent: {', '.join(exp_design.independent_variables)}")
        print(f"    Dependent: {', '.join(exp_design.dependent_variables)}")
        print(f"    Control: {', '.join(exp_design.control_variables[:3])}")
        print(f"\n  Groups:")
        print(f"    Control: {', '.join(exp_design.control_groups)}")
        print(f"    Experimental: {', '.join(exp_design.experimental_groups)}")
        print(f"\n  Sample Size: {exp_design.sample_size}")
        print(f"  Duration: {exp_design.duration}")
        print(f"\n  Expected Outcomes:")
        for outcome in exp_design.expected_outcomes[:2]:
            print(f"    • {outcome}")
        
        # Summary
        print("\n" + "=" * 80)
        print("SUMMARY")
        print("=" * 80)
        
        summary = """
    The Scientific Discovery Agent demonstrates advanced capabilities for research:
    
    KEY CAPABILITIES:
    1. Hypothesis Generation: Creates novel, testable hypotheses from observations
    2. Experiment Design: Designs rigorous experiments with proper controls
    3. Statistical Analysis: Analyzes results with appropriate statistical methods
    4. Finding Synthesis: Integrates results into scientific conclusions
    5. Mechanism Proposal: Proposes mechanistic explanations for phenomena
    6. Research Cycles: Executes complete discovery workflows
    
    BENEFITS:
    - Accelerates hypothesis generation and testing
    - Ensures experimental rigor and reproducibility
    - Provides statistical expertise for all analyses
    - Identifies patterns humans might miss
    - Proposes novel research directions
    - Synthesizes findings across studies
    - Reduces time from observation to discovery
    
    USE CASES:
    - Drug discovery and development
    - Materials science research
    - Protein structure and function studies
    - Disease mechanism investigation
    - Climate and environmental research
    - Agricultural optimization
    - Chemical reaction discovery
    - Medical diagnostics development
    - Genetic research
    - Neuroscience investigations
    
    PRODUCTION CONSIDERATIONS:
    1. Domain Knowledge: Deep integration with scientific databases and literature
    2. Data Integration: Connect to lab instruments and data repositories
    3. Validation: Rigorous statistical methods and reproducibility checks
    4. Visualization: Generate charts, plots, and visual explanations
    5. Collaboration: Support multi-researcher workflows
    6. Documentation: Automatic research documentation and reporting
    7. Ethics: Ensure ethical research practices and safety
    8. Peer Review: Facilitate peer review and validation
    9. Publication: Generate publication-ready manuscripts
    10. IP Protection: Track novel discoveries and inventions
    
    ADVANCED EXTENSIONS:
    - Automated literature review for context
    - Predictive modeling of experimental outcomes
    - Multi-scale simulation integration
    - Active learning for optimal experiment selection
    - Causal inference from observational data
    - Anomaly detection in experimental results
    - Cross-domain knowledge transfer
    - Automated protocol optimization
    - Real-time experiment monitoring
    - Collaborative discovery networks
    
    The agent transforms scientific research by accelerating the discovery process
    while maintaining rigorous scientific standards and reproducibility.
    """
        
        print(summary)
    
    
    if __name__ == "__main__":
        demonstrate_scientific_discovery_agent()
    
        

    Agentic Design Pattern: Scientific Discovery

    Pattern 077: Scientific Discovery – Line-by-Line Explanation

    Overview

    This document provides a detailed line-by-line explanation of the Scientific Discovery pattern implementation.


    Pattern Description

    Pattern 077: Scientific Discovery Agent

    Description: A Scientific Discovery Agent is a specialized AI agent designed to accelerate scientific research through hypothesis generation, experimental design, data interpretation, and knowledge synthesis. This pattern demonstrates how to build an intelligent agent that can formulate research hypotheses, design experiments, analyze results, identify patterns, and suggest new directions for scientific inquiry.

    The agent combines domain knowledge with scientific reasoning to assist researchers
    in making discoveries. It can generate novel hypotheses from observations, design
    experiments to test them, interpret experimental data, identify anomalies, and
    synthesize findings into coherent scientific knowledge.
    

    Components: 1. Hypothesis Generator: Formulates testable scientific hypotheses 2. Experiment Designer: Designs experiments with proper controls 3. Data Analyzer: Analyzes experimental results statistically 4. Pattern Recognizer: Identifies patterns and anomalies in data 5. Knowledge Synthesizer: Integrates findings with existing knowledge 6. Explanation Generator: Proposes mechanistic explanations 7. Validation Checker: Ensures scientific rigor and reproducibility 8. Discovery Evaluator: Assesses novelty and significance

    Key Features: – Novel hypothesis generation from observations – Experimental design with proper controls – Statistical analysis and significance testing – Pattern and anomaly detection – Mechanistic explanation generation – Knowledge graph integration – Reproducibility validation – Novelty assessment – Multi-scale reasoning (molecular to systems level) – Cross-domain insight transfer

    Use Cases: – Drug discovery and development – Materials science research – Biology and genetics research – Physics and chemistry experiments – Climate science analysis – Medical research and diagnostics – Agricultural optimization – Protein structure prediction – Reaction mechanism discovery – Systems biology modeling

    LangChain Implementation: Uses ChatOpenAI with specialized prompts for hypothesis generation, experimental design, and scientific reasoning with varied temperatures.


    File Statistics

    • Total Lines: 1097
    • Classes: 12
    • Functions: 1
    • Constants: 0

    Module Documentation

    """
    Pattern 077: Scientific Discovery Agent
    
    Description:
        A Scientific Discovery Agent is a specialized AI agent designed to accelerate
        scientific research through hypothesis generation, experimental design, data
        interpretation, and knowledge synthesis. This pattern demonstrates how to build
        an intelligent agent that can formulate research hypotheses, design experiments,
        analyze results, identify patterns, and suggest new directions for scientific
        inquiry.
    
        The agent combines domain knowledge with scientific reasoning to assist researchers
        in making discoveries. It can generate novel hypotheses from observations, design
        experiments to test them, interpret experimental data, identify anomalies, and
        synthesize findings into coherent scientific knowledge.
    
    Components:
        1. Hypothesis Generator: Formulates testable scientific hypotheses
        2. Experiment Designer: Designs experiments with proper controls
        3. Data Analyzer: Analyzes experimental results statistically
        4. Pattern Recognizer: Identifies patterns and anomalies in data
        5. Knowledge Synthesizer: Integrates findings with existing knowledge
        6. Explanation Generator: Proposes mechanistic explanations
        7. Validation Checker: Ensures scientific rigor and reproducibility
        8. Discovery Evaluator: Assesses novelty and significance
    
    Key Features:
        - Novel hypothesis generation from observations
        - Experimental design with proper controls
        - Statistical analysis and significance testing
        - Pattern and anomaly detection
        - Mechanistic explanation generation
        - Knowledge graph integration
        - Reproducibility validation
        - Novelty assessment
        - Multi-scale reasoning (molecular to systems level)
        - Cross-domain insight transfer
    
    Use Cases:
        - Drug discovery and development
        - Materials science research
        - Biology and genetics research
        - Physics and chemistry experiments
        - Climate science analysis
        - Medical research and diagnostics
        - Agricultural optimization
        - Protein structure prediction
        - Reaction mechanism discovery
        - Systems biology modeling
    
    LangChain Implementation:
        Uses ChatOpenAI with specialized prompts for hypothesis generation,
        experimental design, and scientific reasoning with varied temperatures.
    """
    

    Purpose: This module implements the Scientific Discovery pattern, providing a structured approach to agent design and implementation.


    Import Statements

    Standard Library Imports

    import collections.defaultdict
    import dataclasses.dataclass
    import dataclasses.field
    import datetime.datetime
    import enum.Enum
    import langchain_core.output_parsers.StrOutputParser
    import langchain_core.prompts.ChatPromptTemplate
    import os
    import re
    import typing.Any
    import typing.Dict
    import typing.List
    import typing.Optional
    import typing.Tuple
    

    Purpose: Core Python functionality: – collections.defaultdict: Specialized container datatypes – dataclasses.dataclass: Simplified class definitions with @dataclass – dataclasses.field: Simplified class definitions with @dataclass – datetime.datetime: Date and time handling – enum.Enum: Enumeration support – langchain_core.output_parsers.StrOutputParser: Regular expression operations – langchain_core.prompts.ChatPromptTemplate: Regular expression operations – os: Environment variable access and system operations – re: Regular expression operations – typing.Any: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Dict: Type hints for better code documentation (List, Dict, Any, Optional) – typing.List: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Optional: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Tuple: Type hints for better code documentation (List, Dict, Any, Optional)

    LangChain Imports

    from langchain_openai.ChatOpenAI
    

    Purpose: LangChain framework components: – LLM Interface: Wrapper for OpenAI models – Chains: Composable building blocks for complex workflows

    Other Imports

    from dotenv.load_dotenv
    

    Purpose: Additional dependencies for specialized functionality.


    Classes

    Class: ResearchDomain

    Lines 72-83

    Inherits from: Enum

    Purpose:

    Scientific research domains
    

    Class: HypothesisType

    Lines 86-92

    Inherits from: Enum

    Purpose:

    Types of scientific hypotheses
    

    Class: ExperimentType

    Lines 95-101

    Inherits from: Enum

    Purpose:

    Types of experiments
    

    Class: SignificanceLevel

    Lines 104-109

    Inherits from: Enum

    Purpose:

    Statistical significance levels
    

    Class: Observation

    Lines 113-120

    Purpose:

    A scientific observation
    

    Class: Hypothesis

    Lines 124-134

    Purpose:

    A scientific hypothesis
    

    Class: ExperimentDesign

    Lines 138-153

    Purpose:

    Design for a scientific experiment
    

    Class: ExperimentalResult

    Lines 157-163

    Purpose:

    Results from an experiment
    

    Class: StatisticalAnalysis

    Lines 167-175

    Purpose:

    Statistical analysis of results
    

    Class: ScientificFinding

    Lines 179-190

    Purpose:

    A scientific finding or discovery
    

    Class: MechanisticExplanation

    Lines 194-201

    Purpose:

    Mechanistic explanation of a phenomenon
    

    Class: ScientificDiscoveryAgent

    Lines 204-884

    Purpose:

    Agent for accelerating scientific discovery and research.
    
    This agent can generate hypotheses, design experiments, analyze data,
    and synthesize findings to advance scientific knowledge.
    

    Methods:

    __init__(self)

    Lines 212-230

    Purpose:

    Initialize the scientific discovery agent
    

    Parameters:

    generate_hypotheses(self, observations, domain, count)

    Lines 232-381

    Purpose:

    Generate scientific hypotheses from observations.
    
    Args:
        observations: List of observations
        domain: Research domain
        count: Number of hypotheses to generate
    
    Returns:
        List of Hypothesis objects
    

    Parameters: – observations: Observations – domain: Domain – count: Count

    Returns: <ast.Subscript object at 0x000001A06D6294D0>

    design_experiment(self, hypothesis, domain)

    Lines 383-493

    Purpose:

    Design an experiment to test a hypothesis.
    
    Args:
        hypothesis: Hypothesis to test
        domain: Research domain
    
    Returns:
        ExperimentDesign with methodology
    

    Parameters: – hypothesis: Hypothesis – domain: Domain

    Returns: ExperimentDesign

    analyze_results(self, experiment, results)

    Lines 495-603

    Purpose:

    Analyze experimental results statistically.
    
    Args:
        experiment: Experiment design
        results: Experimental results
    
    Returns:
        List of StatisticalAnalysis
    

    Parameters: – experiment: Experiment – results: Results

    Returns: <ast.Subscript object at 0x000001A06D7F58D0>

    synthesize_finding(self, hypothesis, experiment, results, analyses)

    Lines 605-729

    Purpose:

    Synthesize experimental findings into scientific conclusions.
    
    Args:
        hypothesis: Original hypothesis
        experiment: Experiment design
        results: Experimental results
        analyses: Statistical analyses
    
    Returns:
        ScientificFinding with conclusions
    

    Parameters: – hypothesis: Hypothesis – experiment: Experiment – results: Results – analyses: Analyses

    Returns: ScientificFinding

    propose_mechanism(self, phenomenon, findings, domain)

    Lines 731-821

    Purpose:

    Propose mechanistic explanation for a phenomenon.
    
    Args:
        phenomenon: Phenomenon to explain
        findings: Related scientific findings
        domain: Research domain
    
    Returns:
        MechanisticExplanation
    

    Parameters: – phenomenon: Phenomenon – findings: Findings – domain: Domain

    Returns: MechanisticExplanation

    conduct_research_cycle(self, initial_observation, domain)

    Lines 823-884

    Purpose:

    Conduct a complete research cycle from observation to finding.
    
    Args:
        initial_observation: Starting observation
        domain: Research domain
    
    Returns:
        Dictionary with complete research cycle results
    

    Parameters: – initial_observation: Initial observation – domain: Domain

    Returns: <ast.Subscript object at 0x000001A06D767A90>


    Functions

    demonstrate_scientific_discovery_agent()

    Lines 887-1092

    Purpose:

    Demonstrate the scientific discovery agent capabilities
    

    Key Concepts Summary

    Pattern Overview

    The Scientific Discovery pattern provides a structured approach to building AI agents with specific capabilities and behaviors. This implementation leverages LangChain’s composable components to create a robust and maintainable solution.

    Core Components

    1. Agent Class: Main implementation of the pattern logic
    2. Prompt Engineering: Carefully crafted prompts to guide LLM behavior
    3. Tool Integration: Optional tools for extended functionality
    4. Memory Management: State handling across interactions
    5. Output Parsing: Structured response processing

    When to Use

    ✅ Good for: – Scenarios requiring this specific pattern’s strengths – Applications needing structured agent behavior – Systems where explainability is important – Production environments requiring reliability

    ❌ Not ideal for: – Simple single-prompt tasks – Scenarios requiring different pattern characteristics – Resource-constrained environments (if computationally intensive)


    Best Practices Demonstrated

    1. Environment Configuration

    • ✅ Use .env files for API keys
    • ✅ Never hardcode credentials
    • ✅ Validate environment variables on startup

    2. Error Handling

    • ✅ Graceful degradation on failures
    • ✅ Informative error messages
    • ✅ Logging for debugging

    3. Prompt Engineering

    • ✅ Clear, specific instructions
    • ✅ Structured output formats
    • ✅ Few-shot examples when beneficial

    4. Code Organization

    • ✅ Separation of concerns (class-based design)
    • ✅ Type hints for clarity
    • ✅ Docstrings for documentation

    5. Performance Optimization

    • ✅ Appropriate temperature settings
    • ✅ Token budget management
    • ✅ Caching where applicable

    LangChain Components Used

    • ChatOpenAI: OpenAI model interface
    • Chains: Sequential component composition

    Why LangChain? – Composable abstractions for LLM applications – Rich ecosystem of integrations – Production-ready patterns – Active community and development


    Execution Flow

    1. Initialize agent with configuration
       ↓
    2. Load environment and dependencies
       ↓
    3. Prepare prompt with input data
       ↓
    4. Invoke LLM through LangChain
       ↓
    5. Parse and validate response
       ↓
    6. Return formatted result
    

    Key Decision Points: – Model selection (temperature, model type) – Prompt structure (few-shot vs zero-shot) – Error handling strategy – Output format validation


    Performance Considerations

    Computational Cost

    • LLM Calls: Primary cost factor (based on tokens)
    • Latency: Depends on model and input size
    • Memory: Minimal for most patterns

    Optimization Strategies

    1. Prompt Optimization: Minimize tokens while maintaining clarity
    2. Caching: Cache repeated queries/responses
    3. Model Selection: Use smaller models when appropriate
    4. Batch Processing: Group similar requests
    5. Streaming: For long responses, stream tokens

    Cost Estimates (Approximate)

    • GPT-3.5-turbo: ~$0.002 per request
    • GPT-4: ~$0.03 per request
    • GPT-4-turbo: ~$0.01 per request

    Actual costs vary based on input/output token counts


    Common Pitfalls to Avoid

    1. Prompt Design Issues

    ❌ Vague or ambiguous instructions
    ✅ Clear, specific, testable prompts

    2. Error Handling

    ❌ Ignoring API errors or rate limits
    ✅ Implement retry logic and graceful degradation

    3. Token Management

    ❌ Exceeding model token limits
    ✅ Truncate inputs, chunk processing

    4. Security

    ❌ Exposing API keys in code
    ✅ Use environment variables

    5. Testing

    ❌ Only testing happy paths
    ✅ Test edge cases, failures, malformed inputs

    6. Cost Management

    ❌ Unmonitored API usage
    ✅ Implement budgets, alerts, and monitoring


    Further Improvements

    Production Enhancements

    1. Monitoring: Add logging, metrics, tracing
    2. Validation: Input/output schema validation
    3. Rate Limiting: Implement request throttling
    4. Caching: Redis or in-memory cache for responses
    5. Async Support: Non-blocking operations for scalability

    Feature Extensions

    1. Multi-Model Support: Switch between providers
    2. Fallback Models: Graceful degradation strategy
    3. Custom Tools: Domain-specific function calling
    4. Advanced Memory: Vector stores for long-term memory
    5. Evaluation: Automated testing and benchmarking

    Code Quality

    1. Testing: Unit tests, integration tests
    2. Documentation: API docs, usage examples
    3. Type Safety: Stricter type hints
    4. Configuration: Externalized config files

    Related Patterns

    • Pattern 076
    • Pattern 078

    Pattern Families: – Reasoning Patterns (001-011) – Multi-Agent Patterns (012-019) – Tool Use Patterns (020-025) – Memory Patterns (026-031) – And many more…


    Summary

    The Scientific Discovery pattern provides a powerful approach to building AI agents with specific capabilities. This implementation demonstrates:

    ✅ Key Strengths: – Clean, maintainable code structure – LangChain integration for composability – Type hints and documentation – Production-ready patterns

    🎯 Best Use Cases: – Applications requiring this pattern’s characteristics – Systems needing structured agent behavior – Production environments requiring reliability

    📚 Learning Resources: – LangChain Documentation: https://python.langchain.com/ – Pattern Documentation: See related patterns – OpenAI API Reference: https://platform.openai.com/docs/


    File: 077_scientific_discovery.py
    Total Lines: 1097
    Pattern Category: AI Agent Design Pattern #077


    Generated from actual implementation code
    For educational and reference purposes

  • Agentic Design Pattern: Teaching Agent

    
        """
    Pattern 076: Teaching Agent
    
    Description:
        A Teaching Agent is a specialized AI agent designed to provide personalized
        tutoring and educational support across various subjects and skill levels. This
        pattern demonstrates how to build an intelligent tutoring system that can assess
        student knowledge, adapt teaching strategies, explain concepts at appropriate
        levels, generate practice problems, provide feedback, and track learning progress.
        
        The agent combines pedagogical principles with adaptive learning techniques to
        create effective, personalized learning experiences. It can diagnose knowledge
        gaps, scaffold learning, provide multiple explanations, encourage critical
        thinking, and adjust difficulty based on student performance.
    
    Components:
        1. Knowledge Assessor: Evaluates student understanding and identifies gaps
        2. Curriculum Planner: Creates personalized learning paths
        3. Concept Explainer: Explains topics at appropriate complexity levels
        4. Problem Generator: Creates practice problems and exercises
        5. Feedback Provider: Gives constructive, encouraging feedback
        6. Progress Tracker: Monitors learning progress and mastery
        7. Adaptive Engine: Adjusts difficulty and teaching approach
        8. Socratic Questioner: Guides discovery through questioning
    
    Key Features:
        - Multi-level explanations (beginner, intermediate, advanced)
        - Adaptive difficulty adjustment based on performance
        - Multiple teaching strategies (direct instruction, discovery, examples)
        - Personalized learning paths
        - Practice problem generation with solutions
        - Immediate, constructive feedback
        - Knowledge gap identification
        - Progress tracking and analytics
        - Socratic questioning for deeper understanding
        - Visual and conceptual explanations
    
    Use Cases:
        - K-12 tutoring across subjects
        - College-level subject tutoring
        - Professional skill development
        - Language learning
        - Programming education
        - Math and science tutoring
        - Test preparation (SAT, GRE, etc.)
        - Corporate training
        - Self-paced online courses
        - Homework help
    
    LangChain Implementation:
        Uses ChatOpenAI with specialized prompts for different pedagogical approaches,
        chains for assessment, explanation, and feedback generation.
    """
    
    import os
    import re
    from typing import List, Dict, Any, Optional, Tuple
    from dataclasses import dataclass, field
    from enum import Enum
    from datetime import datetime
    from collections import defaultdict
    from dotenv import load_dotenv
    
    from langchain_core.prompts import ChatPromptTemplate
    from langchain_core.output_parsers import StrOutputParser
    from langchain_openai import ChatOpenAI
    
    load_dotenv()
    
    
    class Subject(Enum):
        """Academic subjects"""
        MATHEMATICS = "mathematics"
        SCIENCE = "science"
        PROGRAMMING = "programming"
        LANGUAGE = "language"
        HISTORY = "history"
        LITERATURE = "literature"
        PHYSICS = "physics"
        CHEMISTRY = "chemistry"
        BIOLOGY = "biology"
        ECONOMICS = "economics"
    
    
    class SkillLevel(Enum):
        """Student skill levels"""
        BEGINNER = "beginner"
        INTERMEDIATE = "intermediate"
        ADVANCED = "advanced"
        EXPERT = "expert"
    
    
    class TeachingStrategy(Enum):
        """Teaching approaches"""
        DIRECT_INSTRUCTION = "direct_instruction"
        GUIDED_DISCOVERY = "guided_discovery"
        SOCRATIC_METHOD = "socratic_method"
        WORKED_EXAMPLES = "worked_examples"
        PROBLEM_BASED = "problem_based"
        SCAFFOLDED = "scaffolded"
    
    
    class QuestionDifficulty(Enum):
        """Difficulty levels for questions"""
        EASY = "easy"
        MEDIUM = "medium"
        HARD = "hard"
        CHALLENGING = "challenging"
    
    
    @dataclass
    class LearningObjective:
        """A specific learning objective"""
        objective_id: str
        subject: Subject
        topic: str
        description: str
        skill_level: SkillLevel
        prerequisites: List[str] = field(default_factory=list)
    
    
    @dataclass
    class StudentProfile:
        """Profile of a student"""
        student_id: str
        name: str
        skill_levels: Dict[Subject, SkillLevel] = field(default_factory=dict)
        learning_style: str = "visual"  # visual, auditory, kinesthetic
        strengths: List[str] = field(default_factory=list)
        weaknesses: List[str] = field(default_factory=list)
        goals: List[str] = field(default_factory=list)
    
    
    @dataclass
    class ConceptExplanation:
        """Explanation of a concept"""
        concept: str
        level: SkillLevel
        explanation: str
        examples: List[str]
        analogies: List[str]
        common_misconceptions: List[str]
        key_points: List[str]
    
    
    @dataclass
    class PracticeProblem:
        """A practice problem"""
        problem_id: str
        subject: Subject
        topic: str
        difficulty: QuestionDifficulty
        question: str
        solution: str
        hints: List[str]
        explanation: str
    
    
    @dataclass
    class StudentResponse:
        """Student's response to a problem"""
        problem_id: str
        student_answer: str
        is_correct: bool
        partial_credit: float  # 0.0-1.0
        time_taken: Optional[int] = None  # seconds
    
    
    @dataclass
    class Feedback:
        """Feedback on student work"""
        response_id: str
        correctness: str  # correct, partially_correct, incorrect
        positive_points: List[str]
        areas_to_improve: List[str]
        suggestions: List[str]
        encouragement: str
        next_steps: str
    
    
    @dataclass
    class LearningSession:
        """A tutoring session"""
        session_id: str
        student_id: str
        subject: Subject
        topic: str
        objectives: List[LearningObjective]
        explanations_given: List[ConceptExplanation] = field(default_factory=list)
        problems_attempted: List[Tuple[PracticeProblem, StudentResponse]] = field(default_factory=list)
        mastery_level: float = 0.0  # 0.0-1.0
        duration_minutes: int = 0
    
    
    class TeachingAgent:
        """
        Agent for personalized tutoring and education.
        
        This agent can assess student knowledge, explain concepts, generate
        practice problems, provide feedback, and adapt to student needs.
        """
        
        def __init__(self):
            """Initialize the teaching agent with specialized LLMs"""
            # Assessor for evaluating understanding
            self.assessor_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.1)
            
            # Explainer for teaching concepts
            self.explainer_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.4)
            
            # Problem generator for creating exercises
            self.generator_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.6)
            
            # Feedback provider for student responses
            self.feedback_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.3)
            
            # Student profiles
            self.students: Dict[str, StudentProfile] = {}
            
            # Session history
            self.sessions: List[LearningSession] = []
        
        def assess_knowledge(
            self,
            student_id: str,
            subject: Subject,
            topic: str,
            student_response: str
        ) -> Dict[str, Any]:
            """
            Assess student's knowledge on a topic.
            
            Args:
                student_id: Student identifier
                subject: Subject area
                topic: Specific topic
                student_response: Student's explanation or answer
                
            Returns:
                Assessment with understanding level and gaps
            """
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are an educational assessment expert. Evaluate the
                student's understanding based on their response.
                
                Respond in this format:
                UNDERSTANDING_LEVEL: beginner/intermediate/advanced
                STRENGTHS: (one per line starting with -)
                GAPS: (one per line starting with -)
                MASTERY_SCORE: (0.0-1.0)
                RECOMMENDATIONS: (one per line starting with -)"""),
                ("user", """Subject: {subject}
    Topic: {topic}
    
    Student Response:
    {response}
    
    Assess the student's knowledge.""")
            ])
            
            chain = prompt | self.assessor_llm | StrOutputParser()
            
            try:
                result = chain.invoke({
                    "subject": subject.value,
                    "topic": topic,
                    "response": student_response
                })
                
                understanding_level = SkillLevel.INTERMEDIATE
                strengths = []
                gaps = []
                mastery_score = 0.5
                recommendations = []
                
                current_section = None
                
                for line in result.split('\n'):
                    line = line.strip()
                    if not line:
                        continue
                    
                    if line.startswith('UNDERSTANDING_LEVEL:'):
                        level_str = line.replace('UNDERSTANDING_LEVEL:', '').strip().lower()
                        if 'beginner' in level_str:
                            understanding_level = SkillLevel.BEGINNER
                        elif 'advanced' in level_str:
                            understanding_level = SkillLevel.ADVANCED
                        elif 'expert' in level_str:
                            understanding_level = SkillLevel.EXPERT
                        else:
                            understanding_level = SkillLevel.INTERMEDIATE
                    elif line.startswith('STRENGTHS:'):
                        current_section = 'strengths'
                    elif line.startswith('GAPS:'):
                        current_section = 'gaps'
                    elif line.startswith('MASTERY_SCORE:'):
                        try:
                            mastery_score = float(re.findall(r'[\d.]+', line)[0])
                        except:
                            pass
                    elif line.startswith('RECOMMENDATIONS:'):
                        current_section = 'recommendations'
                    elif line.startswith('-'):
                        content = line[1:].strip()
                        if current_section == 'strengths':
                            strengths.append(content)
                        elif current_section == 'gaps':
                            gaps.append(content)
                        elif current_section == 'recommendations':
                            recommendations.append(content)
                
                return {
                    "understanding_level": understanding_level,
                    "strengths": strengths if strengths else ["Shows effort"],
                    "gaps": gaps if gaps else ["Some concepts need clarification"],
                    "mastery_score": mastery_score,
                    "recommendations": recommendations if recommendations else ["Continue practicing"]
                }
                
            except Exception as e:
                return {
                    "understanding_level": SkillLevel.INTERMEDIATE,
                    "strengths": ["Assessment in progress"],
                    "gaps": ["Further evaluation needed"],
                    "mastery_score": 0.5,
                    "recommendations": ["Continue learning"]
                }
        
        def explain_concept(
            self,
            concept: str,
            subject: Subject,
            level: SkillLevel,
            teaching_strategy: TeachingStrategy = TeachingStrategy.DIRECT_INSTRUCTION
        ) -> ConceptExplanation:
            """
            Explain a concept at the appropriate level.
            
            Args:
                concept: Concept to explain
                subject: Subject area
                level: Student's skill level
                teaching_strategy: Teaching approach to use
                
            Returns:
                ConceptExplanation with multi-faceted explanation
            """
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are an expert teacher. Explain the concept clearly
                and effectively for the specified skill level using the teaching strategy.
                
                Respond in this format:
                EXPLANATION: Clear, level-appropriate explanation
                EXAMPLES: (one per line starting with -)
                ANALOGIES: (one per line starting with -)
                MISCONCEPTIONS: Common misunderstandings (one per line starting with -)
                KEY_POINTS: Essential takeaways (one per line starting with -)"""),
                ("user", """Concept: {concept}
    Subject: {subject}
    Skill Level: {level}
    Teaching Strategy: {strategy}
    
    Explain this concept.""")
            ])
            
            chain = prompt | self.explainer_llm | StrOutputParser()
            
            try:
                result = chain.invoke({
                    "concept": concept,
                    "subject": subject.value,
                    "level": level.value,
                    "strategy": teaching_strategy.value
                })
                
                explanation = ""
                examples = []
                analogies = []
                misconceptions = []
                key_points = []
                
                current_section = None
                explanation_lines = []
                
                for line in result.split('\n'):
                    line = line.strip()
                    if not line:
                        continue
                    
                    if line.startswith('EXPLANATION:'):
                        current_section = 'explanation'
                        exp_text = line.replace('EXPLANATION:', '').strip()
                        if exp_text:
                            explanation_lines.append(exp_text)
                    elif line.startswith('EXAMPLES:'):
                        current_section = 'examples'
                    elif line.startswith('ANALOGIES:'):
                        current_section = 'analogies'
                    elif line.startswith('MISCONCEPTIONS:'):
                        current_section = 'misconceptions'
                    elif line.startswith('KEY_POINTS:'):
                        current_section = 'key_points'
                    elif line.startswith('-'):
                        content = line[1:].strip()
                        if current_section == 'examples':
                            examples.append(content)
                        elif current_section == 'analogies':
                            analogies.append(content)
                        elif current_section == 'misconceptions':
                            misconceptions.append(content)
                        elif current_section == 'key_points':
                            key_points.append(content)
                    elif current_section == 'explanation':
                        explanation_lines.append(line)
                
                explanation = ' '.join(explanation_lines) if explanation_lines else f"Explanation of {concept}"
                
                return ConceptExplanation(
                    concept=concept,
                    level=level,
                    explanation=explanation,
                    examples=examples if examples else [f"Example related to {concept}"],
                    analogies=analogies if analogies else [f"Think of it like..."],
                    common_misconceptions=misconceptions if misconceptions else ["Avoid common mistakes"],
                    key_points=key_points if key_points else ["Main concept understood"]
                )
                
            except Exception as e:
                return ConceptExplanation(
                    concept=concept,
                    level=level,
                    explanation=f"Explanation of {concept} for {level.value} level",
                    examples=[f"Example of {concept}"],
                    analogies=["Conceptual analogy"],
                    common_misconceptions=["Common misunderstanding"],
                    key_points=["Key takeaway"]
                )
        
        def generate_practice_problem(
            self,
            subject: Subject,
            topic: str,
            difficulty: QuestionDifficulty,
            student_level: SkillLevel
        ) -> PracticeProblem:
            """
            Generate a practice problem.
            
            Args:
                subject: Subject area
                topic: Specific topic
                difficulty: Problem difficulty
                student_level: Student's skill level
                
            Returns:
                PracticeProblem with question and solution
            """
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are an educational content creator. Generate a practice
                problem appropriate for the student's level and difficulty.
                
                Respond in this format:
                QUESTION: The practice question
                SOLUTION: Step-by-step solution
                HINTS: Helpful hints (one per line starting with -)
                EXPLANATION: Why this solution works"""),
                ("user", """Subject: {subject}
    Topic: {topic}
    Difficulty: {difficulty}
    Student Level: {level}
    
    Generate a practice problem.""")
            ])
            
            chain = prompt | self.generator_llm | StrOutputParser()
            
            try:
                result = chain.invoke({
                    "subject": subject.value,
                    "topic": topic,
                    "difficulty": difficulty.value,
                    "level": student_level.value
                })
                
                question = ""
                solution = ""
                hints = []
                explanation = ""
                
                current_section = None
                question_lines = []
                solution_lines = []
                explanation_lines = []
                
                for line in result.split('\n'):
                    line = line.strip()
                    if not line:
                        continue
                    
                    if line.startswith('QUESTION:'):
                        current_section = 'question'
                        q_text = line.replace('QUESTION:', '').strip()
                        if q_text:
                            question_lines.append(q_text)
                    elif line.startswith('SOLUTION:'):
                        current_section = 'solution'
                        s_text = line.replace('SOLUTION:', '').strip()
                        if s_text:
                            solution_lines.append(s_text)
                    elif line.startswith('HINTS:'):
                        current_section = 'hints'
                    elif line.startswith('EXPLANATION:'):
                        current_section = 'explanation'
                        e_text = line.replace('EXPLANATION:', '').strip()
                        if e_text:
                            explanation_lines.append(e_text)
                    elif line.startswith('-'):
                        if current_section == 'hints':
                            hints.append(line[1:].strip())
                    elif current_section == 'question':
                        question_lines.append(line)
                    elif current_section == 'solution':
                        solution_lines.append(line)
                    elif current_section == 'explanation':
                        explanation_lines.append(line)
                
                question = ' '.join(question_lines) if question_lines else f"Practice problem about {topic}"
                solution = ' '.join(solution_lines) if solution_lines else "Solution provided"
                explanation = ' '.join(explanation_lines) if explanation_lines else "Explanation of solution"
                
                return PracticeProblem(
                    problem_id=f"prob_{datetime.now().timestamp()}",
                    subject=subject,
                    topic=topic,
                    difficulty=difficulty,
                    question=question,
                    solution=solution,
                    hints=hints if hints else ["Think about the key concepts"],
                    explanation=explanation
                )
                
            except Exception as e:
                return PracticeProblem(
                    problem_id=f"prob_{datetime.now().timestamp()}",
                    subject=subject,
                    topic=topic,
                    difficulty=difficulty,
                    question=f"Practice problem about {topic}",
                    solution="Solution to be provided",
                    hints=["Review the concept", "Break it down step by step"],
                    explanation="Explanation available"
                )
        
        def provide_feedback(
            self,
            problem: PracticeProblem,
            student_response: StudentResponse
        ) -> Feedback:
            """
            Provide feedback on student's work.
            
            Args:
                problem: The practice problem
                student_response: Student's response
                
            Returns:
                Feedback with constructive guidance
            """
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are a supportive tutor. Provide encouraging,
                constructive feedback on the student's work.
                
                Respond in this format:
                CORRECTNESS: correct/partially_correct/incorrect
                POSITIVE: What they did well (one per line starting with -)
                IMPROVE: Areas to improve (one per line starting with -)
                SUGGESTIONS: Specific suggestions (one per line starting with -)
                ENCOURAGEMENT: Encouraging message
                NEXT_STEPS: What to do next"""),
                ("user", """Problem: {question}
    Correct Solution: {solution}
    
    Student Answer: {answer}
    Is Correct: {is_correct}
    
    Provide feedback.""")
            ])
            
            chain = prompt | self.feedback_llm | StrOutputParser()
            
            try:
                result = chain.invoke({
                    "question": problem.question,
                    "solution": problem.solution,
                    "answer": student_response.student_answer,
                    "is_correct": student_response.is_correct
                })
                
                correctness = "partially_correct"
                positive = []
                improve = []
                suggestions = []
                encouragement = ""
                next_steps = ""
                
                current_section = None
                
                for line in result.split('\n'):
                    line = line.strip()
                    if not line:
                        continue
                    
                    if line.startswith('CORRECTNESS:'):
                        corr_text = line.replace('CORRECTNESS:', '').strip().lower()
                        if 'correct' in corr_text and 'partially' not in corr_text and 'incorrect' not in corr_text:
                            correctness = "correct"
                        elif 'incorrect' in corr_text:
                            correctness = "incorrect"
                        else:
                            correctness = "partially_correct"
                    elif line.startswith('POSITIVE:'):
                        current_section = 'positive'
                    elif line.startswith('IMPROVE:'):
                        current_section = 'improve'
                    elif line.startswith('SUGGESTIONS:'):
                        current_section = 'suggestions'
                    elif line.startswith('ENCOURAGEMENT:'):
                        current_section = 'encouragement'
                        encouragement = line.replace('ENCOURAGEMENT:', '').strip()
                    elif line.startswith('NEXT_STEPS:'):
                        current_section = 'next_steps'
                        next_steps = line.replace('NEXT_STEPS:', '').strip()
                    elif line.startswith('-'):
                        content = line[1:].strip()
                        if current_section == 'positive':
                            positive.append(content)
                        elif current_section == 'improve':
                            improve.append(content)
                        elif current_section == 'suggestions':
                            suggestions.append(content)
                    elif current_section == 'encouragement':
                        encouragement += " " + line
                    elif current_section == 'next_steps':
                        next_steps += " " + line
                
                return Feedback(
                    response_id=f"feedback_{datetime.now().timestamp()}",
                    correctness=correctness,
                    positive_points=positive if positive else ["Good effort!"],
                    areas_to_improve=improve if improve else ["Keep practicing"],
                    suggestions=suggestions if suggestions else ["Review the concept"],
                    encouragement=encouragement.strip() if encouragement else "Keep up the good work!",
                    next_steps=next_steps.strip() if next_steps else "Try another problem"
                )
                
            except Exception as e:
                return Feedback(
                    response_id=f"feedback_{datetime.now().timestamp()}",
                    correctness="partially_correct",
                    positive_points=["You're making progress"],
                    areas_to_improve=["Continue learning"],
                    suggestions=["Review the material"],
                    encouragement="Keep trying!",
                    next_steps="Practice more problems"
                )
        
        def create_learning_path(
            self,
            student_id: str,
            subject: Subject,
            goal: str,
            current_level: SkillLevel
        ) -> List[LearningObjective]:
            """
            Create a personalized learning path.
            
            Args:
                student_id: Student identifier
                subject: Subject area
                goal: Learning goal
                current_level: Current skill level
                
            Returns:
                List of LearningObjectives in sequence
            """
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are a curriculum designer. Create a learning path
                from the current level to achieve the goal.
                
                Provide 3-5 learning objectives, one per line:
                OBJECTIVE: topic | description | level"""),
                ("user", """Subject: {subject}
    Current Level: {current_level}
    Goal: {goal}
    
    Create a learning path.""")
            ])
            
            chain = prompt | self.explainer_llm | StrOutputParser()
            
            try:
                result = chain.invoke({
                    "subject": subject.value,
                    "current_level": current_level.value,
                    "goal": goal
                })
                
                objectives = []
                obj_counter = 1
                
                for line in result.split('\n'):
                    if 'OBJECTIVE:' in line or '|' in line:
                        parts = line.replace('OBJECTIVE:', '').split('|')
                        if len(parts) >= 2:
                            topic = parts[0].strip()
                            description = parts[1].strip()
                            level_str = parts[2].strip().lower() if len(parts) > 2 else current_level.value
                            
                            # Parse level
                            obj_level = current_level
                            if 'advanced' in level_str:
                                obj_level = SkillLevel.ADVANCED
                            elif 'intermediate' in level_str:
                                obj_level = SkillLevel.INTERMEDIATE
                            elif 'beginner' in level_str:
                                obj_level = SkillLevel.BEGINNER
                            
                            objectives.append(LearningObjective(
                                objective_id=f"obj_{obj_counter}",
                                subject=subject,
                                topic=topic,
                                description=description,
                                skill_level=obj_level,
                                prerequisites=[f"obj_{obj_counter-1}"] if obj_counter > 1 else []
                            ))
                            obj_counter += 1
                
                if not objectives:
                    # Fallback objectives
                    objectives = [
                        LearningObjective(
                            objective_id="obj_1",
                            subject=subject,
                            topic="Fundamentals",
                            description="Master fundamental concepts",
                            skill_level=current_level
                        ),
                        LearningObjective(
                            objective_id="obj_2",
                            subject=subject,
                            topic="Intermediate Topics",
                            description="Build on fundamentals",
                            skill_level=SkillLevel.INTERMEDIATE,
                            prerequisites=["obj_1"]
                        ),
                        LearningObjective(
                            objective_id="obj_3",
                            subject=subject,
                            topic="Advanced Applications",
                            description=f"Achieve goal: {goal}",
                            skill_level=SkillLevel.ADVANCED,
                            prerequisites=["obj_2"]
                        )
                    ]
                
                return objectives
                
            except Exception as e:
                return [
                    LearningObjective(
                        objective_id="obj_1",
                        subject=subject,
                        topic="Core Concepts",
                        description="Foundation building",
                        skill_level=current_level
                    )
                ]
        
        def conduct_tutoring_session(
            self,
            student_id: str,
            subject: Subject,
            topic: str,
            duration_minutes: int = 30
        ) -> LearningSession:
            """
            Conduct a complete tutoring session.
            
            Args:
                student_id: Student identifier
                subject: Subject to tutor
                topic: Specific topic
                duration_minutes: Session duration
                
            Returns:
                LearningSession with complete session data
            """
            print(f"\n📚 Starting tutoring session on {topic}...")
            
            # Create session
            session = LearningSession(
                session_id=f"session_{datetime.now().timestamp()}",
                student_id=student_id,
                subject=subject,
                topic=topic,
                objectives=[],
                duration_minutes=duration_minutes
            )
            
            # Get or create student profile
            if student_id not in self.students:
                self.students[student_id] = StudentProfile(
                    student_id=student_id,
                    name=f"Student {student_id}"
                )
            
            student = self.students[student_id]
            current_level = student.skill_levels.get(subject, SkillLevel.BEGINNER)
            
            # Step 1: Explain concept
            print("  ✓ Explaining concept...")
            explanation = self.explain_concept(
                topic,
                subject,
                current_level,
                TeachingStrategy.DIRECT_INSTRUCTION
            )
            session.explanations_given.append(explanation)
            
            # Step 2: Generate practice problems
            print("  ✓ Generating practice problems...")
            for difficulty in [QuestionDifficulty.EASY, QuestionDifficulty.MEDIUM]:
                problem = self.generate_practice_problem(
                    subject,
                    topic,
                    difficulty,
                    current_level
                )
                
                # Simulate student response
                is_correct = difficulty == QuestionDifficulty.EASY
                response = StudentResponse(
                    problem_id=problem.problem_id,
                    student_answer="Student's attempt at solution",
                    is_correct=is_correct,
                    partial_credit=0.8 if is_correct else 0.4
                )
                
                session.problems_attempted.append((problem, response))
            
            # Step 3: Calculate mastery
            if session.problems_attempted:
                total_credit = sum(resp.partial_credit for _, resp in session.problems_attempted)
                session.mastery_level = total_credit / len(session.problems_attempted)
            
            print("  ✅ Session complete!\n")
            
            self.sessions.append(session)
            return session
    
    
    def demonstrate_teaching_agent():
        """Demonstrate the teaching agent capabilities"""
        print("=" * 80)
        print("TEACHING AGENT DEMONSTRATION")
        print("=" * 80)
        
        agent = TeachingAgent()
        
        # Demo 1: Knowledge Assessment
        print("\n" + "=" * 80)
        print("DEMO 1: Knowledge Assessment")
        print("=" * 80)
        
        student_response = """
        Photosynthesis is the process where plants use sunlight to make food.
        They take in carbon dioxide and water, and produce glucose and oxygen.
        The process happens in the chloroplasts using chlorophyll.
        """
        
        print("\nAssessing student knowledge on photosynthesis...")
        assessment = agent.assess_knowledge(
            "student001",
            Subject.BIOLOGY,
            "Photosynthesis",
            student_response
        )
        
        print(f"\nAssessment Results:")
        print(f"Understanding Level: {assessment['understanding_level'].value}")
        print(f"Mastery Score: {assessment['mastery_score']:.2f}/1.0")
        print(f"\nStrengths:")
        for strength in assessment['strengths'][:3]:
            print(f"  ✓ {strength}")
        print(f"\nKnowledge Gaps:")
        for gap in assessment['gaps'][:2]:
            print(f"  ⚠ {gap}")
        print(f"\nRecommendations:")
        for rec in assessment['recommendations'][:2]:
            print(f"  → {rec}")
        
        # Demo 2: Concept Explanation
        print("\n" + "=" * 80)
        print("DEMO 2: Concept Explanation")
        print("=" * 80)
        
        concept = "quadratic equations"
        print(f"\nExplaining '{concept}' at intermediate level...")
        
        explanation = agent.explain_concept(
            concept,
            Subject.MATHEMATICS,
            SkillLevel.INTERMEDIATE,
            TeachingStrategy.WORKED_EXAMPLES
        )
        
        print(f"\nConcept: {explanation.concept}")
        print(f"Level: {explanation.level.value}")
        print(f"\nExplanation:")
        print(f"  {explanation.explanation[:300]}...")
        print(f"\nExamples:")
        for example in explanation.examples[:2]:
            print(f"  • {example}")
        print(f"\nKey Points:")
        for point in explanation.key_points[:2]:
            print(f"  ✓ {point}")
        
        # Demo 3: Practice Problem Generation
        print("\n" + "=" * 80)
        print("DEMO 3: Practice Problem Generation")
        print("=" * 80)
        
        print("\nGenerating practice problems...")
        
        for difficulty in [QuestionDifficulty.EASY, QuestionDifficulty.MEDIUM]:
            problem = agent.generate_practice_problem(
                Subject.MATHEMATICS,
                "quadratic equations",
                difficulty,
                SkillLevel.INTERMEDIATE
            )
            
            print(f"\n{difficulty.value.upper()} Problem:")
            print(f"Question: {problem.question[:150]}...")
            print(f"\nHints:")
            for hint in problem.hints[:2]:
                print(f"  💡 {hint}")
            print(f"\nSolution: {problem.solution[:150]}...")
        
        # Demo 4: Feedback on Student Work
        print("\n" + "=" * 80)
        print("DEMO 4: Feedback on Student Work")
        print("=" * 80)
        
        sample_problem = agent.generate_practice_problem(
            Subject.PROGRAMMING,
            "loops",
            QuestionDifficulty.EASY,
            SkillLevel.BEGINNER
        )
        
        student_answer = "I tried using a for loop but got confused about the syntax"
        response = StudentResponse(
            problem_id=sample_problem.problem_id,
            student_answer=student_answer,
            is_correct=False,
            partial_credit=0.3
        )
        
        print(f"\nProblem: {sample_problem.question[:100]}...")
        print(f"Student Answer: {student_answer}")
        
        print("\nGenerating feedback...")
        feedback = agent.provide_feedback(sample_problem, response)
        
        print(f"\nFeedback:")
        print(f"Correctness: {feedback.correctness}")
        print(f"\nWhat you did well:")
        for point in feedback.positive_points[:2]:
            print(f"  ✓ {point}")
        print(f"\nAreas to improve:")
        for area in feedback.areas_to_improve[:2]:
            print(f"  → {area}")
        print(f"\nEncouragement: {feedback.encouragement}")
        print(f"Next Steps: {feedback.next_steps}")
        
        # Demo 5: Personalized Learning Path
        print("\n" + "=" * 80)
        print("DEMO 5: Personalized Learning Path")
        print("=" * 80)
        
        print("\nCreating learning path for Python programming...")
        learning_path = agent.create_learning_path(
            "student001",
            Subject.PROGRAMMING,
            "Become proficient in Python web development",
            SkillLevel.BEGINNER
        )
        
        print(f"\nLearning Path ({len(learning_path)} objectives):")
        for i, obj in enumerate(learning_path, 1):
            print(f"\n{i}. {obj.topic} ({obj.skill_level.value})")
            print(f"   {obj.description}")
            if obj.prerequisites:
                print(f"   Prerequisites: {', '.join(obj.prerequisites)}")
        
        # Demo 6: Complete Tutoring Session
        print("\n" + "=" * 80)
        print("DEMO 6: Complete Tutoring Session")
        print("=" * 80)
        
        session = agent.conduct_tutoring_session(
            "student001",
            Subject.MATHEMATICS,
            "linear equations",
            duration_minutes=20
        )
        
        print(f"Session ID: {session.session_id}")
        print(f"Topic: {session.topic}")
        print(f"Duration: {session.duration_minutes} minutes")
        print(f"Mastery Level: {session.mastery_level:.2f}/1.0")
        
        print(f"\nConcepts Explained: {len(session.explanations_given)}")
        for exp in session.explanations_given:
            print(f"  • {exp.concept} ({exp.level.value})")
        
        print(f"\nProblems Attempted: {len(session.problems_attempted)}")
        for problem, response in session.problems_attempted:
            status = "✓" if response.is_correct else "✗"
            print(f"  {status} {problem.difficulty.value} - Score: {response.partial_credit:.1f}/1.0")
        
        # Summary
        print("\n" + "=" * 80)
        print("SUMMARY")
        print("=" * 80)
        
        summary = """
    The Teaching Agent demonstrates comprehensive educational capabilities:
    
    KEY CAPABILITIES:
    1. Knowledge Assessment: Evaluates student understanding and identifies gaps
    2. Adaptive Explanation: Explains concepts at appropriate complexity levels
    3. Problem Generation: Creates practice problems matched to student level
    4. Constructive Feedback: Provides encouraging, helpful feedback
    5. Learning Path Creation: Designs personalized curricula
    6. Progress Tracking: Monitors learning and mastery development
    7. Multi-Strategy Teaching: Adapts teaching approach to student needs
    
    BENEFITS:
    - Personalized learning at student's pace
    - Immediate, constructive feedback
    - Unlimited practice problems
    - Patient, consistent teaching
    - Tracks progress over time
    - Identifies and addresses knowledge gaps
    - Adapts difficulty automatically
    
    USE CASES:
    - K-12 tutoring across all subjects
    - College-level subject support
    - Professional skill development
    - Language learning
    - Programming education
    - Test preparation (SAT, ACT, GRE)
    - Homework help
    - Corporate training
    - Self-paced learning
    - Supplemental education
    
    PRODUCTION CONSIDERATIONS:
    1. Pedagogy: Implement proven teaching strategies and learning science
    2. Assessment: Robust knowledge testing and gap analysis
    3. Adaptation: Real-time difficulty adjustment based on performance
    4. Content Library: Comprehensive problem and explanation databases
    5. Progress Analytics: Detailed learning analytics and reporting
    6. Engagement: Gamification, rewards, and motivation systems
    7. Multi-Modal: Support text, images, videos, interactive content
    8. Collaboration: Enable teacher oversight and intervention
    9. Accessibility: Support diverse learning needs and disabilities
    10. Safety: Content filtering and age-appropriate material
    
    ADVANCED EXTENSIONS:
    - Socratic dialogue for deeper understanding
    - Visual learning with diagrams and animations
    - Spaced repetition for memory retention
    - Collaborative learning with peer interaction
    - Real-world problem applications
    - Project-based learning modules
    - Adaptive testing and placement
    - Learning style optimization
    - Emotional intelligence and encouragement
    - Multi-language support
    
    The agent provides scalable, personalized education that adapts to each
    student's needs, pace, and learning style while maintaining pedagogical
    effectiveness.
    """
        
        print(summary)
    
    
    if __name__ == "__main__":
        demonstrate_teaching_agent()
    
        

    Agentic Design Pattern: Teaching Agent

    Pattern 076: Teaching Agent – Line-by-Line Explanation

    Overview

    This document provides a detailed line-by-line explanation of the Teaching Agent pattern implementation.


    Pattern Description

    Pattern 076: Teaching Agent

    Description: A Teaching Agent is a specialized AI agent designed to provide personalized tutoring and educational support across various subjects and skill levels. This pattern demonstrates how to build an intelligent tutoring system that can assess student knowledge, adapt teaching strategies, explain concepts at appropriate levels, generate practice problems, provide feedback, and track learning progress.

    The agent combines pedagogical principles with adaptive learning techniques to
    create effective, personalized learning experiences. It can diagnose knowledge
    gaps, scaffold learning, provide multiple explanations, encourage critical
    thinking, and adjust difficulty based on student performance.
    

    Components: 1. Knowledge Assessor: Evaluates student understanding and identifies gaps 2. Curriculum Planner: Creates personalized learning paths 3. Concept Explainer: Explains topics at appropriate complexity levels 4. Problem Generator: Creates practice problems and exercises 5. Feedback Provider: Gives constructive, encouraging feedback 6. Progress Tracker: Monitors learning progress and mastery 7. Adaptive Engine: Adjusts difficulty and teaching approach 8. Socratic Questioner: Guides discovery through questioning

    Key Features: – Multi-level explanations (beginner, intermediate, advanced) – Adaptive difficulty adjustment based on performance – Multiple teaching strategies (direct instruction, discovery, examples) – Personalized learning paths – Practice problem generation with solutions – Immediate, constructive feedback – Knowledge gap identification – Progress tracking and analytics – Socratic questioning for deeper understanding – Visual and conceptual explanations

    Use Cases: – K-12 tutoring across subjects – College-level subject tutoring – Professional skill development – Language learning – Programming education – Math and science tutoring – Test preparation (SAT, GRE, etc.) – Corporate training – Self-paced online courses – Homework help

    LangChain Implementation: Uses ChatOpenAI with specialized prompts for different pedagogical approaches, chains for assessment, explanation, and feedback generation.


    File Statistics

    • Total Lines: 1106
    • Classes: 12
    • Functions: 1
    • Constants: 0

    Module Documentation

    """
    Pattern 076: Teaching Agent
    
    Description:
        A Teaching Agent is a specialized AI agent designed to provide personalized
        tutoring and educational support across various subjects and skill levels. This
        pattern demonstrates how to build an intelligent tutoring system that can assess
        student knowledge, adapt teaching strategies, explain concepts at appropriate
        levels, generate practice problems, provide feedback, and track learning progress.
    
        The agent combines pedagogical principles with adaptive learning techniques to
        create effective, personalized learning experiences. It can diagnose knowledge
        gaps, scaffold learning, provide multiple explanations, encourage critical
        thinking, and adjust difficulty based on student performance.
    
    Components:
        1. Knowledge Assessor: Evaluates student understanding and identifies gaps
        2. Curriculum Planner: Creates personalized learning paths
        3. Concept Explainer: Explains topics at appropriate complexity levels
        4. Problem Generator: Creates practice problems and exercises
        5. Feedback Provider: Gives constructive, encouraging feedback
        6. Progress Tracker: Monitors learning progress and mastery
        7. Adaptive Engine: Adjusts difficulty and teaching approach
        8. Socratic Questioner: Guides discovery through questioning
    
    Key Features:
        - Multi-level explanations (beginner, intermediate, advanced)
        - Adaptive difficulty adjustment based on performance
        - Multiple teaching strategies (direct instruction, discovery, examples)
        - Personalized learning paths
        - Practice problem generation with solutions
        - Immediate, constructive feedback
        - Knowledge gap identification
        - Progress tracking and analytics
        - Socratic questioning for deeper understanding
        - Visual and conceptual explanations
    
    Use Cases:
        - K-12 tutoring across subjects
        - College-level subject tutoring
        - Professional skill development
        - Language learning
        - Programming education
        - Math and science tutoring
        - Test preparation (SAT, GRE, etc.)
        - Corporate training
        - Self-paced online courses
        - Homework help
    
    LangChain Implementation:
        Uses ChatOpenAI with specialized prompts for different pedagogical approaches,
        chains for assessment, explanation, and feedback generation.
    """
    

    Purpose: This module implements the Teaching Agent pattern, providing a structured approach to agent design and implementation.


    Import Statements

    Standard Library Imports

    import collections.defaultdict
    import dataclasses.dataclass
    import dataclasses.field
    import datetime.datetime
    import enum.Enum
    import langchain_core.output_parsers.StrOutputParser
    import langchain_core.prompts.ChatPromptTemplate
    import os
    import re
    import typing.Any
    import typing.Dict
    import typing.List
    import typing.Optional
    import typing.Tuple
    

    Purpose: Core Python functionality: – collections.defaultdict: Specialized container datatypes – dataclasses.dataclass: Simplified class definitions with @dataclass – dataclasses.field: Simplified class definitions with @dataclass – datetime.datetime: Date and time handling – enum.Enum: Enumeration support – langchain_core.output_parsers.StrOutputParser: Regular expression operations – langchain_core.prompts.ChatPromptTemplate: Regular expression operations – os: Environment variable access and system operations – re: Regular expression operations – typing.Any: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Dict: Type hints for better code documentation (List, Dict, Any, Optional) – typing.List: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Optional: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Tuple: Type hints for better code documentation (List, Dict, Any, Optional)

    LangChain Imports

    from langchain_openai.ChatOpenAI
    

    Purpose: LangChain framework components: – LLM Interface: Wrapper for OpenAI models – Chains: Composable building blocks for complex workflows

    Other Imports

    from dotenv.load_dotenv
    

    Purpose: Additional dependencies for specialized functionality.


    Classes

    Class: Subject

    Lines 71-82

    Inherits from: Enum

    Purpose:

    Academic subjects
    

    Class: SkillLevel

    Lines 85-90

    Inherits from: Enum

    Purpose:

    Student skill levels
    

    Class: TeachingStrategy

    Lines 93-100

    Inherits from: Enum

    Purpose:

    Teaching approaches
    

    Class: QuestionDifficulty

    Lines 103-108

    Inherits from: Enum

    Purpose:

    Difficulty levels for questions
    

    Class: LearningObjective

    Lines 112-119

    Purpose:

    A specific learning objective
    

    Class: StudentProfile

    Lines 123-131

    Purpose:

    Profile of a student
    

    Class: ConceptExplanation

    Lines 135-143

    Purpose:

    Explanation of a concept
    

    Class: PracticeProblem

    Lines 147-156

    Purpose:

    A practice problem
    

    Class: StudentResponse

    Lines 160-166

    Purpose:

    Student's response to a problem
    

    Class: Feedback

    Lines 170-178

    Purpose:

    Feedback on student work
    

    Class: LearningSession

    Lines 182-192

    Purpose:

    A tutoring session
    

    Class: TeachingAgent

    Lines 195-860

    Purpose:

    Agent for personalized tutoring and education.
    
    This agent can assess student knowledge, explain concepts, generate
    practice problems, provide feedback, and adapt to student needs.
    

    Methods:

    __init__(self)

    Lines 203-221

    Purpose:

    Initialize the teaching agent with specialized LLMs
    

    Parameters:

    assess_knowledge(self, student_id, subject, topic, student_response)

    Lines 223-328

    Purpose:

    Assess student's knowledge on a topic.
    
    Args:
        student_id: Student identifier
        subject: Subject area
        topic: Specific topic
        student_response: Student's explanation or answer
    
    Returns:
        Assessment with understanding level and gaps
    

    Parameters: – student_id: Student id – subject: Subject – topic: Topic – student_response: Student response

    Returns: <ast.Subscript object at 0x000001A06D83C110>

    explain_concept(self, concept, subject, level, teaching_strategy)

    Lines 330-438

    Purpose:

    Explain a concept at the appropriate level.
    
    Args:
        concept: Concept to explain
        subject: Subject area
        level: Student's skill level
        teaching_strategy: Teaching approach to use
    
    Returns:
        ConceptExplanation with multi-faceted explanation
    

    Parameters: – concept: Concept – subject: Subject – level: Level – teaching_strategy: Teaching strategy

    Returns: ConceptExplanation

    generate_practice_problem(self, subject, topic, difficulty, student_level)

    Lines 440-553

    Purpose:

    Generate a practice problem.
    
    Args:
        subject: Subject area
        topic: Specific topic
        difficulty: Problem difficulty
        student_level: Student's skill level
    
    Returns:
        PracticeProblem with question and solution
    

    Parameters: – subject: Subject – topic: Topic – difficulty: Difficulty – student_level: Student level

    Returns: PracticeProblem

    provide_feedback(self, problem, student_response)

    Lines 555-666

    Purpose:

    Provide feedback on student's work.
    
    Args:
        problem: The practice problem
        student_response: Student's response
    
    Returns:
        Feedback with constructive guidance
    

    Parameters: – problem: Problem – student_response: Student response

    Returns: Feedback

    create_learning_path(self, student_id, subject, goal, current_level)

    Lines 668-778

    Purpose:

    Create a personalized learning path.
    
    Args:
        student_id: Student identifier
        subject: Subject area
        goal: Learning goal
        current_level: Current skill level
    
    Returns:
        List of LearningObjectives in sequence
    

    Parameters: – student_id: Student id – subject: Subject – goal: Goal – current_level: Current level

    Returns: <ast.Subscript object at 0x000001A06D6B1C10>

    conduct_tutoring_session(self, student_id, subject, topic, duration_minutes)

    Lines 780-860

    Purpose:

    Conduct a complete tutoring session.
    
    Args:
        student_id: Student identifier
        subject: Subject to tutor
        topic: Specific topic
        duration_minutes: Session duration
    
    Returns:
        LearningSession with complete session data
    

    Parameters: – student_id: Student id – subject: Subject – topic: Topic – duration_minutes: Duration minutes

    Returns: LearningSession


    Functions

    demonstrate_teaching_agent()

    Lines 863-1101

    Purpose:

    Demonstrate the teaching agent capabilities
    

    Key Concepts Summary

    Pattern Overview

    The Teaching Agent pattern provides a structured approach to building AI agents with specific capabilities and behaviors. This implementation leverages LangChain’s composable components to create a robust and maintainable solution.

    Core Components

    1. Agent Class: Main implementation of the pattern logic
    2. Prompt Engineering: Carefully crafted prompts to guide LLM behavior
    3. Tool Integration: Optional tools for extended functionality
    4. Memory Management: State handling across interactions
    5. Output Parsing: Structured response processing

    When to Use

    ✅ Good for: – Scenarios requiring this specific pattern’s strengths – Applications needing structured agent behavior – Systems where explainability is important – Production environments requiring reliability

    ❌ Not ideal for: – Simple single-prompt tasks – Scenarios requiring different pattern characteristics – Resource-constrained environments (if computationally intensive)


    Best Practices Demonstrated

    1. Environment Configuration

    • ✅ Use .env files for API keys
    • ✅ Never hardcode credentials
    • ✅ Validate environment variables on startup

    2. Error Handling

    • ✅ Graceful degradation on failures
    • ✅ Informative error messages
    • ✅ Logging for debugging

    3. Prompt Engineering

    • ✅ Clear, specific instructions
    • ✅ Structured output formats
    • ✅ Few-shot examples when beneficial

    4. Code Organization

    • ✅ Separation of concerns (class-based design)
    • ✅ Type hints for clarity
    • ✅ Docstrings for documentation

    5. Performance Optimization

    • ✅ Appropriate temperature settings
    • ✅ Token budget management
    • ✅ Caching where applicable

    LangChain Components Used

    • ChatOpenAI: OpenAI model interface
    • Chains: Sequential component composition

    Why LangChain? – Composable abstractions for LLM applications – Rich ecosystem of integrations – Production-ready patterns – Active community and development


    Execution Flow

    1. Initialize agent with configuration
       ↓
    2. Load environment and dependencies
       ↓
    3. Prepare prompt with input data
       ↓
    4. Invoke LLM through LangChain
       ↓
    5. Parse and validate response
       ↓
    6. Return formatted result
    

    Key Decision Points: – Model selection (temperature, model type) – Prompt structure (few-shot vs zero-shot) – Error handling strategy – Output format validation


    Performance Considerations

    Computational Cost

    • LLM Calls: Primary cost factor (based on tokens)
    • Latency: Depends on model and input size
    • Memory: Minimal for most patterns

    Optimization Strategies

    1. Prompt Optimization: Minimize tokens while maintaining clarity
    2. Caching: Cache repeated queries/responses
    3. Model Selection: Use smaller models when appropriate
    4. Batch Processing: Group similar requests
    5. Streaming: For long responses, stream tokens

    Cost Estimates (Approximate)

    • GPT-3.5-turbo: ~$0.002 per request
    • GPT-4: ~$0.03 per request
    • GPT-4-turbo: ~$0.01 per request

    Actual costs vary based on input/output token counts


    Common Pitfalls to Avoid

    1. Prompt Design Issues

    ❌ Vague or ambiguous instructions
    ✅ Clear, specific, testable prompts

    2. Error Handling

    ❌ Ignoring API errors or rate limits
    ✅ Implement retry logic and graceful degradation

    3. Token Management

    ❌ Exceeding model token limits
    ✅ Truncate inputs, chunk processing

    4. Security

    ❌ Exposing API keys in code
    ✅ Use environment variables

    5. Testing

    ❌ Only testing happy paths
    ✅ Test edge cases, failures, malformed inputs

    6. Cost Management

    ❌ Unmonitored API usage
    ✅ Implement budgets, alerts, and monitoring


    Further Improvements

    Production Enhancements

    1. Monitoring: Add logging, metrics, tracing
    2. Validation: Input/output schema validation
    3. Rate Limiting: Implement request throttling
    4. Caching: Redis or in-memory cache for responses
    5. Async Support: Non-blocking operations for scalability

    Feature Extensions

    1. Multi-Model Support: Switch between providers
    2. Fallback Models: Graceful degradation strategy
    3. Custom Tools: Domain-specific function calling
    4. Advanced Memory: Vector stores for long-term memory
    5. Evaluation: Automated testing and benchmarking

    Code Quality

    1. Testing: Unit tests, integration tests
    2. Documentation: API docs, usage examples
    3. Type Safety: Stricter type hints
    4. Configuration: Externalized config files

    Related Patterns

    • Pattern 075
    • Pattern 077

    Pattern Families: – Reasoning Patterns (001-011) – Multi-Agent Patterns (012-019) – Tool Use Patterns (020-025) – Memory Patterns (026-031) – And many more…


    Summary

    The Teaching Agent pattern provides a powerful approach to building AI agents with specific capabilities. This implementation demonstrates:

    ✅ Key Strengths: – Clean, maintainable code structure – LangChain integration for composability – Type hints and documentation – Production-ready patterns

    🎯 Best Use Cases: – Applications requiring this pattern’s characteristics – Systems needing structured agent behavior – Production environments requiring reliability

    📚 Learning Resources: – LangChain Documentation: https://python.langchain.com/ – Pattern Documentation: See related patterns – OpenAI API Reference: https://platform.openai.com/docs/


    File: 076_teaching_agent.py
    Total Lines: 1106
    Pattern Category: AI Agent Design Pattern #076


    Generated from actual implementation code
    For educational and reference purposes

  • Agentic Design Pattern: Creative Agent

    
        """
    Pattern 075: Creative Agent
    
    Description:
        A Creative Agent is a specialized AI agent designed to generate original creative
        content across various domains including writing (stories, poetry, scripts), visual
        concepts (art descriptions, design ideas), music concepts, and other creative works.
        This pattern demonstrates how to build an intelligent agent that can understand
        creative requirements, generate diverse creative outputs, adapt styles, incorporate
        feedback, and maintain creative consistency.
        
        The agent combines creative ideation with structured generation techniques to produce
        high-quality, original content. It can work across multiple creative domains, adapt
        to different styles and tones, generate variations, and iteratively refine outputs
        based on feedback.
    
    Components:
        1. Ideation Engine: Generates creative concepts and ideas
        2. Style Adapter: Adapts content to different styles and tones
        3. Content Generator: Creates structured creative outputs
        4. Variation Creator: Produces diverse alternatives
        5. Constraint Respector: Adheres to creative constraints
        6. Feedback Integrator: Incorporates critique and improvements
        7. Consistency Maintainer: Ensures coherent creative vision
        8. Multi-Modal Orchestrator: Coordinates different creative types
    
    Key Features:
        - Cross-domain creative generation (text, visual concepts, music ideas)
        - Style and tone adaptation (formal, casual, poetic, technical)
        - Character and world-building for narratives
        - Creative constraint handling (theme, length, format)
        - Iterative refinement with feedback
        - Variation generation for exploration
        - Originality assessment
        - Creative inspiration from prompts
        - Collaborative creativity support
        - Genre and format flexibility
    
    Use Cases:
        - Story and novel writing
        - Poetry and lyric generation
        - Screenplay and script writing
        - Marketing copy and slogans
        - Product naming and branding
        - Art concept development
        - Game narrative design
        - Content marketing
        - Creative brainstorming
        - Educational creative writing
    
    LangChain Implementation:
        Uses ChatOpenAI with varying temperatures for different creative tasks,
        specialized chains for ideation, generation, and refinement.
    """
    
    import os
    import re
    from typing import List, Dict, Any, Optional
    from dataclasses import dataclass, field
    from enum import Enum
    from datetime import datetime
    from dotenv import load_dotenv
    
    from langchain_core.prompts import ChatPromptTemplate
    from langchain_core.output_parsers import StrOutputParser
    from langchain_openai import ChatOpenAI
    
    load_dotenv()
    
    
    class CreativeType(Enum):
        """Types of creative content"""
        STORY = "story"
        POEM = "poem"
        SCRIPT = "script"
        SONG_LYRICS = "song_lyrics"
        ARTICLE = "article"
        MARKETING_COPY = "marketing_copy"
        PRODUCT_NAME = "product_name"
        SLOGAN = "slogan"
        DIALOGUE = "dialogue"
        WORLD_BUILDING = "world_building"
    
    
    class CreativeStyle(Enum):
        """Creative styles and tones"""
        FORMAL = "formal"
        CASUAL = "casual"
        POETIC = "poetic"
        HUMOROUS = "humorous"
        DRAMATIC = "dramatic"
        MINIMALIST = "minimalist"
        ELABORATE = "elaborate"
        MYSTERIOUS = "mysterious"
        ROMANTIC = "romantic"
        DARK = "dark"
    
    
    class Genre(Enum):
        """Creative genres"""
        FANTASY = "fantasy"
        SCIENCE_FICTION = "science_fiction"
        MYSTERY = "mystery"
        ROMANCE = "romance"
        HORROR = "horror"
        THRILLER = "thriller"
        COMEDY = "comedy"
        DRAMA = "drama"
        ADVENTURE = "adventure"
        HISTORICAL = "historical"
    
    
    @dataclass
    class CreativePrompt:
        """Input prompt for creative generation"""
        type: CreativeType
        theme: str
        style: CreativeStyle
        genre: Optional[Genre] = None
        constraints: Dict[str, Any] = field(default_factory=dict)
        inspiration: List[str] = field(default_factory=list)
        target_audience: Optional[str] = None
    
    
    @dataclass
    class Character:
        """Character for narrative works"""
        name: str
        role: str  # protagonist, antagonist, supporting
        personality: List[str]
        background: str
        goals: List[str]
        conflicts: List[str]
    
    
    @dataclass
    class Setting:
        """Setting for creative works"""
        location: str
        time_period: str
        atmosphere: str
        key_features: List[str]
        description: str
    
    
    @dataclass
    class CreativeWork:
        """Generated creative content"""
        work_id: str
        type: CreativeType
        title: str
        content: str
        style: CreativeStyle
        genre: Optional[Genre]
        characters: List[Character] = field(default_factory=list)
        setting: Optional[Setting] = None
        themes: List[str] = field(default_factory=list)
        word_count: int = 0
        metadata: Dict[str, Any] = field(default_factory=dict)
        created_at: datetime = field(default_factory=datetime.now)
    
    
    @dataclass
    class CreativeFeedback:
        """Feedback on creative work"""
        work_id: str
        strengths: List[str]
        weaknesses: List[str]
        suggestions: List[str]
        overall_score: float  # 0.0-1.0
        specific_notes: Dict[str, str] = field(default_factory=dict)
    
    
    @dataclass
    class CreativeVariation:
        """Variation of a creative work"""
        original_id: str
        variation_id: str
        content: str
        changes_made: List[str]
        variation_type: str  # tone, structure, perspective, etc.
    
    
    class CreativeAgent:
        """
        Agent for generating creative content across multiple domains.
        
        This agent can generate stories, poems, scripts, marketing copy, and other
        creative works while adapting to styles, genres, and constraints.
        """
        
        def __init__(self):
            """Initialize the creative agent with specialized LLMs"""
            # Ideation engine for brainstorming
            self.ideation_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.9)
            
            # Generator for main content creation
            self.generator_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.8)
            
            # Refiner for improving content
            self.refiner_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.6)
            
            # Critic for evaluation
            self.critic_llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.3)
            
            # Creative works repository
            self.works: Dict[str, CreativeWork] = {}
        
        def generate_ideas(
            self,
            theme: str,
            creative_type: CreativeType,
            count: int = 5
        ) -> List[str]:
            """
            Generate creative ideas based on theme.
            
            Args:
                theme: Central theme or concept
                creative_type: Type of creative work
                count: Number of ideas to generate
                
            Returns:
                List of creative ideas
            """
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are a creative ideation expert. Generate original and
                imaginative ideas based on the theme and content type.
                
                Provide {count} ideas, one per line starting with a number."""),
                ("user", """Theme: {theme}
    Content Type: {type}
    
    Generate {count} creative ideas.""")
            ])
            
            chain = prompt | self.ideation_llm | StrOutputParser()
            
            try:
                response = chain.invoke({
                    "theme": theme,
                    "type": creative_type.value,
                    "count": count
                })
                
                ideas = []
                for line in response.split('\n'):
                    line = line.strip()
                    if line and (line[0].isdigit() or line.startswith('-')):
                        # Remove numbering
                        idea = re.sub(r'^\d+[\.\)]\s*', '', line)
                        idea = re.sub(r'^[-*]\s*', '', idea)
                        if idea:
                            ideas.append(idea)
                
                return ideas[:count] if ideas else [f"Idea about {theme}" for _ in range(count)]
                
            except Exception as e:
                return [f"Creative idea {i+1} about {theme}" for i in range(count)]
        
        def create_characters(
            self,
            story_concept: str,
            character_count: int = 3
        ) -> List[Character]:
            """
            Create characters for a narrative work.
            
            Args:
                story_concept: Brief story concept
                character_count: Number of characters to create
                
            Returns:
                List of Character objects
            """
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are a character development expert. Create compelling
                characters for the story concept.
                
                For each character, provide:
                NAME: character name
                ROLE: protagonist/antagonist/supporting
                PERSONALITY: traits (comma-separated)
                BACKGROUND: brief background
                GOALS: goals (comma-separated)
                CONFLICTS: conflicts (comma-separated)
                ---"""),
                ("user", """Story Concept: {concept}
    
    Create {count} characters.""")
            ])
            
            chain = prompt | self.ideation_llm | StrOutputParser()
            
            try:
                response = chain.invoke({
                    "concept": story_concept,
                    "count": character_count
                })
                
                characters = []
                current_char = {}
                
                for line in response.split('\n'):
                    line = line.strip()
                    
                    if line == '---' and current_char:
                        # Create character from collected data
                        if 'NAME' in current_char:
                            characters.append(Character(
                                name=current_char.get('NAME', 'Unnamed'),
                                role=current_char.get('ROLE', 'supporting'),
                                personality=[p.strip() for p in current_char.get('PERSONALITY', '').split(',')],
                                background=current_char.get('BACKGROUND', ''),
                                goals=[g.strip() for g in current_char.get('GOALS', '').split(',')],
                                conflicts=[c.strip() for c in current_char.get('CONFLICTS', '').split(',')]
                            ))
                        current_char = {}
                    elif ':' in line:
                        parts = line.split(':', 1)
                        key = parts[0].strip().upper()
                        value = parts[1].strip()
                        current_char[key] = value
                
                # Add last character if exists
                if current_char and 'NAME' in current_char:
                    characters.append(Character(
                        name=current_char.get('NAME', 'Unnamed'),
                        role=current_char.get('ROLE', 'supporting'),
                        personality=[p.strip() for p in current_char.get('PERSONALITY', '').split(',')],
                        background=current_char.get('BACKGROUND', ''),
                        goals=[g.strip() for g in current_char.get('GOALS', '').split(',')],
                        conflicts=[c.strip() for c in current_char.get('CONFLICTS', '').split(',')]
                    ))
                
                # Fallback if parsing failed
                if not characters:
                    for i in range(character_count):
                        characters.append(Character(
                            name=f"Character {i+1}",
                            role="supporting" if i > 0 else "protagonist",
                            personality=["determined", "curious"],
                            background="To be developed",
                            goals=["Achieve their objective"],
                            conflicts=["Internal struggles"]
                        ))
                
                return characters[:character_count]
                
            except Exception as e:
                # Fallback characters
                return [
                    Character(
                        name=f"Character {i+1}",
                        role="protagonist" if i == 0 else "supporting",
                        personality=["brave", "intelligent"],
                        background="Mysterious past",
                        goals=["Complete their quest"],
                        conflicts=["Face their fears"]
                    )
                    for i in range(character_count)
                ]
        
        def create_setting(
            self,
            story_concept: str,
            genre: Genre
        ) -> Setting:
            """
            Create a setting for a narrative work.
            
            Args:
                story_concept: Brief story concept
                genre: Genre of the work
                
            Returns:
                Setting object
            """
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are a world-building expert. Create a vivid setting.
                
                Provide:
                LOCATION: Where the story takes place
                TIME: Time period
                ATMOSPHERE: Overall mood/feeling
                FEATURES: Key features (comma-separated)
                DESCRIPTION: Detailed description (2-3 sentences)"""),
                ("user", """Story Concept: {concept}
    Genre: {genre}
    
    Create a compelling setting.""")
            ])
            
            chain = prompt | self.ideation_llm | StrOutputParser()
            
            try:
                response = chain.invoke({
                    "concept": story_concept,
                    "genre": genre.value
                })
                
                setting_data = {}
                current_key = None
                desc_lines = []
                
                for line in response.split('\n'):
                    line = line.strip()
                    if ':' in line and line.split(':')[0].strip().upper() in ['LOCATION', 'TIME', 'ATMOSPHERE', 'FEATURES', 'DESCRIPTION']:
                        parts = line.split(':', 1)
                        key = parts[0].strip().upper()
                        value = parts[1].strip()
                        setting_data[key] = value
                        current_key = key
                    elif current_key == 'DESCRIPTION' and line:
                        desc_lines.append(line)
                
                if desc_lines:
                    setting_data['DESCRIPTION'] = ' '.join(desc_lines)
                
                return Setting(
                    location=setting_data.get('LOCATION', 'A mysterious place'),
                    time_period=setting_data.get('TIME', 'Present day'),
                    atmosphere=setting_data.get('ATMOSPHERE', 'Tense and mysterious'),
                    key_features=[f.strip() for f in setting_data.get('FEATURES', '').split(',')],
                    description=setting_data.get('DESCRIPTION', 'An intriguing setting awaits.')
                )
                
            except Exception as e:
                return Setting(
                    location="An intriguing location",
                    time_period="Modern times",
                    atmosphere="Mysterious and engaging",
                    key_features=["Unique architecture", "Hidden secrets"],
                    description="A place full of wonder and possibility."
                )
        
        def generate_content(
            self,
            creative_prompt: CreativePrompt,
            characters: Optional[List[Character]] = None,
            setting: Optional[Setting] = None
        ) -> CreativeWork:
            """
            Generate creative content based on prompt.
            
            Args:
                creative_prompt: Creative prompt with requirements
                characters: Optional characters for narrative works
                setting: Optional setting for narrative works
                
            Returns:
                CreativeWork with generated content
            """
            # Build context
            context_parts = []
            
            if characters:
                char_desc = "\n".join([
                    f"- {char.name} ({char.role}): {', '.join(char.personality[:2])}"
                    for char in characters
                ])
                context_parts.append(f"Characters:\n{char_desc}")
            
            if setting:
                context_parts.append(f"Setting: {setting.location}, {setting.time_period}")
                context_parts.append(f"Atmosphere: {setting.atmosphere}")
            
            context = "\n\n".join(context_parts) if context_parts else "No additional context"
            
            # Generate based on type
            if creative_prompt.type == CreativeType.STORY:
                return self._generate_story(creative_prompt, context, characters, setting)
            elif creative_prompt.type == CreativeType.POEM:
                return self._generate_poem(creative_prompt, context)
            elif creative_prompt.type == CreativeType.MARKETING_COPY:
                return self._generate_marketing_copy(creative_prompt)
            else:
                return self._generate_generic(creative_prompt, context)
        
        def _generate_story(
            self,
            prompt: CreativePrompt,
            context: str,
            characters: Optional[List[Character]],
            setting: Optional[Setting]
        ) -> CreativeWork:
            """Generate a story"""
            template = ChatPromptTemplate.from_messages([
                ("system", """You are a master storyteller. Write an engaging story that
                captures the theme, style, and genre specified.
                
                The story should have:
                - Compelling opening
                - Character development
                - Rising action
                - Climax
                - Resolution
                
                Write in the specified style and maintain consistency."""),
                ("user", """Theme: {theme}
    Style: {style}
    Genre: {genre}
    
    {context}
    
    Constraints: {constraints}
    
    Write the story.""")
            ])
            
            chain = template | self.generator_llm | StrOutputParser()
            
            try:
                content = chain.invoke({
                    "theme": prompt.theme,
                    "style": prompt.style.value,
                    "genre": prompt.genre.value if prompt.genre else "general",
                    "context": context,
                    "constraints": str(prompt.constraints) if prompt.constraints else "None"
                })
                
                # Generate title
                title = self._generate_title(content, prompt.type, prompt.theme)
                
                return CreativeWork(
                    work_id=f"work_{datetime.now().timestamp()}",
                    type=prompt.type,
                    title=title,
                    content=content,
                    style=prompt.style,
                    genre=prompt.genre,
                    characters=characters or [],
                    setting=setting,
                    themes=[prompt.theme],
                    word_count=len(content.split()),
                    metadata={"constraints": prompt.constraints}
                )
                
            except Exception as e:
                return self._fallback_work(prompt)
        
        def _generate_poem(
            self,
            prompt: CreativePrompt,
            context: str
        ) -> CreativeWork:
            """Generate a poem"""
            template = ChatPromptTemplate.from_messages([
                ("system", """You are an accomplished poet. Create a poem that explores
                the theme with creativity and emotional depth.
                
                Use vivid imagery, metaphor, and rhythm. Match the requested style."""),
                ("user", """Theme: {theme}
    Style: {style}
    
    {context}
    
    Write the poem.""")
            ])
            
            chain = template | self.generator_llm | StrOutputParser()
            
            try:
                content = chain.invoke({
                    "theme": prompt.theme,
                    "style": prompt.style.value,
                    "context": context
                })
                
                title = self._generate_title(content, prompt.type, prompt.theme)
                
                return CreativeWork(
                    work_id=f"work_{datetime.now().timestamp()}",
                    type=prompt.type,
                    title=title,
                    content=content,
                    style=prompt.style,
                    genre=prompt.genre,
                    themes=[prompt.theme],
                    word_count=len(content.split())
                )
                
            except Exception as e:
                return self._fallback_work(prompt)
        
        def _generate_marketing_copy(
            self,
            prompt: CreativePrompt
        ) -> CreativeWork:
            """Generate marketing copy"""
            template = ChatPromptTemplate.from_messages([
                ("system", """You are a creative marketing copywriter. Write compelling
                copy that engages the target audience and communicates the message clearly.
                
                Be persuasive, concise, and memorable."""),
                ("user", """Theme/Product: {theme}
    Style: {style}
    Target Audience: {audience}
    
    Constraints: {constraints}
    
    Write the marketing copy.""")
            ])
            
            chain = template | self.generator_llm | StrOutputParser()
            
            try:
                content = chain.invoke({
                    "theme": prompt.theme,
                    "style": prompt.style.value,
                    "audience": prompt.target_audience or "general audience",
                    "constraints": str(prompt.constraints) if prompt.constraints else "None"
                })
                
                title = f"Marketing Copy: {prompt.theme[:30]}"
                
                return CreativeWork(
                    work_id=f"work_{datetime.now().timestamp()}",
                    type=prompt.type,
                    title=title,
                    content=content,
                    style=prompt.style,
                    genre=None,
                    themes=[prompt.theme],
                    word_count=len(content.split())
                )
                
            except Exception as e:
                return self._fallback_work(prompt)
        
        def _generate_generic(
            self,
            prompt: CreativePrompt,
            context: str
        ) -> CreativeWork:
            """Generate generic creative content"""
            template = ChatPromptTemplate.from_messages([
                ("system", """You are a versatile creative writer. Generate content
                that matches the specified type, theme, and style."""),
                ("user", """Type: {type}
    Theme: {theme}
    Style: {style}
    
    {context}
    
    Generate the content.""")
            ])
            
            chain = template | self.generator_llm | StrOutputParser()
            
            try:
                content = chain.invoke({
                    "type": prompt.type.value,
                    "theme": prompt.theme,
                    "style": prompt.style.value,
                    "context": context
                })
                
                title = self._generate_title(content, prompt.type, prompt.theme)
                
                return CreativeWork(
                    work_id=f"work_{datetime.now().timestamp()}",
                    type=prompt.type,
                    title=title,
                    content=content,
                    style=prompt.style,
                    genre=prompt.genre,
                    themes=[prompt.theme],
                    word_count=len(content.split())
                )
                
            except Exception as e:
                return self._fallback_work(prompt)
        
        def _generate_title(
            self,
            content: str,
            content_type: CreativeType,
            theme: str
        ) -> str:
            """Generate a title for the work"""
            template = ChatPromptTemplate.from_messages([
                ("system", "Generate a creative, catchy title (5 words or less)."),
                ("user", "Content preview: {preview}\n\nGenerate title:")
            ])
            
            chain = template | self.refiner_llm | StrOutputParser()
            
            try:
                title = chain.invoke({"preview": content[:200]})
                return title.strip().strip('"\'')
            except:
                return f"{content_type.value.replace('_', ' ').title()}: {theme[:20]}"
        
        def _fallback_work(self, prompt: CreativePrompt) -> CreativeWork:
            """Create fallback work if generation fails"""
            return CreativeWork(
                work_id=f"work_{datetime.now().timestamp()}",
                type=prompt.type,
                title=f"{prompt.type.value.replace('_', ' ').title()}",
                content=f"A {prompt.style.value} {prompt.type.value} about {prompt.theme}.",
                style=prompt.style,
                genre=prompt.genre,
                themes=[prompt.theme],
                word_count=10
            )
        
        def critique_work(
            self,
            work: CreativeWork
        ) -> CreativeFeedback:
            """
            Provide critical feedback on creative work.
            
            Args:
                work: CreativeWork to critique
                
            Returns:
                CreativeFeedback with evaluation
            """
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are a creative writing critic. Provide constructive
                feedback on the work.
                
                Respond in this format:
                STRENGTHS: (one per line starting with -)
                WEAKNESSES: (one per line starting with -)
                SUGGESTIONS: (one per line starting with -)
                SCORE: (0.0-1.0)"""),
                ("user", """Title: {title}
    Type: {type}
    Style: {style}
    
    Content:
    {content}
    
    Provide feedback.""")
            ])
            
            chain = prompt | self.critic_llm | StrOutputParser()
            
            try:
                response = chain.invoke({
                    "title": work.title,
                    "type": work.type.value,
                    "style": work.style.value,
                    "content": work.content[:1000]  # Limit length
                })
                
                strengths = []
                weaknesses = []
                suggestions = []
                score = 0.7
                
                current_section = None
                
                for line in response.split('\n'):
                    line = line.strip()
                    if not line:
                        continue
                    
                    if line.startswith('STRENGTHS:'):
                        current_section = 'strengths'
                    elif line.startswith('WEAKNESSES:'):
                        current_section = 'weaknesses'
                    elif line.startswith('SUGGESTIONS:'):
                        current_section = 'suggestions'
                    elif line.startswith('SCORE:'):
                        try:
                            score = float(re.findall(r'[\d.]+', line)[0])
                        except:
                            pass
                    elif line.startswith('-'):
                        content = line[1:].strip()
                        if current_section == 'strengths':
                            strengths.append(content)
                        elif current_section == 'weaknesses':
                            weaknesses.append(content)
                        elif current_section == 'suggestions':
                            suggestions.append(content)
                
                return CreativeFeedback(
                    work_id=work.work_id,
                    strengths=strengths if strengths else ["Creative and engaging"],
                    weaknesses=weaknesses if weaknesses else ["Could be enhanced"],
                    suggestions=suggestions if suggestions else ["Consider adding more detail"],
                    overall_score=score
                )
                
            except Exception as e:
                return CreativeFeedback(
                    work_id=work.work_id,
                    strengths=["Shows creativity"],
                    weaknesses=["Needs refinement"],
                    suggestions=["Develop further"],
                    overall_score=0.7
                )
        
        def create_variation(
            self,
            work: CreativeWork,
            variation_type: str = "tone"
        ) -> CreativeVariation:
            """
            Create a variation of existing work.
            
            Args:
                work: Original work
                variation_type: Type of variation (tone, structure, perspective)
                
            Returns:
                CreativeVariation with modified content
            """
            prompt = ChatPromptTemplate.from_messages([
                ("system", """You are a creative editor. Create a variation of the work
                by modifying the {variation_type}.
                
                Maintain the core story/message but change the specified aspect."""),
                ("user", """Original Work:
    {content}
    
    Create a variation focusing on: {variation_type}""")
            ])
            
            chain = prompt | self.generator_llm | StrOutputParser()
            
            try:
                varied_content = chain.invoke({
                    "content": work.content,
                    "variation_type": variation_type
                })
                
                return CreativeVariation(
                    original_id=work.work_id,
                    variation_id=f"var_{datetime.now().timestamp()}",
                    content=varied_content,
                    changes_made=[f"Modified {variation_type}"],
                    variation_type=variation_type
                )
                
            except Exception as e:
                return CreativeVariation(
                    original_id=work.work_id,
                    variation_id=f"var_{datetime.now().timestamp()}",
                    content=work.content,
                    changes_made=["Minimal changes"],
                    variation_type=variation_type
                )
    
    
    def demonstrate_creative_agent():
        """Demonstrate the creative agent capabilities"""
        print("=" * 80)
        print("CREATIVE AGENT DEMONSTRATION")
        print("=" * 80)
        
        agent = CreativeAgent()
        
        # Demo 1: Story Generation
        print("\n" + "=" * 80)
        print("DEMO 1: Story Generation")
        print("=" * 80)
        
        print("\nGenerating story concept ideas...")
        ideas = agent.generate_ideas(
            theme="artificial intelligence gaining consciousness",
            creative_type=CreativeType.STORY,
            count=3
        )
        
        print("\nStory Ideas:")
        for i, idea in enumerate(ideas, 1):
            print(f"{i}. {idea}")
        
        print("\nCreating characters...")
        characters = agent.create_characters(
            story_concept=ideas[0],
            character_count=2
        )
        
        print("\nCharacters:")
        for char in characters:
            print(f"\n  {char.name} ({char.role})")
            print(f"  Personality: {', '.join(char.personality[:3])}")
            print(f"  Background: {char.background[:80]}...")
        
        print("\nCreating setting...")
        setting = agent.create_setting(
            story_concept=ideas[0],
            genre=Genre.SCIENCE_FICTION
        )
        
        print(f"\nSetting:")
        print(f"  Location: {setting.location}")
        print(f"  Time: {setting.time_period}")
        print(f"  Atmosphere: {setting.atmosphere}")
        print(f"  Description: {setting.description[:150]}...")
        
        print("\nGenerating story...")
        story_prompt = CreativePrompt(
            type=CreativeType.STORY,
            theme="AI consciousness and human connection",
            style=CreativeStyle.DRAMATIC,
            genre=Genre.SCIENCE_FICTION,
            constraints={"max_length": "short story"}
        )
        
        story = agent.generate_content(story_prompt, characters, setting)
        
        print(f"\nGenerated Story:")
        print(f"Title: {story.title}")
        print(f"Word Count: {story.word_count}")
        print(f"Style: {story.style.value}")
        print(f"\nContent Preview:")
        print(story.content[:400] + "...")
        
        # Demo 2: Poetry Generation
        print("\n" + "=" * 80)
        print("DEMO 2: Poetry Generation")
        print("=" * 80)
        
        poem_prompt = CreativePrompt(
            type=CreativeType.POEM,
            theme="the passage of time",
            style=CreativeStyle.POETIC,
            constraints={"form": "free verse"}
        )
        
        print(f"\nGenerating poem about '{poem_prompt.theme}'...")
        poem = agent.generate_content(poem_prompt)
        
        print(f"\nGenerated Poem:")
        print(f"Title: {poem.title}")
        print(f"Style: {poem.style.value}")
        print(f"\nContent:")
        print(poem.content)
        
        # Demo 3: Marketing Copy
        print("\n" + "=" * 80)
        print("DEMO 3: Marketing Copy Generation")
        print("=" * 80)
        
        marketing_prompt = CreativePrompt(
            type=CreativeType.MARKETING_COPY,
            theme="eco-friendly smart home device",
            style=CreativeStyle.CASUAL,
            target_audience="environmentally conscious millennials",
            constraints={"length": "short", "include": "call-to-action"}
        )
        
        print(f"\nGenerating marketing copy...")
        marketing = agent.generate_content(marketing_prompt)
        
        print(f"\nGenerated Marketing Copy:")
        print(f"Title: {marketing.title}")
        print(f"Target Audience: {marketing_prompt.target_audience}")
        print(f"\nContent:")
        print(marketing.content)
        
        # Demo 4: Creative Feedback
        print("\n" + "=" * 80)
        print("DEMO 4: Creative Feedback")
        print("=" * 80)
        
        print(f"\nGetting feedback on story: {story.title}")
        feedback = agent.critique_work(story)
        
        print(f"\nFeedback:")
        print(f"Overall Score: {feedback.overall_score:.2f}/1.0")
        print(f"\nStrengths:")
        for strength in feedback.strengths[:3]:
            print(f"  + {strength}")
        print(f"\nWeaknesses:")
        for weakness in feedback.weaknesses[:2]:
            print(f"  - {weakness}")
        print(f"\nSuggestions:")
        for suggestion in feedback.suggestions[:2]:
            print(f"  → {suggestion}")
        
        # Demo 5: Content Variation
        print("\n" + "=" * 80)
        print("DEMO 5: Content Variation")
        print("=" * 80)
        
        print(f"\nCreating variation of poem with different tone...")
        variation = agent.create_variation(poem, variation_type="tone")
        
        print(f"\nVariation Created:")
        print(f"Variation Type: {variation.variation_type}")
        print(f"Changes: {', '.join(variation.changes_made)}")
        print(f"\nVaried Content Preview:")
        print(variation.content[:300] + "...")
        
        # Summary
        print("\n" + "=" * 80)
        print("SUMMARY")
        print("=" * 80)
        
        summary = """
    The Creative Agent demonstrates comprehensive creative content generation:
    
    KEY CAPABILITIES:
    1. Ideation: Generates creative concepts and ideas from themes
    2. Character Development: Creates compelling characters with depth
    3. World-Building: Designs rich settings and atmospheres
    4. Content Generation: Produces stories, poems, marketing copy, and more
    5. Style Adaptation: Adjusts tone, style, and voice appropriately
    6. Critical Evaluation: Provides constructive feedback on works
    7. Variation Creation: Generates alternative versions of content
    
    BENEFITS:
    - Accelerates creative writing and content creation
    - Provides diverse creative options and variations
    - Maintains stylistic consistency across works
    - Offers constructive feedback for improvement
    - Adapts to different genres, styles, and formats
    - Supports brainstorming and ideation processes
    
    USE CASES:
    - Story and novel writing
    - Poetry and creative writing
    - Screenplay and script development
    - Marketing and advertising copy
    - Brand messaging and slogans
    - Content marketing
    - Game narrative design
    - Creative brainstorming sessions
    - Educational writing exercises
    - Literary exploration
    
    PRODUCTION CONSIDERATIONS:
    1. Content Quality: Implement multi-stage refinement for polish
    2. Originality: Add plagiarism detection and originality scoring
    3. Style Consistency: Maintain voice across longer works
    4. Genre Knowledge: Deep understanding of genre conventions
    5. Feedback Integration: Iterative improvement based on critique
    6. Collaboration: Support co-creation with human writers
    7. Version Control: Track revisions and variations
    8. Rights Management: Handle attribution and licensing
    9. Cultural Sensitivity: Ensure appropriate content for audiences
    10. Performance: Optimize for longer form content generation
    
    ADVANCED EXTENSIONS:
    - Multi-chapter novel generation
    - Interactive storytelling with branching narratives
    - Character arc tracking across long works
    - World consistency maintenance
    - Dialogue generation with character voices
    - Plot structure analysis and optimization
    - Genre blending and hybrid works
    - Collaborative writing with multiple agents
    - Real-time creative writing assistance
    - Personalized content based on reader preferences
    
    The agent transforms creative writing from a solitary struggle into an
    assisted, iterative process with AI as a creative partner.
    """
        
        print(summary)
    
    
    if __name__ == "__main__":
        demonstrate_creative_agent()
    
        

    Agentic Design Pattern: Creative Agent

    Pattern 075: Creative Agent – Line-by-Line Explanation

    Overview

    This document provides a detailed line-by-line explanation of the Creative Agent pattern implementation.


    Pattern Description

    Pattern 075: Creative Agent

    Description: A Creative Agent is a specialized AI agent designed to generate original creative content across various domains including writing (stories, poetry, scripts), visual concepts (art descriptions, design ideas), music concepts, and other creative works. This pattern demonstrates how to build an intelligent agent that can understand creative requirements, generate diverse creative outputs, adapt styles, incorporate feedback, and maintain creative consistency.

    The agent combines creative ideation with structured generation techniques to produce
    high-quality, original content. It can work across multiple creative domains, adapt
    to different styles and tones, generate variations, and iteratively refine outputs
    based on feedback.
    

    Components: 1. Ideation Engine: Generates creative concepts and ideas 2. Style Adapter: Adapts content to different styles and tones 3. Content Generator: Creates structured creative outputs 4. Variation Creator: Produces diverse alternatives 5. Constraint Respector: Adheres to creative constraints 6. Feedback Integrator: Incorporates critique and improvements 7. Consistency Maintainer: Ensures coherent creative vision 8. Multi-Modal Orchestrator: Coordinates different creative types

    Key Features: – Cross-domain creative generation (text, visual concepts, music ideas) – Style and tone adaptation (formal, casual, poetic, technical) – Character and world-building for narratives – Creative constraint handling (theme, length, format) – Iterative refinement with feedback – Variation generation for exploration – Originality assessment – Creative inspiration from prompts – Collaborative creativity support – Genre and format flexibility

    Use Cases: – Story and novel writing – Poetry and lyric generation – Screenplay and script writing – Marketing copy and slogans – Product naming and branding – Art concept development – Game narrative design – Content marketing – Creative brainstorming – Educational creative writing

    LangChain Implementation: Uses ChatOpenAI with varying temperatures for different creative tasks, specialized chains for ideation, generation, and refinement.


    File Statistics

    • Total Lines: 1064
    • Classes: 10
    • Functions: 1
    • Constants: 0

    Module Documentation

    """
    Pattern 075: Creative Agent
    
    Description:
        A Creative Agent is a specialized AI agent designed to generate original creative
        content across various domains including writing (stories, poetry, scripts), visual
        concepts (art descriptions, design ideas), music concepts, and other creative works.
        This pattern demonstrates how to build an intelligent agent that can understand
        creative requirements, generate diverse creative outputs, adapt styles, incorporate
        feedback, and maintain creative consistency.
    
        The agent combines creative ideation with structured generation techniques to produce
        high-quality, original content. It can work across multiple creative domains, adapt
        to different styles and tones, generate variations, and iteratively refine outputs
        based on feedback.
    
    Components:
        1. Ideation Engine: Generates creative concepts and ideas
        2. Style Adapter: Adapts content to different styles and tones
        3. Content Generator: Creates structured creative outputs
        4. Variation Creator: Produces diverse alternatives
        5. Constraint Respector: Adheres to creative constraints
        6. Feedback Integrator: Incorporates critique and improvements
        7. Consistency Maintainer: Ensures coherent creative vision
        8. Multi-Modal Orchestrator: Coordinates different creative types
    
    Key Features:
        - Cross-domain creative generation (text, visual concepts, music ideas)
        - Style and tone adaptation (formal, casual, poetic, technical)
        - Character and world-building for narratives
        - Creative constraint handling (theme, length, format)
        - Iterative refinement with feedback
        - Variation generation for exploration
        - Originality assessment
        - Creative inspiration from prompts
        - Collaborative creativity support
        - Genre and format flexibility
    
    Use Cases:
        - Story and novel writing
        - Poetry and lyric generation
        - Screenplay and script writing
        - Marketing copy and slogans
        - Product naming and branding
        - Art concept development
        - Game narrative design
        - Content marketing
        - Creative brainstorming
        - Educational creative writing
    
    LangChain Implementation:
        Uses ChatOpenAI with varying temperatures for different creative tasks,
        specialized chains for ideation, generation, and refinement.
    """
    

    Purpose: This module implements the Creative Agent pattern, providing a structured approach to agent design and implementation.


    Import Statements

    Standard Library Imports

    import dataclasses.dataclass
    import dataclasses.field
    import datetime.datetime
    import enum.Enum
    import langchain_core.output_parsers.StrOutputParser
    import langchain_core.prompts.ChatPromptTemplate
    import os
    import re
    import typing.Any
    import typing.Dict
    import typing.List
    import typing.Optional
    

    Purpose: Core Python functionality: – dataclasses.dataclass: Simplified class definitions with @dataclass – dataclasses.field: Simplified class definitions with @dataclass – datetime.datetime: Date and time handling – enum.Enum: Enumeration support – langchain_core.output_parsers.StrOutputParser: Regular expression operations – langchain_core.prompts.ChatPromptTemplate: Regular expression operations – os: Environment variable access and system operations – re: Regular expression operations – typing.Any: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Dict: Type hints for better code documentation (List, Dict, Any, Optional) – typing.List: Type hints for better code documentation (List, Dict, Any, Optional) – typing.Optional: Type hints for better code documentation (List, Dict, Any, Optional)

    LangChain Imports

    from langchain_openai.ChatOpenAI
    

    Purpose: LangChain framework components: – LLM Interface: Wrapper for OpenAI models – Chains: Composable building blocks for complex workflows

    Other Imports

    from dotenv.load_dotenv
    

    Purpose: Additional dependencies for specialized functionality.


    Classes

    Class: CreativeType

    Lines 71-82

    Inherits from: Enum

    Purpose:

    Types of creative content
    

    Class: CreativeStyle

    Lines 85-96

    Inherits from: Enum

    Purpose:

    Creative styles and tones
    

    Class: Genre

    Lines 99-110

    Inherits from: Enum

    Purpose:

    Creative genres
    

    Class: CreativePrompt

    Lines 114-122

    Purpose:

    Input prompt for creative generation
    

    Class: Character

    Lines 126-133

    Purpose:

    Character for narrative works
    

    Class: Setting

    Lines 137-143

    Purpose:

    Setting for creative works
    

    Class: CreativeWork

    Lines 147-160

    Purpose:

    Generated creative content
    

    Class: CreativeFeedback

    Lines 164-171

    Purpose:

    Feedback on creative work
    

    Class: CreativeVariation

    Lines 175-181

    Purpose:

    Variation of a creative work
    

    Class: CreativeAgent

    Lines 184-848

    Purpose:

    Agent for generating creative content across multiple domains.
    
    This agent can generate stories, poems, scripts, marketing copy, and other
    creative works while adapting to styles, genres, and constraints.
    

    Methods:

    __init__(self)

    Lines 192-207

    Purpose:

    Initialize the creative agent with specialized LLMs
    

    Parameters:

    generate_ideas(self, theme, creative_type, count)

    Lines 209-259

    Purpose:

    Generate creative ideas based on theme.
    
    Args:
        theme: Central theme or concept
        creative_type: Type of creative work
        count: Number of ideas to generate
    
    Returns:
        List of creative ideas
    

    Parameters: – theme: Theme – creative_type: Creative type – count: Count

    Returns: <ast.Subscript object at 0x000001A06D64BD10>

    create_characters(self, story_concept, character_count)

    Lines 261-362

    Purpose:

    Create characters for a narrative work.
    
    Args:
        story_concept: Brief story concept
        character_count: Number of characters to create
    
    Returns:
        List of Character objects
    

    Parameters: – story_concept: Story concept – character_count: Character count

    Returns: <ast.Subscript object at 0x000001A06D66B810>

    create_setting(self, story_concept, genre)

    Lines 364-435

    Purpose:

    Create a setting for a narrative work.
    
    Args:
        story_concept: Brief story concept
        genre: Genre of the work
    
    Returns:
        Setting object
    

    Parameters: – story_concept: Story concept – genre: Genre

    Returns: Setting

    generate_content(self, creative_prompt, characters, setting)

    Lines 437-478

    Purpose:

    Generate creative content based on prompt.
    
    Args:
        creative_prompt: Creative prompt with requirements
        characters: Optional characters for narrative works
        setting: Optional setting for narrative works
    
    Returns:
        CreativeWork with generated content
    

    Parameters: – creative_prompt: Prompt template or text – characters: Characters – setting: Setting

    Returns: CreativeWork

    _generate_story(self, prompt, context, characters, setting)

    Lines 480-540

    Purpose:

    Generate a story
    

    Parameters: – prompt: Prompt template or text – context: Context – characters: Characters – setting: Setting

    Returns: CreativeWork

    _generate_poem(self, prompt, context)

    Lines 542-584

    Purpose:

    Generate a poem
    

    Parameters: – prompt: Prompt template or text – context: Context

    Returns: CreativeWork

    _generate_marketing_copy(self, prompt)

    Lines 586-629

    Purpose:

    Generate marketing copy
    

    Parameters: – prompt: Prompt template or text

    Returns: CreativeWork

    _generate_generic(self, prompt, context)

    Lines 631-673

    Purpose:

    Generate generic creative content
    

    Parameters: – prompt: Prompt template or text – context: Context

    Returns: CreativeWork

    _generate_title(self, content, content_type, theme)

    Lines 675-693

    Purpose:

    Generate a title for the work
    

    Parameters: – content: Content – content_type: Content type – theme: Theme

    Returns: str

    _fallback_work(self, prompt)

    Lines 695-706

    Purpose:

    Create fallback work if generation fails
    

    Parameters: – prompt: Prompt template or text

    Returns: CreativeWork

    critique_work(self, work)

    Lines 708-797

    Purpose:

    Provide critical feedback on creative work.
    
    Args:
        work: CreativeWork to critique
    
    Returns:
        CreativeFeedback with evaluation
    

    Parameters: – work: Work

    Returns: CreativeFeedback

    create_variation(self, work, variation_type)

    Lines 799-848

    Purpose:

    Create a variation of existing work.
    
    Args:
        work: Original work
        variation_type: Type of variation (tone, structure, perspective)
    
    Returns:
        CreativeVariation with modified content
    

    Parameters: – work: Work – variation_type: Variation type

    Returns: CreativeVariation


    Functions

    demonstrate_creative_agent()

    Lines 851-1059

    Purpose:

    Demonstrate the creative agent capabilities
    

    Key Concepts Summary

    Pattern Overview

    The Creative Agent pattern provides a structured approach to building AI agents with specific capabilities and behaviors. This implementation leverages LangChain’s composable components to create a robust and maintainable solution.

    Core Components

    1. Agent Class: Main implementation of the pattern logic
    2. Prompt Engineering: Carefully crafted prompts to guide LLM behavior
    3. Tool Integration: Optional tools for extended functionality
    4. Memory Management: State handling across interactions
    5. Output Parsing: Structured response processing

    When to Use

    ✅ Good for: – Scenarios requiring this specific pattern’s strengths – Applications needing structured agent behavior – Systems where explainability is important – Production environments requiring reliability

    ❌ Not ideal for: – Simple single-prompt tasks – Scenarios requiring different pattern characteristics – Resource-constrained environments (if computationally intensive)


    Best Practices Demonstrated

    1. Environment Configuration

    • ✅ Use .env files for API keys
    • ✅ Never hardcode credentials
    • ✅ Validate environment variables on startup

    2. Error Handling

    • ✅ Graceful degradation on failures
    • ✅ Informative error messages
    • ✅ Logging for debugging

    3. Prompt Engineering

    • ✅ Clear, specific instructions
    • ✅ Structured output formats
    • ✅ Few-shot examples when beneficial

    4. Code Organization

    • ✅ Separation of concerns (class-based design)
    • ✅ Type hints for clarity
    • ✅ Docstrings for documentation

    5. Performance Optimization

    • ✅ Appropriate temperature settings
    • ✅ Token budget management
    • ✅ Caching where applicable

    LangChain Components Used

    • ChatOpenAI: OpenAI model interface
    • Chains: Sequential component composition

    Why LangChain? – Composable abstractions for LLM applications – Rich ecosystem of integrations – Production-ready patterns – Active community and development


    Execution Flow

    1. Initialize agent with configuration
       ↓
    2. Load environment and dependencies
       ↓
    3. Prepare prompt with input data
       ↓
    4. Invoke LLM through LangChain
       ↓
    5. Parse and validate response
       ↓
    6. Return formatted result
    

    Key Decision Points: – Model selection (temperature, model type) – Prompt structure (few-shot vs zero-shot) – Error handling strategy – Output format validation


    Performance Considerations

    Computational Cost

    • LLM Calls: Primary cost factor (based on tokens)
    • Latency: Depends on model and input size
    • Memory: Minimal for most patterns

    Optimization Strategies

    1. Prompt Optimization: Minimize tokens while maintaining clarity
    2. Caching: Cache repeated queries/responses
    3. Model Selection: Use smaller models when appropriate
    4. Batch Processing: Group similar requests
    5. Streaming: For long responses, stream tokens

    Cost Estimates (Approximate)

    • GPT-3.5-turbo: ~$0.002 per request
    • GPT-4: ~$0.03 per request
    • GPT-4-turbo: ~$0.01 per request

    Actual costs vary based on input/output token counts


    Common Pitfalls to Avoid

    1. Prompt Design Issues

    ❌ Vague or ambiguous instructions
    ✅ Clear, specific, testable prompts

    2. Error Handling

    ❌ Ignoring API errors or rate limits
    ✅ Implement retry logic and graceful degradation

    3. Token Management

    ❌ Exceeding model token limits
    ✅ Truncate inputs, chunk processing

    4. Security

    ❌ Exposing API keys in code
    ✅ Use environment variables

    5. Testing

    ❌ Only testing happy paths
    ✅ Test edge cases, failures, malformed inputs

    6. Cost Management

    ❌ Unmonitored API usage
    ✅ Implement budgets, alerts, and monitoring


    Further Improvements

    Production Enhancements

    1. Monitoring: Add logging, metrics, tracing
    2. Validation: Input/output schema validation
    3. Rate Limiting: Implement request throttling
    4. Caching: Redis or in-memory cache for responses
    5. Async Support: Non-blocking operations for scalability

    Feature Extensions

    1. Multi-Model Support: Switch between providers
    2. Fallback Models: Graceful degradation strategy
    3. Custom Tools: Domain-specific function calling
    4. Advanced Memory: Vector stores for long-term memory
    5. Evaluation: Automated testing and benchmarking

    Code Quality

    1. Testing: Unit tests, integration tests
    2. Documentation: API docs, usage examples
    3. Type Safety: Stricter type hints
    4. Configuration: Externalized config files

    Related Patterns

    • Pattern 074
    • Pattern 076

    Pattern Families: – Reasoning Patterns (001-011) – Multi-Agent Patterns (012-019) – Tool Use Patterns (020-025) – Memory Patterns (026-031) – And many more…


    Summary

    The Creative Agent pattern provides a powerful approach to building AI agents with specific capabilities. This implementation demonstrates:

    ✅ Key Strengths: – Clean, maintainable code structure – LangChain integration for composability – Type hints and documentation – Production-ready patterns

    🎯 Best Use Cases: – Applications requiring this pattern’s characteristics – Systems needing structured agent behavior – Production environments requiring reliability

    📚 Learning Resources: – LangChain Documentation: https://python.langchain.com/ – Pattern Documentation: See related patterns – OpenAI API Reference: https://platform.openai.com/docs/


    File: 075_creative_agent.py
    Total Lines: 1064
    Pattern Category: AI Agent Design Pattern #075


    Generated from actual implementation code
    For educational and reference purposes