llm-agents / openai-client
OpenAI API client for LLM Agents
Requires
- php: ^8.3
- guzzlehttp/guzzle: ^7.0
- llm-agents/agents: ^1.6
- openai-php/client: ^0.10.1
Requires (Dev)
- illuminate/support: ^11.0
- phpunit/phpunit: ^11.3
- spiral/boot: ^3.13
README
This package is your go-to solution for integrating OpenAI's powerful API into your LLM Agents projects.
What's in the box?
- Easy setup with Spiral framework
- Smooth integration with OpenAI's API
- Built to work hand-in-hand with LLM Agents
Installation 🛠️
- Run this command to add the package to your project:
composer require llm-agents/openai-client
- That's it! You're ready to roll.
Setting it up in Spiral
To get the OpenAI client up and running in your Spiral app, you need to register the bootloader.
Here's how:
-
Open up your
app/src/Application/Kernel.php
file. -
In your
Kernel
class add theLLM\Agents\OpenAI\Client\Integration\Spiral\OpenAIClientBootloader
bootloader:
class Kernel extends \Spiral\Framework\Kernel { public function defineBootloaders(): array { return [ // ... other bootloaders ... \LLM\Agents\OpenAI\Client\Integration\Spiral\OpenAIClientBootloader::class, ]; } }
The package uses your OpenAI API key and organization (if you have one) to authenticate.
Set these up in your .env
file:
OPENAI_KEY=your_api_key_here
Setting it up in Laravel
If you're using the Laravel framework, you'll need to install the openai-php/laravel
package register the Service
provider.
Here's how:
- Install the
openai-php/laravel
package:
composer require openai-php/laravel
- Next, execute the install command:
php artisan openai:install
- Finally, add your OpenAI API key to your
.env
file:
OPENAI_API_KEY=sk-...
OPENAI_ORGANIZATION=org-...
- And register the
LLM\Agents\OpenAI\Client\Integration\Laravel\OpenAIClientServiceProvider
And that's it! The service provider will take care of registering the LLMInterface
for you.
Contributing
We're always happy to get help making this package even better! Here's how you can chip in:
- Fork the repo
- Make your changes
- Create a new Pull Request
Please make sure your code follows PSR-12 coding standards and include tests for any new features.
License
This project is licensed under the MIT License - see the LICENSE file for details.
That's all, folks! If you run into any issues or have questions, feel free to open an issue on GitHub.