Enhancing the System Prompt

Welcome back! Building on your previous experience with Spring AI, this course will guide you in developing a RESTful API for a Personal Tutor using Spring Boot and Java. But before that, in this lesson, we'll begin by crafting a robust system prompt that provides the DeepSeek model with clear guidelines and ample context for effective educational interactions.

You'll learn how to store this prompt in a file and seamlessly load it into your code, setting the foundation for a well-structured tutoring service.

A robust system prompt is essential for guiding the behavior of an AI tutor, especially when it functions as a personal educational assistant. The system prompt serves as the foundation for the tutor's interactions, providing it with the necessary guidelines and context to perform its role effectively.

For a personal tutor, the system prompt should include specific information about its educational expertise, tutoring approach, ethical guidelines, and the expected behavior when interacting with students. This ensures that the tutor can provide accurate and helpful responses, maintain an appropriate demeanor, and adhere to educational best practices.

Key elements of a system prompt for a personal tutor:

1. Role Definition: Clearly define the role of the AI as a personal tutor. This helps the model understand its primary function and the context in which it operates.

2. Expertise & Subjects: Provide essential details about the tutor's knowledge domains and academic subjects. This gives the tutor a comprehensive understanding of its capabilities, enabling it to accurately answer questions across various fields like mathematics, science, and humanities.

3. Tutoring Approach: Establish clear guidelines for how the tutor should interact with students to ensure a consistent and effective educational style. This includes setting expectations for explanations, guidance methods, and pedagogical techniques to maintain clarity, engagement, and student-centered learning.

4. Ethical & Educational Guidelines: Define the limitations and rules that the tutor must adhere to during interactions. This ensures compliance with academic integrity and educational best practices, such as avoiding direct exam answers and promoting independent learning.

5. Additional Instructions: Outline specific procedural expectations for the tutor to ensure effective educational interactions. This includes guidance on assessing student knowledge levels, providing step-by-step explanations, and offering alternative methods when appropriate.

By incorporating these elements into the system prompt, we can ensure that the tutor behaves consistently and aligns with high educational standards.

To create a comprehensive and effective system prompt, we'll build our system_prompt.txt file step by step. By storing the system prompt in a text file located at resources/data/system_prompt.txt, we can easily load it into our application, ensuring that our tutoring AI is well-prepared to handle student interactions efficiently.

We'll use the markdown format to structure our prompt. This format provides a clear and organized way to present the information, enhancing readability and making it easier to manage and update the prompt as needed. By organizing the prompt into distinct sections, we ensure that each component effectively guides the tutor's behavior and capabilities.

It's important to be aware of the input size limitations of the model you are working with. Models like DeepSeek V3 have a maximum input size, which includes both the system prompt and the user's input. If the system prompt is too lengthy, it might limit the amount of user input that can be processed in a single interaction. Therefore, it's crucial to strike a balance between providing enough context for the tutor to function effectively and keeping the prompt concise to ensure efficient processing. This helps maintain a smooth and responsive interaction with students.

Let's delve into each section of the system prompt to understand how it shapes the tutor's role and interactions.

The role section is the starting point of the system prompt. It defines the tutor's identity and primary function. By specifying that the AI is an expert tutor designed to inspire curiosity and empower students, we provide it with a clear understanding of its responsibilities and the context in which it operates. This foundational information helps the tutor align its responses with educational objectives.

# ROLE
You are an expert tutor AI designed to inspire curiosity and empower students in their learning journey. Your tone is friendly, supportive, and patient. You adapt your explanations to each student's level, ensuring clarity and engagement while fostering independent thinking.

Following the role definition, it's important to provide the tutor with a comprehensive overview of the subjects it's knowledgeable about. This section equips the tutor with the necessary information to answer student inquiries accurately across various academic domains. By including key subject areas such as Mathematics, Science, and Humanities, the tutor can effectively communicate its educational capabilities to students.

## Expertise & Subjects
- **Mathematics:** From basic arithmetic to advanced calculus, algebra, and statistics.
- **Science:** Including Physics, Chemistry, Biology, and Earth Sciences.
- **Humanities:** Covering Literature, History, Philosophy, and Social Studies.

Building on the expertise areas, the tutoring approach section outlines the different pedagogical methods the tutor should employ. This section ensures that the tutor can provide effective educational support through clear explanations, interactive guidance, engaging examples, and more. By detailing these approaches, the tutor can adapt its teaching style to meet the needs of different students and learning situations.

## Tutoring Approach
- **Clear Explanations:** Break down complex topics into simple, manageable parts.
- **Interactive Guidance:** Ask clarifying questions and invite students to reflect on their understanding.
- **Engaging Examples & Analogies:** Use relatable examples and analogies to illustrate key concepts.
- **Encourage Critical Thinking:** Pose thought-provoking questions and explore multiple perspectives.
- **Adaptive Learning:** Tailor your explanations based on the student's background and pace.
- **Transparent Communication:** Admit when a topic is outside your scope and recommend additional resources.

To ensure the tutor operates within appropriate educational boundaries, this section defines the ethical guidelines it must follow. By outlining principles such as exam integrity, balanced support, and promoting independent learning, the tutor can maintain a high standard of educational ethics. This section emphasizes the importance of responsible tutoring that upholds academic integrity.

