Skip to main content

Vigyan — SDK for agentic search on scientific documents with citations

Overview

Vigyan provides a small, clean Python SDK to parse scientific PDFs, embed the content, index it in a vector database, and answer research questions with citation-aware metadata (paper, page range, paragraph ids, etc.).

Design Principles

  • Clear interfaces: VectorStore and DocumentParser decouple concerns.
  • Storage-agnostic domain models from vigyan.models: Document, Chunk, and QueryHit.
  • Adapter implementations: LanceDB vector store with built-in embedding, GROBID parser.
  • Domain-named Corpus modules: CorpusIngestor, CorpusRetriever, and run_research_query orchestrate ingestion, retrieval, and cited answers.

Install

Requires Python 3.12+.

Dependencies include lancedb, httpx, lxml, and pydantic (declared in pyproject.toml).

Quick Start

from vigyan.corpus import CorpusIngestor, CorpusRetriever
from vigyan.parsers import GrobidParser
from vigyan.vectordb import LanceDBVectorStore
from vigyan.agent import run_research_query

# Configure adapters
store = LanceDBVectorStore(embedding_model="text-embedding-3-small")
parser = GrobidParser(server_url="http://localhost:8070")  # GROBID must be running

# Ingest a PDF with automatic metadata via GROBID
pdf_bytes = open("paper.pdf", "rb").read()
ingestor = CorpusIngestor(parser=parser, store=store)
ingestor.ingest_pdf(pdf_bytes, meta=None)

# Retrieve relevant passages directly
retriever = CorpusRetriever(store=store)
hits = retriever.retrieve("protein folding with attention", top_k=5)
for h in hits:
    print(h.citation, "-", h.title)
    print(h.text)

# Or run the research agent for a cited answer
answer = run_research_query(
    "What does this corpus say about protein folding with attention?",
    db_uri="./vigyan_db",
    embed_model="text-embedding-3-small",
)
print(answer.answer)
for citation in answer.citations:
    print(f"[{citation.index}] {citation.citation}")

CLai Web Agent

clai web cannot pass Pydantic AI deps directly, so Vigyan's importable agent resolves vector-store deps from environment variables when explicit SDK deps are not provided:

export VIGYAN_DB_URI=./vigyan_db
export VIGYAN_EMBED_MODEL=text-embedding-3-small
# Optional:
# export VIGYAN_TOP_K=8
# export VIGYAN_FILTERS="year >= 2020"

uv run clai web --agent src.vigyan.agent.research_agent:agent

The normal SDK path still uses explicit deps via run_research_query(...).

Notes

  • OpenAI-compatible key must be available in the environment for embedding.
  • GROBID must be running for parsing and metadata extraction. You can swap in a different DocumentParser implementation if preferred.
  • The LanceDB store uses auto-embedding via the LanceDB registry, supporting OpenAI and other providers.

Metadata

Release files for vigyan 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vigyan 0.1.0
File Size Uploaded Provenance
vigyan-0.1.0.tar.gz 13.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for vigyan 0.1.0
File Interpreter ABI Platform
vigyan-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 32.5 kB

Release files / vigyan-0.1.0.tar.gz

Download URL vigyan-0.1.0.tar.gz
Size 13.9 kB
Tags Source
SHA-256 checksum
How to use checksums
b3f9746c8d9d95e16374c0146e6899629e5a22c1119c4141eed2628879382ad3
BLAKE2b-256 checksum
How to use checksums
e8ddfc1d9b5d0b3227cc48570ad0a91dfac6846ed71969c0da5f4175fc9b20f6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / vigyan-0.1.0-py3-none-any.whl

Download URL vigyan-0.1.0-py3-none-any.whl
Size 18.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
46088b85f2a6122131df0f36d56dc437273a482557294c193127d9568ce5f606
BLAKE2b-256 checksum
How to use checksums
89bbafc4b3b281956420db21c461bb908b504a9696715e6e1ea85ff8e408874e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for vigyan 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page