एक्सटेंशन:सिरसखोज

मीडियाविकि एक्सटेंशन मैनुअल

CirrusSearch रिलीज़ की स्थिति: स्थिर
कार्यान्वयन	खोज, एपीआई , हुक
विवरण	एलियस्टिक्स खोज का उपयोग करके मीडियाविकी की खोज करने वाले औजार
लेखक	Nik Everett, Chad Horohoe, Erik Bernhardson
नवीनतम संस्करण	निरंतर अद्यतन
संगतता नीति	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	>= 1.37.0
लाइसेंस	GNU General Public License 2.0 or later
डाउनलोड	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review README
प्राचल $wgCirrusSearchLanguageWeight $wgCirrusSearchAutomationCIDRs $wgCirrusSearchUseIcuFolding $wgCirrusSearchStemmedWeight $wgCirrusSearchQueryStringMaxDeterminizedStates $wgCirrusSearchCrossClusterSearch $wgCirrusSearchExtraIndexSettings $wgCirrusSearchAutomationUserAgentRegex $wgCirrusSearchTalkNamespaceWeight $wgCirrusSearchPrefixWeights $wgCirrusSearchPrefixSearchRescoreProfile $wgCirrusSearchDisableUpdate $wgCirrusSearchActiveTest $wgCirrusSearchMoreLikeThisMaxQueryTermsLimit $wgCirrusSearchUseIcuTokenizer $wgCirrusSearchCompletionBannedPageIds $wgCirrusSearchOptimizeIndexForExperimentalHighlighter $wgCirrusSearchRescoreProfiles $wgCirrusSearchPhraseRescoreBoost $wgCirrusSearchInterwikiProv $wgCirrusSearchDefaultCluster $wgCirrusSearchElasticQuirks $wgCirrusSearchMaxFileTextLength $wgCirrusSearchFallbackProfiles $wgCirrusSearchMoreLikeThisTTL $wgCirrusSearchAllowLeadingWildcard $wgCirrusSearchInterwikiPrefixOverrides $wgCirrusSearchMaintenanceTimeout $wgCirrusSearchReplicas $wgCirrusSearchPhraseSlop $wgCirrusSearchBoostOpening $wgCirrusSearchWriteBackoffExponent $wgCirrusSearchUserTesting $wgCirrusSearchShardCount $wgCirrusSearchUseCompletionSuggester $wgCirrusSearchPhraseSuggestReverseField $wgCirrusSearchFallbackProfile $wgCirrusSearchFragmentSize $wgCirrusSearchUnlinkedArticlesToUpdate $wgCirrusSearchClientSideUpdateTimeout $wgCirrusSearchIgnoreOnWikiBoostTemplates $wgCirrusSearchRegexMaxDeterminizedStates $wgCirrusSearchInterwikiHTTPConnectTimeout $wgCirrusSearchExtraIndexes $wgCirrusSearchCategoryDepth $wgCirrusSearchMergeSettings $wgCirrusSearchClusters $wgCirrusSearchAllFields $wgCirrusSearchBannedPlugins $wgCirrusSearchMoreLikeThisConfig $wgCirrusSearchClusterOverrides $wgCirrusSearchCrossProjectBlockScorerProfiles $wgCirrusSearchNearMatchWeight $wgCirrusSearchReplicaGroup $wgCirrusSearchIndexedRedirects $wgCirrusSearchIndexAllocation $wgCirrusSearchNumCrossProjectSearchResults $wgCirrusSearchLanguageDetectors $wgCirrusSearchUpdateShardTimeout $wgCirrusSearchEnableCrossProjectSearch $wgCirrusSearchFullTextQueryBuilderProfiles $wgCirrusSearchCompletionDefaultScore $wgCirrusSearchWriteClusters $wgCirrusSearchCompletionSuggesterHardLimit $wgCirrusSearchRecycleCompletionSuggesterIndex $wgCirrusSearchLogElasticRequests $wgCirrusSearchConnectionAttempts $wgCirrusSearchWikiToNameMap $wgCirrusSearchMaxFullTextQueryLength $wgCirrusSearchLogElasticRequestsSecret $wgCirrusSearchEnableRegex $wgCirrusSearchClientSideSearchTimeout $wgCirrusSearchExtraBackendLatency $wgCirrusSearchNamespaceMappings $wgCirrusSearchWMFExtraFeatures $wgCirrusSearchPreferRecentUnspecifiedDecayPortion $wgCirrusSearchNamespaceResolutionMethod $wgCirrusSearchCategoryMax $wgCirrusSearchSearchShardTimeout $wgCirrusSearchCategoryEndpoint $wgCirrusSearchPrivateClusters $wgCirrusSearchSimilarityProfiles $wgCirrusSearchCrossProjectShowMultimedia $wgCirrusSearchRefreshInterval $wgCirrusSearchPoolCounterKey $wgCirrusSearchCompletionProfiles $wgCirrusSearchMaxShardsPerNode $wgCirrusSearchEnableArchive $wgCirrusSearchIndexDeletes $wgCirrusSearchSimilarityProfile $wgCirrusExploreSimilarResults $wgCirrusSearchFiletypeAliases $wgCirrusSearchDevelOptions $wgCirrusSearchBoostTemplates $wgCirrusSearchPrefixIds $wgCirrusSearchPrefixSearchStartsWithAnyWord $wgCirrusSearchUpdateConflictRetryCount $wgCirrusSearchInterwikiHTTPTimeout $wgCirrusSearchFetchConfigFromApi $wgCirrusSearchFullTextQueryBuilderProfile $wgCirrusSearchExtraIndexBoostTemplates $wgCirrusSearchStripQuestionMarks $wgCirrusSearchIndexBaseName $wgCirrusSearchTextcatModel $wgCirrusSearchMoreLikeThisFields $wgCirrusSearchMasterTimeout $wgCirrusSearchTextcatConfig $wgCirrusSearchSanityCheck $wgCirrusSearchInterwikiThreshold $wgCirrusSearchNamespaceWeights $wgCirrusSearchCrossProjectOrder $wgCirrusSearchRescoreProfile $wgCirrusSearchRescoreFunctionChains $wgCirrusSearchMoreAccurateScoringMode $wgCirrusSearchMaxPhraseTokens $wgCirrusSearchCrossProjectSearchBlockList $wgCirrusSearchCrossProjectProfiles $wgCirrusSearchLanguageToWikiMap $wgCirrusSearchMaxIncategoryOptions $wgCirrusSearchEnableAltLanguage $wgCirrusSearchWikimediaExtraPlugin $wgCirrusSearchCompletionSuggesterUseDefaultSort $wgCirrusSearchLinkedArticlesToUpdate $wgCirrusSearchCompletionSuggesterSubphrases $wgCirrusSearchPreferRecentDefaultHalfLife $wgCirrusSearchEnablePhraseSuggest $wgCirrusSearchFunctionRescoreWindowSize $wgCirrusSearchPhraseSuggestUseOpeningText $wgCirrusSearchCompletionSettings $wgCirrusSearchUseExperimentalHighlighter $wgCirrusSearchDropDelayedJobsAfter $wgCirrusSearchFeedbackLink $wgCirrusSearchUpdateDelay $wgCirrusSearchInterleaveConfig $wgCirrusSearchPhraseRescoreWindowSize $wgCirrusSearchDefaultNamespaceWeight $wgCirrusSearchMoreLikeThisAllowedFields $wgCirrusSearchClientSideConnectTimeout $wgCirrusSearchPhraseSuggestUseText $wgCirrusSearchPhraseSuggestProfiles $wgCirrusSearchPreferRecentDefaultDecayPortion $wgCirrusSearchInterwikiSources $wgCirrusSearchWeights $wgCirrusSearchICUNormalizationUnicodeSetFilter $wgCirrusSearchICUFoldingUnicodeSetFilter $wgCirrusSearchSlowSearch
हुक उपयोग किया जाता है APIAfterExecute ApiBeforeMain ArticleDelete ArticleDeleteComplete ArticleRevisionVisibilitySet ArticleUndelete BeforeInitialize CirrusSearchAddQueryFeatures CirrusSearchAnalysisConfig CirrusSearchSimilarityConfig GetPreferences LinksUpdateComplete MediaWikiServices PageMoveComplete PrefixSearchExtractNamespace ResourceLoaderGetConfigVars SearchGetNearMatch SearchIndexFields ShowSearchHitTitle SoftwareInfo SpecialSearchResults SpecialSearchResultsAppend SpecialStatsAddExtra TitleMove UploadComplete UserGetDefaultOptions
हुक प्रदान CirrusSearchAddQueryFeatures CirrusSearchAnalysisConfig CirrusSearchBuildDocumentFinishBatch CirrusSearchBuildDocumentLinks CirrusSearchBuildDocumentParse CirrusSearchFulltextQueryBuilder CirrusSearchFulltextQueryBuilderComplete CirrusSearchMappingConfig CirrusSearchProfileService CirrusSearchRegisterFullTextQueryClassifiers CirrusSearchScoreBuilder
Translate the CirrusSearch extension if it is available at translatewiki.net
चेक उपयोग और संस्करण मैट्रिक्स.
आवारा भूमिका	cirrussearch
मुद्दा	ओपन कार्य · बग की रिपोर्ट करें

