lucilla

Lucilla

Lucilla ist eine In-Memory-Bibliothek für Volltext-Suchbibliothek für Kotlin.

Es ermöglicht Ihnen, einen Volltext -Suchindex für Daten zu erstellen, der nicht in eine Datenbank bestehen muss. Sie können Suchanfragen gegen den Index ausführen, um übereinstimmende Dokumente schnell zu finden.

 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 ist in aktiver Entwicklung. Es ist ein Early Stady -Prototyp und noch nicht für die Produktionsnutzung geeignet.

Merkmale

• Patricia Trie -basierter Raumeffizienter FTS -Index
• Erweiterte Textverarbeitungspipeline mit Unterstützung für Tokenisierung, Stamm, Interpunktionsentfernung und vieles mehr.
• Erweiterbare Textverarbeitung mit benutzerdefinierten Pipeline -Schritten
• Suchergebnisse mithilfe von TF-IDF-Bewertungen
• Anpassbares Dokument analysiert mit der Fähigkeit, unerwünschte Felder zu ignorieren

Während Lucilla Sie über die meisten grundlegenden Funktionen abgedeckt hat, fehlt die Unterstützung für einige erweiterte Funktionen (aber geplant):

• Fuzzy -Suche
• Benutzerdefinierte Feldschubs
• Asynchronisierungsverarbeitung

Verwendung

Modellierungsdaten

Um die FTS -Funktionen von Lucilla zu verwenden, müssen Sie Ihre Daten zunächst als Klasse modellieren.

Wir empfehlen, Datenklassen für diesen Zweck zu verwenden, aber alles sollte funktionieren, solange es die folgenden Anforderungen erfüllt:

• Muss ein @Id markiertes Feld haben, das als Int analysiert werden kann
• Muss eine oder mehrere andere Eigenschaften haben, die als String s analysiert werden können

 import com.haroldadmin.lucilla.core.Id

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

Wenn Sie nicht möchten, dass Lucilla einige Felder Ihres Dokuments indexiert, kommentieren Sie sie mit @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 ,
)

Erstellen Sie den Index

Erstellen Sie einen FTS -Index und fügen Sie Ihre Daten hinzu:

 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)

Das Hinzufügen von Dokumenten zum Index oder das Erstellen des Index mit Samendaten ist ein potenziell teurer Prozess, je nachdem, wie groß jedes Dokument ist. Es ist am besten, diesen Prozess auf einem Hintergrund -Thread oder einer Coroutine durchzuführen.

Suchen Sie den Index

Senden Sie Ihre Abfragen an den Index, um die nach Relevanz bestellten Suchergebnisse zu erhalten.

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

Lucilla führt jede Suchabfrage über eine Textverarbeitungspipeline aus, um durchsuchbare Token aus der IT zu extrahieren. Die Token spiegeln die Suchabfrage möglicherweise nicht genau wider. Um herauszufinden, welches Token Ihrer Suchabfrage mit einem bestimmten Suchergebnis übereinstimmt, verwenden Sie die Eigenschaft "Matchterm" für ein Suchergebnis.

Installation

Fügen Sie das Jitpack -Repository Ihrer Liste der Repositories hinzu:

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

Fügen Sie dann die Abhängigkeit in Ihre Gradle -Datei hinzu:

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

Beitragen

Lucilla befindet sich in aktiver Entwicklung und verspricht keine API -Stabilität. Erwarten Sie, dass die Bibliothek erhebliche Änderungen unterzogen wird, bevor sie einen stabilen Status erreicht.

Wir ermutigen die Community, Funktionen beizutragen und Fehler zu melden.

Meta

Der Name 'Lucilla' ist vom Namen von Sebastian Vettels 2020 Ferrari inspiriert. Es klingt auch ähnlich wie Lucene (von Apache Lucene), dem Branchenstandard für Volltext -Such -Framework.

Die Implementierung von Lucilla leiht sich von einer JavaScript -Bibliotheksminisearch aus.

Lizenz

 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.