Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/llm-agents-php/openai-client
OpenAI API client for LLM Agents
https://github.com/llm-agents-php/openai-client
client llm llm-agents llm-tools openai php php8
Last synced: 3 months ago
JSON representation
OpenAI API client for LLM Agents
- Host: GitHub
- URL: https://github.com/llm-agents-php/openai-client
- Owner: llm-agents-php
- License: mit
- Created: 2024-08-27T19:14:57.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-10T15:23:02.000Z (4 months ago)
- Last Synced: 2024-09-29T20:01:59.535Z (3 months ago)
- Topics: client, llm, llm-agents, llm-tools, openai, php, php8
- Language: PHP
- Homepage:
- Size: 29.3 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LLM Agents OpenAI Client
[](https://packagist.org/packages/llm-agents/openai-client)
[](https://packagist.org/packages/llm-agents/openai-client)
[](https://packagist.org/packages/llm-agents/openai-client)
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 🛠️
1. Run this command to add the package to your project:
```bash
composer require llm-agents/openai-client
```
2. 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:**
1. Open up your `app/src/Application/Kernel.php` file.
2. In your `Kernel` class add the `LLM\Agents\OpenAI\Client\Integration\Spiral\OpenAIClientBootloader` bootloader:
```php
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:**
1. Install the `openai-php/laravel` package:
```bash
composer require openai-php/laravel
```
2. Next, execute the install command:
```bash
php artisan openai:install
```
3. Finally, add your OpenAI API key to your `.env` file:
```
OPENAI_API_KEY=sk-...
OPENAI_ORGANIZATION=org-...
```
4. 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:
1. Fork the repo
2. Make your changes
3. 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](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.