Repository files navigation

OpenAI PHP for Symfony is a community-maintained PHP API client that allows you to interact with theOpen AI API. If you or your business relies on this package, it's important to support the developers who have contributed their time and effort to create and maintain this valuable tool:

• Nuno Maduro:github.com/sponsors/nunomaduro
• Sandro Gehri:github.com/sponsors/gehrisandro

Note: This repository contains the integration code of theOpenAI PHP for Symfony. If you want to use theOpenAI PHP client in a framework-agnostic way, take a look at theopenai-php/client repository.

RequiresPHP 8.1+

First, install OpenAI via theComposer package manager:

composer require openai-php/symfony

Next, register the bundle in yourconfig/bundles.php:

return [// ...OpenAI\Symfony\OpenAIBundle::class => ['all' =>true],]

This will create a.env configuration file in your project, which you can modify to your needsusing environment variables:

OPENAI_API_KEY=sk-...OPENAI_ORGANIZATION=...

For more configuration options, take a look at theConfiguration Reference.

Finally, you may use theopenai service to access the OpenAI API:

$result =$container->get('openai')->completions()->create(['model' =>'gpt-4o-mini','prompt' =>'PHP is',]);echo$result['choices'][0]['text'];// an open-source, widely-used, server-side scripting language.

For usage examples, take a look at theopenai-php/client repository.

The bundle provides the following configuration options, which you can set in yourconfig/packages/openai.yaml file:

openai:api_key:'%env(OPENAI_API_KEY)%'# Your OpenAI API key (required)organization:'%env(OPENAI_ORGANIZATION)%'# Your OpenAI organization ID (optional)project:'proj_...'# The project ID (optional)base_uri:'api.openai.com/v1'# The base URI for the OpenAI API (optional)

OpenAI PHP for Symfony is an open-sourced software licensed under theMIT license.