Skip to main content

andnp-searchkernel

andnp-searchkernel is a source-agnostic Python library for building hybrid keyword, vector, and graph search systems. Applications map their native data to canonical Record values, choose the storage and provider adapters they need, and keep source-specific lifecycle logic outside the kernel.

It supports canonical record search, checkpointed record ingestion, optional local/Postgres/FAISS/provider integrations, and bounded federation across compatible search sources. The API is still evolving before the first stable major release.

Install

The core package supports Python 3.13 and newer:

pip install andnp-searchkernel

Install optional integrations only when you need them:

pip install "andnp-searchkernel[faiss]"
pip install "andnp-searchkernel[pgvector]"
pip install "andnp-searchkernel[pgvector-psycopg3]"
pip install "andnp-searchkernel[huggingface]"
pip install "andnp-searchkernel[ollama]"
pip install "andnp-searchkernel[markdown]"

First local search

The local composition helper creates durable SQLite-backed stores. This small example uses a deterministic provider so it can run without downloading a model; replace it with a real provider for semantic retrieval.

import asyncio
from datetime import UTC, datetime
from pathlib import Path

from searchkernel import Record, build_local_record_kernel


class DemoEmbeddingProvider:
    model_name = "demo"
    dim = 2

    def embed(self, texts: list[str]) -> list[list[float]]:
        return [[1.0, 0.0] for _ in texts]


async def main() -> None:
    timestamp = datetime.now(UTC)
    composition = build_local_record_kernel(
        Path("records.db"),
        embedding_provider=DemoEmbeddingProvider(),
    )
    record = Record(
        workspace_id="demo",
        source_kind="notes",
        source_id="welcome",
        title="Welcome",
        body="Canonical records can be searched locally.",
        created_at=timestamp,
        updated_at=timestamp,
    )
    composition.keyword_store.index([record])

    outcome = await composition.kernel.search("canonical records", limit=5)
    for result in outcome.results:
        print(result.record.title, result.score)


asyncio.run(main())

The result is a RecordSearchOutcome. Each result retains the complete workspace/source identity and search provenance; degraded execution is reported through outcome.failures and outcome.diagnostics.

Documentation

Start with the documentation map to choose the right guide:

  • Getting started — install the package and build a first local index.
  • Core concepts — records, identity, ingestion, querying, stores, providers, and readiness.
  • Federated search — combine local or HTTP search sources with bounded concurrency and explicit partial-result diagnostics.
  • Performance and retrieval roadmap — developer-facing validation evidence, constraints, and future work.

Optional integrations

The core import surface does not require optional providers or backends. The available extras are faiss, pgvector, pgvector-psycopg3, huggingface, ollama, and markdown. See the getting-started guide for the selection rule and the federation guide for the HTTP source adapter.

Validation and releases

CI runs Ruff, Pyrefly, import-linter, the safe test suite, supported Python versions, and selected optional-import checks. Pgvector integration tests need Docker or SEARCHKERNEL_PG_DSN; real-embedding tests are outside the default offline gate. The performance roadmap records what those checks do and do not prove.

Merges to main with release-worthy Conventional Commits are released by the repository workflows. The package and runtime __version__ are checked against each other in CI and before semantic release.

License

MIT. See LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

andnp_searchkernel-0.25.0.tar.gz (542.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

andnp_searchkernel-0.25.0-py3-none-any.whl (251.5 kB view details)

Uploaded Python 3

File details

Details for the file andnp_searchkernel-0.25.0.tar.gz.

File metadata

  • Download URL: andnp_searchkernel-0.25.0.tar.gz
  • Upload date:
  • Size: 542.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for andnp_searchkernel-0.25.0.tar.gz
Algorithm Hash digest
SHA256 b22cf3eaca5c5570710acf6fd781be3d5ac8236f75b64c1b9d5cf4f565f588e9
MD5 247b36c126d570535e544a4c29171bc2
BLAKE2b-256 9caa0af07ea0eb7968eac9709898765359615a87e05753d7cc8b8e763f456886

See more details on using hashes here.

Provenance

The following attestation bundles were made for andnp_searchkernel-0.25.0.tar.gz:

Publisher: publish.yml on andnp/andnp-searchkernel

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file andnp_searchkernel-0.25.0-py3-none-any.whl.

File metadata

File hashes

Hashes for andnp_searchkernel-0.25.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3b1012cf86806b0f578f9814098f0d19a9687d025a8af468c768d7a8b020b85f
MD5 2152c62f29e052a413a3b756624460f8
BLAKE2b-256 80606930c3a8a243990f6ef008c4998b190f276db28d8e701398c9443f48935c

See more details on using hashes here.

Provenance

The following attestation bundles were made for andnp_searchkernel-0.25.0-py3-none-any.whl:

Publisher: publish.yml on andnp/andnp-searchkernel

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page