Skip to main content

Lightweight verbatim span extraction -- the RAG-agnostic core of verbatim-rag

Project description

verbatim-core

Lightweight verbatim span extraction -- the RAG-agnostic core of verbatim-rag.

Extract exact, verbatim text spans from documents that answer a question. No vector databases, no embeddings, no heavy ML dependencies -- just openai and pydantic.

Installation

pip install verbatim-core

Quick Start

from verbatim_core import VerbatimTransform

vt = VerbatimTransform()
response = vt.transform(
    question="What is the main finding?",
    context=[
        {"content": "The study found that X leads to Y.", "title": "Paper A"},
        {"content": "Results show Z is statistically significant.", "title": "Paper B"},
    ],
)

print(response.answer)

# Access individual highlights and citations
for doc in response.documents:
    for highlight in doc.highlights:
        print(f"  [{highlight.start}:{highlight.end}] {highlight.text}")

What This Package Includes

  • VerbatimTransform -- question + context -> cited, grounded answer
  • LLMSpanExtractor -- extract verbatim spans using an LLM
  • LLMClient -- unified OpenAI API wrapper (sync + async)
  • TemplateManager -- response formatting with multiple template strategies
  • @verbatim_enhance -- decorator to enhance existing RAG functions
  • CLI (verbatim-enhance) -- batch processing from the command line

Model-Based Extraction

For ModernBERT or Zilliz semantic highlight extractors (adds torch, transformers):

pip install verbatim-core[model]

Environment

export OPENAI_API_KEY=your_api_key_here

Full RAG System

For the complete RAG pipeline with vector indexing, embeddings, and document processing, install the full package:

pip install verbatim-rag

Project details


Download files

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

Source Distribution

verbatim_core-0.2.4.tar.gz (45.6 kB view details)

Uploaded Source

Built Distribution

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

verbatim_core-0.2.4-py3-none-any.whl (60.1 kB view details)

Uploaded Python 3

File details

Details for the file verbatim_core-0.2.4.tar.gz.

File metadata

  • Download URL: verbatim_core-0.2.4.tar.gz
  • Upload date:
  • Size: 45.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for verbatim_core-0.2.4.tar.gz
Algorithm Hash digest
SHA256 64f57b1de73cac374273a690c13abc599fa65b6710518cfd86d7172a2b4d600c
MD5 9bce577611be1f432068b975e4b3e2c6
BLAKE2b-256 7d67d9b8f92a3dc63bafd112d53a0f09da2a45c809bebd6c0b0cc2ae04b33a9a

See more details on using hashes here.

File details

Details for the file verbatim_core-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: verbatim_core-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 60.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for verbatim_core-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f2ea431be8da7d000126e99e2ff8808a30a5363c20645aec4731a54a3a016a58
MD5 d756528259f06fb9c09fd68b2226a7bc
BLAKE2b-256 60872a31d26de5bd9907f238571f034e5c1f2615d1fa4fb54ec03dfc1871daad

See more details on using hashes here.

Supported by

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