lucenenet

Bienvenue sur Apache Lucene.NET

Recherche en texte intégral puissante pour .NET

Apache Lucene.NET est une bibliothèque de recherche en texte intégral open source écrite en C#. Il s'agit d'un portage du populaire projet Java Apache Lucene.

Apache Lucene.NET est une bibliothèque .NET offrant de puissantes fonctionnalités d'indexation et de recherche, ainsi que des fonctionnalités de vérification orthographique, de mise en évidence des résultats et d'analyse/tokenisation avancées.

Lucene.NET version 4.8 (toujours en version bêta) s'exécute partout où .NET s'exécute, notamment Windows, Unix, MacOS, Android et iOS.

Le site Web Apache Lucene.NET se trouve à l'adresse : http://lucenenet.apache.org

Cadres pris en charge

Lucène.NET 3.0.3

• .NET Framework 4.0
• .NET Framework 3.5

Lucène.NET 4.8.0

• .NET 8.0
• .NET 6.0
• Norme .NET 2.1
• Norme .NET 2.0
• .NET Framework 4.6.2

Statut

Dernière version : Lucene.NET 3.0.3

En route vers Lucene.NET 4.8.0 (actuellement en version bêta)

• La version bêta est extrêmement stable
• A plus de 7 800 tests unitaires réussis
• S'intègre bien avec .NET 8.0 et .NET 6.0 (ainsi qu'avec d'autres versions non prises en charge)
• Prend en charge .NET Standard 2.1 et .NET Standard 2.0
• Prend en charge .NET Framework 4.6.2+
• Certains développeurs l'utilisent déjà dans des environnements de production

Télécharger

Lucène.NET 3.0.3

Bibliothèque principale

 PM> Install-Package Lucene.Net

Tous les forfaits

• Lucene.Net - Bibliothèque principale
• Lucene.Net.Contrib - Diverses fonctionnalités et extras contribués par les utilisateurs
• Lucene.Net.Contrib.Spatial - Recherche géospatiale
• Lucene.Net.Contrib.Spatial.NTS - Recherche géospatiale avec prise en charge de NetTopologySuite.

Lucène.NET 4.8.0

Bibliothèque principale

 PM> Install-Package Lucene.Net -Pre

Tous les forfaits

• Lucene.Net - Bibliothèque principale
• Lucene.Net.Analysis.Common - Analyseurs pour indexer le contenu dans différentes langues et domaines
• Lucene.Net.Analysis.Kuromoji - Analyseur morphologique japonais
• Lucene.Net.Analysis.Morfologik - Analyseur de recherche de dictionnaire, dictionnaire polonais intégré
• Lucene.Net.Analysis.OpenNLP - Intégration de la bibliothèque OpenNLP
• Lucene.Net.Analysis.Phonetic - Analyseur d'indexation de signatures phonétiques (pour la recherche de sons similaires)
• Lucene.Net.Analysis.SmartCn - Analyseur pour l'indexation du chinois
• Lucene.Net.Analysis.Stempel - Analyseur pour l'indexation du polonais
• Lucene.Net.Benchmark - Système d'analyse comparative Lucene
• Lucene.Net.Classification - Module de classification pour Lucene
• Lucene.Net.Codecs - Codecs Lucene et formats de publication
• Lucene.Net.Expressions - Valeurs calculées dynamiquement sur lesquelles trier/facettes/rechercher en fonction d'une grammaire enfichable
• Lucene.Net.Facet - Capacités d'indexation et de recherche à facettes
• Lucene.Net.Grouping - Collecteurs pour regrouper les résultats de recherche
• Lucene.Net.Highlighter – Met en évidence les mots-clés de recherche dans les résultats
• Lucene.Net.ICU - Analyseurs et surligneurs spécialisés ICU (International Components for Unicode)
• Lucene.Net.Join - Jointures au moment de l'index et au moment de la requête pour le contenu normalisé
• Lucene.Net.Memory - Implémentation d'un index en mémoire pour un document unique
• Lucene.Net.Misc - Outils d'indexation et autres codes divers
• Lucene.Net.Queries - Filtres et requêtes qui s'ajoutent au cœur de Lucene
• Lucene.Net.QueryParser - Analyseurs Text to Query et cadre d'analyse
• Utilitaire de réplication de fichiers Lucene.Net.Replicator
• Lucene.Net.Sandbox - Diverses contributions de tiers et nouvelles idées
• Lucene.Net.Spatial - Recherche géospatiale
• Lucene.Net.Suggest - Prise en charge de la suggestion automatique et de la vérification orthographique
• Lucene.Net.TestFramework - Framework pour tester les applications basées sur Lucene

