Extension:CirrusSearch/fr

Manuel des extensions MediaWiki

CirrusSearch État de la version : stable
Implémentation	Rechercher, API , Accroche
Description	Implémente la recherche dans MediaWiki en utilisant Elasticsearch
Auteur(s)	Nik Everett, Chad Horohoe, Erik Bernhardson
Dernière version	mises à jour continues
Politique de compatibilité	Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière.
MediaWiki	>= 1.37.0
Composer	mediawiki/cirrussearch
Licence	Licence publique générale GNU v2.0 ou supérieur
Téléchargement	Télécharger l'extension Git [?]: Télécharger la branche master de Git parcourir le dépôt (GitHub) historique des validations (commits) contributeurs du dépôt (GitHub) relecture du code README
Paramètres $wgCirrusSearchLanguageWeight $wgCirrusSearchAutomationCIDRs $wgCirrusSearchUseIcuFolding $wgCirrusSearchStemmedWeight $wgCirrusSearchQueryStringMaxDeterminizedStates $wgCirrusSearchCrossClusterSearch $wgCirrusSearchExtraIndexSettings $wgCirrusSearchAutomationUserAgentRegex $wgCirrusSearchTalkNamespaceWeight $wgCirrusSearchPrefixWeights $wgCirrusSearchPrefixSearchRescoreProfile $wgCirrusSearchDisableUpdate $wgCirrusSearchActiveTest $wgCirrusSearchMoreLikeThisMaxQueryTermsLimit $wgCirrusSearchUseIcuTokenizer $wgCirrusSearchCompletionBannedPageIds $wgCirrusSearchOptimizeIndexForExperimentalHighlighter $wgCirrusSearchRescoreProfiles $wgCirrusSearchPhraseRescoreBoost $wgCirrusSearchInterwikiProv $wgCirrusSearchDefaultCluster $wgCirrusSearchQueryStringMaxWildcards $wgCirrusSearchElasticQuirks $wgCirrusSearchMaxFileTextLength $wgCirrusSearchFallbackProfiles $wgCirrusSearchMoreLikeThisTTL $wgCirrusSearchAllowLeadingWildcard $wgCirrusSearchInterwikiPrefixOverrides $wgCirrusSearchMaintenanceTimeout $wgCirrusSearchReplicas $wgCirrusSearchPhraseSlop $wgCirrusSearchBoostOpening $wgCirrusSearchWriteBackoffExponent $wgCirrusSearchUserTesting $wgCirrusSearchShardCount $wgCirrusSearchUseCompletionSuggester $wgCirrusSearchPhraseSuggestReverseField $wgCirrusSearchFallbackProfile $wgCirrusSearchFragmentSize $wgCirrusSearchUnlinkedArticlesToUpdate $wgCirrusSearchCustomPageFields $wgCirrusSearchClientSideUpdateTimeout $wgCirrusSearchIgnoreOnWikiBoostTemplates $wgCirrusSearchRegexMaxDeterminizedStates $wgCirrusSearchInterwikiHTTPConnectTimeout $wgCirrusSearchExtraIndexes $wgCirrusSearchCategoryDepth $wgCirrusSearchMergeSettings $wgCirrusSearchClusters $wgCirrusSearchAllFields $wgCirrusSearchBannedPlugins $wgCirrusSearchMoreLikeThisConfig $wgCirrusSearchClusterOverrides $wgCirrusSearchCrossProjectBlockScorerProfiles $wgCirrusSearchNearMatchWeight $wgCirrusSearchWriteIsolateClusters $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 $wgCirrusSearchWeights $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 $wgCirrusSearchSlowSearch $wgCirrusSearchFunctionRescoreWindowSize $wgCirrusSearchEnablePhraseSuggest $wgCirrusSearchCompletionSettings $wgCirrusSearchUseExperimentalHighlighter $wgCirrusSearchFeedbackLink $wgCirrusSearchUpdateDelay $wgCirrusSearchRefreshInterval $wgCirrusSearchInterleaveConfig $wgCirrusSearchPhraseRescoreWindowSize $wgCirrusSearchMoreLikeThisAllowedFields $wgCirrusSearchPreferRecentDefaultDecayPortion $wgCirrusSearchClientSideConnectTimeout $wgCirrusSearchPhraseSuggestUseText $wgCirrusSearchPhraseSuggestProfiles $wgCirrusSearchDefaultNamespaceWeight $wgCirrusSearchInterwikiSources $wgCirrusSearchPhraseSuggestUseOpeningText $wgCirrusSearchICUNormalizationUnicodeSetFilter $wgCirrusSearchICUFoldingUnicodeSetFilter $wgCirrusSearchReplicaGroup
Accroches utilisées 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
Accroches fournies CirrusSearchAddQueryFeatures CirrusSearchAnalysisConfig CirrusSearchBuildDocumentFinishBatch CirrusSearchBuildDocumentLinks CirrusSearchBuildDocumentParse CirrusSearchFulltextQueryBuilder CirrusSearchFulltextQueryBuilderComplete CirrusSearchMappingConfig CirrusSearchProfileService CirrusSearchRegisterFullTextQueryClassifiers CirrusSearchScoreBuilder
Traduire l’extension CirrusSearch sur translatewiki.net si elle y est disponible
Vérifier la matrice des utilisations et des versions.
Rôle Vagrant	cirrussearch
Problèmes	Tâches ouvertes · Signaler un bogue

