fix: Introduce NullVector and VectorInterface (#114)

* Introduce `NullVector` and `VectorInterface`

* -

* -

* -

* -

Author: OskarStark

src/Document/NullVector.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpLlm\LlmChain\Document;
+
+use PhpLlm\LlmChain\Exception\RuntimeException;
+
+final class NullVector implements VectorInterface
+{
+    public function getData(): array
+    {
+        throw new RuntimeException('getData() method cannot be called on a NullVector.');
+    }
+
+    public function getDimensions(): int
+    {
+        throw new RuntimeException('getDimensions() method cannot be called on a NullVector.');
+    }
+}

src/Document/Vector.php

@@ -6,7 +6,7 @@
 
 use PhpLlm\LlmChain\Exception\InvalidArgumentException;
 
-final class Vector
+final class Vector implements VectorInterface
 {
     /**
      * @param list<float> $data

src/Document/VectorDocument.php

@@ -10,7 +10,7 @@
 {
     public function __construct(
         public Uuid $id,
-        public Vector $vector,
+        public VectorInterface $vector,
         public Metadata $metadata = new Metadata(),
     ) {
     }

src/Document/VectorInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpLlm\LlmChain\Document;
+
+interface VectorInterface
+{
+    /**
+     * @return list<float>
+     */
+    public function getData(): array;
+
+    public function getDimensions(): int;
+}

src/Store/Azure/SearchStore.php

@@ -5,6 +5,7 @@
 namespace PhpLlm\LlmChain\Store\Azure;
 
 use PhpLlm\LlmChain\Document\Metadata;
+use PhpLlm\LlmChain\Document\NullVector;
 use PhpLlm\LlmChain\Document\Vector;
 use PhpLlm\LlmChain\Document\VectorDocument;
 use PhpLlm\LlmChain\Store\VectorStoreInterface;
@@ -80,7 +81,9 @@ private function convertToVectorDocument(array $data): VectorDocument
     {
         return new VectorDocument(
             id: Uuid::fromString($data['id']),
-            vector: $data[$this->vectorFieldName] ? new Vector($data[$this->vectorFieldName]) : null,
+            vector: !array_key_exists($this->vectorFieldName, $data) || null === $data[$this->vectorFieldName]
+                ? new NullVector()
+                : new Vector($data[$this->vectorFieldName]),
             metadata: new Metadata($data),
         );
     }

tests/Document/NullVectorTest.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpLlm\LlmChain\Tests\Document;
+
+use PhpLlm\LlmChain\Document\NullVector;
+use PhpLlm\LlmChain\Document\VectorInterface;
+use PhpLlm\LlmChain\Exception\RuntimeException;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+#[CoversClass(NullVector::class)]
+final class NullVectorTest extends TestCase
+{
+    #[Test]
+    public function implementsInterface(): void
+    {
+        self::assertInstanceOf(VectorInterface::class, new NullVector());
+    }
+
+    #[Test]
+    public function getDataThrowsOnAccess(): void
+    {
+        $this->expectException(RuntimeException::class);
+
+        (new NullVector())->getData();
+    }
+
+    #[Test]
+    public function getDimensionsThrowsOnAccess(): void
+    {
+        $this->expectException(RuntimeException::class);
+
+        (new NullVector())->getDimensions();
+    }
+}

tests/Document/VectorTest.php

@@ -5,13 +5,23 @@
 namespace PhpLlm\LlmChain\Tests\Document;
 
 use PhpLlm\LlmChain\Document\Vector;
+use PhpLlm\LlmChain\Document\VectorInterface;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 #[CoversClass(Vector::class)]
 final class VectorTest extends TestCase
 {
+    #[Test]
+    public function implementsInterface(): void
+    {
+        self::assertInstanceOf(
+            VectorInterface::class,
+            new Vector([1.0, 2.0, 3.0])
+        );
+    }
+
     #[Test]
     public function withDimensionNull(): void
     {