FriendsOfHyperf

English

中文

English

中文

Appearance

OpenAI Client ​

OpenAI PHP for Laravel is a powerful community PHP API client that allows you to interact with the Open AI API.

Note: This repository contains the Hyperf integration code for OpenAI PHP. If you want to use the OpenAI PHP client in a framework-agnostic way, check out the openai-php/client repository.

Quick Start ​

Requires PHP 8.1+

First, install OpenAI via the Composer package manager:

shell
composer require friendsofhyperf/openai-client

Next, publish the configuration file:

shell
php bin/hyperf.php vendor:publish friendsofhyperf/openai-client

This will create a config/autoload/openai.php configuration file in your project that you can modify as needed using environment variables:

env
OPENAI_API_KEY=sk-...

Finally, you can use the OpenAI\Client instance from the container to access the OpenAI API:

php
use OpenAI\Client;

$result = di(OpenAI\Client::class)->completions()->create([
    'model' => 'text-davinci-003',
    'prompt' => 'PHP is',
]);

echo $result['choices'][0]['text']; // an open-source, widely-used, server-side scripting language.

Azure ​

To use Azure OpenAI Service, you must manually build the client using the factory.

php
$client = OpenAI::factory()
    ->withBaseUri('{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}')
    ->withHttpHeader('api-key', '{your-api-key}')
    ->withQueryParam('api-version', '{version}')
    ->make();

For Azure usage, you must deploy a model which is identified by the {deployment-id} that is integrated into the API call. Therefore, you don't have to provide the model during the call as it's already included in the BaseUri.

Thus, a basic example completion call would be:

php
$result = $client->completions()->create([
    'prompt' => 'PHP is'
]);

Official Guide ​

For usage examples, please check out the openai-php/client repository.