L'extension CirrusSearch implémente la recherche dans MediaWiki en utilisant Elasticsearch.

Elastic Search is a standalone third-party software that must be installed in advance. It's a database system that provides search and indexing functionality, and where the current text of all pages of your wiki will be indexed for faster search results. The communication between MediaWiki and ElasticSearch is done through web services.

Cette page concerne l'installation. Une fois celle-ci opérationnelle, voir Help:CirrusSearch pour l'utilisation.

Objectifs

• Aucune dépendance native qui rendrait l'installation difficile
  • Les seules dépendances sont avec les extensions MediaWiki purement PHP et Elasticsearch lui-même
• Fournir un index de recherche quasiment en temps réel pour les pages wiki extensibles par d'autres extensions MediaWiki
• Fournir aux utilisateurs toutes les options de recherche dont MWSearch disposait, et davantage.

Dépendances

PHP et cURL

• En plus des besoins standard de MediaWiki pour PHP, CirrusSearch nécessite que PHP soit compilé avec la prise en charge de cURL.

Elasticsearch

• Vous devrez installer Elasticsearch.

Every version of ElasticSearch change how web services work, and cause compatibility problems. You must install the version of Elastic Search compatible with the version of MediaWiki you are currently using:

• MediaWiki 1.29.x - 1.30.x nécessitent Elasticsearch 5.3.x - 5.4.x.
• MediaWiki 1.31.x - 1.32.x nécessitent Elasticsearch 5.5.x - 5.6.x.
• MediaWiki 1.33.x - 1.38.x nécessitent Elasticsearch 6.5.x - 6.8.x (6.8.23+ recommended)

Notez bien qu'une installation supplémentaire de Java comme OpenJDK est nécessaire. It's best to use the official Elasticsearch Docker image or a self-hosted version. A managed product like Amazon OpenSearch (formerly Amazon Elasticsearch) can work but may require additional configuration depending on its specifics. For example, Amazon OpenSearch only listens for Elasticsearch API requests over HTTPS on port 443 (i.e. it does not expose the default Elasticsearch port 9200), so a TLS-enabled proxy (e.g. Nginx) can enable CirrusSearch to communicate with an Amazon OpenSearch cluster.

Elastica

• Elastica est une bibliothèque PHP pour parler à Elasticsearch. Installez Elastica à l'aide des instructions ci-dessous.

Autres

• A cause de la manière dont l'extension CirrusSearch gère actuellement les tâches, il est recommandé de fixer les tâches dans Redis afin d'empêcher les messages tels que Notice: unserialize(): Error at offset 64870 of 65535 bytes in JobQueueDB.php et les erreurs qui en découlent comme Unsupported operand types. Voir tâche T157759.

Installation

Elastica

Bien que les instructions ci-dessous vous indiquent de n'excuter Composer que lorsque vous faites une installation à partir de Git, il peut être nécessaire de le faire passer dans tous les cas afin d'installer toutes les dépendances PHP.

• Téléchargez et placez le(s) fichiers (s) dans un répertoire appelé Elastica dans votre dossier extensions/.
• Seulement lorsque vous installez à partir de Git, exécutez Composer pour installer les dépendances PHP, en entrant composer install --no-dev après vous être positionné dans le répertoire de l'extension. (Voir tâche T173141 pour des complications potentielles.)
• Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :

  wfLoadExtension( 'Elastica' );
  

•  Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

CirrusSearch

• Téléchargez et placez le(s) fichiers (s) dans un répertoire appelé CirrusSearch dans votre dossier extensions/.
• Seulement lorsque vous installez à partir de Git, exécutez Composer pour installer les dépendances PHP, en entrant composer install --no-dev après vous être positionné dans le répertoire de l'extension. (Voir tâche T173141 pour des complications potentielles.)
• Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :

  wfLoadExtension( 'CirrusSearch' );
  