Documentation

Nous disposons d'une documentation préliminaire pour Lucene.NET 4.8.0 sur le site Web Lucene.NET.

L'API est similaire à Java Lucene 4.8.0, que vous trouverez peut-être également utile de consulter.

REMARQUE : Nous travaillons à résoudre les problèmes liés à la documentation, mais nous pourrions avoir besoin de plus d'aide car il s'agit d'un projet massif. Voir #206.

Versions héritées

• Documentation de l'API Lucene.Net 3.0.3
• Documentation de l'API Lucene.Net 2.9.4

Démos et outils

Il existe plusieurs démos implémentées sous forme d'applications console simples qui peuvent être copiées et collées dans Visual Studio ou compilées sur la ligne de commande dans le projet Lucene.Net.Demo.

Il existe également un outil de ligne de commande dotnet disponible sur NuGet. Il contient toutes les démos ainsi que les outils gérant votre index Lucene.NET, comprenant des opérations telles que le fractionnement, la fusion, la liste des informations sur les segments, la correction, la suppression de segments, la mise à niveau, etc. Assurez-vous toujours de sauvegarder votre index avant d'exécuter des commandes. contre ça !

• Condition préalable : .NET 8.0 Runtime ou version ultérieure

 dotnet tool install lucene-cli -g --version 4.8.0-beta00015

REMARQUE : La version de la CLI que vous installez doit correspondre à la version de Lucene.NET que vous utilisez.

Une fois installé, vous pouvez explorer les commandes et options disponibles en entrant la commande lucene .

Documentation lucene-cli

Comment contribuer

Nous aimons recevoir des contributions ! Lisez notre Guide de contribution ou poursuivez votre lecture pour savoir comment vous pouvez aider.

Rejoignez les listes de diffusion

Comment rejoindre les listes de diffusion

Poser une question

Si vous avez une question générale ou avez besoin d'aide de la communauté Lucene.NET, veuillez vous inscrire à la liste de diffusion user en envoyant un e-mail à [email protected], puis suivez les instructions pour vérifier votre adresse e-mail. . Notez que vous ne devez vous abonner qu’une seule fois.

Après vous être abonné à la liste de diffusion, envoyez votre message par courrier électronique à [email protected].

Vous pouvez également obtenir de l'aide via la communauté active de StackOverflow.

Veuillez ne pas soumettre de questions générales à GitHub, utilisez GitHub uniquement pour les rapports de bugs et les tâches.

Signaler un bug

Pour signaler un bug, veuillez utiliser le outil de suivi des problèmes GitHub.

REMARQUE : Dans le passé, le projet Lucene.NET utilisait le système de suivi des problèmes JIRA, qui est désormais obsolète. Cependant, nous le gardons actif pour suivre les problèmes hérités. Veuillez soumettre tout nouveau problème à GitHub.

Démarrer une discussion

Pour démarrer une discussion de développement concernant les fonctionnalités techniques de Lucene.NET, veuillez envoyer un e-mail à la liste de diffusion dev en envoyant un e-mail à [email protected], puis suivez les instructions pour vérifier votre adresse e-mail. Notez que vous ne devez vous abonner qu’une seule fois.

Après vous être abonné à la liste de diffusion, envoyez votre message par e-mail à [email protected].

Soumettre une demande de tirage

Avant de commencer à travailler sur une pull request, veuillez lire notre guide de contribution.

Construction et tests

Ligne de commande

Conditions préalables

1. PowerShell 5.0 ou supérieur (voir cette question pour vérifier votre version PowerShell)
2. SDK .NET 8.0 ou supérieur

Exécution

