support all points scroll parameters

Author: yunwuxin

src/Endpoints/Collections/Points.php

@@ -7,6 +7,7 @@
  * @since     Mar 2023
  * @author    Haydar KULEKCI <haydarkulekci@gmail.com>
  */
+
 namespace Qdrant\Endpoints\Collections;
 
 use Qdrant\Endpoints\AbstractEndpoint;
@@ -16,6 +17,7 @@
 use Qdrant\Models\PointsStruct;
 use Qdrant\Models\Request\PointsBatch;
 use Qdrant\Models\Request\RecommendRequest;
+use Qdrant\Models\Request\ScrollRequest;
 use Qdrant\Models\Request\SearchRequest;
 use Qdrant\Response;
 
@@ -43,19 +45,18 @@ public function search(SearchRequest $searchParams): Response
     /**
      * @throws InvalidArgumentException
      */
-    public function scroll(Filter $filter = null, int $limit = null): Response
+    public function scroll(Filter|ScrollRequest $scrollParams = null, array $queryParams = []): Response
     {
         $body = [];
-        if ($filter) {
-            $body['filter'] = $filter->toArray();
-        }
-        if ($limit) {
-            $body['limit'] = $limit;
+        if ($scrollParams instanceof Filter) {
+            $body['filter'] = $scrollParams->toArray();
+        } elseif ($scrollParams instanceof ScrollRequest) {
+            $body = $scrollParams->toArray();
         }
         return $this->client->execute(
             $this->createRequest(
                 'POST',
-                '/collections/' . $this->getCollectionName() . '/points/scroll',
+                '/collections/' . $this->getCollectionName() . '/points/scroll' . $this->queryBuild($queryParams),
                 $body
             )
         );
@@ -103,9 +104,9 @@ public function ids(array $ids, $withPayload = false, $withVector = true, array
                 'POST',
                 '/collections/' . $this->getCollectionName() . '/points' . $this->queryBuild($queryParams),
                 [
-                    'ids' => $ids,
+                    'ids'          => $ids,
                     'with_payload' => $withPayload,
-                    'with_vector' => $withVector,
+                    'with_vector'  => $withVector,
                 ]
             )
         );

src/Models/Request/ScrollRequest.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Qdrant\Models\Request;
+
+use Qdrant\Models\Filter\Filter;
+use Qdrant\Models\Traits\ProtectedPropertyAccessor;
+
+class ScrollRequest implements RequestModel
+{
+
+    use ProtectedPropertyAccessor;
+
+    protected ?Filter $filter = null;
+
+    protected ?int $limit = null;
+
+    protected int|string|null $offset = null;
+
+    protected bool|array|null $withVector = null;
+
+    protected bool|array|null $withPayload = null;
+
+    public function setFilter(Filter $filter): static
+    {
+        $this->filter = $filter;
+
+        return $this;
+    }
+
+    public function setLimit(int $limit): static
+    {
+        $this->limit = $limit;
+
+        return $this;
+    }
+
+    public function setOffset(int|string $offset): static
+    {
+        $this->offset = $offset;
+
+        return $this;
+    }
+
+    public function setWithPayload($withPayload): static
+    {
+        $this->withPayload = $withPayload;
+
+        return $this;
+    }
+
+    public function setWithVector($withVector): static
+    {
+        $this->withVector = $withVector;
+
+        return $this;
+    }
+
+    public function toArray(): array
+    {
+        $body = [];
+
+        if ($this->filter !== null && $this->filter->toArray()) {
+            $body['filter'] = $this->filter->toArray();
+        }
+        if ($this->limit) {
+            $body['limit'] = $this->limit;
+        }
+        if ($this->offset) {
+            $body['offset'] = $this->offset;
+        }
+        if ($this->withVector) {
+            $body['with_vector'] = $this->withVector;
+        }
+        if ($this->withPayload) {
+            $body['with_payload'] = $this->withPayload;
+        }
+
+        return $body;
+    }
+}

tests/Integration/Endpoints/Collections/PointsTest.php

@@ -13,6 +13,7 @@
 use Qdrant\Models\PointStruct;
 use Qdrant\Models\Request\CreateCollection;
 use Qdrant\Models\Request\PointsBatch;
+use Qdrant\Models\Request\ScrollRequest;
 use Qdrant\Models\Request\VectorParams;
 use Qdrant\Models\VectorStruct;
 use Qdrant\Tests\Integration\AbstractIntegration;
@@ -137,6 +138,18 @@ public function testScrollPoint(array $points): void
         $response = $this->getCollections('sample-collection')->points()->scroll($filter);
         $this->assertCount(1, $response['result']['points']);
         $this->assertEquals(2, $response['result']['points'][0]['id']);
+
+        $request = (new ScrollRequest())
+            ->setLimit(1)
+            ->setFilter($filter)
+            ->setWithPayload(true)
+            ->setWithVector(true)
+            ->setOffset(2);
+
+        $response = $this->getCollections('sample-collection')->points()->scroll($request);
+
+        $this->assertCount(1, $response['result']['points']);
+        $this->assertEquals(2, $response['result']['points'][0]['id']);
     }
 
     /**
@@ -232,4 +245,4 @@ protected function tearDown(): void
 
         $this->getCollections('sample-collection')->delete();
     }
-}
+}