• Maintenant suivez les instructions de configuration du fichier CirrusSearch README figurant avec votre extension par exemple $IP/extensions/CirrusSearch/README. Notez bien que toutes les informations qui y figurent ne s'appliquent pas forcément à la version de votre extension, particulièrement en ce qui concerne la version compatible de Elasticsearch.
• Configurez comme cela est indiqué.
•  Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Mise à jour

Veuillez suivre les instructions de mise à jour conenues dans le fichier CirrusSearch UPGRADE .

Configuration

Les paramètres de configuration CirrusSearch sont documentés dans le fichiers "settings.txt". Voir aussi la documentation sur les profils de configuration CirrusSearch.

Elasticsearch échouera à indexer pour CirrusSearch si l'on utilise un nom de base de données pour MySQL qui contient un caractère majuscule, par exemple "MyWikiDatabaseName". Pour atténuer ce problème, CirrusSearch fournit le paramètre de configuration $wgCirrusSearchIndexBaseName que l'on doit définir, par exemple $wgCirrusSearchIndexBaseName & # 61; 'mywikidatabasename';.

Accroches

L'extension CirrusSearch définit un nombre d'accroches que les autres extensions peuvent réutiliser pour étendre le schéma du noyau et pour modifier les documents. Les accroches suivantes sont utilisables :

• CirrusSearchAnalysisConfig - permet de s'accocher à la configuration pour des besoins d'analyse
• CirrusSearchMappingConfig - permet le paramètrage de la correspondance des champs
• CirrusSearchBuildDocumentParse - permet aux extensions de modifer le document ElasticSearch produit à partir d'une page
• CirrusSearchBuildDocumentLinks - permet aux extensions de traiter les liens entrants et sortants pour le document
• CirrusSearchBuildDocumentFinishBatch - appelé lorsqu'un lot de pages a été indexé
• CirrusSearchAddQueryFeatures - permet aux extensions d'ajouter des fonctionnalités à l'analyseur syntaxique des requêtes
• CirrusSearchScoreBuilder - permet aux extensions de définir des fonctions de rescore au build
• CirrusSearchProfileService - allows extension to declare various search components and configuration

API

Les fonctionnalités de CirrusSearch peuvent être utilisées dans les requêtes d'API. La recherche se fait en utilisant l'API search, action=query&list=search ; vous pouvez utiliser les fonctionnalités spécifiques de CirrusSearch, telles que le préfixe spécial morelike: pour trouver les pages relatives à Marie Curie et au radium: api.php?action=query&list=search&srsearch=morelike:Marie_Curie%7Cradium&srlimit=10&srprop=size&formatversion=2 Les APIs personnalisées et les paramètres sont fournis pour interroger la configuration CirrusSearch et les informations de débogage :

• action=cirrusdump module: 2014?action=cirrusdump
• cirrusDumpQuery paramètre vers Special:Search ou requêtes API search: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpQuery
• cirrusDumpResult paramètre de Special:Search ou requêtes API search : https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpResult
• Un paramètre supplémentaire, cirrusExplain, peut être passé avec cirrusDumpResult pour obtenir l'explication Lucene du noyau inclus avec la liste des résultats: https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpResult&cirrusExplain Il peut aussi être utilisé pour obtenir l'explication dans un format lisible par un humain, en lui donnant une des valeurs suivantes : verbose, pretty or hot, comme pour : https://en.wikipedia.org/wiki/Special:Search/cat%20dog%20chicken?cirrusDumpResult&cirrusExplain=pretty
• Les modules cirrus-config-dump, cirrus-settings-dump, cirrus-mapping-dump, cirrus-profiles-dump permettent d'obtenir les paramètres CirrusSearch de configuration : api.php?action=cirrus-config-dump&formatversion=2

Voir aussi

General links

• Page d'aide sur l'utilisation - Documentation sur l'utilisation de CirrusSearch (nécessaire après l'installation)
• Page du projet
• Informations concernant les paramètres Wikimedia Cirrus/Elastic
• Page d'aide à la configuration - ensembles de paramètres adaptables qui influencent différents aspects de l'indexation
• Extension:AdvancedSearch/fr - Enhances Special:Search by providing advanced parameters

Débogage

• Comment déterminer que Cirrus est réellement utilisé comme moteur de recherche

Développement local

Le service Elastic Search peut être exécuté avec les rôles Vagrant (cirrussearch) et MediaWiki Vagrant.

Pour Docker, vous pouvez utiliser une commande telle que docker run -d --name elasticsearch -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" elasticsearch:6.8.2. Ensuite suivez les instructions pour l'installation et la configuration. Si l'hôte pour votre web se trouve dans un conteneur, assurez vous que le conteneur se trouve sur le même réseau, et dans LocalSettings.php référencez elasticsearch comme le nom de l'hôte. Ceci ne prendra pas en compte les plugins WMF mais peut être suffisant pour les tests de base.