Skip to content

API reference#

NLQL's public API is organized into 9 groups, all importable from the top-level import nlql. The reference is rendered from the Python docstrings (which are in English) on the default-language pages linked below.

Engine & construction#

Engine is the main application entry point; QueryBuilder is the fluent constructor.

  • Engine, QueryBuilder, select, F, Meta, content, field, similarity, contains, length
  • Module: nlql.sdk

Data model#

Document / Payload / Unit / Modality.

  • Document, Payload, Unit, Modality, UnitKind, Span, Vector
  • Module: nlql.model

Language & IR#

parse compiles an NLQL statement into the Query IR; query_json_schema exports the JSON Schema.

  • parse, NLQLParser · module: nlql.lang
  • Query, Select, Binding, Literal, Path, Ref, Call, Compare · module: nlql.ir

Embedder#

The Embedder protocol and backends, MultimodalEmbedder, and EmbeddingCache.

  • Embedder, FakeEmbedder, OpenAIEmbedder, CachedEmbedder, EmbeddingCache, MultimodalEmbedder, FakeMultimodalEmbedder, DoubaoVisionEmbedder
  • Module: nlql.embed

Reranker#

The Reranker protocol.

  • Reranker, FakeReranker, CrossEncoderReranker
  • Module: nlql.rerank

Store#

The Store interface and StoreCaps; built-in LocalStore. Backend adapters: bottom of the Store page.

  • Store, StoreCaps, LocalStore, matches_filter
  • Module: nlql.store

Registry#

Registry.

  • Registry, GLOBAL_REGISTRY, Capability, register_function, register_splitter
  • Module: nlql.registry

Ingestion#

IngestionPipeline.

  • IngestionPipeline, Normalizer, DefaultNormalizer, split_sentences, split_chunks, make_pysbd_splitter
  • Module: nlql.ingest

Planner / Executor / Loaders / Types / Errors#