Building the Tutor Service Layer for a Personal Tutor Application

Building the Tutor Service Layer

In the previous lesson, we explored the SessionManager class, which plays a crucial role in managing tutoring session data within our application. Now, we will take the next step in our journey by building the Tutor Service Layer . This layer is essential for integrating the DeepSeek language model with tutoring sessions, allowing us to process student queries and generate tailored explanations. By the end of this lesson, you will understand how to set up the TutorService class, create tutoring sessions, and process academic questions using DeepSeek models via the OpenAI SDK . The service layer acts as a bridge between the model layer, where data is managed, and the AI model, which generates educational responses. It is responsible for orchestrating the flow of data and ensuring that student interactions are handled effectively. Let's dive into the details of setting up this important component.

Setting Up the TutorService Class

The TutorService class is the heart of our service layer. It is responsible for managing tutoring sessions and interacting with the DeepSeek model to generate educational responses. To begin, we need to set up the class and its components. First, we import the necessary modules, including the SessionManager from our previous lesson and the OpenAI client (which we'll use to access DeepSeek models). We also use the uuid module to generate unique session IDs. Here's how the class is initialized: Python import uuid from openai import OpenAI from models.session import SessionManager class TutorService: def __init__(self): self.session_manager = SessionManager() self.deepseek_client = OpenAI() self.system_prompt = self.load_system_prompt('data/system_prompt.txt') In this setup, we instantiate SessionManager to manage tutoring data, initialize the OpenAI client for DeepSeek model access, and load the system_prompt using the same load_system_prompt method we implemented in Unit 1 .

Loading the System Prompt

The system prompt is a crucial component that guides the tutor AI's responses. It provides context and instructions for the AI, ensuring that it behaves like an effective educational assistant. Let's quickly recap the load_system_prompt method we implemented earlier, which loads the prompt from a file: Pythondef load_system_prompt(self, file_path: str) -> str: """Load the tutor system prompt from file.""" try: with open(file_path, 'r') as f: return f.read() except Exception as e: print(f"Error loading system prompt: {e}") return "You are a helpful tutor."

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Processing Student Queries

The process_query method is where the educational magic happens. It processes student questions, interacts with the DeepSeek model to generate tutoring explanations, and updates the session history. Below, we outline the steps involved in this process, followed by the corresponding code implementation:

Retrieve the session using get_session, and raise an error if the session is not found.
Add the student's query to the session history.
Send the conversation, including the system prompt and all previous exchanges, to the DeepSeek model to generate a response.
Add the tutor's explanation to the session history and return it to the student.
Handle any errors with the AI client gracefully.

Python

def process_query(self, student_id: str, session_id: str, query: str) -> str:
    """Process a student query and provide a tutoring explanation."""
    
    # Step 1: Retrieve the session
    session = self.session_manager.get_session(student_id, session_id)
    if not session:
        raise ValueError("Session not found")
    
    # Step 2: Add student's query to session
    self.session_manager.add_message(student_id, session_id, "user", query)
    
    try:
        # Step 3: Get tutor response
        conversation = self.session_manager.get_conversation(student_id, session_id)
        
        response = self.deepseek_client.chat.completions.create(
            model="deepseek-ai/DeepSeek-V3",
            messages=conversation,
            temperature=0.6,
            max_tokens=500
        )
        
        tutor_response = response.choices[0].message.content.strip()
        
        # Step 4: Add tutor's explanation to session history
        self.session_manager.add_message(student_id, session_id, "assistant", tutor_response)
        
        return tutor_response
        
    except Exception as e:
        # Step 5: Handle errors
        raise RuntimeError(f"Error getting tutor response: {str(e)}")

def process_query(self, student_id: str, session_id: str, query: str) -> str:
    """Process a student query and provide a tutoring explanation."""
    
    # Step 1: Retrieve the session
    session = self.session_manager.get_session(student_id, session_id)
    if not session:
        raise ValueError("Session not found")
    
    # Step 2: Add student's query to session
    self.session_manager.add_message(student_id, session_id, "user", query)
    
    try:
        # Step 3: Get tutor response
        conversation = self.session_manager.get_conversation(student_id, session_id)
        
        response = self.deepseek_client.chat.completions.create(
            model="deepseek-ai/DeepSeek-V3",
            messages=conversation,
            temperature=0.6,
            max_tokens=500
        )
        
        tutor_response = response.choices[0].message.content.strip()
        
        # Step 4: Add tutor's explanation to session history
        self.session_manager.add_message(student_id, session_id, "assistant", tutor_response)
        
        return tutor_response
        
    except Exception as e:
        # Step 5: Handle errors
        raise RuntimeError(f"Error getting tutor response: {str(e)}")

In the context of a personal tutor, we configure our DeepSeek model with specific parameters to optimize its educational performance. The temperature is set to 0.6, which balances accuracy and creativity in the tutor's explanations, ensuring they are both informative and engaging. The max_tokens is set to 500, allowing the model to provide detailed educational content without overwhelming the student, thus maintaining an effective learning experience.

Example: Simulating a Tutoring Session

Let's see the TutorService in action by simulating a tutoring session. We'll create a script to initialize a tutoring session and process a student's academic query.

Python

from services.tutor_service import TutorService

# Initialize the tutor service
tutor_service = TutorService()

# Simulate a student ID
student_id = "student123"

# Create a new tutoring session
session_id = tutor_service.create_session(student_id)
print(f"Tutoring session created with ID: {session_id}")

# Simulate sending a tutoring query
student_query = "Can you explain the principles of supply and demand in economics?"

try:
    tutor_response = tutor_service.process_query(student_id, session_id, student_query)
    print(f"Tutor Response: {tutor_response}")
except Exception as e:
    print(f"Error: {e}")

from services.tutor_service import TutorService

# Initialize the tutor service
tutor_service = TutorService()

# Simulate a student ID
student_id = "student123"

# Create a new tutoring session
session_id = tutor_service.create_session(student_id)
print(f"Tutoring session created with ID: {session_id}")

# Simulate sending a tutoring query
student_query = "Can you explain the principles of supply and demand in economics?"

try:
    tutor_response = tutor_service.process_query(student_id, session_id, student_query)
    print(f"Tutor Response: {tutor_response}")
except Exception as e:
    print(f"Error: {e}")

In this example, we initialize the TutorService, simulate a student ID, and create a new tutoring session, printing the session ID. We then simulate sending an economics question and print the tutor's response, demonstrating the flow from student query to tutoring explanation and showcasing the functionality of the TutorService.

text

Tutoring session created with ID: 01a17870-8a4f-4b6f-a3ce-f04e1136d597
Tutor Response: Supply and demand are fundamental principles in economics that describe how prices are determined in a market economy. Let me explain each concept and how they interact:

1. Supply: This refers to the quantity of a good or service that producers are willing and able to offer for sale at various price points. 
   - The law of supply states that as the price of a good increases, the quantity supplied also increases (and vice versa).
   - This creates an upward-sloping supply curve when plotted on a graph with price on the vertical axis and quantity on the horizontal axis.

2. Demand: This refers to the quantity of a good or service that consumers are willing and able to purchase at various price points.
   - The law of demand states that as the price of a good increases, the quantity demanded decreases (and vice versa).
   - This creates a downward-sloping demand curve on the same type of graph.

3. Market Equilibrium: This occurs at the intersection of the supply and demand curves.
   - At this point, the quantity that producers want to supply exactly equals the quantity that consumers want to buy.
   - The price at this intersection is called the equilibrium price, and the quantity is called the equilibrium quantity.

4. Price Mechanism: When markets are not in equilibrium, the price acts as a signal:
   - If price is above equilibrium, there's a surplus (excess supply), which puts downward pressure on prices.
   - If price is below equilibrium, there's a shortage (excess demand), which puts upward pressure on prices.

5. Shifts in Supply and Demand: Various factors can cause entire curves to shift:
   - Supply shifters include technology, input costs, number of sellers, and expectations.
   - Demand shifters include income, preferences, number of buyers, and expectations.

These principles help explain how markets allocate resources efficiently and how changes in market conditions affect prices and quantities.

Does this explanation help? Would you like me to elaborate on any specific aspect of supply and demand?

Tutoring session created with ID: 01a17870-8a4f-4b6f-a3ce-f04e1136d597
Tutor Response: Supply and demand are fundamental principles in economics that describe how prices are determined in a market economy. Let me explain each concept and how they interact:

1. Supply: This refers to the quantity of a good or service that producers are willing and able to offer for sale at various price points. 
   - The law of supply states that as the price of a good increases, the quantity supplied also increases (and vice versa).
   - This creates an upward-sloping supply curve when plotted on a graph with price on the vertical axis and quantity on the horizontal axis.

2. Demand: This refers to the quantity of a good or service that consumers are willing and able to purchase at various price points.
   - The law of demand states that as the price of a good increases, the quantity demanded decreases (and vice versa).
   - This creates a downward-sloping demand curve on the same type of graph.

3. Market Equilibrium: This occurs at the intersection of the supply and demand curves.
   - At this point, the quantity that producers want to supply exactly equals the quantity that consumers want to buy.
   - The price at this intersection is called the equilibrium price, and the quantity is called the equilibrium quantity.

4. Price Mechanism: When markets are not in equilibrium, the price acts as a signal:
   - If price is above equilibrium, there's a surplus (excess supply), which puts downward pressure on prices.
   - If price is below equilibrium, there's a shortage (excess demand), which puts upward pressure on prices.

5. Shifts in Supply and Demand: Various factors can cause entire curves to shift:
   - Supply shifters include technology, input costs, number of sellers, and expectations.
   - Demand shifters include income, preferences, number of buyers, and expectations.

These principles help explain how markets allocate resources efficiently and how changes in market conditions affect prices and quantities.

Does this explanation help? Would you like me to elaborate on any specific aspect of supply and demand?

This output illustrates a successful tutoring interaction where a new session is created, and the AI responds to the student's economics question with a comprehensive explanation. The tutor's response demonstrates the system's ability to provide relevant, structured, and educational content, showcasing how the DeepSeek model can be effectively used for personalized academic support.