Create tool (call) normalizers for Responses API

Since we're migration from chat completions to Responses, which has a
differnt data structure for function calls

Author: paulinevos

src/platform/src/Bridge/OpenAi/Contract/Gpt/ToolCallNormalizer.php

@@ -0,0 +1,50 @@
+<?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.
+ */
+
+namespace Symfony\AI\Platform\Bridge\OpenAi\Contract\Gpt;
+
+use Symfony\AI\Platform\Bridge\OpenAi\Gpt;
+use Symfony\AI\Platform\Contract\Normalizer\ModelContractNormalizer;
+use Symfony\AI\Platform\Model;
+use Symfony\AI\Platform\Result\ToolCall;
+
+final class ToolCallNormalizer extends ModelContractNormalizer
+{
+    /**
+     * @param ToolCall $data
+     *
+     * @return array{
+     *     arguments: string,
+     *     call_id: string,
+     *     name: string,
+     *     type: 'function_call'
+     * }
+     */
+    public function normalize(mixed $data, ?string $format = null, array $context = []): array
+    {
+        return [
+            'arguments' => json_encode($data->getArguments()),
+            'call_id' => $data->getId(),
+            'name' => $data->getName(),
+            'type' => 'function_call',
+        ];
+    }
+
+    protected function supportedDataClass(): string
+    {
+        return ToolCall::class;
+    }
+
+    protected function supportsModel(Model $model): bool
+    {
+        return $model instanceof Gpt;
+    }
+}

src/platform/src/Bridge/OpenAi/Contract/Gpt/ToolNormalizer.php

@@ -0,0 +1,61 @@
+<?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.
+ */
+
+namespace Symfony\AI\Platform\Bridge\OpenAi\Contract\Gpt;
+
+use Symfony\AI\Platform\Bridge\OpenAi\Gpt;
+use Symfony\AI\Platform\Contract\JsonSchema\Factory;
+use Symfony\AI\Platform\Contract\Normalizer\ModelContractNormalizer;
+use Symfony\AI\Platform\Model;
+use Symfony\AI\Platform\Tool\Tool;
+
+/**
+ * @phpstan-import-type JsonSchema from Factory
+ *
+ * @author Christopher Hertel <[email protected]>
+ */
+class ToolNormalizer extends ModelContractNormalizer
+{
+    /**
+     * @param Tool $data
+     *
+     * @return array{
+     *     type: 'function',
+     *     name: string,
+     *     description: string,
+     *     parameters?: JsonSchema
+     * }
+     */
+    public function normalize(mixed $data, ?string $format = null, array $context = []): array
+    {
+        $function = [
+            'type' => 'function',
+            'name' => $data->getName(),
+            'description' => $data->getDescription(),
+        ];
+
+        if (null !== $data->getParameters()) {
+            $function['parameters'] = $data->getParameters();
+        }
+
+        return $function;
+    }
+
+    protected function supportedDataClass(): string
+    {
+        return Tool::class;
+    }
+
+    protected function supportsModel(Model $model): bool
+    {
+        return $model instanceof Gpt;
+    }
+}

