encurio/openai-service

A flexible OpenAI integration for Laravel

v1.0.4 2025-03-14 02:03 UTC

Requires

• php: >=8.0
• guzzlehttp/guzzle: ^7.0
• illuminate/support: ^10.0 || ^11.0 || ^12.0

MIT

README

This package provides a flexible OpenAI Service for Laravel, allowing seamless integration with OpenAI’s API.
Supports both Assistants (structured interactions) and Completions (direct text responses).

📌 Features

• ✅ Supports Assistants & Completions – Structured AI assistants or direct text completions.
• ✅ Dynamic API Key Handling – Uses a default key but allows per-request overrides.
• ✅ Flexible Model Selection – Defaults to gpt-4o, but any OpenAI model can be used.
• ✅ Handles Images & Text – Send images for AI-based recognition.
• ✅ Built-in Rate Limiting & Error Handling – Prevents API overuse and manages failures.

📦 Installation

composer require encurio/openai-service

⚙️ Configuration

1️⃣ Set OpenAI API Keys in .env

Ensure your .env file includes:

OPENAI_API_KEY_COMPLETIONS=your_openai_completions_key
OPENAI_API_KEY_ASSISTANTS=your_openai_assistants_key

2️⃣ Publish Config File (Optional)

php artisan vendor:publish --tag=openai-config

This will generate config/openai.php, where you can set defaults.

🛠️ Usage Examples

1️⃣ Basic Completion Request (Text Generation)

use OpenAI;

$response = OpenAI::requestOpenAI(
    [['role' => 'user', 'content' => 'Write a short SEO-friendly product description.']],
    useAssistant: false
);

echo $response['choices'][0]['message']['content'];

Alternatively you can use a simple way:

$response = OpenAI::completion([
    'messages' => [
        ['role' => 'user', 'content' => 'Write a short story about AI.']
    ]
]);

Or use more paramters

$response = OpenAI::completion([
    'messages' => [
        ['role' => 'user', 'content' => 'Tell me a joke.']
    ]
], model: 'gpt-4o', temperature: 0.9, maxTokens: 200);

2️⃣ Using an OpenAI Assistant

$response = OpenAI::requestOpenAI(
    [['role' => 'user', 'content' => 'Analyze this artwork.']],
    assistantId: 'asst_12345' // Your Assistant ID
);

Or simpler

$response = OpenAI::assistant(
    'asst_123456789',
    [['role' => 'user', 'content' => 'Summarize this document.']]
);

With more parameters

$response = OpenAI::assistant(
    'asst_123456789',
    [['role' => 'user', 'content' => 'Give me a detailed analysis.']],
    temperature: 0.8,
    maxTokens: 500
);

3️⃣ Sending an Image for Analysis

$imageUrl = "https://example.com/sample.jpg";

$response = OpenAI::requestOpenAI(
    [['role' => 'user', 'content' => [
        ['type' => 'text', 'text' => 'Describe this artwork in detail.'],
        ['type' => 'image_url', 'image_url' => [
            'url' => $imageUrl,
            'detail' => 'high'
        ]]
    ]]],
    useAssistant: false
);

echo $response['choices'][0]['message']['content'];

🔧 Available Parameters

Parameter	Type	Default	Description
messages	array	Required	List of chat messages (roles: system, user, assistant).
useAssistant	bool	false	Whether to use an OpenAI Assistant for this request.
assistantId	string	null	The ID of an OpenAI Assistant (if useAssistant is true).
model	string	'gpt-4o'	The OpenAI model to use (e.g., gpt-4o, gpt-3.5-turbo).
temperature	float	0.7	Controls randomness (0.0 = strict, 1.0 = creative).
maxTokens	int	1000	The response length limit in tokens.
topP	float	1.0	Alternative to temperature, sampling technique (0.0–1.0).
apiKey	string	.env value	Allows overriding the default API key from .env.
retries	int	3	Number of retry attempts if the request fails.

📄 License

This package is licensed under the MIT License.