The CirrusSearch extension implements searching for MediaWiki using Elasticsearch.

यह पृष्ठ स्थापना के लिए है। इंस्टॉल के काम करने के बाद, उपयोग के लिए मदद: CirrusSearch देखें।

लक्ष्य

• कोई देशी निर्भरता नहीं जो इसे स्थापित करना मुश्किल बना दे

• • The only dependencies are pure-PHP MediaWiki extensions and Elasticsearch itself

• Provide a near-real-time search index for wiki pages that's extendable by other MediaWiki extensions

• Provide all of the query options MWSearch has given users, and more

निर्भरता

PHP और cURL

• In addition to the standard MediaWiki requirements for PHP, CirrusSearch requires PHP to be compiled with cURL support.

Elasticsearch

• You will need to install Elasticsearch.

• MediaWiki 1.29.x - 1.30.x require Elasticsearch 5.3.x - 5.4.x.
• MediaWiki 1.31.x - 1.32.x require Elasticsearch 5.5.x - 5.6.x.
• MediaWiki 1.33.x - 1.36.x require Elasticsearch 6.5.x - 6.8.x (6.5.4 recommended)

Take note that a Java installation like OpenJDK is needed in addition. It's best to use the official Elasticsearch Docker image or a self-hosted version. A managed product like AWS Elasticsearch most likely won't work and will result in weird errors during search index initialization.

