Use JSON Path to convert responses

chr-hertel · chr-hertel · commit a5e2e2812771 · 2025-07-26T11:12:23.000+02:00
diff --git a/examples/composer.json b/examples/composer.json
@@ -22,6 +22,7 @@
         "symfony/event-dispatcher": "^6.4|^7.0",
         "symfony/filesystem": "^6.4|^7.0",
         "symfony/finder": "^6.4|^7.0",
+        "symfony/json-path": "7.3.*",
         "symfony/process": "^6.4|^7.0",
         "symfony/var-dumper": "^6.4|^7.0"
     },
diff --git a/src/platform/composer.json b/src/platform/composer.json
@@ -28,6 +28,7 @@
         "psr/log": "^3.0",
         "symfony/clock": "^6.4 || ^7.1",
         "symfony/http-client": "^6.4 || ^7.1",
+        "symfony/json-path": "7.3.*",
         "symfony/property-access": "^6.4 || ^7.1",
         "symfony/property-info": "^6.4 || ^7.1",
         "symfony/serializer": "^6.4 || ^7.1",
diff --git a/src/platform/src/Bridge/Albert/PlatformFactory.php b/src/platform/src/Bridge/Albert/PlatformFactory.php
@@ -11,7 +11,6 @@
 
 namespace Symfony\AI\Platform\Bridge\Albert;
 
-use Symfony\AI\Platform\Bridge\OpenAI\Embeddings;
 use Symfony\AI\Platform\Bridge\OpenAI\GPT;
 use Symfony\AI\Platform\Contract;
 use Symfony\AI\Platform\Exception\InvalidArgumentException;
@@ -40,7 +39,7 @@ public static function create(
                 new GPTModelClient($httpClient, $apiKey, $baseUrl),
                 new EmbeddingsModelClient($httpClient, $apiKey, $baseUrl),
             ],
-            [new GPT\ResultConverter(), new Embeddings\ResultConverter()],
+            [new GPT\ResultConverter()],
             Contract::create(),
         );
     }
diff --git a/src/platform/src/Bridge/Azure/OpenAI/PlatformFactory.php b/src/platform/src/Bridge/Azure/OpenAI/PlatformFactory.php
@@ -41,7 +41,7 @@ public static function create(
 
         return new Platform(
             [$GPTModelClient, $embeddingsModelClient, $whisperModelClient],
-            [new GPT\ResultConverter(), new Embeddings\ResultConverter(), new Whisper\ResultConverter()],
+            [new GPT\ResultConverter(), new Whisper\ResultConverter()],
             $contract ?? Contract::create(new AudioNormalizer()),
         );
     }
diff --git a/src/platform/src/Bridge/Gemini/Embeddings.php b/src/platform/src/Bridge/Gemini/Embeddings.php
@@ -32,6 +32,6 @@ class Embeddings extends Model
      */
     public function __construct(string $name = self::GEMINI_EMBEDDING_EXP_03_07, array $options = [])
     {
-        parent::__construct($name, [Capability::INPUT_MULTIPLE], $options);
+        parent::__construct($name, [Capability::INPUT_MULTIPLE, Capability::OUTPUT_VECTOR], $options);
     }
 }
diff --git a/src/platform/src/Bridge/Gemini/Embeddings/ResultConverter.php b/src/platform/src/Bridge/Gemini/Embeddings/ResultConverter.php
@@ -11,37 +11,15 @@
 
 namespace Symfony\AI\Platform\Bridge\Gemini\Embeddings;
 
-use Symfony\AI\Platform\Bridge\Gemini\Embeddings;
-use Symfony\AI\Platform\Exception\RuntimeException;
-use Symfony\AI\Platform\Model;
-use Symfony\AI\Platform\Result\RawResultInterface;
-use Symfony\AI\Platform\Result\VectorResult;
-use Symfony\AI\Platform\ResultConverterInterface;
-use Symfony\AI\Platform\Vector\Vector;
+use Symfony\AI\Platform\Contract\ResultConverter\VectorResultConverter;
 
 /**
  * @author Valtteri R <valtzu@gmail.com>
  */
