PHP Class Smile\ElasticsuiteCore\Search\Request\ContainerConfiguration\RelevanceConfig

Author: Romain Ruaud ([email protected])
Inheritance: implements Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfigurationInterface
Show file Open project: smile-sa/elasticsuite

Public Methods

Method Description
__construct ( string $minimumShouldMatch, float $tieBreaker, integer | null $phraseMatchBoost, float $cutOffFrequency, Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfiguration\FuzzinessConfigurationInterface $fuzziness = null, Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfiguration\PhoneticConfigurationInterface $phonetic = null ) RelevanceConfiguration constructor.
getCutOffFrequency ( ) : float
getFuzzinessConfiguration ( ) : Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfiguration\FuzzinessConfigurationInterface | null Retrieve FuzzinessConfiguration
getMinimumShouldMatch ( ) {@inheritDoc}
getPhoneticConfiguration ( ) : Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfiguration\PhoneticConfigurationInterface | null Retrieve Phonetic Configuration
getPhraseMatchBoost ( ) : integer | null
getTieBreaker ( ) {@inheritDoc}
isFuzzinessEnabled ( ) : boolean Check if fuzziness is enabled
isPhoneticSearchEnabled ( ) : boolean Check if phonetic search is enabled

Method Details

__construct() public method

RelevanceConfiguration constructor.
public __construct ( string $minimumShouldMatch, float $tieBreaker, integer | null $phraseMatchBoost, float $cutOffFrequency, Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfiguration\FuzzinessConfigurationInterface $fuzziness = null, Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfiguration\PhoneticConfigurationInterface $phonetic = null )
$minimumShouldMatch string Minimum should match clause of the text query.
$tieBreaker float Tie breaker for multimatch queries.
$phraseMatchBoost integer | null The Phrase match boost value, or null if not enabled
$cutOffFrequency float The cutoff Frequency value
$fuzziness Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfiguration\FuzzinessConfigurationInterface The fuzziness Configuration, or null
$phonetic Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfiguration\PhoneticConfigurationInterface The phonetic Configuration, or null

getCutOffFrequency() public method

public getCutOffFrequency ( ) : float
return float

getFuzzinessConfiguration() public method

Retrieve FuzzinessConfiguration
public getFuzzinessConfiguration ( ) : Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfiguration\FuzzinessConfigurationInterface | null
return Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfiguration\FuzzinessConfigurationInterface | null

getMinimumShouldMatch() public method

{@inheritDoc}
public getMinimumShouldMatch ( )

getPhoneticConfiguration() public method

Retrieve Phonetic Configuration
public getPhoneticConfiguration ( ) : Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfiguration\PhoneticConfigurationInterface | null
return Smile\ElasticsuiteCore\Api\Search\Request\Container\RelevanceConfiguration\PhoneticConfigurationInterface | null

getPhraseMatchBoost() public method

public getPhraseMatchBoost ( ) : integer | null
return integer | null

getTieBreaker() public method

{@inheritDoc}
public getTieBreaker ( )

isFuzzinessEnabled() public method

Check if fuzziness is enabled
public isFuzzinessEnabled ( ) : boolean
return boolean

isPhoneticSearchEnabled() public method

Check if phonetic search is enabled
public isPhoneticSearchEnabled ( ) : boolean
return boolean