lucenenet

Bienvenido a Apache Lucene.NET

Potente búsqueda de texto completo para .NET

Apache Lucene.NET es una biblioteca de búsqueda de texto completo de código abierto escrita en C#. Es una adaptación del popular proyecto Java Apache Lucene.

Apache Lucene.NET es una biblioteca .NET que proporciona potentes funciones de búsqueda e indexación, así como corrección ortográfica, resaltado de visitas y capacidades avanzadas de análisis/tokenización.

Lucene.NET versión 4.8 (aún en Beta) se ejecuta en todos los lugares donde se ejecuta .NET, incluidos Windows, Unix, MacOS, Android e iOS.

El sitio web de Apache Lucene.NET está en: http://lucenenet.apache.org

Marcos soportados

Lucene.NET 3.0.3

• Marco .NET 4.0
• Marco .NET 3.5

Lucene.NET 4.8.0

• .NET 8.0
• NET 6.0
• Estándar .NET 2.1
• Estándar .NET 2.0
• Marco .NET 4.6.2

Estado

Última versión de lanzamiento: Lucene.NET 3.0.3

Trabajando hacia Lucene.NET 4.8.0 (actualmente en BETA)

• La versión beta es extremadamente estable.
• Tiene más de 7800 pruebas unitarias aprobadas
• Se integra bien con .NET 8.0 y .NET 6.0 (así como con otras versiones no compatibles)
• Soporta .NET Standard 2.1 y .NET Standard 2.0
• Compatible con .NET Framework 4.6.2+
• Algunos desarrolladores ya lo utilizan en entornos de producción

Descargar

Lucene.NET 3.0.3

Biblioteca principal

 PM> Install-Package Lucene.Net

Todos los paquetes

• Lucene.Net - Biblioteca principal
• Lucene.Net.Contrib: varias funciones y extras aportados por usuarios
• Lucene.Net.Contrib.Spatial - Búsqueda geoespacial
• Lucene.Net.Contrib.Spatial.NTS: búsqueda geoespacial compatible con NetTopologySuite.

Lucene.NET 4.8.0

Biblioteca principal

 PM> Install-Package Lucene.Net -Pre

Todos los paquetes

• Lucene.Net - Biblioteca principal
• Lucene.Net.Analysis.Common: analizadores para indexar contenido en diferentes idiomas y dominios
• Lucene.Net.Analysis.Kuromoji - Analizador morfológico japonés
• Lucene.Net.Analysis.Morfologik: analizador de derivaciones de diccionarios, diccionario polaco integrado
• Lucene.Net.Analysis.OpenNLP - Integración de la biblioteca OpenNLP
• Lucene.Net.Analysis.Phonetic: analizador para indexar firmas fonéticas (para búsquedas de sonidos similares)
• Lucene.Net.Analysis.SmartCn - Analizador para indexar chino
• Lucene.Net.Analysis.Stempel - Analizador para indexar polaco
• Lucene.Net.Benchmark - Sistema de evaluación comparativa Lucene
• Lucene.Net.Classification: módulo de clasificación para Lucene
• Lucene.Net.Codecs: códecs y formatos de publicaciones de Lucene
• Lucene.Net.Expressions: valores calculados dinámicamente para ordenar/facetar/buscar en función de una gramática conectable
• Lucene.Net.Facet: capacidades de búsqueda e indexación por facetas
• Lucene.Net.Grouping: recopiladores para agrupar resultados de búsqueda
• Lucene.Net.Highlighter: resalta las palabras clave de búsqueda en los resultados
• Lucene.Net.ICU - Analizadores y resaltadores especializados ICU (componentes internacionales para Unicode)
• Lucene.Net.Join: uniones en tiempo de índice y tiempo de consulta para contenido normalizado
• Lucene.Net.Memory: implementación de índice en memoria de un solo documento
• Lucene.Net.Misc: herramientas de índice y otros códigos diversos
• Lucene.Net.Queries: filtros y consultas que se agregan al núcleo de Lucene
• Lucene.Net.QueryParser: analizadores de texto a consulta y marco de análisis
• Utilidad de replicación de archivos Lucene.Net.Replicator
• Lucene.Net.Sandbox: varias contribuciones de terceros y nuevas ideas
• Lucene.Net.Spatial - Búsqueda geoespacial
• Lucene.Net.Suggest: compatibilidad con sugerencias automáticas y revisión ortográfica
• Lucene.Net.TestFramework: marco para probar aplicaciones basadas en Lucene

