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

Uploaded Python 3

File details

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

File metadata

  • Download URL: verbatim_core-0.2.8.tar.gz
  • Upload date:
  • Size: 47.8 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.8.tar.gz
Algorithm Hash digest
SHA256 6030ffa14a6bd918db82ac317e1a4b6babd3566b2d2aaabcef6f25f6b91f133f
MD5 37b7e5e7f861f1d4869b01ad309e74d0
BLAKE2b-256 c507126ccb196962c9e08a096fe5dfae1791f2fdb09082747f5fa101140ce570

See more details on using hashes here.

File details

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

File metadata

  • Download URL: verbatim_core-0.2.8-py3-none-any.whl
  • Upload date:
  • Size: 62.4 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 16e79e02cc87b9733503b0a7dccb09cbd0c60d1ad84a5399fc787a1221fe2ba1
MD5 fc170e28271401a745c0009d95c8c56a
BLAKE2b-256 d5f623fe1a765607a2d735f94a67f2a4242f80bfddd5eecdc65792a48ae35754

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