Initial commit

Author: sentosango

.env.example

@@ -0,0 +1 @@
+OPENAI_BASE_URL=https://api.openai.com

.gitignore

@@ -0,0 +1,5 @@
+/vendor/
+/references/
+/debug/
+/.env
+composer.lock

LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) sentosango
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,81 @@
+# PHP client for OpenAI API.
+
+This is a PHP client for the OpenAI API.
+
+## Installation
+
+Install the package via composer:
+
+```bash
+composer require php-client/openai
+```
+
+## Usage
+
+```php
+use PhpClient\OpenAI\OpenAI;
+
+$syncthing = new OpenAI(
+    baseUrl: 'https://api.openai.com',
+    token: 'YOUR_API_TOKEN',
+);
+
+$response = $syncthing->api->chat()->createChatCompletion(
+    model: 'gpt-4o',
+    messages: [
+        ['role' => 'user', 'content' => 'Hello'],
+    ],
+);
+
+echo $response->json(key: 'choices.0.message.content');
+
+// or
+
+foreach ($response->json(key: 'choices') as $choice) {
+    echo $choice['message']['content'];
+}
+
+```
+
+## List of available API methods
+
+- Audio
+    - Create speech|transcription|translation
+- Chat
+    - Create chat completion
+- Embeddings
+    - Create embeddings
+- Fine-tuning
+    - Create|Retrieve|Cancel fine-tuning job
+    - List fine-tuning jobs|events|checkpoints
+- Batch
+    - Create|Retrieve|Cancel|List batch
+- Files
+    - List files
+    - Upload|Retrieve|Delete file
+    - Retrieve file content
+- Uploads
+    - Create|Complete|Cancel upload
+    - Add upload part
+- Images
+    - Create image
+    - Create image edit|variation
+- Models
+    - List models
+    - Retrieve model
+    - Delete fine-tuned model
+- Moderations
+    - Create moderation
+- LegacyCompletions
+    - Create completion
+
+## Not implemented API methods (in development)
+
+- Assistants
+- Administration
+- Realtime
+- Legacy
+
+## License
+
+This package is released under the [MIT License](LICENSE.md).

composer.json

@@ -0,0 +1,21 @@
+{
+    "name": "php-client/openai",
+    "description": "PHP Client for OpenAI API",
+    "keywords": ["openai", "api", "client", "saloon", "gpt"],
+    "type": "library",
+    "license": "MIT",
+    "require": {
+        "php": "^8.3",
+        "saloonphp/saloon": "^3.10"
+    },
+    "require-dev": {
+        "symfony/var-dumper": "^7.2",
+        "vlucas/phpdotenv": "^5.6"
+    },
+    "autoload": {
+        "psr-4": {
+            "PhpClient\\OpenAI\\": "src/"
+        }
+    },
+    "minimum-stability": "stable"
+}

src/Helpers/MultipartValueHelper.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpClient\OpenAI\Helpers;
+
+use InvalidArgumentException;
+use Psr\Http\Message\StreamInterface;
+use Saloon\Data\MultipartValue;
+
+use function is_int;
+use function is_resource;
+use function is_string;
+
+final class MultipartValueHelper
+{
+    /**
+     * @param  MultipartValue|string  $file  MultipartValue representation of file or string path to file
+     * @return MultipartValue
+     */
+    public static function ensureFile(MultipartValue|string $file): MultipartValue
+    {
+        if (is_string(value: $file)) {
+            if (!file_exists(filename: $file)) {
+                throw new InvalidArgumentException(message: 'File does not exist');
+            }
+
+            $file = new MultipartValue(
+                name: basename(path: $file),
+                value: $file,
+            );
+        }
+
+        return $file;
+    }
+
+    /**
+     * @param  MultipartValue|StreamInterface|resource|string|int  $data
+     * @return MultipartValue
+     */
+    public static function ensureData(mixed $data): MultipartValue
+    {
+        if ($data instanceof MultipartValue) {
+            return $data;
+        }
+
+        if (
+            $data instanceof StreamInterface
+            || is_resource(value: $data)
+            || is_string(value: $data)
+            || is_int(value: $data)
+        ) {
+            return new MultipartValue(name: '', value: $data);
+        }
+
+        throw new InvalidArgumentException(
+            message: 'Data must be a MultipartValue, StreamInterface, resource, string or integer.',
+        );
+    }
+}

src/OpenAI.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpClient\OpenAI;
+
+use PhpClient\OpenAI\Resources\Api;
+use Saloon\Http\Connector;
+use Saloon\Traits\Plugins\HasTimeout;
+
+use function array_filter;
+
+/**
+ * PHP Client for OpenAI API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/introduction
+ * @version Relevant for 2025-02-13, OpenAI API v1
+ */
+final class OpenAI extends Connector
+{
+    use HasTimeout;
+
+    public readonly Api $api;
+    public readonly float $requestTimeout;
+
+    /**
+     * @param  string  $baseUrl  The base URL of the OpenAI server
+     */
+    public function __construct(
+        private readonly string $baseUrl,
+        private readonly null|string $token = null,
+        private readonly null|string $organization = null,
+        private readonly null|string $project = null,
+    ) {
+        $this->api = new Api(connector: $this);
+        $this->requestTimeout = 300.0;
+    }
+
+    public function resolveBaseUrl(): string
+    {
+        return $this->baseUrl;
+    }
+
+    protected function defaultHeaders(): array
+    {
+        return array_filter(
+            array: [
+                'Accept' => 'application/json',
+                'Authorization' => $this->token ? "Bearer $this->token" : null,
+                'Content-Type' => 'application/json',
+                'OpenAI-Organization' => $this->organization,
+                'OpenAI-Project' => $this->project,
+            ],
+        );
+    }
+}