src/platform/tests/Bridge/OpenAi/Contract/Gpt/ToolCallNormalizerTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Symfony\AI\Platform\Tests\Bridge\OpenAi\Contract\Gpt;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use Symfony\AI\Platform\Bridge\Gemini\Gemini;
+use Symfony\AI\Platform\Bridge\OpenAi\Contract\Gpt\ToolCallNormalizer;
+use PHPUnit\Framework\TestCase;
+use Symfony\AI\Platform\Bridge\OpenAi\Gpt;
+use Symfony\AI\Platform\Contract;
+use Symfony\AI\Platform\Message\Content\Text;
+use Symfony\AI\Platform\Model;
+use Symfony\AI\Platform\Result\ToolCall;
+
+class ToolCallNormalizerTest extends TestCase
+{
+    public function testNormalize()
+    {
+        $toolCall = new ToolCall('some-id', 'roll-die', ['sides' => 24]);
+
+        $actual = (new ToolCallNormalizer())->normalize($toolCall, null, [Contract::CONTEXT_MODEL => new Gpt('o3')]);
+        $this->assertEquals([
+            'arguments' => json_encode($toolCall->getArguments()),
+            'call_id' => $toolCall->getId(),
+            'name' => $toolCall->getName(),
+            'type' => 'function_call',
+        ], $actual);
+    }
+
+    #[DataProvider('supportsNormalizationProvider')]
+    public function testSupportsNormalization(mixed $data, Model $model, bool $expected)
+    {
+        $this->assertSame(
+            $expected,
+            (new ToolCallNormalizer())->supportsNormalization($data, null, [Contract::CONTEXT_MODEL => $model])
+        );
+    }
+
+    public static function supportsNormalizationProvider(): \Generator
+    {
+        $toolCall = new ToolCall('some-id', 'roll-die', ['sides' => 24]);
+        $gpt = new Gpt('o3');
+
+        yield 'supported' => [$toolCall, $gpt, true];
+        yield 'unsupported model' => [$toolCall, new Gemini('foo'), false];
+        yield 'unsupported data' => [new Text('foo'), $gpt, false];
+    }
+}

src/platform/tests/Bridge/OpenAi/Contract/Gpt/ToolNormalizerTest.php

@@ -0,0 +1,71 @@
+<?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.
+ */
+
+namespace Symfony\AI\Platform\Tests\Bridge\OpenAi\Contract\Gpt;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use Symfony\AI\Platform\Bridge\Gemini\Gemini;
+use Symfony\AI\Platform\Bridge\OpenAi\Contract\Gpt\ToolNormalizer;
+use Symfony\AI\Platform\Bridge\OpenAi\Gpt;
+use Symfony\AI\Platform\Contract;
+use Symfony\AI\Platform\Message\Content\Text;
+use Symfony\AI\Platform\Model;
+use Symfony\AI\Platform\Tool\ExecutionReference;
+use Symfony\AI\Platform\Tool\Tool;
+
+class ToolNormalizerTest extends TestCase
+{
+    #[DataProvider('normalizeProvider')]
+    public function testNormalize(array $expected, Tool $tool)
+    {
+        $actual = (new ToolNormalizer())->normalize($tool, null, [Contract::CONTEXT_MODEL => new Gpt('o3')]);
+        $this->assertEquals($expected, $actual);
+    }
+
+    public static function normalizeProvider(): \Generator
+    {
+        $tool = new Tool(new ExecutionReference('Foo\Bar'), 'bar', 'description');
+
+        $expected = [
+            'type' => 'function',
+            'name' => $tool->getName(),
+            'description' => $tool->getDescription(),
+        ];
+
+        $parameters = ['foo' => 'bar'];
+
+        yield 'no parameters' => [$expected, $tool];
+        yield 'with parameters' => [
+            array_merge($expected, ['parameters' => $parameters]),
+            new Tool(new ExecutionReference('Foo\Bar'), 'bar', 'description', $parameters),
+        ];
+    }
+
+    #[DataProvider('supportsNormalizationProvider')]
+    public function testSupportsNormalization(mixed $data, Model $model, bool $expected)
+    {
+        $this->assertSame(
+            $expected,
+            (new ToolNormalizer())->supportsNormalization($data, null, [Contract::CONTEXT_MODEL => $model])
+        );
+    }
+
+    public static function supportsNormalizationProvider(): \Generator
+    {
+        $tool = new Tool(new ExecutionReference('Foo\Bar'), 'bar', 'description');
+        $gpt = new Gpt('o3');
+
+        yield 'supported' => [$tool, $gpt, true];
+        yield 'unsupported model' => [$tool, new Gemini('foo'), false];
+        yield 'unsupported data' => [new Text('foo'), $gpt, false];
+    }
+}