REMARQUE : si le projet est ouvert dans Visual Studio, sa restauration en arrière-plan peut interférer avec ces commandes. Il est recommandé de fermer toutes les instances de Visual Studio sur lesquelles Lucene.Net.sln est ouvert avant l'exécution.

Pour créer la source, clonez ou téléchargez et décompressez le référentiel. Pour des versions spécifiques, téléchargez et décompressez le fichier .src.zip à partir de la page de téléchargement de la version spécifique. À partir de la racine du référentiel ou de la distribution, exécutez la commande build à partir d'une invite de commande et incluez les options souhaitées dans le tableau des options de build ci-dessous :

Fenêtres

 > build [options]

Linux ou macOS

 ./build [options]

REMARQUE : le fichier build devra recevoir l'autorisation de s'exécuter à l'aide de la commande chmod u+x build avant la première exécution.

Options de construction

Les options suivantes ne sont pas sensibles à la casse. Chaque option a à la fois une forme courte indiquée par un simple - et une forme longue indiquée par -- . Les options qui nécessitent une valeur doivent être suivies d'un espace, puis de la valeur, comme lors de l'exécution de la CLI dotnet.

Court	Long	Description	Exemple
‑config	--configuration	La configuration de build ("Release" ou "Debug").	build ‑‑configuration Débogage
‑mp	‑‑tâches-parallèles maximales	Nombre maximum de tâches parallèles à exécuter pendant les tests. S’il n’est pas fourni, la valeur par défaut est 8.	construire ‑t ‑mp 10
-pv	‑‑version-package	La version du package NuGet. S'il n'est pas fourni, utilisera la version du fichier Version.proj.	build-pv 4.8.0-beta00001
-t	--test	Exécute les tests après la construction. Cette option ne nécessite pas de valeur. Notez que les tests prennent généralement environ 40 minutes avec 8 tâches parallèles.	construire -t
-fv	‑‑version-fichier	La version du fichier d'assemblage. S'il n'est pas fourni, la valeur par défaut est --package-version (à l'exclusion de toute étiquette de version préliminaire). La version de l'assembly sera dérivée du composant de version majeure de la valeur transmise, à l'exclusion des composants mineurs, de construction et de révision.	build ‑pv 4.8.0‑beta00001 ‑fv 4.8.0

Par exemple, la commande suivante crée une version Release avec la version du package NuGet 4.8.0‑ci00015 et la version de fichier 4.8.0. La version de l'assembly sera dérivée du composant de version majeure de la valeur transmise, à l'exclusion des composants mineurs, de construction et de révision (dans ce cas, 4.0.0).

Fenêtres

 > build ‑‑configuration Release ‑pv 4.8.0‑ci00015 ‑fv 4.8.0

Linux ou macOS

 ./build ‑‑configuration Release ‑pv 4.8.0‑ci00015 ‑fv 4.8.0

Dans l'exemple ci-dessus, nous utilisons "ci" dans la version du package pour indiquer qu'il ne s'agit pas d'une version bêta publiée publiquement, mais plutôt du résultat d'une version d'intégration continue de master qui a eu lieu après la version bêta00014 mais avant la publication de la version bêta00015.

Les packages NuGet sont générés par la build dans le répertoire /_artifacts/NuGetPackages/ . Les résultats des tests (le cas échéant) sont affichés dans le répertoire /_artifacts/TestResults/ .

Vous pouvez configurer Visual Studio pour lire les packages NuGet comme n'importe quel flux NuGet en suivant ces étapes :

1. Dans Visual Studio, cliquez avec le bouton droit sur la solution dans l'Explorateur de solutions et choisissez « Gérer les packages NuGet pour la solution »
2. Cliquez sur l'icône d'engrenage à côté de la liste déroulante Sources du package.
3. Cliquez sur l'icône + (pour ajouter)
4. Donnez à la source un nom tel que Lucene.Net Local Packages
5. Cliquez sur le bouton ... à côté du champ Source et choisissez le dossier /src/_artifacts/NuGetPackages sur votre système local.
6. Cliquez sur OK

