API reference

• High-level API: nind.nind_engine
  • NindEngine
  • NindIndexer
• Low-level API: binary format readers
  • nind.NindFile
  • nind.NindPadFile
  • nind.NindIndex
  • nind.NindRetrolexicon
  • nind.NindLexiconindex
  • nind.NindTermindex
  • nind.NindLocalindex

The reference is split in two, matching the layering described in Architecture:

• High-level API: nind.nind_engine - the high-level, pure-Python search frontend (NindEngine, NindIndexer). Start here for indexing and searching a corpus.

• Low-level API: binary format readers - the low-level, read-only binary format readers (NindFile through NindLocalindex). Reach for these when working directly with nind’s on-disk formats, including files written by the C++ implementation.