Documentación

Disponemos de documentación preliminar para Lucene.NET 4.8.0 en el sitio web de Lucene.NET.

La API es similar a Java Lucene 4.8.0, y también puede resultarle útil revisarla.

NOTA: Estamos trabajando para solucionar problemas con la documentación, pero nos vendría bien más ayuda ya que es un proyecto enorme. Ver #206.

Versiones heredadas

• Documentación de la API de Lucene.Net 3.0.3
• Documentación de la API de Lucene.Net 2.9.4

Demostraciones y herramientas

Hay varias demostraciones implementadas como aplicaciones de consola simples que se pueden copiar y pegar en Visual Studio o compilar en la línea de comandos en el proyecto Lucene.Net.Demo.

También hay una herramienta de línea de comandos dotnet disponible en NuGet. Contiene todas las demostraciones, así como herramientas que mantienen su índice Lucene.NET, con operaciones como dividir, fusionar, enumerar información de segmentos, corregir, eliminar segmentos, actualizar, etc. Asegúrese siempre de hacer una copia de seguridad de su índice antes de ejecutar cualquier comando. ¡en contra!

• Requisito previo: .NET 8.0 Runtime o superior

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

NOTA: La versión de la CLI que instale debe coincidir con la versión de Lucene.NET que utilice.

Una vez instalado, puede explorar los comandos y opciones que están disponibles ingresando el comando lucene .

Documentación de lucene-cli

Cómo contribuir

¡Nos encanta recibir contribuciones! Lea nuestra Guía de contribuciones o siga leyendo para descubrir formas en las que puede ayudar.

Únase a listas de correo

Cómo unirse a listas de correo

Haz una pregunta

Si tiene una pregunta general sobre cómo hacerlo o necesita ayuda de la comunidad Lucene.NET, suscríbase a la lista de correo user enviando un correo electrónico a [email protected] y luego siga las instrucciones para verificar su dirección de correo electrónico. . Tenga en cuenta que solo necesita suscribirse una vez.

Después de suscribirse a la lista de correo, envíe su mensaje por correo electrónico a [email protected].

Alternativamente, puede obtener ayuda a través de la comunidad activa de StackOverflow.

No envíe preguntas prácticas generales a GitHub; utilice GitHub únicamente para informes de errores y tareas.

Informar un error

Para informar un error, utilice el rastreador de problemas de GitHub.

NOTA: En el pasado, el proyecto Lucene.NET utilizaba el rastreador de problemas JIRA, que ahora ha quedado obsoleto. Sin embargo, lo mantenemos activo para realizar un seguimiento de los problemas heredados. Envíe cualquier problema nuevo a GitHub.

Iniciar una discusión

Para iniciar una discusión de desarrollo sobre las características técnicas de Lucene.NET, envíe un correo electrónico a la lista de correo dev a [email protected] y luego siga las instrucciones para verificar su dirección de correo electrónico. Tenga en cuenta que solo necesita suscribirse una vez.

Después de suscribirse a la lista de correo, envíe su mensaje por correo electrónico a [email protected].

Enviar una solicitud de extracción

Antes de comenzar a trabajar en una solicitud de extracción, lea nuestra guía de contribución.

Construcción y pruebas

Línea de comando

Requisitos previos

1. PowerShell 5.0 o superior (consulte esta pregunta para comprobar su versión de PowerShell)
2. SDK de .NET 8.0 o superior

