Merge pull request hkulekci#28 from mbukovy/patch-1

Support uuid for Points

Author: hkulekci

src/Endpoints/Collections/Points.php

@@ -111,7 +111,7 @@ public function ids(array $ids, $withPayload = false, $withVector = true, array
     /**
      * @throws InvalidArgumentException
      */
-    public function id(int $id, array $queryParams = []): Response
+    public function id(int|string $id, array $queryParams = []): Response
     {
         return $this->client->execute(
             $this->createRequest(
@@ -190,4 +190,4 @@ public function recommend(RecommendRequest $recommendParams): Response
             )
         );
     }
-}
+}

src/Models/PointStruct.php

@@ -16,11 +16,11 @@ class PointStruct
     use ProtectedPropertyAccessor;
 
     // TODO: we need a solution for point with uuid
-    protected int $id;
+    protected int|string $id;
     protected ?array $payload = null;
     protected VectorStruct $vector;
 
-    public function __construct(int $id, VectorStruct $vector, array $payload = null)
+    public function __construct(int|string $id, VectorStruct $vector, array $payload = null)
     {
         $this->id = $id;
         $this->vector = $vector;
@@ -58,7 +58,7 @@ public function toArray(): array
     /**
      * @return int
      */
-    public function getId(): int
+    public function getId(): int|string
     {
         return $this->id;
     }
@@ -78,4 +78,4 @@ public function getVector(): VectorStruct
     {
         return $this->vector;
     }
-}
+}

tests/Unit/Models/PointStructTest.php

@@ -26,6 +26,19 @@ public function testPointStruct(): void
         );
     }
 
+    public function testPointStructWithUUid(): void
+    {
+        $point = new PointStruct('550e8400-e29b-41d4-a716-446655440000', new VectorStruct([1, 2, 3]));
+
+        $this->assertEquals(
+            [
+                'id' => '550e8400-e29b-41d4-a716-446655440000',
+                'vector' => [1, 2, 3]
+            ],
+            $point->toArray()
+        );
+    }
+
     public function testPointStructWithArray(): void
     {
         $points = PointStruct::createFromArray([

tests/Unit/Models/PointsStructTest.php

@@ -34,6 +34,27 @@ public function testPointsStruct(): void
         );
     }
 
+    public function testPointsStructWithUUid(): void
+    {
+        $points = new PointsStruct();
+        $points->addPoint(
+            new PointStruct(
+                '550e8400-e29b-41d4-a716-446655440000',
+                new VectorStruct([1, 2, 3])
+            )
+        );
+
+        $this->assertEquals(
+            [
+                [
+                    'id' => '550e8400-e29b-41d4-a716-446655440000',
+                    'vector' => [1, 2, 3]
+                ]
+            ],
+            $points->toArray()
+        );
+    }
+
     public function testPointsStructWithArray(): void
     {
         $points = PointsStruct::createFromArray([
@@ -64,7 +85,7 @@ public function testPointsStructWithNamedVectors(): void
                 ],
             ],
             [
-                'id' => 1,
+                'id' => '550e8400-e29b-41d4-a716-446655440000',
                 'vector' => [
                     'image' => [3, 4, 5]
                 ],
@@ -80,7 +101,7 @@ public function testPointsStructWithNamedVectors(): void
                     ],
                 ],
                 [
-                    'id' => 1,
+                    'id' => '550e8400-e29b-41d4-a716-446655440000',
                     'vector' => [
                         'image' => [3, 4, 5]
                     ],