feat: Google structured output (#354)

Author: valtzu

examples/google/structured-output-clock.php

@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Symfony\AI\Agent\Agent;
+use Symfony\AI\Agent\StructuredOutput\AgentProcessor as StructuredOutputProcessor;
+use Symfony\AI\Agent\Toolbox\AgentProcessor as ToolProcessor;
+use Symfony\AI\Agent\Toolbox\Tool\Clock;
+use Symfony\AI\Agent\Toolbox\Toolbox;
+use Symfony\AI\Platform\Bridge\Google\Gemini;
+use Symfony\AI\Platform\Bridge\Google\PlatformFactory;
+use Symfony\AI\Platform\Message\Message;
+use Symfony\AI\Platform\Message\MessageBag;
+use Symfony\Component\Clock\Clock as SymfonyClock;
+use Symfony\Component\Dotenv\Dotenv;
+
+require_once dirname(__DIR__, 2).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__, 2).'/.env');
+
+if (empty($_ENV['GOOGLE_API_KEY'])) {
+    echo 'Please set the GOOGLE_API_KEY environment variable.'.\PHP_EOL;
+    exit(1);
+}
+
+$platform = PlatformFactory::create($_ENV['GOOGLE_API_KEY']);
+$model = new Gemini(Gemini::GEMINI_1_5_FLASH);
+
+$clock = new Clock(new SymfonyClock());
+$toolbox = Toolbox::create($clock);
+$toolProcessor = new ToolProcessor($toolbox);
+$structuredOutputProcessor = new StructuredOutputProcessor();
+$agent = new Agent($platform, $model, [$toolProcessor, $structuredOutputProcessor], [$toolProcessor, $structuredOutputProcessor]);
+
+$messages = new MessageBag(Message::ofUser('What date and time is it?'));
+$response = $agent->call($messages, ['response_format' => [
+    'type' => 'json_schema',
+    'json_schema' => [
+        'name' => 'clock',
+        'strict' => true,
+        'schema' => [
+            'type' => 'object',
+            'properties' => [
+                'date' => ['type' => 'string', 'description' => 'The current date in the format YYYY-MM-DD.'],
+                'time' => ['type' => 'string', 'description' => 'The current time in the format HH:MM:SS.'],
+            ],
+            'required' => ['date', 'time'],
+            'additionalProperties' => false,
+        ],
+    ],
+]]);
+
+dump($response->getContent());

examples/google/structured-output-math.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Symfony\AI\Agent\Agent;
+use Symfony\AI\Agent\StructuredOutput\AgentProcessor;
+use Symfony\AI\Fixtures\StructuredOutput\MathReasoning;
+use Symfony\AI\Platform\Bridge\Google\Gemini;
+use Symfony\AI\Platform\Bridge\Google\PlatformFactory;
+use Symfony\AI\Platform\Message\Message;
+use Symfony\AI\Platform\Message\MessageBag;
+use Symfony\Component\Dotenv\Dotenv;
+
+require_once dirname(__DIR__, 2).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__, 2).'/.env');
+
+if (empty($_ENV['GOOGLE_API_KEY'])) {
+    echo 'Please set the GOOGLE_API_KEY environment variable.'.\PHP_EOL;
+    exit(1);
+}
+
+$platform = PlatformFactory::create($_ENV['GOOGLE_API_KEY']);
+$model = new Gemini(Gemini::GEMINI_1_5_FLASH);
+
+$processor = new AgentProcessor();
+$agent = new Agent($platform, $model, [$processor], [$processor]);
+$messages = new MessageBag(
+    Message::forSystem('You are a helpful math tutor. Guide the user through the solution step by step.'),
+    Message::ofUser('how can I solve 8x + 7 = -23'),
+);
+$response = $agent->call($messages, ['output_structure' => MathReasoning::class]);
+
+dump($response->getContent());

src/platform/src/Bridge/Google/Gemini.php

@@ -36,6 +36,7 @@ public function __construct(string $name = self::GEMINI_2_PRO, array $options =
             Capability::INPUT_AUDIO,
             Capability::INPUT_PDF,
             Capability::OUTPUT_STREAMING,
+            Capability::OUTPUT_STRUCTURED,
             Capability::TOOL_CALLING,
         ];
 

src/platform/src/Bridge/Google/ModelHandler.php

@@ -61,6 +61,12 @@ public function request(Model $model, array|string $payload, array $options = []
             $options['stream'] ?? false ? 'streamGenerateContent' : 'generateContent',
         );
 
+        if (isset($options['response_format']['json_schema']['schema'])) {
+            $options['responseMimeType'] = 'application/json';
+            $options['responseJsonSchema'] = $options['response_format']['json_schema']['schema'];
+            unset($options['response_format']);
+        }
+
         $generationConfig = ['generationConfig' => $options];
         unset($generationConfig['generationConfig']['stream']);
         unset($generationConfig['generationConfig']['tools']);