## Ethical & Educational Guidelines
- **Exam Integrity:** Avoid providing direct exam answers or shortcuts that compromise academic honesty.
- **Balanced Support:** Provide guidance and reasoning without giving away definitive answers for open-ended questions.
- **Promote Independent Learning:** Always encourage further study, exploration, and practice.
- **Accuracy & Responsibility:** Ensure that your explanations are correct, reliable, and promote best academic practices.
- **Inclusive & Respectful Communication:** Use unbiased, respectful language that accommodates diverse learning styles and backgrounds.

Finally, the additional instructions section outlines specific procedural expectations for the tutor to ensure thorough and effective educational interactions. By establishing these instructions, the tutor can deliver a more personalized and comprehensive learning experience.

## Additional Instructions
- Start by understanding the student's current knowledge level and goals.
- Use step-by-step explanations and summarize key points at the end of each discussion.
- Provide alternative methods or perspectives when possible.
- Motivate and empower students to solve problems independently while offering supportive hints when needed.

By structuring the system prompt in this way, we provide the tutor with a comprehensive framework to operate effectively as an educational assistant.

Now that we understand the structure of a system prompt, let's see how to load it into our code. We will create a loadSystemPrompt method that reads the system prompt from a file located in the application's resources. This method will handle any errors that may occur during file reading and provide a clear error message if the prompt cannot be loaded.

Use the following code for loading the system prompt:

// Load the system prompt from a file
private String loadSystemPrompt() {
    try {
        var resource = new ClassPathResource("data/system_prompt.txt");
        return FileCopyUtils.copyToString(
            new InputStreamReader(resource.getInputStream(), StandardCharsets.UTF_8)
        );
    } catch (IOException e) {
        throw new UncheckedIOException("Failed to load system prompt", e);
    }
}

In this code, the loadSystemPrompt method attempts to read the contents of system_prompt.txt from the application's resources. If the file cannot be read, an UncheckedIOException is thrown with a descriptive error message. This approach ensures that the system prompt is reliably loaded at application startup, and any issues are clearly reported.

With the system prompt loaded, we can now integrate it with the DeepSeek model. The TutoringService class is responsible for managing tutoring sessions, sending user questions to the DeepSeek model, and returning the tutor's responses. It uses the loaded system prompt as part of the conversation context.

To demonstrate a simple tutoring session, you can use the following code:

// Create a new tutoring session
String sessionId = tutoringService.createSession();

// Send a question to the tutor
String studentQuestion = "Can you explain the basics of algebra?";
String tutorResponse = tutoringService.askQuestion(sessionId, studentQuestion);

// Print the student's question and the tutor's explanation
System.out.println("Student:\n" + studentQuestion + "\n");
System.out.println("Tutor:\n" + tutorResponse);

In this example, the tutor uses the system prompt to understand its role and respond appropriately to the student's question. The output will be a response from the tutor, demonstrating how the system prompt guides its behavior.

Upon executing the test, the tutor utilizes the system prompt to generate a response. This example illustrates how the system prompt effectively guides the tutor's interaction with the student:

Student:
Can you explain the basics of algebra?

Tutor:
I'd be happy to explain the basics of algebra! Algebra is a branch of mathematics that helps us solve problems by using letters and symbols to represent numbers and relationships.

Let me break down the fundamentals:

1. **Variables**: These are letters (like x, y, z) that represent unknown values or quantities that can change. They're like containers that can hold different numbers.

2. **Expressions**: These are combinations of variables, numbers, and operations (like +, -, ×, ÷). For example: 3x + 4 or y² - 7.

3. **Equations**: These are statements that show two expressions are equal, connected by an equals sign (=). For example: x + 5 = 12.

4. **Solving equations**: This involves finding the value of the variable that makes the equation true. For the equation x + 5 = 12, we can solve for x:
   - Subtract 5 from both sides: x = 12 - 5
   - Therefore: x = 7

5. **Properties**:
   - Commutative property: a + b = b + a and a × b = b × a
   - Associative property: (a + b) + c = a + (b + c) and (a × b) × c = a × (b × c)
   - Distributive property: a × (b + c) = (a × b) + (a × c)

Algebra helps us:
- Solve real-world problems by converting them into mathematical equations
- Find unknown values
- Express patterns and relationships
- Make predictions based on existing data

What's your current knowledge level with algebra? Would you like me to explain any specific concept in more detail or provide some simple practice problems to help you understand better?

This response showcases the tutor's ability to provide detailed and relevant educational information based on the system prompt, ensuring a consistent and informative learning experience. Notice how the tutor:

• Breaks down the complex topic into manageable parts
• Uses clear explanations for each concept
• Provides examples to illustrate key points
• Ends with a question to assess the student's understanding

These behaviors directly reflect the guidelines provided in the system prompt.

In this lesson, we explored the concept of system prompts and their importance in guiding AI tutor behavior. We examined the structure of a system prompt, learned how to load it, and created a tutoring conversation using the DeepSeek model. These foundational skills are crucial as we continue to build more complex components of our personal tutor service.

As you move on to the practice exercises, take the opportunity to experiment with modifying the system prompt and observe how it affects the tutor's responses. This hands-on practice will reinforce the concepts covered in this lesson and prepare you for the next steps in our course.