Merge pull request #22 from utopia-php/fix/openai-gpt5-nano-adapter

fix(openai): support gpt-5-nano parameters

Author: ChiragAgg5k

README.md

@@ -70,6 +70,7 @@ $openai = new OpenAI(
 ```
 
 Available OpenAI Models:
+- `MODEL_GPT_5_NANO`: GPT-5 Nano - Small GPT-5 variant optimized for low latency and cost-sensitive workloads
 - `MODEL_GPT_4_5_PREVIEW`: GPT-4.5 Preview - OpenAI's most advanced model with enhanced reasoning, broader knowledge, and improved instruction following
 - `MODEL_GPT_4_1`: GPT-4.1 - Advanced large language model with strong reasoning capabilities and improved context handling
 - `MODEL_GPT_4O`: GPT-4o - Multimodal model optimized for both text and image processing with faster response times
@@ -143,14 +144,15 @@ use Utopia\Agents\Adapters\XAI;
 
 $xai = new XAI(
     apiKey: 'your-api-key',
-    model: XAI::MODEL_GROK_2_LATEST,
+    model: XAI::MODEL_GROK_3_MINI,
     maxTokens: 2048,
     temperature: 0.7
 );
 ```
 
 Available XAI Models:
-- `MODEL_GROK_2_LATEST`: Latest Grok model
+- `MODEL_GROK_3`: Latest Grok model
+- `MODEL_GROK_3_MINI`: Mini version of Grok model
 - `MODEL_GROK_2_IMAGE`: Latest Grok model with image support
 
 ### Managing Conversations
@@ -245,4 +247,4 @@ We truly ❤️ pull requests! If you wish to help, you can learn more about how
 
 ## Copyright and license
 
-The MIT License (MIT) [http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php) 
+The MIT License (MIT) [http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php) 

docker-compose.yml

@@ -10,12 +10,12 @@ services:
       - ./phpunit.xml:/usr/src/code/phpunit.xml
     environment:
       - TESTING=true
-      - LLM_KEY_ANTHROPIC=${LLM_KEY_ANTHROPIC}
-      - LLM_KEY_OPENAI=${LLM_KEY_OPENAI}
-      - LLM_KEY_DEEPSEEK=${LLM_KEY_DEEPSEEK}
-      - LLM_KEY_XAI=${LLM_KEY_XAI}
-      - LLM_KEY_PERPLEXITY=${LLM_KEY_PERPLEXITY}
-      - LLM_KEY_GEMINI=${LLM_KEY_GEMINI}
+      - LLM_KEY_ANTHROPIC=${LLM_KEY_ANTHROPIC:-}
+      - LLM_KEY_OPENAI=${LLM_KEY_OPENAI:-}
+      - LLM_KEY_DEEPSEEK=${LLM_KEY_DEEPSEEK:-}
+      - LLM_KEY_XAI=${LLM_KEY_XAI:-}
+      - LLM_KEY_PERPLEXITY=${LLM_KEY_PERPLEXITY:-}
+      - LLM_KEY_GEMINI=${LLM_KEY_GEMINI:-}
     depends_on:
       - ollama
     networks:
@@ -41,4 +41,4 @@ volumes:
   ollama_models:
 
 networks:
-  utopia:
+  utopia:

src/Agents/Adapters/OpenAI.php

@@ -11,6 +11,11 @@
 
 class OpenAI extends Adapter
 {
+    /**
+     * GPT-5 Nano - Small GPT-5 variant optimized for low latency and cost-sensitive workloads
+     */
+    public const MODEL_GPT_5_NANO = 'gpt-5-nano';
+
     /**
      * GPT-4.5 Preview - OpenAI's most advanced model with enhanced reasoning, broader knowledge, and improved instruction following
      */
@@ -76,6 +81,11 @@ class OpenAI extends Adapter
      */
     protected int $timeout;
 
+    /**
+     * @var bool
+     */
+    protected bool $hasWarnedTemperatureOverride = false;
+
     /**
      * Create a new OpenAI adapter
      *
@@ -125,7 +135,8 @@ public function isSchemaSupported(): bool
      */
     public function send(array $messages, ?callable $listener = null): Message
     {
-        if ($this->getAgent() === null) {
+        $agent = $this->getAgent();
+        if ($agent === null) {
             throw new \Exception('Agent not set');
         }
 
@@ -147,11 +158,11 @@ public function send(array $messages, ?callable $listener = null): Message
         }
 
         $instructions = [];
-        foreach ($this->getAgent()->getInstructions() as $name => $content) {
+        foreach ($agent->getInstructions() as $name => $content) {
             $instructions[] = '# '.$name."\n\n".$content;
         }
 
-        $systemMessage = $this->getAgent()->getDescription().
+        $systemMessage = $agent->getDescription().
             (empty($instructions) ? '' : "\n\n".implode("\n\n", $instructions));
 
         if (! empty($systemMessage)) {
@@ -164,10 +175,14 @@ public function send(array $messages, ?callable $listener = null): Message
         $payload = [
             'model' => $this->model,
             'messages' => $formattedMessages,
-            'temperature' => $this->temperature,
         ];
+        $temperature = $this->temperature;
+        if ($this->usesDefaultTemperatureOnly()) {
+            $temperature = 1.0;
+        }
+        $payload['temperature'] = $temperature;
 
-        $schema = $this->getAgent()->getSchema();
+        $schema = $agent->getSchema();
         if ($schema !== null) {
             $payload['response_format'] = [
                 'type' => 'json_schema',
@@ -187,13 +202,7 @@ public function send(array $messages, ?callable $listener = null): Message
             $payload['stream'] = true;
         }
 
-        // Use 'max_completion_tokens' for o-series models, else 'max_tokens'
-        $oSeriesModels = [
-            self::MODEL_O3,
-            self::MODEL_O3_MINI,
-            self::MODEL_O4_MINI,
-        ];
-        if (in_array($this->model, $oSeriesModels)) {
+        if ($this->usesMaxCompletionTokens()) {
             $payload['max_completion_tokens'] = $this->maxTokens;
         } else {
             $payload['max_tokens'] = $this->maxTokens;
@@ -306,6 +315,7 @@ protected function process(Chunk $chunk, ?callable $listener): string
     public function getModels(): array
     {
         return [
+            self::MODEL_GPT_5_NANO,
             self::MODEL_GPT_4_5_PREVIEW,
             self::MODEL_GPT_4_1,
             self::MODEL_GPT_4O,
@@ -315,6 +325,40 @@ public function getModels(): array
         ];
     }
 
+    /**
+     * OpenAI expects max_completion_tokens for these models.
+     */
+    protected function usesMaxCompletionTokens(): bool
+    {
+        return in_array($this->model, [
+            self::MODEL_GPT_5_NANO,
+            self::MODEL_O4_MINI,
+            self::MODEL_O3,
+            self::MODEL_O3_MINI,
+        ], true);
+    }
+
+    /**
+     * Some models only accept the default temperature (1).
+     */
+    protected function usesDefaultTemperatureOnly(): bool
+    {
+        $usesDefaultTemperatureOnly = in_array($this->model, [
+            self::MODEL_GPT_5_NANO,
+        ], true);
+
+        if ($usesDefaultTemperatureOnly && $this->temperature !== 1.0 && ! $this->hasWarnedTemperatureOverride) {
+            $this->hasWarnedTemperatureOverride = true;
+            error_log(
+                "OpenAI adapter warning: model '{$this->model}' only supports temperature=1.0. "
+                ."Overriding provided value {$this->temperature}. "
+                .'Set temperature to 1.0 to remove this warning.'
+            );
+        }
+
+        return $usesDefaultTemperatureOnly;
+    }
+
     /**
      * Get current model
      *

src/Agents/Adapters/XAI.php

@@ -12,14 +12,19 @@ class XAI extends OpenAI
     protected const ENDPOINT = 'https://api.x.ai/v1/chat/completions';
 
     /**
-     * Grok 2 Latest - Latest Grok model
+     * Grok 3 - Latest Grok model
      */
-    public const MODEL_GROK_2_LATEST = 'grok-2-latest';
+    public const MODEL_GROK_3 = 'grok-3';
+
+    /**
+     * Grok 3 Mini - Mini version of grok 3
+     */
+    public const MODEL_GROK_3_MINI = 'grok-3-mini';
 
     /**
      * Grok 2 Image - Latest Grok model with image support
      */
-    public const MODEL_GROK_2_IMAGE = 'grok-2-image';
+    public const MODEL_GROK_2_IMAGE = 'grok-2-image-1212';
 
     /**
      * Create a new XAI adapter
@@ -35,7 +40,7 @@ class XAI extends OpenAI
      */
     public function __construct(
         string $apiKey,
-        string $model = self::MODEL_GROK_2_LATEST,
+        string $model = self::MODEL_GROK_3_MINI,
         int $maxTokens = 1024,
         float $temperature = 1.0,
         ?string $endpoint = null,
@@ -69,7 +74,8 @@ public function isSchemaSupported(): bool
     public function getModels(): array
     {
         return [
-            self::MODEL_GROK_2_LATEST,
+            self::MODEL_GROK_3,
+            self::MODEL_GROK_3_MINI,
             self::MODEL_GROK_2_IMAGE,
         ];
     }

tests/Agents/Conversation/ConversationXAITest.php

@@ -17,7 +17,7 @@ protected function createAdapter(): Adapter
 
         return new XAI(
             $apiKey,
-            XAI::MODEL_GROK_2_LATEST,
+            XAI::MODEL_GROK_3_MINI,
             1024,
             1.0
         );