createCollection hnswConfig initialized hkulekci#36

Author: hkulekci

src/Models/Request/CollectionConfig/HnswConfig.php

@@ -0,0 +1,104 @@
+<?php
+/**
+ * HnswConfig
+ *
+ * @since     Dec 2023
+ * @author    Haydar KULEKCI <haydarkulekci@gmail.com>
+ */
+
+namespace Qdrant\Models\Request\CollectionConfig;
+
+use Qdrant\Exception\InvalidArgumentException;
+use Qdrant\Models\Request\RequestModel;
+
+class HnswConfig implements RequestModel
+{
+    protected ?int $m = null;
+    protected ?int $efConstruct = null;
+    protected ?int $fullScanThreshold = null;
+    protected ?int $maxIndexingThreads = null;
+    protected ?bool $onDisk = null;
+    protected ?int $payloadM = null;
+
+    public function setM(?int $m): HnswConfig
+    {
+        if ($this->efConstruct < 0) {
+            throw new InvalidArgumentException('m should be bigger than 0');
+        }
+        $this->m = $m;
+
+        return $this;
+    }
+
+    public function setEfConstruct(?int $efConstruct): HnswConfig
+    {
+        if ($efConstruct < 4) {
+            throw new InvalidArgumentException('ef_construct should be bigger than 4');
+        }
+        $this->efConstruct = $efConstruct;
+
+        return $this;
+    }
+
+    public function setFullScanThreshold(?int $fullScanThreshold): HnswConfig
+    {
+        if ($fullScanThreshold < 10) {
+            throw new InvalidArgumentException('full_scan_threshold should be bigger than 10');
+        }
+        $this->fullScanThreshold = $fullScanThreshold;
+
+        return $this;
+    }
+
+    public function setMaxIndexingThreads(?int $maxIndexingThreads): HnswConfig
+    {
+        if ($maxIndexingThreads < 0) {
+            throw new InvalidArgumentException('max_indexing_threads should be bigger than 0');
+        }
+        $this->maxIndexingThreads = $maxIndexingThreads;
+
+        return $this;
+    }
+
+    public function setOnDisk(?bool $onDisk): HnswConfig
+    {
+        $this->onDisk = $onDisk;
+
+        return $this;
+    }
+
+    public function setPayloadM(?int $payloadM): HnswConfig
+    {
+        if ($payloadM < 0) {
+            throw new InvalidArgumentException('payload_m should be bigger than 0');
+        }
+        $this->payloadM = $payloadM;
+
+        return $this;
+    }
+
+    public function toArray(): array
+    {
+        $data = [];
+        if ($this->m) {
+            $data['m'] = $this->m;
+        }
+        if ($this->efConstruct) {
+            $data['ef_construct'] = $this->efConstruct;
+        }
+        if ($this->fullScanThreshold) {
+            $data['full_scan_threshold'] = $this->fullScanThreshold;
+        }
+        if ($this->maxIndexingThreads) {
+            $data['max_indexing_threads'] = $this->maxIndexingThreads;
+        }
+        if ($this->onDisk) {
+            $data['on_disk'] = $this->onDisk;
+        }
+        if ($this->payloadM) {
+            $data['payload_m'] = $this->payloadM;
+        }
+
+        return $data;
+    }
+}

src/Models/Request/CreateCollection.php

@@ -9,6 +9,7 @@
 namespace Qdrant\Models\Request;
 
 use Qdrant\Models\Request\CollectionConfig\DisabledQuantization;
+use Qdrant\Models\Request\CollectionConfig\HnswConfig;
 use Qdrant\Models\Request\CollectionConfig\OptimizersConfigDiff;
 use Qdrant\Models\Request\CollectionConfig\QuantizationConfig;
 
@@ -29,6 +30,8 @@ class CreateCollection implements RequestModel
 
     protected ?OptimizersConfigDiff $optimizersConfig = null;
 
+    protected ?HnswConfig $hnswConfig = null;
+
     protected ?QuantizationConfig $quantizationConfig = null;
 
     public function addVector(VectorParams $vectorParams, string $name = null): CreateCollection
@@ -112,6 +115,12 @@ public function toArray(): array
         if ($this->initFrom !== null) {
             $data['init_from'] = $this->initFrom->toArray();
         }
+        if ($this->optimizersConfig !== null) {
+            $data['optimizers_config'] = $this->optimizersConfig->toArray();
+        }
+        if ($this->hnswConfig !== null) {
+            $data['hnsw_config'] = $this->hnswConfig->toArray();
+        }
 
         if ($this->quantizationConfig instanceof DisabledQuantization) {
             $data['quantization_config'] = 'Disabled';

tests/Unit/Models/Request/CollectionConfig/HnswConfigTest.php

@@ -0,0 +1,84 @@
+<?php
+/**
+ * @since     Oct 2023
+ * @author    Haydar KULEKCI <haydarkulekci@gmail.com>
+ */
+
+namespace Qdrant\Tests\Unit\Models\Request\CollectionConfig;
+
+use PHPUnit\Framework\TestCase;
+use Qdrant\Models\Request\CollectionConfig\HnswConfig;
+
+class HnswConfigTest extends TestCase
+{
+    public function testBasic(): void
+    {
+        $config = new HnswConfig();
+
+        $this->assertEquals([], $config->toArray());
+    }
+
+    public function testWithM(): void
+    {
+        $config = (new HnswConfig())->setM(10);
+
+        $this->assertEquals([
+            'm' => 10
+        ], $config->toArray());
+    }
+
+    public function testWithEfConstruct(): void
+    {
+        $config = (new HnswConfig())->setEfConstruct(10);
+
+        $this->assertEquals([
+            'ef_construct' => 10
+        ], $config->toArray());
+    }
+
+    public function testWithFullScanThreshold(): void
+    {
+        $config = (new HnswConfig())->setFullScanThreshold(10);
+
+        $this->assertEquals([
+            'full_scan_threshold' => 10
+        ], $config->toArray());
+    }
+
+    public function testWithDeletedThreshold(): void
+    {
+        $config = (new HnswConfig())->setMaxIndexingThreads(9);
+
+        $this->assertEquals([
+            'max_indexing_threads' => 9
+        ], $config->toArray());
+    }
+
+    public function testWithOnDisk(): void
+    {
+        $config = (new HnswConfig())->setOnDisk(true);
+
+        $this->assertEquals([
+            'on_disk' => 10
+        ], $config->toArray());
+    }
+
+    public function testWithDefaultSegmentNumber(): void
+    {
+        $config = (new HnswConfig())->setPayloadM(10);
+
+        $this->assertEquals([
+            'payload_m' => 10
+        ], $config->toArray());
+    }
+
+    public function testWithFlushIntervalSec(): void
+    {
+        $config = (new HnswConfig())->setMaxIndexingThreads(10)->setPayloadM(10);
+
+        $this->assertEquals([
+            'max_indexing_threads' => 10,
+            'payload_m' => 10,
+        ], $config->toArray());
+    }
+}

tests/Unit/Models/Request/CollectionConfig/OptimizerConfigDiffTest.php

@@ -7,7 +7,6 @@
 namespace Qdrant\Tests\Unit\Models\Request\CollectionConfig;
 
 use PHPUnit\Framework\TestCase;
-use Qdrant\Models\Request\CollectionConfig\BinaryQuantization;
 use Qdrant\Models\Request\CollectionConfig\OptimizersConfigDiff;
 
 class OptimizerConfigDiffTest extends TestCase