Elastica

• Elastica is a PHP library to talk to Elasticsearch. Install Elastica per the instructions below.

अन्य

• Due to the actual handling of jobs by the CirrusSearch extension, it is advisable to set up jobs in Redis to prevent messages like Notice: unserialize(): Error at offset 64870 of 65535 bytes in JobQueueDB.php and subsequent errors like Unsupported operand types.

task T157759 देखें।

स्थापित

Elastica

Even though the instructions below tell you to only run Composer when installing from git, it may be necessary to issue it anyway in order to install all PHP dependencies.

• Download and place the file(s) in a directory called Elastica in your extensions/ folder.
• Only when installing from git run Composer to install PHP dependencies, by issuing composer install --no-dev in the extension directory. (संभावित जटिलताओं के लिए task T173141 देखें।)
• अपनी LocalSettings.php के नीचे निम्नलिखित कोड जोड़ें:

  wfLoadExtension( 'Elastica' );
  

•  पूर्ण – इस बात की पुष्टि करने के लिए अपने विकी पर Special:Version पर नेविगेट करें कि एक्सटेंशन सफलतापूर्वक स्थापित हो गया है।

CirrusSearch

• Download and place the file(s) in a directory called CirrusSearch in your extensions/ folder.
• अपनी LocalSettings.php के नीचे निम्नलिखित कोड जोड़ें:

  wfLoadExtension( 'CirrusSearch' );
  

