feat: expose more information about the index (#14)

* feat: expose more information about the index
* test: add tests for dense and hybrid index info
* chore: remove prefix in import

---------

Co-authored-by: ytkimirti <yusuftaha9@gmail.com>

Author: heyjorgedev

src/DenseIndexInfo.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Upstash\Vector;
+
+use Upstash\Vector\Contracts\Arrayable;
+
+final readonly class DenseIndexInfo implements Arrayable
+{
+    public function __construct(
+        public int $dimension = 0,
+        public string $similarityFunction = '',
+        public string $embeddingModel = '',
+    ) {}
+
+    public function toArray(): array
+    {
+        return [
+            'dimension' => $this->dimension,
+            'similarityFunction' => $this->similarityFunction,
+            'embeddingModel' => $this->embeddingModel,
+        ];
+    }
+}

src/Enums/IndexType.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Upstash\Vector\Enums;
+
+enum IndexType: string
+{
+    case DENSE = 'DENSE';
+    case SPARSE = 'SPARSE';
+    case HYBRID = 'HYBRID';
+    case UNKNOWN = 'UNKNOWN';
+}

src/IndexInfo.php

@@ -3,6 +3,7 @@
 namespace Upstash\Vector;
 
 use Upstash\Vector\Contracts\Arrayable;
+use Upstash\Vector\Enums\IndexType;
 
 final readonly class IndexInfo implements Arrayable
 {
@@ -16,6 +17,9 @@ public function __construct(
         public int $dimension = 0,
         public string $similarityFunction = '',
         public array $namespaces = [],
+        public IndexType $indexType = IndexType::UNKNOWN,
+        public ?DenseIndexInfo $denseIndex = null,
+        public ?SparseIndexInfo $sparseIndex = null,
     ) {}
 
     public function namespace(string $namespace): NamespaceInfo
@@ -38,6 +42,9 @@ public function toArray(): array
             'dimension' => $this->dimension,
             'similarityFunction' => $this->similarityFunction,
             'namespaces' => $this->namespaces,
+            'indexType' => $this->indexType->value,
+            'denseIndex' => $this->denseIndex?->toArray(),
+            'sparseIndex' => $this->sparseIndex?->toArray(),
         ];
     }
 }

src/Iterators/VectorRangeIterator.php

@@ -2,6 +2,7 @@
 
 namespace Upstash\Vector\Iterators;
 
+use Iterator;
 use Upstash\Vector\Operations\RangeVectorsOperation;
 use Upstash\Vector\VectorMatch;
 use Upstash\Vector\VectorRange;
@@ -10,7 +11,7 @@
 /**
  * @implements \Iterator<string, VectorMatch>
  */
-class VectorRangeIterator implements \Iterator
+class VectorRangeIterator implements Iterator
 {
     private string $nextCursor;
 
@@ -46,7 +47,6 @@ public function next(): void
             $this->results = $rangeResult->getResults();
             $this->position = 0;
         }
-
     }
 
     public function key(): string

src/Operations/GetIndexInfoOperation.php

@@ -3,9 +3,12 @@
 namespace Upstash\Vector\Operations;
 
 use Upstash\Vector\Contracts\TransporterInterface;
+use Upstash\Vector\DenseIndexInfo;
+use Upstash\Vector\Enums\IndexType;
 use Upstash\Vector\IndexInfo;
 use Upstash\Vector\NamespaceInfo;
 use Upstash\Vector\Operations\Concerns\AssertsApiResponseErrors;
+use Upstash\Vector\SparseIndexInfo;
 use Upstash\Vector\Transporter\ContentType;
 use Upstash\Vector\Transporter\Method;
 use Upstash\Vector\Transporter\TransporterRequest;
@@ -55,6 +58,31 @@ private function transformResponse(TransporterResponse $response): IndexInfo
             dimension: $result['dimension'],
             similarityFunction: $result['similarityFunction'],
             namespaces: $namespaces,
