Handling AI Interactions with the Chat Service Layer
In the previous lesson, we explored the ChatManager class, which plays a crucial role in managing chat data within our application. Now, we will take the next step in our journey by building the chat service layer. This layer is essential for integrating the language model with chat sessions, allowing us to process user messages and generate AI responses. By the end of this lesson, you will understand how to set up the ChatService class, create chat sessions, and process messages using OpenAI's PHP client.
The service layer acts as a bridge between the model layer, where data is managed, and the AI model, which generates responses. It is responsible for orchestrating the flow of data and ensuring that user interactions are handled smoothly. Let's dive into the details of setting up this important component.
Setting Up the ChatService Class
Loading the System Prompt
Creating a New Chat Session
Processing User Messages
Example: Simulating a Chat Session
Summary and Next Steps
In this lesson, we explored the ChatService class and its role in integrating OpenAI's language model with chat sessions. We learned how to set up the class, load the system prompt, create chat sessions, and process user messages. The service layer is a vital component of our chatbot application, ensuring that user interactions are handled smoothly and efficiently.
As you move on to the practice exercises, take the opportunity to experiment with the ChatService functionality. This hands-on practice will reinforce the concepts covered in this lesson and prepare you for the next steps in our course. Keep up the great work, and I look forward to seeing your progress!
Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal
The ChatService class is the heart of our service layer. It is responsible for managing chat sessions and interacting with OpenAI’s API to generate AI responses. To begin, we need to set up the class and its components.
First, we import the necessary classes, including the ChatManager from our previous lesson and OpenAI's PHP client. Here's how the class is initialized:
PHP
<?phpnamespace App\Services;use App\Models\ChatManager;use OpenAI;class ChatService { private ChatManager $chatManager; private OpenAI\Client $openai; private string $systemPrompt; public function __construct() { $this->chatManager = new ChatManager(); // Load OpenAI API key from environment variables $apiKey = $_ENV['OPENAI_API_KEY'] ?? getenv('OPENAI_API_KEY'); $baseUrl = $_ENV['OPENAI_BASE_URI'] ?? getenv('OPENAI_BASE_URI'); // Initialize the OpenAI client $this->openai = OpenAI::factory() ->withApiKey($apiKey) ->withBaseUri($baseUrl) ->make(); $this->systemPrompt = $this->loadSystemPrompt(__DIR__ . '/../data/system_prompt.txt'); }}
In this setup, we instantiate ChatManager to manage chat data, initialize the OpenAI client, and load the systemPrompt using the loadSystemPrompt method.
The system prompt is a crucial component that guides the AI’s responses. It provides context and instructions for the AI, ensuring that it behaves in a manner consistent with our application's goals. Here’s how we implement the loadSystemPrompt method:
PHP
private function loadSystemPrompt(string $filePath): string { return file_exists($filePath) ? file_get_contents($filePath) : "You are a helpful assistant.";}
This method attempts to read the system prompt from a specified file path. If successful, it returns the prompt as a string. In case of an error, it prints an error message and returns a default prompt. This ensures that the application can continue functioning even if the file is missing or corrupted.
Creating a new chat session is a fundamental task of the ChatService. The createChat method is responsible for generating a unique chat ID and initializing a chat session using the ChatManager.
PHP
public function createChat($userId) { $chatId = uniqid(); $this->chatManager->createChat($userId, $chatId, $this->systemPrompt); return $chatId;}
In this method, we generate a unique chatId using PHP's uniqid() function. We then call the createChat method of ChatManager, passing the userId, chatId, and systemPrompt. This initializes a new chat session, which is ready to receive messages.
he processMessage method is where the magic happens. It processes user messages, interacts with the OpenAI client to generate responses, and updates the chat history. Below, we outline the steps involved in this process, followed by the corresponding code implementation:
Retrieve the chat using getChat, and raise an error if the chat is not found.
Add the user's message to the chat history.
Send the conversation, including the system prompt and all messages, to the AI client to generate a response.
Add the AI's response to the chat history and return it to the user.
Handle any errors with the AI client gracefully.
PHP
public function processMessage($userId, $chatId, $message) { // Retrieve the chat $chat = $this->chatManager->getChat($userId, $chatId); if (!$chat) { throw new \Exception("Chat not found"); } // Add user message to chat history $this->chatManager->addMessage($userId, $chatId, "user", $message); try { // Get AI response from OpenAI $conversation = $this->chatManager->getConversation($userId, $chatId); $response = $this->openai->chat()->create([ 'model' => 'gpt-4', 'messages' => $conversation, ]); $aiMessage = $response['choices'][0]['message']['content'] ?? "I'm sorry, I couldn't generate a response."; // Add AI response to chat history $this->chatManager->addMessage($userId, $chatId, "assistant", $aiMessage); return $aiMessage; } catch (\Exception $e) { throw new \RuntimeException("Error getting AI response: " . $e->getMessage()); }}
In the context of a customer service agent, we configure our model with specific parameters to optimize its performance. The OpenAI client is assumed to handle these configurations internally, ensuring responses are both engaging and relevant.
Let's see the ChatService in action by simulating a chat session. We'll use a PHP script to create a chat session and process a user message.
PHP
<?phprequire 'vendor/autoload.php';use App\Services\ChatService;// Initialize the chat service$chatService = new ChatService();// Simulate a user ID$userId = "user123";// Create a new chat session$chatId = $chatService->createChat($userId);echo "Chat session created with ID: $chatId\n";// Simulate sending a message$userMessage = "Hello, how are you?";try { $aiResponse = $chatService->processMessage($userId, $chatId, $userMessage); echo "AI Response: $aiResponse\n";} catch (Exception $e) { echo "Error: " . $e->getMessage() . "\n";}
In this example, we initialize the ChatService, simulate a user ID, and create a new chat session, printing the chat ID. We then simulate sending a message and print the AI's response, demonstrating the flow from user input to AI response and showcasing the functionality of the ChatService.
text
Chat session created with ID: 01a178708a4f4b6fa3cef04e1136d597AI Response: Hello! I'm here to help with any questions or concerns you might have regarding our IT services. How can I assist you today?
This output illustrates a successful interaction where a new chat session is created, and the AI responds to the user's greeting with a helpful message. The AI's response is tailored to assist with IT services, showcasing the system's ability to provide relevant and context-aware assistance.