src/Requests/Audio/CreateSpeechRequest.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpClient\OpenAI\Requests\Audio;
+
+use Saloon\Contracts\Body\HasBody;
+use Saloon\Enums\Method;
+use Saloon\Http\Request;
+use Saloon\Traits\Body\HasJsonBody;
+
+use function array_filter;
+
+/**
+ * Generates audio from the input text.
+ *
+ * @see https://platform.openai.com/docs/api-reference/audio/createSpeech
+ * @version Relevant for 2025-02-13, OpenAI API v1
+ */
+final class CreateSpeechRequest extends Request implements HasBody
+{
+    use HasJsonBody;
+
+    protected Method $method = Method::POST;
+
+    /**
+     * @param  string  $model  One of the available TTS models: `tts-1` or `tts-1-hd`.
+     *
+     * @param  string  $input  The text to generate audio for. The maximum length is 4096 characters.
+     *
+     * @param  string  $voice  The voice to use when generating the audio. Supported voices are `alloy`, `ash`,
+     * `coral`, `echo`, `fable`, `onyx`, `nova`, `sage` and `shimmer`.
+     *
+     * @param  string|null  $responseFormat  The format to audio in. Supported formats are `mp3`, `opus`, `aac`,
+     * `flac`, `wav`, and `pcm`.
+     *
+     * @param  float|null  $speed  The speed of the generated audio. Select a value from `0.25` to `4.0`.
+     * `1.0` is the default.
+     */
+    public function __construct(
+        public readonly string $model,
+        public readonly string $input,
+        public readonly string $voice,
+        public readonly null|string $responseFormat = null,
+        public readonly null|float $speed = null,
+    ) {}
+
+    public function resolveEndpoint(): string
+    {
+        return '/v1/audio/speech';
+    }
+
+    protected function defaultBody(): array
+    {
+        return array_filter(
+            array: [
+                'model' => $this->model,
+                'input' => $this->input,
+                'voice' => $this->voice,
+                'response_format' => $this->responseFormat,
+                'speed' => $this->speed,
+            ],
+            callback: static fn(mixed $value): bool => $value !== null,
+        );
+    }
+}

src/Requests/Audio/CreateTranscriptionRequest.php

@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpClient\OpenAI\Requests\Audio;
+
+use PhpClient\OpenAI\Helpers\MultipartValueHelper;
+use Saloon\Contracts\Body\HasBody;
+use Saloon\Data\MultipartValue;
+use Saloon\Enums\Method;
+use Saloon\Http\Request;
+use Saloon\Traits\Body\HasMultipartBody;
+
+use function array_filter;
+
+/**
+ * Transcribes audio into the input language.
+ *
+ * @see https://platform.openai.com/docs/api-reference/audio/createTranscription
+ * @version Relevant for 2025-02-13, OpenAI API v1
+ */
+final class CreateTranscriptionRequest extends Request implements HasBody
+{
+    use HasMultipartBody;
+
+    protected Method $method = Method::POST;
+
+    /**
+     * @param  MultipartValue|string  $file  The audio file (object or path) to transcribe, in one of these formats:
+     * `flac`, `mp3`, `mp4`, `mpeg`, `mpga`, `m4a`, `ogg`, `wav`, or `webm`.
+     *
+     * @param  string  $model  ID of the model to use. Only `whisper-1` is currently available.
+     *
+     * @param  string|null  $language  The language of the input audio. Supplying the input language in ISO-639-1
+     * (e.g. en) format will improve accuracy and latency.
+     *
+     * @param  string|null  $prompt  An optional text to guide the model's style or continue a previous audio segment.
+     * The prompt should match the audio language.
+     *
+     * @param  string|null  $responseFormat  The format of the output, in one of these options:
+     * `json`, `text`, `srt`, `verbose_json`, or `vtt`.
+     *
+     * @param  float|null  $temperature  The sampling temperature, between 0 and 1. Higher values like 0.8 will make
+     * the output more random, while lower values like 0.2 will make it more focused and deterministic.
+     * If set to 0, the model will use log probability to automatically increase the temperature until certain
+     * thresholds are hit.
+     *
+     * @param  array|null  $timestampGranularities  The timestamp granularities to populate for this transcription.
+     * `$responseFormat` must be set `verbose_json` to use timestamp granularities. Either or both of these options
+     * are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating
+     * word timestamps incurs additional latency.
+     */
+    public function __construct(
+        public readonly MultipartValue|string $file,
+        public readonly string $model,
+        public readonly null|string $language = null,
+        public readonly null|string $prompt = null,
+        public readonly null|string $responseFormat = null,
+        public readonly null|float $temperature = null,
+        public readonly null|array $timestampGranularities = null,
+    ) {}
+
+    public function resolveEndpoint(): string
+    {
+        return '/v1/audio/transcriptions';
+    }
+
+    protected function defaultBody(): array
+    {
+        return array_filter(
+            array: [
+                'file' => MultipartValueHelper::ensureFile(file: $this->file),
+                'model' => $this->model,
+                'language' => $this->language,
+                'prompt' => $this->prompt,
+                'response_format' => $this->responseFormat,
+                'temperature' => $this->temperature,
+                'timestamp_granularity' => $this->timestampGranularities,
+            ],
+            callback: static fn(mixed $value): bool => $value !== null,
+        );
+    }
+}