Sending a Simple Message to OpenAI Using PHP

Sending a Simple Message to OpenAI

Welcome to the first lesson of our course on creating a chatbot with OpenAI . In this lesson, we will explore the basics of interacting with OpenAI's API, which is a powerful tool for building chatbots. OpenAI provides advanced language models that can understand and generate human-like text, making it an excellent choice for chatbot development. Our goal in this lesson is to send a simple message to OpenAI's language model and receive a response. This foundational step will set the stage for more complex interactions in future lessons.

Setting Up Your Environment

Before we can send a message to OpenAI, we need to set up our development environment. This involves installing the necessary tools and libraries. For this course, you will need the openai-php/client library, which allows us to interact with OpenAI's API. To install this library, you can use the following command in your terminal: Shell composer require openai-php/client composer require openai-php/client If you are following the course on CodeSignal, the library is already installed, so you can focus on writing and running your code without worrying about installation.

Setting the OpenAI API Key as an Environment Variable

In this course, you'll be using a coding environment where we've already set up everything you need to start working with OpenAI models. This means you don't need to worry about setting up an API key or configuring environment variables — it's all taken care of for you. However, it's still useful to understand how this process works in case you want to set it up on your own server in the future. To work with OpenAI models outside of a pre-configured environment, you need to set up a payment method and obtain an API key from their website. This API key is essential for accessing OpenAI's services and making requests to their API. To keep your API key secure, you can use a .env file or server configuration. Here's how you can do it using a .env file: Create a file named .env in the root of your project. Add the following line to the .env file: OPENAI_API_KEY=your_api_key_hereOPENAI_API_KEY=your_api_key_here Use a library like vlucas/phpdotenv to load the environment variables in your PHP script: PHPrequire 'vendor/autoload.php'; $dotenv = Dotenv\Dotenv::createImmutable(__DIR__); $dotenv->load();require 'vendor/autoload.php'; $dotenv = Dotenv\Dotenv::createImmutable(__DIR__); $dotenv->load(); This approach helps keep your key safe and secure.

Initializing the OpenAI Client

Once the environment variable is set, you can initialize the OpenAI client in your script. This is done by using the OpenAI\Client class from the openai-php/client library and then creating an instance of it. Here’s how you do it: PHPrequire 'vendor/autoload.php'; $apiKey = $_ENV['OPENAI_API_KEY'] ?? getenv('OPENAI_API_KEY'); $baseUrl = $_ENV['OPENAI_BASE_URI'] ?? getenv('OPENAI_BASE_URI'); // Initialize the OpenAI client $client = \OpenAI::factory() ->withApiKey($apiKey) ->withBaseUri($baseUrl) ->make(); By initializing the client in this manner, you ensure that your script is ready to authenticate requests to OpenAI's API securely.

Sending Your First Message to OpenAI

Now that your environment is set up and your API client is configured, it's time to send your first message to OpenAI. We'll start by defining a simple user prompt and then use the chat method to send this message to the AI model. Here's the code to accomplish this: PHP // Define a simple user message to test the API $prompt = "Hi, can you tell me a joke?"; // Create a chat completion request to get the AI response $response = $client->chat()->create(['model' => 'gpt-4','messages' => [['role' => 'user', 'content' => $prompt]]]); In this code, we define a user prompt asking the AI to tell a joke. The chat method of the Client is used to send a message to the AI model and receive a response. It takes some basic parameters to function: The model parameter specifies which AI model to use for generating the response. In this example, we use "gpt-4", which is a version of OpenAI's language model known for its advanced text understanding and generation capabilities. The messages parameter is an array of associative arrays where each array represents a message in the conversation. Each array must include a "role", which indicates the role of the message sender, such as "user" for the person interacting with the AI, and "content", which contains the actual text of the message.

Understanding OpenAI Response

