Use JSON Path to convert responses

Author: chr-hertel

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"
     },

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",

src/platform/src/Bridge/Google/Embeddings/ResponseConverter.php

@@ -12,11 +12,10 @@
 namespace Symfony\AI\Platform\Bridge\Google\Embeddings;
 
 use Symfony\AI\Platform\Bridge\Google\Embeddings;
-use Symfony\AI\Platform\Exception\RuntimeException;
+use Symfony\AI\Platform\Contract\ResponseConverter\VectorResponseConverter;
 use Symfony\AI\Platform\Model;
 use Symfony\AI\Platform\Response\VectorResponse;
 use Symfony\AI\Platform\ResponseConverterInterface;
-use Symfony\AI\Platform\Vector\Vector;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
 /**
@@ -31,17 +30,6 @@ public function supports(Model $model): bool
 
     public function convert(ResponseInterface $response, array $options = []): VectorResponse
     {
-        $data = $response->toArray();
-
-        if (!isset($data['embeddings'])) {
-            throw new RuntimeException('Response does not contain data');
-        }
-
-        return new VectorResponse(
-            ...array_map(
-                static fn (array $item): Vector => new Vector($item['values']),
-                $data['embeddings'],
-            ),
-        );
+        return (new VectorResponseConverter('$.embeddings[*].values'))($response->getContent(false));
     }
 }

src/platform/src/Bridge/Mistral/Embeddings/ResponseConverter.php

@@ -12,11 +12,11 @@
 namespace Symfony\AI\Platform\Bridge\Mistral\Embeddings;
 
 use Symfony\AI\Platform\Bridge\Mistral\Embeddings;
+use Symfony\AI\Platform\Contract\ResponseConverter\VectorResponseConverter;
 use Symfony\AI\Platform\Exception\RuntimeException;
 use Symfony\AI\Platform\Model;
 use Symfony\AI\Platform\Response\VectorResponse;
 use Symfony\AI\Platform\ResponseConverterInterface;
-use Symfony\AI\Platform\Vector\Vector;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
 /**
@@ -31,21 +31,10 @@ public function supports(Model $model): bool
 
     public function convert(ResponseInterface $response, array $options = []): VectorResponse
     {
-        $data = $response->toArray(false);
-
         if (200 !== $response->getStatusCode()) {
             throw new RuntimeException(\sprintf('Unexpected response code %d: %s', $response->getStatusCode(), $response->getContent(false)));
         }
 
-        if (!isset($data['data'])) {
-            throw new RuntimeException('Response does not contain data');
-        }
-
-        return new VectorResponse(
-            ...array_map(
-                static fn (array $item): Vector => new Vector($item['embedding']),
-                $data['data']
-            ),
-        );
+        return (new VectorResponseConverter())($response->getContent(false));
     }
 }

src/platform/src/Bridge/OpenAI/Embeddings/ResponseConverter.php

@@ -12,11 +12,10 @@
 namespace Symfony\AI\Platform\Bridge\OpenAI\Embeddings;
 
 use Symfony\AI\Platform\Bridge\OpenAI\Embeddings;
-use Symfony\AI\Platform\Exception\RuntimeException;
+use Symfony\AI\Platform\Contract\ResponseConverter\VectorResponseConverter;
 use Symfony\AI\Platform\Model;
 use Symfony\AI\Platform\Response\VectorResponse;
 use Symfony\AI\Platform\ResponseConverterInterface as PlatformResponseConverter;
-use Symfony\AI\Platform\Vector\Vector;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
 /**
@@ -31,17 +30,6 @@ public function supports(Model $model): bool
 
     public function convert(ResponseInterface $response, array $options = []): VectorResponse
     {
-        $data = $response->toArray();
-
-        if (!isset($data['data'])) {
-            throw new RuntimeException('Response does not contain data');
-        }
-
-        return new VectorResponse(
-            ...array_map(
-                static fn (array $item): Vector => new Vector($item['embedding']),
-                $data['data']
-            ),
-        );
+        return (new VectorResponseConverter())($response->getContent(false));
     }
 }

src/platform/src/Bridge/Voyage/ResponseConverter.php

@@ -11,12 +11,10 @@
 
 namespace Symfony\AI\Platform\Bridge\Voyage;
 
-use Symfony\AI\Platform\Exception\RuntimeException;
+use Symfony\AI\Platform\Contract\ResponseConverter\VectorResponseConverter;
 use Symfony\AI\Platform\Model;
 use Symfony\AI\Platform\Response\ResponseInterface as LlmResponse;
-use Symfony\AI\Platform\Response\VectorResponse;
 use Symfony\AI\Platform\ResponseConverterInterface;
-use Symfony\AI\Platform\Vector\Vector;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
 /**
@@ -31,14 +29,6 @@ public function supports(Model $model): bool
 
     public function convert(ResponseInterface $response, array $options = []): LlmResponse
     {
-        $response = $response->toArray();
-
-        if (!isset($response['data'])) {
-            throw new RuntimeException('Response does not contain embedding data');
-        }
-
-        $vectors = array_map(fn (array $data) => new Vector($data['embedding']), $response['data']);
-
-        return new VectorResponse($vectors[0]);
+        return (new VectorResponseConverter())($response->getContent(false));
     }
 }

src/platform/src/Contract/ResponseConverter/VectorResponseConverter.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.
+ */
+
+namespace Symfony\AI\Platform\Contract\ResponseConverter;
+
+use Symfony\AI\Platform\Exception\RuntimeException;
+use Symfony\AI\Platform\Response\VectorResponse;
+use Symfony\AI\Platform\Vector\Vector;
+use Symfony\Component\JsonPath\JsonCrawler;
+use Symfony\Component\JsonPath\JsonPath;
+
+final readonly class VectorResponseConverter
+{
+    public function __construct(
+        private string|JsonPath $query = '$.data[*].embedding',
+    ) {
+    }
+
+    public function __invoke(string $json): VectorResponse
+    {
+        $crawler = new JsonCrawler($json);
+        $vectors = $crawler->find($this->query);
+
+        if (empty($vectors)) {
+            throw new RuntimeException('Response does not contain any vectors');
+        }
+
+        return new VectorResponse(
+            ...array_map(static fn (array $vector): Vector => new Vector($vector), $vectors),
+        );
+    }
+}