chore: improve example execution with make and dotenv (#54)

Author: chr-hertel

.env

@@ -0,0 +1,16 @@
+# You only need to fill in the values when running the examples, see examples/
+
+# For using GPT on OpenAI
+OPENAI_API_KEY=
+
+# For using Claude on Anthropic
+ANTHROPIC_API_KEY=
+
+# For using GPT on Azure
+AZURE_OPENAI_BASEURL=
+AZURE_OPENAI_DEPLOYMENT=
+AZURE_OPENAI_VERSION=
+AZURE_OPENAI_KEY=
+
+# For using SerpApi (tool)
+SERP_API_KEY=

.gitignore

@@ -3,3 +3,4 @@ vendor
 .php-cs-fixer.cache
 .phpunit.cache
 coverage
+.env.local

Makefile

@@ -9,7 +9,19 @@ qa-lowest:
 	vendor/bin/php-cs-fixer fix --diff --verbose
 	vendor/bin/phpstan
 	vendor/bin/phpunit
-	git restore composer.lock
 
 coverage:
 	XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html=coverage
+
+run-all-examples:
+	php ./examples/chat-claude-anthropic.php
+	php ./examples/chat-gpt-azure.php
+	php ./examples/chat-gpt-openai.php
+	php ./examples/image-describer.php
+	php ./examples/reasoning-openai.php
+	php ./examples/structured-output-math.php
+	php ./examples/toolbox-clock.php
+	php ./examples/toolbox-serpapi.php
+	php ./examples/toolbox-weather.php
+	php ./examples/toolbox-wikipedia.php
+	php ./examples/toolbox-youtube.php

README.md

@@ -62,7 +62,10 @@ Usage Examples
 --------------
 
 See [examples](examples) to run example implementations using this library.
-Depending on the example you need to export different environment variables for API keys or deployment configurations:
+Depending on the example you need to export different environment variables
+for API keys or deployment configurations or create a `.env.local` based on `.env` file.
+
+To run all examples, just use `make run-all-examples`.
 
 ### Chat Examples
 
@@ -120,13 +123,21 @@ Depending on the example you need to export different environment variables for
    php examples/toolbox-youtube.php
    ```
 
-### Structured Output
+### Structured Output Example
 
 1. Structured Output Example: OpenAI's GPT
    ```bash
    export OPENAI_API_KEY=sk-...
    php examples/structured-output-math.php
    ```
+   
+### Reasoning Example
+
+1. Reasoning Example: OpenAI's o1
+   ```bash
+   export OPENAI_API_KEY=sk-...
+   php examples/reasoning-openai.php
+   ```
 
 Contributions
 -------------

composer.json

@@ -34,6 +34,7 @@
         "symfony/console": "^6.4 || ^7.1",
         "symfony/css-selector": "^6.4 || ^7.1",
         "symfony/dom-crawler": "^6.4 || ^7.1",
+        "symfony/dotenv": "^6.4 || ^7.1",
         "symfony/var-dumper": "^6.4 || ^7.1"
     },
     "suggest": {

examples/chat-claude-anthropic.php

@@ -5,11 +5,13 @@
 use PhpLlm\LlmChain\Chain;
 use PhpLlm\LlmChain\Message\Message;
 use PhpLlm\LlmChain\Message\MessageBag;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
-$platform = new Anthropic(HttpClient::create(), getenv('ANTHROPIC_API_KEY'));
+$platform = new Anthropic(HttpClient::create(), $_ENV['ANTHROPIC_API_KEY']);
 $llm = new Claude($platform);
 
 $chain = new Chain($llm);

examples/chat-gpt-azure.php

@@ -6,15 +6,17 @@
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
 use PhpLlm\LlmChain\OpenAI\Platform\Azure;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
 $platform = new Azure(HttpClient::create(),
-    getenv('AZURE_OPENAI_BASEURL'),
-    getenv('AZURE_OPENAI_DEPLOYMENT'),
-    getenv('AZURE_OPENAI_VERSION'),
-    getenv('AZURE_OPENAI_KEY')
+    $_ENV['AZURE_OPENAI_BASEURL'],
+    $_ENV['AZURE_OPENAI_DEPLOYMENT'],
+    $_ENV['AZURE_OPENAI_VERSION'],
+    $_ENV['AZURE_OPENAI_KEY'],
 );
 $llm = new Gpt($platform, Version::gpt4oMini());
 

examples/chat-gpt-openai.php

@@ -6,11 +6,13 @@
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
 use PhpLlm\LlmChain\OpenAI\Platform\OpenAI;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
-$platform = new OpenAI(HttpClient::create(), getenv('OPENAI_API_KEY'));
+$platform = new OpenAI(HttpClient::create(), $_ENV['OPENAI_API_KEY']);
 $llm = new Gpt($platform, Version::gpt4oMini(), [
     'temperature' => 0.5, // default options for the model
 ]);

examples/image-describer.php

@@ -7,11 +7,13 @@
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
 use PhpLlm\LlmChain\OpenAI\Platform\OpenAI;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
-$platform = new OpenAI(HttpClient::create(), getenv('OPENAI_API_KEY'));
+$platform = new OpenAI(HttpClient::create(), $_ENV['OPENAI_API_KEY']);
 $llm = new Gpt($platform, Version::gpt4oMini());
 
 $chain = new Chain($llm);

examples/reasoning-openai.php

@@ -6,11 +6,13 @@
 use PhpLlm\LlmChain\OpenAI\Model\Gpt;
 use PhpLlm\LlmChain\OpenAI\Model\Gpt\Version;
 use PhpLlm\LlmChain\OpenAI\Platform\OpenAI;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
-$platform = new OpenAI(HttpClient::create(), getenv('OPENAI_API_KEY'));
+$platform = new OpenAI(HttpClient::create(), $_ENV['OPENAI_API_KEY']);
 $llm = new Gpt($platform, Version::o1Preview());
 
 $prompt = <<<PROMPT

examples/structured-output-math.php

@@ -9,14 +9,16 @@
 use PhpLlm\LlmChain\StructuredOutput\ResponseFormatFactory;
 use PhpLlm\LlmChain\StructuredOutput\SchemaFactory;
 use PhpLlm\LlmChain\Tests\StructuredOutput\Data\MathReasoning;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 use Symfony\Component\Serializer\Serializer;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
-$platform = new OpenAI(HttpClient::create(), getenv('OPENAI_API_KEY'));
+$platform = new OpenAI(HttpClient::create(), $_ENV['OPENAI_API_KEY']);
 $llm = new Gpt($platform, Version::gpt4oMini());
 $responseFormatFactory = new ResponseFormatFactory(SchemaFactory::create());
 $serializer = new Serializer([new ObjectNormalizer()], [new JsonEncoder()]);

examples/toolbox-clock.php

@@ -10,11 +10,13 @@
 use PhpLlm\LlmChain\ToolBox\ToolAnalyzer;
 use PhpLlm\LlmChain\ToolBox\ToolBox;
 use Symfony\Component\Clock\Clock as SymfonyClock;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
-$platform = new OpenAI(HttpClient::create(), getenv('OPENAI_API_KEY'));
+$platform = new OpenAI(HttpClient::create(), $_ENV['OPENAI_API_KEY']);
 $llm = new Gpt($platform, Version::gpt4oMini());
 
 $clock = new Clock(new SymfonyClock());

examples/toolbox-serpapi.php

@@ -9,15 +9,17 @@
 use PhpLlm\LlmChain\ToolBox\Tool\SerpApi;
 use PhpLlm\LlmChain\ToolBox\ToolAnalyzer;
 use PhpLlm\LlmChain\ToolBox\ToolBox;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
 $httpClient = HttpClient::create();
-$platform = new OpenAI($httpClient, getenv('OPENAI_API_KEY'));
+$platform = new OpenAI($httpClient, $_ENV['OPENAI_API_KEY']);
 $llm = new Gpt($platform, Version::gpt4oMini());
 
-$serpApi = new SerpApi($httpClient, getenv('SERP_API_KEY'));
+$serpApi = new SerpApi($httpClient, $_ENV['SERP_API_KEY']);
 $toolBox = new ToolBox(new ToolAnalyzer(), [$serpApi]);
 $chain = new Chain($llm, $toolBox);
 

examples/toolbox-weather.php

@@ -9,12 +9,14 @@
 use PhpLlm\LlmChain\ToolBox\Tool\OpenMeteo;
 use PhpLlm\LlmChain\ToolBox\ToolAnalyzer;
 use PhpLlm\LlmChain\ToolBox\ToolBox;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
 $httpClient = HttpClient::create();
-$platform = new OpenAI($httpClient, getenv('OPENAI_API_KEY'));
+$platform = new OpenAI($httpClient, $_ENV['OPENAI_API_KEY']);
 $llm = new Gpt($platform, Version::gpt4oMini());
 
 $wikipedia = new OpenMeteo($httpClient);

examples/toolbox-wikipedia.php

@@ -9,12 +9,14 @@
 use PhpLlm\LlmChain\ToolBox\Tool\Wikipedia;
 use PhpLlm\LlmChain\ToolBox\ToolAnalyzer;
 use PhpLlm\LlmChain\ToolBox\ToolBox;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
 $httpClient = HttpClient::create();
-$platform = new OpenAI($httpClient, getenv('OPENAI_API_KEY'));
+$platform = new OpenAI($httpClient, $_ENV['OPENAI_API_KEY']);
 $llm = new Gpt($platform, Version::gpt4oMini());
 
 $wikipedia = new Wikipedia($httpClient);

examples/toolbox-youtube.php

@@ -9,12 +9,14 @@
 use PhpLlm\LlmChain\ToolBox\Tool\YouTubeTranscriber;
 use PhpLlm\LlmChain\ToolBox\ToolAnalyzer;
 use PhpLlm\LlmChain\ToolBox\ToolBox;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpClient\HttpClient;
 
 require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
 
 $httpClient = HttpClient::create();
-$platform = new OpenAI($httpClient, getenv('OPENAI_API_KEY'));
+$platform = new OpenAI($httpClient, $_ENV['OPENAI_API_KEY']);
 $llm = new Gpt($platform, Version::gpt4oMini());
 
 $transcriber = new YouTubeTranscriber($httpClient);