Ensuite, tout ce que vous avez à faire est de choisir le flux Lucene.Net Local Packages dans la liste déroulante (dans le gestionnaire de packages NuGet) et vous pouvez rechercher, installer et mettre à jour les packages NuGet comme vous le pouvez avec n'importe quel flux basé sur Internet.

Studio visuel

Conditions préalables

1. Visual Studio 2022 ou supérieur
2. SDK .NET 8.0 ou supérieur

Exécution

1. Ouvrez Lucene.Net.sln dans Visual Studio.
2. Choisissez le framework cible à tester en ouvrant .build/TestTargetFramework.props et en décommentant le <TargetFramework> correspondant (et en commentant tous les autres).
3. Créez un projet ou la solution entière et attendez que Visual Studio découvre les tests. Cela peut prendre plusieurs minutes.
4. Exécutez ou déboguez les tests dans Test Explorer, en utilisant éventuellement les filtres souhaités.

REMARQUE : lors de l'exécution de tests dans Visual Studio, veillez à définir l'architecture de processeur par défaut sur 64 bits pour éviter de manquer de mémoire virtuelle lors de certains tests.

Azure DevOps

Nous avons configuré notre fichier azure-pipelines.yml avec des valeurs logiques par défaut afin que toute personne disposant d'un compte Azure DevOps puisse créer Lucene.NET et exécuter les tests avec un minimum d'effort. Même un compte Azure DevOps gratuit fonctionnera, mais les tests s'exécuteront beaucoup plus rapidement si le compte est configuré comme public, ce qui permet d'exécuter jusqu'à 10 tâches parallèles simultanément.

Conditions préalables

1. Un compte Azure DevOps.
2. Un fork de ce référentiel soit sur GitHub, soit sur Azure DevOps. Le reste de ces instructions suppose un fork de GitHub.

Exécution

Si vous n'avez pas encore configuré de pipeline :

1. Créez une organisation Azure DevOps. Si vous en possédez déjà un que vous souhaitez utiliser, vous pouvez ignorer cette étape.
2. Créez un projet Azure DevOps. Nous vous recommandons de nommer le projet Lucene.NET. Notez que si vous utilisez un compte Azure DevOps gratuit, vous devez choisir de rendre le projet public afin d'activer 10 tâches parallèles. Si vous rendez le projet privé, vous n'obtiendrez qu'un seul travail parallèle. De plus, si vous désactivez des fonctionnalités, assurez-vous de laisser les pipelines activés.
3. Créez un pipeline Azure DevOps.
   • Cliquez sur "Pipelines" dans le menu de gauche.
   • Cliquez sur le bouton "Créer un pipeline" ou "Nouveau pipeline", selon que des pipelines existent déjà.
   • Sélectionnez GitHub comme emplacement pour rechercher le fichier YAML.
   • Sélectionnez le fork de ce dépôt que vous avez créé dans "Prérequis". Notez que s'il s'agit d'un nouveau compte Azure DevOps, vous devrez peut-être configurer des autorisations supplémentaires pour accéder à votre compte GitHub.
   • Ensuite, une page « Vérifiez votre YAML » est présentée montrant le contenu de azure-pipelines.yml . Il existe une documentation en haut du fichier indiquant les variables qui peuvent être configurées pour activer des options supplémentaires, mais notez que la configuration par défaut exécutera automatiquement la construction et tous les tests.
   • Cliquez sur le bouton "Exécuter" en haut à droite de la page.

Si vous avez déjà configuré un pipeline :

1. Cliquez sur "Pipelines" dans le menu de gauche.
2. Sélectionnez le pipeline que vous souhaitez exécuter.
3. Cliquez sur le bouton "File d'attente" en haut à droite.
4. (Facultatif) Sélectionnez la branche et remplacez toutes les variables du pipeline pour cette exécution.
5. Cliquez sur le bouton "Exécuter".

Notez qu'une fois la construction terminée, l'artefact nuget contient des fichiers .nupkg qui peuvent être téléchargés sur votre ordinateur local où vous pouvez configurer un dossier local pour agir comme un flux NuGet.

Il est également possible d'ajouter un identifiant de flux Azure DevOps à une nouvelle variable nommée ArtifactFeedID , mais nous obtenons des résultats mitigés en raison de problèmes d'autorisation.