#100616 (#12)

* #100616

* Fix styling

---------

Co-authored-by: Ms_Natali <golubkova@greensight.ru>
Co-authored-by: MsNatali <MsNatali@users.noreply.github.com>

Author: MsNatali

.gitignore

@@ -1,6 +1,7 @@
 .idea
 /vendor
 /node_modules
+/coverage
 
 *.cache
 phpunit.xml

README.md

@@ -139,8 +139,6 @@ $aggs = $aggQuery
                 'offers',
                 fn(AggregationsBuilder $builder) => $builder->where('seller_id', 10)->minmax('price', 'price')
             );
-
-$aggs
 
 ```
 
@@ -189,6 +187,53 @@ $aggQuery->composite(function (AggregationsBuilder $builder) {
 });
 ```
 
+## Suggesting
+
+Suggest queries can be created like this
+
+```php
+$sugQuery = ProductsIndex::suggest();
+
+/** @var \Illuminate\Support\Collection $suggests */
+$suggests = $sugQuery->phrase('suggestName', 'name.trigram')
+    ->text('glves')
+    ->size(1)
+    ->shardSize(3)
+    ->get();
+            
+```
+
+### Global suggest text
+
+User can set global text like this
+
+```php
+$sugQuery = ProductsIndex::suggest()->text('glves');
+
+$sugQuery->phrase('suggestName1', 'name.trigram')->size(1)->shardSize(3);
+    
+$sugQuery->phrase('suggestName2', 'name.trigram');
+    
+/** @var \Illuminate\Support\Collection $suggests */
+$suggests = $sugQuery->get();
+            
+```
+
+
+### Suggester types
+
+Term suggester:
+
+```php
+$aggQuery->term('suggestName', 'name.trigram')->text('glves')->...->get();
+```
+
+Phrase Suggester:
+
+```php
+$aggQuery->phrase('suggestName', 'name.trigram')->text('glves')->...->get();
+```
+
 ## Additional methods
 
 ```php
@@ -200,6 +245,10 @@ $index->bulk(); // Send bulk request
 $index->get(); // Send get request
 $index->documentDelete(); // Send documentDelete request
 $index->deleteByQuery(); // Send deleteByQuery request
+
+$index->catIndices();
+$index->indicesDelete();
+$index->indicesRefresh();
 ```
 
 ## Query Log

composer.json

@@ -39,7 +39,7 @@
     "scripts": {
         "cs": "php-cs-fixer fix --config .php-cs-fixer.php",
         "test": "vendor/bin/phpunit",
-        "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
+        "test-coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html coverage"
 
     },
     "config": {

src/Concerns/InteractsWithIndex.php

@@ -6,6 +6,7 @@
 use Ensi\LaravelElasticQuery\Contracts\SearchIndex;
 use Ensi\LaravelElasticQuery\ElasticClient;
 use Ensi\LaravelElasticQuery\Search\SearchQuery;
+use Ensi\LaravelElasticQuery\Suggesting\SuggestQuery;
 use Exception;
 
 trait InteractsWithIndex
@@ -75,6 +76,11 @@ public function indicesDelete(string $index)
         return $this->resolveClient()->indicesDelete($index);
     }
 
+    public function indicesRefresh()
+    {
+        return $this->resolveClient()->indicesRefresh($this->indexName());
+    }
+
     public static function query(): SearchQuery
     {
         return new SearchQuery(new static());
@@ -85,6 +91,11 @@ public static function aggregate(): AggregationsQuery
         return new AggregationsQuery(new static());
     }
 
+    public static function suggest(): SuggestQuery
+    {
+        return new SuggestQuery(new static());
+    }
+
     protected function resolveClient(): ElasticClient
     {
         $this->client ??= resolve(ElasticClient::class);

src/ElasticClient.php

@@ -82,9 +82,14 @@ public function catIndices(string $indexName, ?array $getFields = null)
         return $this->client->cat()->indices($params);
     }
 
-    public function indicesDelete(string $index)
+    public function indicesDelete(string $indexName)
     {
-        return $this->client->indices()->delete(['index' => $index]);
+        return $this->client->indices()->delete(['index' => $indexName]);
+    }
+
+    public function indicesRefresh(string $indexName)
+    {
+        return $this->client->indices()->refresh(['index' => $indexName]);
     }
 
     public function enableQueryLog(): void

src/Suggesting/Enums/SuggestMode.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Suggesting\Enums;
+
+final class SuggestMode
+{
+    public const MISSING = 'missing';
+    public const POPULAR = 'popular';
+    public const ALWAYS = 'always';
+
+    public static function cases(): array
+    {
+        return [
+            self::MISSING,
+            self::POPULAR,
+            self::ALWAYS,
+        ];
+    }
+}

