lucilla

Lucilla

Lucilla เป็นไลบรารีการค้นหาข้อความแบบเต็มในหน่วยความจำสำหรับ Kotlin

ช่วยให้คุณสามารถสร้างดัชนีการค้นหาข้อความแบบเต็มสำหรับข้อมูลที่ไม่จำเป็นต้องคงอยู่กับฐานข้อมูล คุณสามารถเรียกใช้คำค้นหาการค้นหากับดัชนีเพื่อค้นหาเอกสารการจับคู่ได้อย่างรวดเร็ว

 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 กำลังพัฒนาอย่างแข็งขัน มันเป็นต้นแบบระยะแรกและยังไม่เหมาะสำหรับการใช้งานการผลิต

คุณสมบัติ

• ดัชนี FTS ที่มีประสิทธิภาพจาก Patricia Trie
• ไปป์ไลน์การประมวลผลข้อความขั้นสูงพร้อมการสนับสนุนสำหรับ tokenization, stemming, การกำจัดเครื่องหมายวรรคตอนและอื่น ๆ
• การประมวลผลข้อความที่ขยายได้ด้วยขั้นตอนไปป์ไลน์ที่กำหนดเอง
• การจัดอันดับผลการค้นหาโดยใช้คะแนน TF-IDF
• การแยกวิเคราะห์เอกสารที่ปรับแต่งได้ด้วยความสามารถในการเพิกเฉยต่อฟิลด์ที่ไม่ต้องการ

ในขณะที่ Lucilla ได้ครอบคลุมคุณสมบัติพื้นฐานส่วนใหญ่การสนับสนุนสำหรับคุณสมบัติขั้นสูงบางอย่างหายไป (แต่วางแผน):

• การค้นหาฟัซซี่
• เพิ่มฟิลด์ที่กำหนดเอง
• การประมวลผล async

การใช้งาน

การสร้างแบบจำลองข้อมูล

ในการใช้ความสามารถ FTS ของ Lucilla คุณต้องสร้างแบบจำลองข้อมูลของคุณเป็นชั้นเรียนก่อน

เราขอแนะนำให้ใช้คลาสข้อมูลเพื่อจุดประสงค์นี้ แต่สิ่งใดควรทำงานตราบเท่าที่มันเป็นไปตามข้อกำหนดดังต่อไปนี้:

• ต้องมีฟิลด์ @Id ที่ทำเครื่องหมายไว้ซึ่งสามารถแยกวิเคราะห์เป็น Int
• ต้องมีคุณสมบัติอื่น ๆ อย่างน้อยหนึ่งอย่างที่สามารถแยกวิเคราะห์เป็น String ได้

 import com.haroldadmin.lucilla.core.Id

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

หากคุณไม่ต้องการให้ Lucilla จัดทำดัชนีบางฟิลด์ของเอกสารของคุณให้ใส่คำอธิบายประกอบด้วย @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 ,
)

สร้างดัชนี

สร้างดัชนี FTS และเพิ่มข้อมูลของคุณลงไป:

 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)

การเพิ่มเอกสารในดัชนีหรือการสร้างดัชนีด้วยข้อมูลเมล็ดเป็นกระบวนการที่มีราคาแพงขึ้นอยู่กับว่าแต่ละเอกสารมีขนาดใหญ่เพียงใด เป็นการดีที่สุดที่จะดำเนินการกระบวนการนี้บนเธรดพื้นหลังหรือ coroutine

ค้นหาดัชนี

ส่งแบบสอบถามของคุณไปยังดัชนีเพื่อรับผลการค้นหาที่สั่งซื้อตามความเกี่ยวข้อง

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

Lucilla รันคำค้นหาทุกครั้งผ่านไปป์ไลน์การประมวลผลข้อความเพื่อแยกโทเค็นที่ค้นหาได้จากมัน โทเค็นอาจไม่สะท้อนการค้นหาอย่างแน่นอน ในการค้นหาโทเค็นของคำค้นหาการค้นหาของคุณที่ตรงกับผลการค้นหาที่กำหนดให้ใช้คุณสมบัติ "matchterm" ในผลการค้นหา

การติดตั้ง

เพิ่มที่เก็บ jitpack ลงในรายการที่เก็บของคุณ:

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

จากนั้นเพิ่มการพึ่งพาในไฟล์ Gradle ของคุณ:

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

การบริจาค

Lucilla อยู่ในระหว่างการพัฒนาอย่างแข็งขันและไม่สัญญาความมั่นคงของ API คาดว่าห้องสมุดจะได้รับการเปลี่ยนแปลงที่สำคัญก่อนที่จะถึงสถานะที่มั่นคง

เราสนับสนุนให้ชุมชนมีส่วนร่วมในคุณสมบัติและรายงานข้อบกพร่อง

เมตา

ชื่อ 'Lucilla' ได้รับแรงบันดาลใจจากชื่อของ Sebastian Vettel ในปี 2020 Ferrari นอกจากนี้ยังฟังดูคล้ายกับ Lucene (จาก Apache Lucene) ซึ่งเป็นกรอบการค้นหาข้อความแบบเต็มมาตรฐานอุตสาหกรรม

การใช้งานของ Lucilla ยืมมาจากห้องสมุด JavaScript Minisearch

ใบอนุญาต

 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.