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

Uploaded Python 3

File details

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

File metadata

  • Download URL: verbatim_core-0.2.7.tar.gz
  • Upload date:
  • Size: 46.5 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.7.tar.gz
Algorithm Hash digest
SHA256 d556c9ac7fe4ce8cb6afc856fc1570c9566c8fb07f82c5fadda263a570b0b99e
MD5 26d8d0e3fb1e6e7addc8f61853b88296
BLAKE2b-256 9b8b70b9434ae3d2bf61e4c658446d4c89c3900dad8a89642053562dcd6addab

See more details on using hashes here.

File details

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

File metadata

  • Download URL: verbatim_core-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 61.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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9af905de62d7a52dd47dee4f561247a525aa8828029c8f845400b093b904efb0
MD5 f7437427b65c5b57e76f7aeb3c1063d3
BLAKE2b-256 ba1544523465e9780418c9de94dec9062cf6c5ab9b4b98073789dd62518bc815

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