ndx

NDX ·

مكتبة الفهرسة والبحث عن النص الكامل الوزن.

تم تصميم هذه المكتبة لحالة استخدام محددة عندما يتم تخزين جميع المستندات على القرص (INSTEDDB) ويمكن إضافتها أو إزالتها ديناميكيًا إلى فهرس.

تدعم وظيفة الاستعلام فقط مشغلي الانفصال. ستعمل الاستعلامات مثل one two كـ "one" or "two" .

الفهرس المقلوب لا يخزن المواقع ولن تتمكن وظيفة الاستعلام من البحث عن عبارات مثل "Super Mario" .

هناك العديد من الحلول البديلة مع مفاضلات مختلفة قد تناسب حالاتك بشكل أفضل. للحصول على بحث بسيط من المستندات مع مجموعة بيانات ثابتة ، أوصي باستخدام شيء مثل FST ونشره كدالة EDGE (WASM).

سمات

• حقول متعددة فهرسة النص الكامل والبحث.
• لكل حقل درجة تعزيز.
• BM25 وظيفة الترتيب لتصنيف المستندات المطابقة.
• فهرس ديناميكي مقلوب القائم على تري.
• الرمز المميز القابل للتكوين ومرشح المصطلح.
• استفسارات نص مجانية مع توسيع الاستعلام.

مثال

 import { createIndex , indexAdd } from "ndx" ;
import { indexQuery } from "ndx/query" ;

const termFilter = ( term ) => term . toLowerCase ( ) ;

function createDocumentIndex ( fields ) {
  // `createIndex()` creates an index data structure.
  // First argument specifies how many different fields we want to index.
  const index = createIndex (
    fields . length ,
    // Tokenizer is a function that breaks text into words, phrases, symbols,
    // or other meaningful elements called tokens.
    ( s ) => s . split ( " " ) ,
    // Filter is a function that processes tokens and returns terms, terms are
    // used in Inverted Index to index documents.
    termFilter ,
  ) ;
  // `fieldGetters` is an array with functions that will be used to retrieve
  // data from different fields.
  const fieldGetters = fields . map ( ( f ) => ( doc ) => doc [ f . name ] ) ;
  // `fieldBoostFactors` is an array of boost factors for each field, in this
  // example all fields will have identical weight.
  const fieldBoostFactors = fields . map ( ( ) => 1 ) ;

  return {
    index ,
    // `add()` will add documents to the index.
    add ( doc ) {
      indexAdd (
        index ,
        fieldGetters ,
        // Docum  ent key, it can be an unique document id or a refernce to a
        // document if you want to store all documents in memory.
        doc . id ,
        // Document.
        doc ,
      ) ;
    } ,
    // `remove()` will remove documents from the index.
    remove ( id ) {
      // When document is removed we are just marking document id as being
      // removed. Index data structure still contains references to the removed
      // document.
      indexRemove ( index , removed , id ) ;
      if ( removed . size > 10 ) {
        // `indexVacuum()` removes all references to removed documents from the
        // index.
        indexVacuum ( index , removed ) ;
      }
    } ,

    // `search()` will be used to perform queries.
    search ( q ) {
      return indexQuery (
        index ,
        fieldBoostFactors ,
        // BM25 ranking function constants:
        // BM25 k1 constant, controls non-linear term frequency normalization
        // (saturation).
        1.2 ,
        // BM25 b constant, controls to what degree document length normalizes
        // tf values.
        0.75 ,
        q ,
      ) ;
    }
  } ;
}

// Create a document index that will index `content` field.
const index = createDocumentIndex ( [ { name : "content" } ] ) ;

const docs = [
  {
    "id" : "1" ,
    "content" : "Lorem ipsum dolor" ,
  } ,
  {
    "id" : "2" ,
    "content" : "Lorem ipsum" ,
  }
] ;

// Add documents to the index.
docs . forEach ( ( d ) => { index . add ( d ) ; } ) ;

// Perform a search query.
index . search ( "Lorem" ) ;
// => [{ key: "2" , score: ... }, { key: "1", score: ... } ]
//
// document with an id `"2"` is ranked higher because it has a `"content"`
// field with a less number of terms than document with an id `"1"`.

index . search ( "dolor" ) ;
// => [{ key: "1", score: ... }]

المميزات والمرشحات

لا توفر مكتبة ndx أي مميزات أو مرشحات. هناك مكتبات أخرى تنفذ الرمز المميزات ، على سبيل المثال Natural لديها مجموعة جيدة من الرمز المميزات و STEMMERS.

رخصة

معهد ماساتشوستس للتكنولوجيا