IndxSearchLib 4.0.0

IndxSearchLib

IndxSearchLib Developer Kit v4.0.0

Indx is a high-performance, embeddable search engine for developers working with structured data. Built from the ground up for speed, typo tolerance, and ease of use.

Whether you're building a modern SaaS platform, a high-throughput microservice, or a lightning-fast local app, Indx is designed to drop in and just work.

Indx differs from other search libraries by using a pattern recognition system rather than a lexical model. It identifies fragments of repeating structure — where the shape and length of the pattern influence recognition — enabling powerful text matching across variations.

V4 JSON mode

• Field based indexing with support for nesting
• Schema-less JSON configuration
• Filters, Weights, Sorting, Boosting logic
• Facets with histogram

Documentation: Indx Documentation.

Download example apps to see how to use IndxSearchLib here:

• Core mode
• JSON mode
• Advanced JSON example using Spectre.Console

Core Features at a glance

• Language agnostic pattern recognition
• Real-time, instant search as you type
• Smart handling of major typos
• Lightweight software with minimal resource usage

Developer license

This is an unlicensed version of Indx, and is limited to 25.000 documents. To get a developer license and extend the limit, register as a developer.

A commercial license is required to use the system in a production environment.

The documentations in this document covers text string search. To use JSON workflow, see the documentation

Installation

Prerequisites: Download .NET 9.

// Namespaces
using Indx;
using Indx.Api;

Get started

A minimal approach to using Indx v4

Create an instance

var engine = new SearchEngine();

Insert documents

The Insert function also accepts arrays.

var data = new Document[]
{
    new (0, "The Matrix"),
    new (1, "The Matrix Reloaded?"),
    new (2, "The Matrix Revolutions"),
    new (3, "The Matrix Resurrections")
};

engine.Insert(data);

Index

engine.Index();

while (engine.Status.SystemState != SystemState.Ready) Thread.Sleep(100); // await indexing complete

Set up query

var text = "Matri"; // Pattern to be searched for
var numRecords = 30; // Max records to be returned
var query = new Query(text, numRecords);

Search

var result = engine.Search(query);

List results

foreach (var record in result.SearchRecords)
{
    Console.Write(record.IndexedText);
    Console.WriteLine($" ({record.Score})");
}

Delete documents

engine.Delete(key); // Specify a key to a single doc
engine.DeleteAllDocuments(); // Delete all docs of instance

Check if reindex is required

Indx is a vector based engine that compares all searchable patterns to each other to create a vector model. Therefore when you alter the dataset more than 20% by inserting and deleting single documents, you should run indexing again. The status class has a bool to tell you this.

bool reIndexRequired = engine.Status.ReIndexRequired;

Searching will still be possible even if reindexing is necessary, but the automatic relevancy ranking function will be somewhat degraded.

Licensing

This Nuget is unlicensed and intended for testing purposes. The number of documents you can index without a license is 25.000. To extend this, register as a developer.

Adding a license

After registering as a developer, or by acquiring rights for commercial use, you will receive a .license file. This should be placed in your project and loaded in the constructor.

var engine = new SearchEngine("indx.license");

Check version and license information

string version = engine.Status.Version;
bool validLicense = engine.Status.LicenseInfo.ValidLicense;
int documentLimit = engine.Status.LicenseInfo.DocumentLimit;
DateTime licenseExpiration = engine.Status.LicenseInfo.ExpirationDate;

Commercial use

Indx has a licensing fee for commercial use. Please contact us on post@indx.co to inquire.