Ejecución

NOTA: Si el proyecto está abierto en Visual Studio, su restauración en segundo plano puede interferir con estos comandos. Se recomienda cerrar todas las instancias de Visual Studio que tengan Lucene.Net.sln abierto antes de ejecutar.

Para compilar el código fuente, clone o descargue y descomprima el repositorio. Para versiones específicas, descargue y descomprima el archivo .src.zip desde la página de descarga de la versión específica. Desde el repositorio o la raíz de distribución, ejecute el comando de compilación desde un símbolo del sistema e incluya las opciones deseadas de la tabla de opciones de compilación a continuación:

ventanas

 > build [options]

Linux o macOS

 ./build [options]

NOTA: Será necesario otorgar permiso al archivo build para ejecutarlo usando el comando chmod u+x build antes de la primera ejecución.

Opciones de construcción

Las siguientes opciones no distinguen entre mayúsculas y minúsculas. Cada opción tiene una forma corta indicada por un solo - y una forma larga indicada por -- . Las opciones que requieren un valor deben ir seguidas de un espacio y luego del valor, similar a ejecutar la CLI de dotnet.

Corto	Largo	Descripción	Ejemplo
-config	--configuración	La configuración de compilación ("Versión" o "Depuración").	construir-‑configuración Depurar
-mp	‑‑trabajos-paralelos-máximo	El número máximo de trabajos paralelos que se ejecutarán durante la prueba. Si no se proporciona, el valor predeterminado es 8.	construir -t -mp 10
-pv	‑‑versión-paquete	La versión del paquete NuGet. Si no se proporciona, utilizará la versión del archivo Version.proj.	compilación-pv 4.8.0-beta00001
-t	--prueba	Ejecuta las pruebas después de la construcción. Esta opción no requiere un valor. Tenga en cuenta que las pruebas suelen tardar unos 40 minutos con 8 trabajos paralelos.	construir -t
-fv	‑‑versión-archivo	La versión del archivo ensamblado. Si no se proporciona, el valor predeterminado es --package-version (excluyendo cualquier etiqueta de prelanzamiento). La versión ensamblada se derivará del componente de la versión principal del valor pasado, excluyendo los componentes menores, de compilación y de revisión.	compilación-pv 4.8.0-beta00001-fv 4.8.0

Por ejemplo, el siguiente comando crea una compilación de lanzamiento con la versión 4.8.0‑ci00015 del paquete NuGet y la versión 4.8.0 del archivo. La versión ensamblada se derivará del componente de versión principal del valor pasado, excluyendo los componentes menores, de compilación y de revisión (en este caso 4.0.0).

ventanas

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

Linux o macOS

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

En el ejemplo anterior, utilizamos "ci" en la versión del paquete para indicar que no se trata de una versión beta publicada públicamente, sino más bien del resultado de una compilación de integración continua desde master que ocurrió después de beta00014 pero antes de que se lanzara beta00015.

La compilación envía los paquetes NuGet al directorio /_artifacts/NuGetPackages/ . Los resultados de la prueba (si corresponde) se envían al directorio /_artifacts/TestResults/ .

Puede configurar Visual Studio para leer los paquetes NuGet como cualquier fuente NuGet siguiendo estos pasos:

1. En Visual Studio, haga clic derecho en la solución en el Explorador de soluciones y elija "Administrar paquetes NuGet para la solución".
2. Haga clic en el ícono de ajustes al lado del menú desplegable Fuentes del paquete.
3. Haga clic en el ícono + (para agregar)
4. Asigne un nombre a la fuente, como Lucene.Net Local Packages
5. Haga clic en el botón ... junto al campo Fuente y elija la carpeta /src/_artifacts/NuGetPackages en su sistema local.
6. Haga clic en Aceptar

Luego, todo lo que necesita hacer es elegir la fuente Lucene.Net Local Packages en el menú desplegable (en el Administrador de paquetes NuGet) y podrá buscar, instalar y actualizar los paquetes NuGet tal como puede hacerlo con cualquier fuente basada en Internet.