-final readonly class ResultConverter implements ResultConverterInterface
+final readonly class ResultConverter extends VectorResultConverter
 {
-    public function supports(Model $model): bool
+    public function __construct()
     {
-        return $model instanceof Embeddings;
-    }
-
-    public function convert(RawResultInterface $result, array $options = []): VectorResult
-    {
-        $data = $result->getData();
-
-        if (!isset($data['embeddings'])) {
-            throw new RuntimeException('Response does not contain data');
-        }
-
-        return new VectorResult(
-            ...array_map(
-                static fn (array $item): Vector => new Vector($item['values']),
-                $data['embeddings'],
-            ),
-        );
+        parent::__construct('$.embeddings[*].values');
     }
 }
diff --git a/src/platform/src/Bridge/Mistral/Embeddings.php b/src/platform/src/Bridge/Mistral/Embeddings.php
@@ -28,6 +28,6 @@ public function __construct(
         string $name = self::MISTRAL_EMBED,
         array $options = [],
     ) {
-        parent::__construct($name, [Capability::INPUT_MULTIPLE], $options);
+        parent::__construct($name, [Capability::INPUT_MULTIPLE, Capability::OUTPUT_VECTOR], $options);
     }
 }
diff --git a/src/platform/src/Bridge/Mistral/PlatformFactory.php b/src/platform/src/Bridge/Mistral/PlatformFactory.php
@@ -32,7 +32,7 @@ public static function create(
 
         return new Platform(
             [new Embeddings\ModelClient($httpClient, $apiKey), new Llm\ModelClient($httpClient, $apiKey)],
-            [new Embeddings\ResultConverter(), new Llm\ResultConverter()],
+            [new Llm\ResultConverter()],
             $contract ?? Contract::create(new ToolNormalizer()),
         );
     }
diff --git a/src/platform/src/Bridge/OpenAI/Embeddings.php b/src/platform/src/Bridge/OpenAI/Embeddings.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\AI\Platform\Bridge\OpenAI;
 
+use Symfony\AI\Platform\Capability;
 use Symfony\AI\Platform\Model;
 
 /**
@@ -27,6 +28,6 @@ class Embeddings extends Model
      */
     public function __construct(string $name = self::TEXT_3_SMALL, array $options = [])
     {
-        parent::__construct($name, [], $options);
+        parent::__construct($name, [Capability::OUTPUT_VECTOR], $options);
     }
 }
diff --git a/src/platform/src/Bridge/OpenAI/Embeddings/ResultConverter.php b/src/platform/src/Bridge/OpenAI/Embeddings/ResultConverter.php
diff --git a/src/platform/src/Bridge/OpenAI/PlatformFactory.php b/src/platform/src/Bridge/OpenAI/PlatformFactory.php
@@ -41,7 +41,6 @@ public static function create(
             ],
             [
                 new GPT\ResultConverter(),
-                new Embeddings\ResultConverter(),
                 new DallE\ResultConverter(),
                 new WhisperResponseConverter(),
             ],
diff --git a/src/platform/src/Bridge/Voyage/PlatformFactory.php b/src/platform/src/Bridge/Voyage/PlatformFactory.php
@@ -29,6 +29,6 @@ public static function create(
     ): Platform {
         $httpClient = $httpClient instanceof EventSourceHttpClient ? $httpClient : new EventSourceHttpClient($httpClient);
 
-        return new Platform([new ModelClient($httpClient, $apiKey)], [new ResultConverter()], $contract);
+        return new Platform([new ModelClient($httpClient, $apiKey)], [], $contract);
     }
 }
diff --git a/src/platform/src/Bridge/Voyage/ResultConverter.php b/src/platform/src/Bridge/Voyage/ResultConverter.php
diff --git a/src/platform/src/Bridge/Voyage/Voyage.php b/src/platform/src/Bridge/Voyage/Voyage.php
@@ -31,6 +31,6 @@ class Voyage extends Model
      */
     public function __construct(string $name = self::V3, array $options = [])
     {
-        parent::__construct($name, [Capability::INPUT_MULTIPLE], $options);
+        parent::__construct($name, [Capability::INPUT_MULTIPLE, Capability::OUTPUT_VECTOR], $options);
     }
 }
