Skip to main content

SFS SDK — Spatial Faithfulness Score

A lightweight Python SDK for measuring numerical faithfulness in Retrieval-Augmented Generation (RAG) systems. SFS extracts numerical claims from LLM-generated text and verifies them against ground-truth evidence.

SFS = verified_claims / total_claims

Installation

pip install sfs-sdk

Quick Start

from sfs_sdk import SFSClient

client = SFSClient(preset="property_valuation")

report = client.compute(
    text="The median price is $850,000 located 12.5 km from CBD.",
    evidence=[
        {"key": "median_price", "value": 842000, "unit": "AUD"},
        {"key": "cbd_distance", "value": 12.3, "unit": "km"},
    ],
)

print(f"SFS Score: {report.sfs_score}")        # 1.0
print(f"Verified: {report.verified_claims}/{report.total_claims}")

Features

  • Zero LLM dependency — deterministic regex-based claim extraction
  • Domain presets — property valuation, medical, legal, financial
  • Custom domains — define your own extraction patterns and tolerances
  • Pydantic models — fully typed, serializable data structures
  • Lightweight — only depends on pydantic

Usage

Extract Claims

from sfs_sdk import SFSClient

client = SFSClient(preset="medical")
claims = client.extract("Patient received 500 mg of amoxicillin for 7 days.")

for claim in claims:
    print(f"  {claim.claim_type}: {claim.extracted_value} {claim.unit}")

Verify Claims

report = client.verify(
    claims=claims,
    evidence=[
        {"key": "dosage", "value": 500, "unit": "dosage"},
        {"key": "duration", "value": 7, "unit": "duration"},
    ],
)
print(f"SFS: {report.sfs_score}")

Verify a Single Claim

result = client.verify_single(
    claim_text="The property is 12.5 km from CBD.",
    claim_type="distance",
    extracted_value=12.5,
    unit="km",
    evidence=[{"key": "cbd_distance", "value": 12.3, "unit": "km"}],
)
print(f"Verified: {result.verified}, Error: {result.error:.2%}")

Custom Domain Configuration

from sfs_sdk import SFSClient, DomainConfig, ExtractionPattern

config = DomainConfig(
    name="My Domain",
    tolerance=0.10,
    extraction_patterns=[
        ExtractionPattern(
            claim_type="temperature",
            pattern=r'([\d.]+)\s*°[CF]',
            unit="degrees",
            min_value=-50,
            max_value=200,
        ),
    ],
)

client = SFSClient(config=config)

Low-Level API

For direct access without the client wrapper:

from sfs_sdk import extract_claims, compute_sfs, EvidencePool, EvidenceItem

claims = extract_claims("The price is $500,000.")
evidence = EvidencePool(items=[
    EvidenceItem(key="price", value=495000, unit="USD"),
])
report = compute_sfs(claims, evidence)

Domain Presets

Preset Tolerance Claim Types
property_valuation 15% currency, percentage, distance, count
medical 10% dosage (5%), lab_value, percentage, count, duration
legal 10% currency (5%), percentage, duration, count
financial 10% currency, percentage, ratio (5%)
from sfs_sdk import SFSClient
presets = SFSClient.available_presets()

How It Works

  1. Extract — Regex patterns scan the LLM output for numerical claims (prices, distances, percentages, etc.)
  2. Match — Each claim is matched to the closest evidence item by unit
  3. Verify — Relative error is computed: |claimed - actual| / actual
  4. Score — A claim passes if its error is within the domain tolerance

Companion: SFS MCP Toolkit

For LLM-native integration via the Model Context Protocol, see sfs-mcp-toolkit — same engine, exposed as MCP tools for Claude Desktop, Claude Code, and other MCP clients.

Citation

If you use SFS in your research, please cite:

@software{rathnasinghe2025sfs,
  author  = {Rathnasinghe, Ganusha},
  title   = {SFS SDK: Spatial Faithfulness Score for RAG Verification},
  year    = {2025},
  url     = {https://github.com/rganushachadika/sfs-sdk},
}

License

MIT License. See LICENSE for details.

Metadata

Release files for sfs-sdk 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 sfs-sdk 0.1.0
File Size Uploaded Provenance Actions
sfs_sdk-0.1.0.tar.gz 11.0 kB Without provenance Details for sfs_sdk-0.1.0.tar.gz

Built distribution (wheel)

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

Total release size: 24.2 kB

Release files / sfs_sdk-0.1.0.tar.gz

Download URL sfs_sdk-0.1.0.tar.gz
Size 11.0 kB
Tags Source
SHA-256 checksum
How to use checksums
46ac964d7d6b63cb260849b388455add1dc459f5284c343cbbd044e6909f44e2
BLAKE2b-256 checksum
How to use checksums
e4f89d4af5457efeebe03f34591bcbf1cf6b73a30dd08f6f597e2631a97cd4a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.5

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

Download URL sfs_sdk-0.1.0-py3-none-any.whl
Size 13.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e66f1470097dfddfde1eac0b63cbc1f5cb47ee0d17f61b4a1a6960f155e5e463
BLAKE2b-256 checksum
How to use checksums
898af1a8410beef7fc8203d5ca9a52722d5e52f150f4b1c1a6135ce6c2167a5f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.5

Security for sfs-sdk 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.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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