• Now follow the setup instructions in the CirrusSearch README delivered with your extension i.e. $IP/extensions/CirrusSearch/README. Note that all info in it might not apply to your version of the extension, especially the version of Elasticsearch supported.
• आवश्यकतानुसार कॉन्फ़िगर करें।
•  पूर्ण – इस बात की पुष्टि करने के लिए अपने विकी पर Special:Version पर नेविगेट करें कि एक्सटेंशन सफलतापूर्वक स्थापित हो गया है।

उन्नयन

Please follow the upgrade instructions in the CirrusSearch UPGRADE file.

विन्यास

The configuration parameters of CirrusSearch are documented at the "settings.txt" file. See also documentation on CirrusSearch configuration profiles.

Elasticsearch will fail to index for CirrusSearch if one is using a database name for MySQL which contains a capital character, e.g. "MyWikiDatabaseName". To mitigate this CirrusSearch provides the $wgCirrusSearchIndexBaseName configuration parameter which one needs to set, e.g. $wgCirrusSearchIndexBaseName = 'mywikidatabasename';.

हुक

CirrusSearch extension defines a number of hooks that other extensions can make use of to extend the core schema and modify documents. निम्नलिखित हुक उपलब्ध हैं:

• CirrusSearchAnalysisConfig - allows to hook into the configuration for analysis
• CirrusSearchMappingConfig - allows configuration of the mapping of fields
• CirrusSearchBuildDocumentParse - allows extensions to modify ElasticSearch document produced from a page
• CirrusSearchBuildDocumentLinks - allows extensions to process incoming and outgoing links for the document
• CirrusSearchBuildDocumentFinishBatch - called when a batch of pages has been indexed
• CirrusSearchAddQueryFeatures - allows extensions to add query parser features
• CirrusSearchScoreBuilder - allows extensions to define rescore builder functions
• CirrusSearchProfileService - allows extension to declare various search components and configuration

एपीआई

CirrusSearch features can be used in API queries. Searching happens via the normal search API, action=query&list=search; you can use CirrusSearch-specific features, such as the morelike: special prefix to find pages related to Marie Curie and radium: api.php?action=query&list=search&srsearch=morelike:Marie_Curie%7Cradium&srlimit=10&srprop=size&formatversion=2 Custom APIs and parameters are provided for querying CirrusSearch configuration and debug information:

• action=cirrusdump module: 2014?action=cirrusdump
• cirrusDumpQuery parameter to Special:Search or search API queries: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpQuery
• cirrusDumpResult parameter to Special:Search or search API queries: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpResult
• An additional parameter, cirrusExplain, can be passed with cirrusDumpResult to have the Lucene explanation of the score included with the result dump: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpResult&cirrusExplain It can also be used to get the explanation in a human-readable format, by giving it one of the values verbose, pretty or hot, such as: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpResult&cirrusExplain=pretty
• cirrus-config-dump, cirrus-settings-dump, cirrus-mapping-dump, cirrus-profiles-dump modules to obtain dump from the CirrusSearch setup: api.php?action=cirrus-config-dump&formatversion=2

यह भी देखें

सामान्य लिंक

• उपयोग सहायता पृष्ठ - CirrusSearch usage documentation (needed after the install)
• परियोजना पृष्ठ
• Info about Wikimedia Cirrus/Elastic setup
• विन्यास मदद पृष्ठ - sets of tunable parameters that influence various aspect of the indexing
• Extension:AdvancedSearch - Enhances Special:Search by providing advanced parameters

डिबगिंग

• How to determine that Cirrus is actually used as the search backend

स्थानीय विकास

Elastic Search service can be run with the Vagrant role (cirrussearch) and MediaWiki Vagrant.

For Docker, you can use a command like docker run -d --name elasticsearch -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" elasticsearch:6.8.2. Then follow the installation and configuration directions. If your web host is in a container you'll want to make sure the above container is on the same network, and in LocalSettings.php you will want to reference elasticsearch as the host name. This will not have the WMF plugins but can be sufficient for basic testing.