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.5.tar.gz (45.7 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.5-py3-none-any.whl (60.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for verbatim_core-0.2.5.tar.gz
Algorithm Hash digest
SHA256 4c7d377e355b054955da354739945ecde69f240ce3671480a55180491f65e980
MD5 6bae33423d44305ff6ea9ad9018115de
BLAKE2b-256 79da2ca742e7bdbb5b200f9c0e4730ebac9e4700e6082214be7aa8ceb90cf88a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: verbatim_core-0.2.5-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.12.9

File hashes

Hashes for verbatim_core-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 32fb14c426687ea01c28b88cbac941ce8eefb061c4034be4e525a1a37a0aed36
MD5 0c9a35a141cfd76732f1e3d2b9c6bc9a
BLAKE2b-256 7752731c0b4c13eaa9d0ff4556392c0f430af791a35f887ecfba60f6e564196a

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