Extension:WikibaseLexemeCirrusSearch

MediaWiki extensions manual

WikibaseLexemeCirrusSearch Release status: stable
Implementation	Search, API
Description	Implements searching for Wikibase Lexeme space using ElasticSearch
Author(s)	Stas Malyshev
Latest version	0.1.0 (continuous updates)
Compatibility policy	Master maintains backwards compatibility.
MediaWiki	1.33+
PHP	7.0+
Database changes	No
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review README
Parameters $wgLexemeUseCirrus $wgLexemePrefixSearchProfile $wgLexemePrefixSearchProfiles $wgLexemePrefixRescoreProfile $wgLexemeFulltextRescoreProfile $wgLexemeRescoreFunctions
Hooks used CirrusSearchProfileService ShowSearchHit WikibaseRepoEntityTypes
Translate the WikibaseLexemeCirrusSearch extension if it is available at translatewiki.net
Check usage and version matrix.
Issues	Open tasks · Report a bug

The WikibaseLexemeCirrusSearch extension provides ElasticSearch functionality, as supported by CirrusSearch extension, to WikibaseLexeme extension. It requires both CirrusSearch and WikibaseLexeme extensions to be installed.

Installation

• Download and place the file(s) in a directory called WikibaseLexemeCirrusSearch in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php:

  wfLoadExtension( 'WikibaseLexemeCirrusSearch' );
  

• Configure as required.
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

Following configuration options are supported:

$wgLexemeUseCirrus

boolean|null, whether we should use search functionality provided by this extension. If set to null, CirrusSearch is not used unless the request has useCirrus=1. Note: The default for this value is false, to enable search functionality it should be set to true in the configuration.

$wgLexemePrefixSearchProfile

name of the label scoring profile to use for prefix search. The profile should be defined like examples in config/LexemePrefixSearchProfiles.php.

$wgLexemePrefixSearchProfiles

Loaded from config/LexemePrefixSearchProfiles.php, does not need to be defined manually.

$wgLexemePrefixRescoreProfile

name of the rescoring profile to use for prefix search. The profile should be defined in config/LexemePrefixSearchProfiles.php.

$wgLexemeFulltextRescoreProfile

name of the search profile to use for fulltext search. The profile should be defined like examples in config/LexemeRescoreProfiles.php.

$wgLexemeRescoreFunctions

Loaded from config/LexemeRescoreFunctions.php.php, does not have to be defined manually.

See Also

• WikibaseCirrusSearch extension
• WIkibaseLexeme extension