estudio visual

Requisitos previos

1. Visual Studio 2022 o superior
2. SDK de .NET 8.0 o superior

Ejecución

1. Abra Lucene.Net.sln en Visual Studio.
2. Elija el marco de destino para probar abriendo .build/TestTargetFramework.props y descomentando el <TargetFramework> correspondiente (y comentando todos los demás).
3. Cree un proyecto o la solución completa y espere a que Visual Studio descubra las pruebas; esto puede tardar varios minutos.
4. Ejecute o depure las pruebas en Test Explorer, utilizando opcionalmente los filtros deseados.

NOTA: Al ejecutar pruebas en Visual Studio, asegúrese de configurar la arquitectura del procesador predeterminada en 64 bits para evitar quedarse sin memoria virtual en algunas pruebas.

Azure DevOps

Hemos configurado nuestro archivo azure-pipelines.yml con valores predeterminados lógicos para que cualquier persona con una cuenta de Azure DevOps pueda crear Lucene.NET y ejecutar las pruebas con el mínimo esfuerzo. Incluso una cuenta gratuita de Azure DevOps funcionará, pero las pruebas se ejecutarán mucho más rápido si la cuenta está configurada como pública, lo que permite ejecutar hasta 10 trabajos paralelos simultáneamente.

Requisitos previos

1. Una cuenta de Azure DevOps.
2. Una bifurcación de este repositorio en GitHub o Azure DevOps. El resto de estas instrucciones asumen una bifurcación de GitHub.

Ejecución

Si aún no tienes una canalización configurada:

1. Cree una organización de Azure DevOps. Si ya tiene uno que desea utilizar, puede omitir este paso.
2. Cree un proyecto de Azure DevOps. Recomendamos nombrar el proyecto Lucene.NET. Tenga en cuenta que si está utilizando una cuenta gratuita de Azure DevOps, debe optar por hacer público el proyecto para habilitar 10 trabajos paralelos. Si hace que el proyecto sea privado, solo obtendrá 1 trabajo paralelo. Además, si deshabilita funciones, asegúrese de dejar Pipelines habilitados.
3. Cree una canalización de Azure DevOps.
   • Haga clic en "Tuberías" en el menú de la izquierda.
   • Haga clic en el botón "Crear canalización" o "Nueva canalización", dependiendo de si ya existe alguna canalización.
   • Seleccione GitHub como ubicación para encontrar el archivo YAML.
   • Seleccione la bifurcación de este repositorio que creó en "Requisitos previos". Tenga en cuenta que si se trata de una nueva cuenta de Azure DevOps, es posible que necesite configurar permisos adicionales para acceder a su cuenta de GitHub.
   • A continuación, se presenta una página "Revise su YAML" que muestra el contenido de azure-pipelines.yml . Hay documentación cerca de la parte superior del archivo que indica las variables que se pueden configurar para habilitar opciones adicionales, pero tenga en cuenta que la configuración predeterminada ejecutará automáticamente la compilación y todas las pruebas.
   • Haga clic en el botón "Ejecutar" en la parte superior derecha de la página.

Si ya tiene una canalización configurada:

1. Haga clic en "Tuberías" en el menú de la izquierda.
2. Seleccione la canalización que desea ejecutar.
3. Haga clic en el botón "Cola" en la esquina superior derecha.
4. (Opcional) Seleccione la rama y anule cualquier variable en la canalización para esta ejecución.
5. Haga clic en el botón "Ejecutar".

Tenga en cuenta que una vez completada la compilación, el artefacto nuget contiene archivos .nupkg que pueden descargarse en su máquina local, donde puede configurar una carpeta local para que actúe como fuente NuGet.

También es posible agregar una identificación de fuente de Azure DevOps a una nueva variable denominada ArtifactFeedID , pero obtenemos resultados mixtos debido a problemas de permisos.