Scoring methods used by the completion suggester. More...
Inheritance diagram for CirrusSearch\BuildDocument\Completion\SuggestScoringMethod:
Public Member Functions | |
| score (array $doc) | |
| getRequiredFields () | |
| The list of fields needed to compute the score. | |
| setMaxDocs ( $maxDocs) | |
| This method will be called by the indexer script. | |
| explain (array $doc) | |
| Explain the score. | |
Detailed Description
Scoring methods used by the completion suggester.
Set $wgSearchType to 'CirrusSearch'
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html
Member Function Documentation
◆ explain()
| CirrusSearch\BuildDocument\Completion\SuggestScoringMethod::explain | ( | array | $doc | ) |
Explain the score.
- Parameters
-
array $doc
- Returns
- array
Implemented in CirrusSearch\BuildDocument\Completion\IncomingLinksScoringMethod, CirrusSearch\BuildDocument\Completion\PQScore, and CirrusSearch\BuildDocument\Completion\QualityScore.
◆ getRequiredFields()
| CirrusSearch\BuildDocument\Completion\SuggestScoringMethod::getRequiredFields | ( | ) |
The list of fields needed to compute the score.
- Returns
- string[] the list of required fields
Implemented in CirrusSearch\BuildDocument\Completion\IncomingLinksScoringMethod, CirrusSearch\BuildDocument\Completion\PQScore, and CirrusSearch\BuildDocument\Completion\QualityScore.
◆ score()
| CirrusSearch\BuildDocument\Completion\SuggestScoringMethod::score | ( | array | $doc | ) |
- Parameters
-
array $doc A document from the PAGE type
- Returns
- int the weight of the document
Implemented in CirrusSearch\BuildDocument\Completion\IncomingLinksScoringMethod, CirrusSearch\BuildDocument\Completion\PQScore, and CirrusSearch\BuildDocument\Completion\QualityScore.
◆ setMaxDocs()
| CirrusSearch\BuildDocument\Completion\SuggestScoringMethod::setMaxDocs | ( | $maxDocs | ) |
This method will be called by the indexer script.
some scoring method may want to normalize values based index size
- Parameters
-
int $maxDocs the total number of docs in the index
Implemented in CirrusSearch\BuildDocument\Completion\IncomingLinksScoringMethod, and CirrusSearch\BuildDocument\Completion\QualityScore.
The documentation for this interface was generated from the following file:
- includes/BuildDocument/Completion/SuggestScoringMethod.php