diff --git a/src/platform/src/Capability.php b/src/platform/src/Capability.php
@@ -30,6 +30,7 @@ enum Capability: string
     case OUTPUT_STREAMING = 'output-streaming';
     case OUTPUT_STRUCTURED = 'output-structured';
     case OUTPUT_TEXT = 'output-text';
+    case OUTPUT_VECTOR = 'output-vector';
 
     // FUNCTIONALITY
     case TOOL_CALLING = 'tool-calling';
diff --git a/src/platform/src/Contract/ResultConverter/VectorResultConverter.php b/src/platform/src/Contract/ResultConverter/VectorResultConverter.php
@@ -9,46 +9,44 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\AI\Platform\Bridge\Mistral\Embeddings;
+namespace Symfony\AI\Platform\Contract\ResultConverter;
 
-use Symfony\AI\Platform\Bridge\Mistral\Embeddings;
+use Symfony\AI\Platform\Capability;
 use Symfony\AI\Platform\Exception\RuntimeException;
 use Symfony\AI\Platform\Model;
 use Symfony\AI\Platform\Result\RawHttpResult;
 use Symfony\AI\Platform\Result\RawResultInterface;
+use Symfony\AI\Platform\Result\ResultInterface;
 use Symfony\AI\Platform\Result\VectorResult;
 use Symfony\AI\Platform\ResultConverterInterface;
 use Symfony\AI\Platform\Vector\Vector;
+use Symfony\Component\JsonPath\JsonCrawler;
+use Symfony\Component\JsonPath\JsonPath;
 
