softcreatr/php-openai-sdk

A powerful and easy-to-use PHP SDK for the OpenAI API, allowing seamless integration of advanced AI-powered features into your PHP projects.

Maintainers

Details

github.com/SoftCreatR/php-openai-sdk

Source

Issues

Fund package maintenance!
softcreatr
ecologi.com/softcreatr?r=61212ab3fc69b8eb8a2014f4

Installs: 732

Dependents: 0

Suggesters: 0

Security: 0

Stars: 8

Watchers: 2

Forks: 2

Open Issues: 0

3.0.0 2024-10-10 08:26 UTC

Requires

Requires (Dev)

ISC c73885feb0f85211cbcb6493a036dd6bbc446a14

  • Sascha Greuel <hello.woop@1-2.dev>

phpsdknlpapi-wrappermachine-learningnatural-language-processingartificial-intelligenceGPT-3openaigptgpt-4gpt-o1

This package is auto-updated.

Last update: 2025-03-26 08:13:01 UTC

README

Build Latest Release ISC licensed Plant Tree Codecov branch Code Climate maintainability

This PHP library provides a simple wrapper for the OpenAI API, allowing you to easily integrate the OpenAI API into your PHP projects.

Features

  • Easy integration with OpenAI API
  • Supports all OpenAI API endpoints
  • Streaming support for real-time responses in chat completions
  • Utilizes PSR-17 and PSR-18 compliant HTTP clients and factories for making API requests

Requirements

Installation

You can install the library via Composer:

composer require softcreatr/php-openai-sdk

Usage

First, include the library in your project:

<?php

require_once 'vendor/autoload.php';

Then, create an instance of the OpenAI class with your API key, organization (optional), an HTTP client, an HTTP request factory, and an HTTP stream factory:

use SoftCreatR\OpenAI\OpenAI;

$apiKey = 'your_api_key';
$organization = 'your_organization_id'; // optional

// Replace these lines with your chosen PSR-17 and PSR-18 compatible HTTP client and factories
$httpClient = new YourChosenHttpClient();
$requestFactory = new YourChosenRequestFactory();
$streamFactory = new YourChosenStreamFactory();
$uriFactory = new YourChosenUriFactory();

$openAI = new OpenAI($requestFactory, $streamFactory, $uriFactory, $httpClient, $apiKey, $organization);

Now you can call any supported OpenAI API endpoint using the magic method __call:

$response = $openAI->createChatCompletion([
    'model' => 'gpt-4',
    'messages' => [
        ['role' => 'system', 'content' => 'You are a helpful assistant.'],
        ['role' => 'user', 'content' => 'Hello!'],
    ],
]);

// Process the API response
if ($response->getStatusCode() === 200) {
    $responseObj = json_decode($response->getBody()->getContents(), true);

    print_r($responseObj);
} else {
    echo "Error: " . $response->getStatusCode();
}

Streaming Example

You can enable real-time streaming for chat completions:

$streamCallback = static function ($data) {
    if (isset($data['choices'][0]['delta']['content'])) {
        echo $data['choices'][0]['delta']['content'];
    }
};

$openAI->createChatCompletion(
    [
        'model' => 'gpt-4',
        'messages' => [
            [
                'role' => 'user',
                'content' => 'Tell me a story about a brave knight.',
            ],
        ],
        'stream' => true,
    ],
    $streamCallback
);

For more details on how to use each endpoint, refer to the OpenAI API documentation, and the examples provided in the repository.

Supported Methods

Below is a list of supported methods organized by category. Each method links to its corresponding OpenAI API documentation and includes a link to an example in this repository.

Audio

Chat

Embeddings

Fine-tuning

Batch

Files

Uploads

Images

Models

Moderations

Assistants

Assistants

Threads

Messages

Runs

Run Steps

Vector Stores

Vector Store Files

Vector Store File Batches

  • Create Vector Store File Batch - API Reference - Example
    • createVectorStoreFileBatch(array $parameters, array $options = [])
  • Retrieve Vector Store File Batch - API Reference - Example
    • retrieveVectorStoreFileBatch(array $parameters)
  • Cancel Vector Store File Batch - API Reference - Example
    • cancelVectorStoreFileBatch(array $parameters)
  • List Vector Store Files in Batch - API Reference - Example
    • listVectorStoreFilesInBatch(array $parameters)

Administration

Invites

Users

Projects

Project Users

Project Service Accounts

  • List Project Service Accounts - API Reference - Example
    • listProjectServiceAccounts(array $parameters)
  • Create Project Service Account - API Reference - Example
    • createProjectServiceAccount(array $parameters, array $options = [])
  • Retrieve Project Service Account - API Reference - Example
    • retrieveProjectServiceAccount(array $parameters)
  • Delete Project Service Account - API Reference - Example
    • deleteProjectServiceAccount(array $parameters)

Project API Keys

Audit Logs

Changelog

For a detailed list of changes and updates, please refer to the CHANGELOG.md file. We adhere to Semantic Versioning and document notable changes for each release.

Known Problems and Limitations

Streaming Support

Streaming is now supported for real-time token generation in chat completions. Please make sure you are handling streams correctly using a callback, as demonstrated in the examples.

License

This library is licensed under the ISC License. See the LICENSE file for more information.

Maintainers 🛠️

Sascha Greuel
Sascha Greuel

Contributors ✨