16. Suggest

Suggests similar looking terms based on a provided text by using a suggester. Parts of the suggest feature are still under development.

Save a suggestion to index

<?php

$elastic = new ElasticSearch();

$suggest = $elastic->suggest()
                ->index('my-index')
                ->id(1)
                ->input([
                    [
                        'input' => 'My name is Şêro',
                        'weight' => 25
                    ]
                ])
                ->save();

Search with suggest

<?php

$suggest = $elastic->suggest()
            ->index('my-index')
            ->name('my-index-suggest')
            ->text('My name is ') // it returns "My name is Şêro"
            ->completion([
                'field' => 'suggest',
                'skip_duplicates' => true
            ])
            ->search();

return $suggest;

You can use multiple suggestion

<?php

$suggest = $elastic->suggest()
            ->index('my-index')
            ->name('my-index-suggest')
            ->text('My name is ') // it returns "My name is Şêro"
            ->completion([
                'field' => 'suggest',
                'skip_duplicates' => true
            ])
            ->addSuggest(function(){
                return $this->index('my-index')
                        ->name('my-index-suggest-2')
                        ->text('Music')
                        ->completion([
                            'field' => 'suggest',
                            'skip_duplicates' => true,
                            'fuzzy' => [
                                'fuzziness' => 1
                            ]
                        ])
                        ->getMap();
            })
            ->addSuggest(function(){
                return $this->index('my-index')
                            ->name('my-index-suggest-3')
                            ->text('Music')
                            ->completion([
                                'field' => 'suggest',
                                'skip_duplicates' => true
                            ])
                            ->getMap();
                })
            ->search();

return $suggest;

Other functions you can use for suggestion

<?php

$suggest = $elastic->suggest()
                ->index('my-index')
                ->name('product-suggestion')
                ->text('tring out Elasticsearch')
                ->term(['name' => 'message'])
                ->input([ "Nevermind", "Nirvana" ])
                ->weight(34)
                ->prefix('nir')
                ->regex('regex')
                ->completion([
                    'field' => 'suggest',
                    'size'  => 10,
                    'contexts' => [
                        'place_type' => [
                            [
                                'context' => 'cafe'
                            ],
                            [
                                'context'   => 'restaurants',
                                'boost'     => 2
                            ]
                        ]
                    ]
                ])
                ->contexts([
                    [
                        "name" => "place_type",
                        "type" => "category"
                    ],
                    [
                        "name" => "location",
                        "type" => "geo",
                        "precision" => 4
                    ],
                ])
                ->simplePhrase(function(){
                    return $this
                            ->field('name')
                            ->directGenerator([
                                [
                                    'field' => 'name',
                                    'suggest_mode'  => 'always'
                                ],
                                [
                                    "field" => "title.reverse",
                                    "suggest_mode" => "always",
                                    "pre_filter" => "reverse",
                                    "post_filter" => "reverse"
                                ]
                            ])
                            ->highlight([
                                'pre_tag' => "<em>",
                                'post_tag' => "</em>"
                            ])
                            ->collate([
                                'source' => [
                                    'match' => [
                                        "{{field_name}}" => "{{suggestion}}"
                                    ]
                                ]
                            ])
                            ->smoothing([
                                'laplace' => [
                                    'alpha' => 0.7
                                ]
                            ])
                            ->size(2)
                            ->getMap();
                })
                ->getMap();