lucilla

Lucilla

Lucilla es una biblioteca de búsqueda de texto completo en memoria para Kotlin.

Le permite crear un índice de búsqueda de texto completo para datos que no necesiten persistir en una base de datos. Puede ejecutar consultas de búsqueda contra el índice para encontrar documentos coincidentes rápidamente.

 import com.haroldadmin.lucilla.core.*

data class Book (
    @Id
    val id : Int ,
    val title : String ,
    val summary : String ,
)

val index = useFts(getBooks())

index.search( " Martian " ).map { searchResult ->
    val bookId = searchResult.documentId
    val book = getBook(bookId)
    // Show search result to the user
}

Lucilla está en desarrollo activo. Es un prototipo de etapa temprana, y aún no es adecuado para el uso de la producción.

Características

• Índice de FTS eficiente con sede en Patricia Trie
• Tubería de procesamiento de texto avanzado con soporte para la tokenización, la derivación, la eliminación de puntuación y más.
• Procesamiento de texto extensible con pasos de canalización personalizados
• Ranking de resultados de búsqueda utilizando puntajes TF-IDF
• Elaboración de documentos personalizable con capacidad para ignorar los campos no deseados

Si bien Lucilla lo tiene cubierto en la mayoría de las características básicas, falta el soporte para algunas características avanzadas (pero planeadas):

• Búsqueda borrosa
• Aumentos de campo personalizados
• Procesamiento de asíncrono

Uso

Modelado de datos

Para usar las capacidades FTS de Lucilla, primero debe modelar sus datos como clase.

Recomendamos usar clases de datos para este propósito, pero cualquier cosa debería funcionar siempre que satisfaga los siguientes requisitos:

• Debe tener un campo marcado @Id que se pueda analizar como un Int
• Debe tener una o más otras propiedades que se puedan analizar como String S

 import com.haroldadmin.lucilla.core.Id

data class Book (
  @Id
  val id : Int ,
  val title : String ,
  val summary : String ,
)

Si no desea que Lucilla indexe algunos campos de su documento, anotes con @Ignore .

 import com.haroldadmin.lucilla.core.Id
import com.haroldadmin.lucilla.core.Ignore

data class Book (
    @Id
    val id : Int ,
    val title : String ,
    val summary : String , 
    @Ignore
    val publisher : String ,
)

Crear el índice

Cree un índice FTS y agregue sus datos:

 val index = useFts< Book >()
getBooks().forEach { index.add(it) }

// You can also pass your seed data directly
val books = getBooks()
val index = useFts< Book >(books)

Agregar documentos al índice o crear el índice con datos de semillas es un proceso potencialmente costoso dependiendo de cuán grande sea cada documento. Es mejor realizar este proceso en un hilo de fondo o coroutina.

Buscar el índice

Envíe sus consultas al índice para obtener los resultados de búsqueda ordenados por relevancia.

 val searchResults = index.search(query)
val books = searchResults.map { r -> r.documentId }.map { id -> getBook(id) }
showResults(books)

Lucilla ejecuta cada consulta de búsqueda a través de una tubería de procesamiento de texto para extraer tokens de búsqueda de ella. Los tokens pueden no reflejar exactamente la consulta de búsqueda. Para encontrar qué token de su consulta de búsqueda coincidió con un resultado de búsqueda determinado, use la propiedad "MatchterM" en un resultado de búsqueda.

Instalación

Agregue el repositorio de jitpack a su lista de repositorios:

 // Project level build.gradle file
allprojects {
    repositories {
        maven { url ' https://jitpack.io ' }
    }
}

Y luego agregue la dependencia en su archivo de Gradle:

 // Module build.gradle file
dependencies {
    implementation " com.github.haroldadmin.lucilla:core:(latest-version) "
}

Que contribuye

Lucilla está en desarrollo activo y no promete la estabilidad de la API. Espere que la biblioteca se someta a cambios significativos antes de alcanzar el estado estable.

Alentamos a la comunidad a contribuir con características e informes.

Meta

El nombre 'Lucilla' se inspira en el nombre de Ferrari 2020 de Sebastian Vettel. También suena similar a Lucene (de Apache Lucene), que es el marco de búsqueda de texto completo estándar de la industria.

La implementación de Lucilla toma prestada de una biblioteca JavaScript MiniSearch.

Licencia

 MIT License

Copyright (c) 2022 Kshitij Chauhan

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.