+            indexType: IndexType::tryFrom($result['indexType'] ?? '') ?? IndexType::UNKNOWN,
+            denseIndex: isset($result['denseIndex']) ? $this->transformDenseIndex($result['denseIndex']) : null,
+            sparseIndex: isset($result['sparseIndex']) ? $this->transformSparseIndex($result['sparseIndex']) : null,
+        );
+    }
+
+    /**
+     * @param  array<string, mixed>  $data
+     */
+    private function transformDenseIndex(array $data): DenseIndexInfo
+    {
+        return new DenseIndexInfo(
+            dimension: $data['dimension'] ?? 0,
+            similarityFunction: $data['similarityFunction'] ?? '',
+            embeddingModel: $data['embeddingModel'] ?? '',
+        );
+    }
+
+    /**
+     * @param  array<string, mixed>  $data
+     */
+    private function transformSparseIndex(array $data): SparseIndexInfo
+    {
+        return new SparseIndexInfo(
+            embeddingModel: $data['embeddingModel'] ?? '',
         );
     }
 }

src/SparseIndexInfo.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Upstash\Vector;
+
+use Upstash\Vector\Contracts\Arrayable;
+
+final readonly class SparseIndexInfo implements Arrayable
+{
+    public function __construct(
+        public string $embeddingModel = '',
+    ) {}
+
+    public function toArray(): array
+    {
+        return [
+            'embeddingModel' => $this->embeddingModel,
+        ];
+    }
+}

tests/Dense/Operations/GetIndexInfoTest.php

@@ -3,6 +3,7 @@
 namespace Upstash\Vector\Tests\Dense\Operations;
 
 use PHPUnit\Framework\TestCase;
+use Upstash\Vector\Enums\IndexType;
 use Upstash\Vector\IndexInfo;
 use Upstash\Vector\Tests\Concerns\UsesDenseIndex;
 
@@ -15,5 +16,10 @@ public function test_get_info(): void
         $info = $this->index->getInfo();
 
         $this->assertInstanceOf(IndexInfo::class, $info);
+        $this->assertSame(IndexType::DENSE, $info->indexType);
+        $this->assertNull($info->sparseIndex);
+        $this->assertNotNull($info->denseIndex);
+        $this->assertSame(2, $info->denseIndex->dimension);
+        $this->assertSame('COSINE', $info->denseIndex->similarityFunction);
     }
 }

tests/Hybrid/Operations/GetIndexInfoTest.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Upstash\Vector\Tests\Hybrid\Operations;
+
+use PHPUnit\Framework\TestCase;
+use Upstash\Vector\Enums\IndexType;
+use Upstash\Vector\IndexInfo;
+use Upstash\Vector\Tests\Concerns\UsesHybridIndex;
+
+class GetIndexInfoTest extends TestCase
+{
+    use UsesHybridIndex;
+
+    public function test_get_info(): void
+    {
+        $info = $this->index->getInfo();
+
+        $this->assertInstanceOf(IndexInfo::class, $info);
+        $this->assertSame(IndexType::HYBRID, $info->indexType);
+        $this->assertNotNull($info->sparseIndex);
+        $this->assertNotNull($info->denseIndex);
+    }
+}

tests/Sparse/Operations/GetIndexInfoTest.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Upstash\Vector\Tests\Sparse\Operations;
+
+use PHPUnit\Framework\TestCase;
+use Upstash\Vector\Enums\IndexType;
+use Upstash\Vector\IndexInfo;
+use Upstash\Vector\Tests\Concerns\UsesSparseIndex;
+
+class GetIndexInfoTest extends TestCase
+{
+    use UsesSparseIndex;
+
+    public function test_get_info(): void
+    {
+        $info = $this->index->getInfo();
+
+        $this->assertInstanceOf(IndexInfo::class, $info);
+        $this->assertSame(IndexType::SPARSE, $info->indexType);
+        $this->assertNotNull($info->sparseIndex);
+        $this->assertNull($info->denseIndex);
+        $this->assertSame('BM25', $info->sparseIndex->embeddingModel);
+    }
+}