src/Suggesting/Enums/SuggestSort.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Suggesting\Enums;
+
+final class SuggestSort
+{
+    public const SCORE = 'score';
+    public const FREQUENCY = 'frequency';
+
+    public static function cases(): array
+    {
+        return [
+            self::SCORE,
+            self::FREQUENCY,
+        ];
+    }
+}

src/Suggesting/Enums/SuggestStringDistance.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Suggesting\Enums;
+
+final class SuggestStringDistance
+{
+    public const INTERNAL = 'internal';
+    public const DAMERAU_LEVENSHTEIN = 'damerau_levenshtein';
+    public const LEVENSHTEIN = 'levenshtein';
+    public const JARO_WINKLER = 'jaro_winkler';
+    public const NGRAM = 'ngram';
+
+    public static function cases(): array
+    {
+        return [
+            self::INTERNAL,
+            self::DAMERAU_LEVENSHTEIN,
+            self::LEVENSHTEIN,
+            self::JARO_WINKLER,
+            self::NGRAM,
+        ];
+    }
+}

src/Suggesting/Request/PhraseSuggester.php

@@ -0,0 +1,131 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Suggesting\Request;
+
+use Webmozart\Assert\Assert;
+
+class PhraseSuggester implements Suggester
+{
+    // basic phrase suggest api parameters
+    protected ?string $text = null;
+    protected ?int $gramSize = null;
+    protected ?float $realWordErrorLikelihood = null;
+    protected ?float $confidence = null;
+    protected ?float $maxErrors = null;
+    protected ?string $separator = null;
+    protected ?int $size = null;
+    protected ?string $analyzer = null;
+    protected ?int $shardSize = null;
+    protected ?string $highlightPreTag = null;
+    protected ?string $highlightPostTag = null;
+
+    public function __construct(protected string $name, protected string $field)
+    {
+        Assert::stringNotEmpty(trim($name));
+        Assert::stringNotEmpty(trim($field));
+    }
+
+    public function toDSL(): array
+    {
+        return [
+            "text" => $this->text,
+            "phrase" => array_filter([
+                "field" => $this->field,
+
+                "gram_size" => $this->gramSize,
+                "real_word_error_likelihood" => $this->realWordErrorLikelihood,
+                "confidence" => $this->confidence,
+                "max_errors" => $this->maxErrors,
+                "separator" => $this->separator,
+                "size" => $this->size,
+                "analyzer" => $this->analyzer,
+                "shard_size" => $this->shardSize,
+                "highlight" => array_filter([
+                    "pre_tag" => $this->highlightPreTag,
+                    "post_tag" => $this->highlightPostTag,
+                ]) ?: null,
+                // todo collate
+                // todo smoothing models
+                // todo direct_generator
+            ]),
+        ];
+    }
+
+    public function name(): string
+    {
+        return $this->name;
+    }
+
+    public function text(string $text): self
+    {
+        Assert::stringNotEmpty(trim($text));
+
+        $this->text = $text;
+
+        return $this;
+    }
+
+    public function gramSize(int $gramSize): self
+    {
+        $this->gramSize = $gramSize;
+
+        return $this;
+    }
+
+    public function realWordErrorLikelihood(float $realWordErrorLikelihood): self
+    {
+        $this->realWordErrorLikelihood = $realWordErrorLikelihood;
+
+        return $this;
+    }
+
+    public function confidence(float $confidence): self
+    {
+        $this->confidence = $confidence;
+
+        return $this;
+    }
+
+    public function maxErrors(float $maxErrors): self
+    {
+        $this->maxErrors = $maxErrors;
+
+        return $this;
+    }
+
+    public function separator(string $separator): self
+    {
+        $this->separator = $separator;
+
+        return $this;
+    }
+
+    public function size(int $size): self
+    {
+        $this->size = $size;
+
+        return $this;
+    }
+
+    public function analyzer(string $analyzer): self
+    {
+        $this->analyzer = $analyzer;
+
+        return $this;
+    }
+
+    public function shardSize(int $shardSize): self
+    {
+        $this->shardSize = $shardSize;
+
+        return $this;
+    }
+
+    public function highlight(string $highlightPreTag, string $highlightPostTag): self
+    {
+        $this->highlightPreTag = $highlightPreTag;
+        $this->highlightPostTag = $highlightPostTag;
+
+        return $this;
+    }
+}

src/Suggesting/Request/Suggester.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Suggesting\Request;
+
+use Ensi\LaravelElasticQuery\Contracts\DSLAware;
+
+interface Suggester extends DSLAware
+{
+    public function name(): string;
+}