-/**
- * @author Christopher Hertel <mail@christopher-hertel.de>
- */
-final readonly class ResultConverter implements ResultConverterInterface
+readonly class VectorResultConverter implements ResultConverterInterface
 {
+    public function __construct(
+        private string|JsonPath $query = '$.data[*].embedding',
+    ) {
+    }
+
     public function supports(Model $model): bool
     {
-        return $model instanceof Embeddings;
+        // TODO: THIS IS NOT ENOUGH TO GET ACTIVATED
+        return $model->supports(Capability::OUTPUT_VECTOR);
     }
 
-    public function convert(RawResultInterface|RawHttpResult $result, array $options = []): VectorResult
+    public function convert(RawResultInterface|RawHttpResult $result, array $options = []): ResultInterface
     {
-        $httpResponse = $result->getObject();
-
-        if (200 !== $httpResponse->getStatusCode()) {
-            throw new RuntimeException(\sprintf('Unexpected response code %d: %s', $httpResponse->getStatusCode(), $httpResponse->getContent(false)));
-        }
-
-        $data = $result->getData();
+        $crawler = new JsonCrawler($result->getObject()->getContent(false));
+        $vectors = $crawler->find($this->query);
 
-        if (!isset($data['data'])) {
-            throw new RuntimeException('Response does not contain data');
+        if (empty($vectors)) {
+            throw new RuntimeException('Response does not contain any vectors');
         }
 
         return new VectorResult(
-            ...array_map(
-                static fn (array $item): Vector => new Vector($item['embedding']),
-                $data['data']
-            ),
+            ...array_map(static fn (array $vector): Vector => new Vector($vector), $vectors),
         );
     }
 }
diff --git a/src/platform/src/Platform.php b/src/platform/src/Platform.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\AI\Platform;
 
+use Symfony\AI\Platform\Contract\ResultConverter\VectorResultConverter;
 use Symfony\AI\Platform\Exception\RuntimeException;
 use Symfony\AI\Platform\Result\RawResultInterface;
 use Symfony\AI\Platform\Result\ResultPromise;
@@ -41,7 +42,10 @@ public function __construct(
     ) {
         $this->contract = $contract ?? Contract::create();
         $this->modelClients = $modelClients instanceof \Traversable ? iterator_to_array($modelClients) : $modelClients;
-        $this->resultConverters = $resultConverters instanceof \Traversable ? iterator_to_array($resultConverters) : $resultConverters;
+        $this->resultConverters = array_merge(
+            $resultConverters instanceof \Traversable ? iterator_to_array($resultConverters) : $resultConverters,
+            [new VectorResultConverter()],
+        );
     }
 
     public function invoke(Model $model, array|string|object $input, array $options = []): ResultPromise
diff --git a/src/platform/tests/Bridge/Gemini/Embeddings/ResponseConverterTest.php b/src/platform/tests/Bridge/Gemini/Embeddings/ResponseConverterTest.php
diff --git a/src/platform/tests/Bridge/OpenAI/Embeddings/ResponseConverterTest.php b/src/platform/tests/Bridge/OpenAI/Embeddings/ResponseConverterTest.php
diff --git a/src/platform/tests/Contract/ResultConverter/VectorResultConverterTest.php b/src/platform/tests/Contract/ResultConverter/VectorResultConverterTest.php
diff --git a/src/platform/tests/Contract/ResultConverter/fixtures/specific-embeddings-success.json b/src/platform/tests/Contract/ResultConverter/fixtures/specific-embeddings-success.json
diff --git a/src/platform/tests/Contract/ResultConverter/fixtures/standard-embeddings-success.json b/src/platform/tests/Contract/ResultConverter/fixtures/standard-embeddings-success.json

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public static function create(`
`41`	`41`
`42`	`42`	`return new Platform(`
`43`	`43`	`[$GPTModelClient, $embeddingsModelClient, $whisperModelClient],`
`44`		`- [new GPT\ResultConverter(), new Embeddings\ResultConverter(), new Whisper\ResultConverter()],`
	`44`	`+ [new GPT\ResultConverter(), new Whisper\ResultConverter()],`
`45`	`45`	`$contract ?? Contract::create(new AudioNormalizer()),`
`46`	`46`	`);`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,6 @@ class Embeddings extends Model`
`32`	`32`	`*/`
`33`	`33`	`public function __construct(string $name = self::GEMINI_EMBEDDING_EXP_03_07, array $options = [])`
`34`	`34`	`{`
`35`		`- parent::__construct($name, [Capability::INPUT_MULTIPLE], $options);`
	`35`	`+ parent::__construct($name, [Capability::INPUT_MULTIPLE, Capability::OUTPUT_VECTOR], $options);`
`36`	`36`	`}`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,6 @@ public function __construct(`
`28`	`28`	`string $name = self::MISTRAL_EMBED,`
`29`	`29`	`array $options = [],`
`30`	`30`	`) {`
`31`		`- parent::__construct($name, [Capability::INPUT_MULTIPLE], $options);`
	`31`	`+ parent::__construct($name, [Capability::INPUT_MULTIPLE, Capability::OUTPUT_VECTOR], $options);`
`32`	`32`	`}`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public static function create(`
`32`	`32`
`33`	`33`	`return new Platform(`
`34`	`34`	`[new Embeddings\ModelClient($httpClient, $apiKey), new Llm\ModelClient($httpClient, $apiKey)],`
`35`		`- [new Embeddings\ResultConverter(), new Llm\ResultConverter()],`
	`35`	`+ [new Llm\ResultConverter()],`
`36`	`36`	`$contract ?? Contract::create(new ToolNormalizer()),`
`37`	`37`	`);`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\AI\Platform\Bridge\OpenAI;`
`13`	`13`
	`14`	`+use Symfony\AI\Platform\Capability;`
`14`	`15`	`use Symfony\AI\Platform\Model;`
`15`	`16`
`16`	`17`	`/**`
`@@ -27,6 +28,6 @@ class Embeddings extends Model`
`27`	`28`	`*/`
`28`	`29`	`public function __construct(string $name = self::TEXT_3_SMALL, array $options = [])`
`29`	`30`	`{`
`30`		`- parent::__construct($name, [], $options);`
	`31`	`+ parent::__construct($name, [Capability::OUTPUT_VECTOR], $options);`
`31`	`32`	`}`
`32`	`33`	`}`