When you send a request to OpenAI's API, it returns a structured JSON response. Below is an example: JSON{ "id": "chatcmpl-12345", "object": "chat.completion", "created": 1677652284, "model": "gpt-4", "choices": [ { "index": 0, "message": { "role": "assistant", "content": "Why don't scientists trust atoms? Because they make up everything!" }, "finish_reason": "stop" } ], "usage": { "prompt_tokens": 10, "completion_tokens": 20, "total_tokens": 30 } }{ "id": "chatcmpl-12345", "object": "chat.completion", "created": 1677652284, "model": "gpt-4", "choices": [ { "index": 0, "message": { "role": "assistant", "content": "Why don't scientists trust atoms? Because they make up everything!" }, "finish_reason": "stop" } ], "usage": { "prompt_tokens": 10, "completion_tokens": 20, "total_tokens": 30 } }

Key Fields

choices : Contains the AI's response. message : Holds the AI-generated message. role : Indicates the sender (assistant). content : The AI's response text. finish_reason : Explains why the response ended (e.g., stop means the AI completed its reply naturally). usage : Tracks token consumption. prompt_tokens : Number of tokens used in the input message. completion_tokens : Number of tokens in the AI's response. total_tokens : Sum of both, useful for monitoring API usage and costs.

Extracting and Displaying the AI's Reply

After sending the message to OpenAI, the next step is to extract the AI's reply from the API response and display it. Here's how you can do that: PHP// Extract the AI's response from the API result $reply = trim($response['choices'][0]['message']['content']); // Show both sides of the conversation echo "Prompt: $prompt\n"; echo "Response: $reply\n"; Once the create method is called, it returns a response array. To extract the AI's reply, you need to access the choices array from the response, which contains possible responses generated by the AI. You then select the first choice with choices[0] and retrieve the message content using message['content'], trimming any extra spaces or newlines. Finally, we print both the prompt and the AI's reply to see the interaction. This helps verify that the message was successfully sent and received. When you run this code, you should see an output similar to the following: textPrompt: Hi, can you tell me a joke? Response: Why don't scientists trust atoms? Because they make up everything! This output demonstrates a successful interaction with the AI, where it responds to the user's prompt with a joke.

Example: Full Code Implementation

Let's look at the complete code example for sending a message to OpenAI. This example includes all the steps we've discussed so far: PHP<?php require 'vendor/autoload.php'; use Dotenv\Dotenv; // Load environment variables $dotenv = Dotenv::createImmutable(__DIR__); $dotenv->load(); // Fetch the api key $apiKey = $_ENV['OPENAI_API_KEY'] ?? getenv('OPENAI_API_KEY'); $baseUrl = $_ENV['OPENAI_BASE_URI'] ?? getenv('OPENAI_BASE_URI'); // Initialize the OpenAI client $client = \OpenAI::factory() ->withApiKey($apiKey) ->withBaseUri($baseUrl) ->make(); // Define a simple user message to test the API $prompt = "Hi, can you tell me a joke?"; // Create a chat request to get the AI response $response = $client->chat()->create([ 'model' => 'gpt-4', 'messages' => [ ['role' => 'user', 'content' => $prompt] ] ]); // Extract the AI's response from the API result $reply = trim($response['choices'][0]['message']['content']); // Show both sides of the conversation echo "Prompt: $prompt\n"; echo "Response: $reply\n";

Summary and Next Steps

In this lesson, we covered the essential steps to send a simple message to OpenAI's language model. We set up our environment, configured API access, and sent a message to receive a response. This foundational knowledge is crucial as we move forward in building more complex chatbot interactions. As you proceed to the practice exercises, I encourage you to experiment with different prompts and explore the AI's responses. This hands-on practice will reinforce what you've learned and prepare you for the next unit, where we'll delve deeper into handling API parameters. Keep up the great work, and enjoy the journey of creating your chatbot with OpenAI!

Next Lesson: Exploring Model Parameters in PHP

Join the 1M+ learners on CodeSignal

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