fix isse #46 mistral tool_choice (#50)

.readme.yaml

@@ -1,3 +1,4 @@
 title: OpenAI Adapter
 description: The adapter integrates OpenAI models into Modelflow AI.
 shortDescription: The adapter for integrating OpenAI models.
+examples: true

README.md

@@ -11,6 +11,11 @@ you can add the package to your project by running the following command:
 composer require modelflow-ai/openai-adapter
 ```
 
+## Examples
+
+Here are some examples of how you can use the Mistral package in your PHP applications. You can find more detailed
+examples in the [examples directory](examples).
+
 ## Usage
 
 Detailed usage instructions will be provided in the future. For now, you can refer to the source code and unit tests for

composer.json

@@ -33,6 +33,7 @@
         "nyholm/psr7": "^1.8"
     },
     "require-dev": {
+        "modelflow-ai/prompt-template": "^0.1",
         "php-cs-fixer/shim": "^3.15",
         "phpstan/extension-installer": "^1.2",
         "phpstan/phpstan": "^1.10",
@@ -41,7 +42,8 @@
         "rector/rector": "^0.18.1",
         "phpspec/prophecy": "^1.0@dev",
         "jangregor/phpstan-prophecy": "^1.0",
-        "phpspec/prophecy-phpunit": "^2.1@stable"
+        "phpspec/prophecy-phpunit": "^2.1@stable",
+        "symfony/dotenv": "7.1.x-dev"
     },
     "scripts": {
         "test": [

examples/.env

@@ -0,0 +1 @@
+OPENAI_KEY=

examples/.gitignore

@@ -0,0 +1 @@
+.env.local

examples/WeatherTool.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Modelflow AI package.
+ *
+ * (c) Johannes Wachter <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App;
+
+class WeatherTool
+{
+    /**
+     * Can be called foreach location to get the current weather. Also multiple times in one call.
+     *
+     * @return array{
+     *     location: string,
+     *     timestamp: int,
+     *     weather: string,
+     *     temperature: float,
+     * }
+     */
+    public function getCurrentWeather(string $location, ?int $timestamp): array
+    {
+        $weather = ['rainy', 'sunny', 'cloudy', 'stormy', 'snowy'];
+
+        return [
+            'location' => $location,
+            'timestamp' => $timestamp ?? \time(),
+            'weather' => $weather[\random_int(0, \count($weather) - 1)],
+            'temperature' => \random_int(-20, 40) + \random_int(0, 9) / 10.0,
+        ];
+    }
+}

examples/bootstrap.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Modelflow AI package.
+ *
+ * (c) Johannes Wachter <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App;
+
+require_once \dirname(__DIR__) . '/vendor/autoload.php';
+
+use ModelflowAi\Core\AIRequestHandler;
+use ModelflowAi\Core\DecisionTree\AIModelDecisionTree;
+use ModelflowAi\Core\DecisionTree\DecisionRule;
+use ModelflowAi\Core\Request\Criteria\CapabilityCriteria;
+use ModelflowAi\OpenaiAdapter\Model\OpenaiChatModelAdapter;
+use Symfony\Component\Dotenv\Dotenv;
+
+(new Dotenv())->bootEnv(__DIR__ . '/.env');
+
+$adapter = [];
+
+$openaiApiKey = $_ENV['OPENAI_API_KEY'];
+if (!$openaiApiKey) {
+    throw new \RuntimeException('Openai API key is required');
+}
+
+$openaiClient = \OpenAI::client($openaiApiKey);
+
+$gpt4Adapter = new OpenaiChatModelAdapter($openaiClient, 'gpt-4');
+$gpt35Adapter = new OpenaiChatModelAdapter($openaiClient, 'gpt-3.5');
+
+$adapter[] = new DecisionRule($gpt4Adapter, [CapabilityCriteria::SMART]);
+$adapter[] = new DecisionRule($gpt35Adapter, [CapabilityCriteria::BASIC]);
+
+$decisionTree = new AIModelDecisionTree($adapter);
+
+return new AIRequestHandler($decisionTree);

examples/chat-stream.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Modelflow AI package.
+ *
+ * (c) Johannes Wachter <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App;
+
+use ModelflowAi\Core\AIRequestHandlerInterface;
+use ModelflowAi\Core\Request\Criteria\CapabilityCriteria;
+use ModelflowAi\Core\Request\Message\AIChatMessage;
+use ModelflowAi\Core\Request\Message\AIChatMessageRoleEnum;
+use ModelflowAi\Core\Response\AIChatResponseStream;
+use ModelflowAi\PromptTemplate\ChatPromptTemplate;
+
+/** @var AIRequestHandlerInterface $handler */
+$handler = require_once __DIR__ . '/bootstrap.php';
+
+/** @var AIChatResponseStream $response */
+$response = $handler->createChatRequest(
+    ...ChatPromptTemplate::create(
+        new AIChatMessage(AIChatMessageRoleEnum::SYSTEM, 'You are an {feeling} bot'),
+        new AIChatMessage(AIChatMessageRoleEnum::USER, 'Hello {where}!'),
+    )->format(['where' => 'world', 'feeling' => 'angry']),
+)
+    ->addCriteria(CapabilityCriteria::BASIC)
+    ->streamed()
+    ->build()
+    ->execute();
+
+foreach ($response->getMessageStream() as $index => $message) {
+    if (0 === $index) {
+        echo $message->role->value . ': ';
+    }
+
+    echo $message->content;
+}