Skip to main content

Tacit Context Gap Detection for Handover-oriented RAG

Project description

HandoverGap RAG

CI Python

日本語 | Repository version: README.ja.md

HandoverGap RAG detects tacit context that is missing from otherwise correct organizational memories.

Correct memories are not always transferable.

PyPI: https://pypi.org/project/handovergap/

A normal RAG system may retrieve:

For Company A, use CSV for this release. The API will come in the next phase.

The statement can be correct while still being unsafe for a customer-support successor. They may not know:

  • whether the customer was informed;
  • what “this release” covers;
  • what support is authorized to promise;
  • what fallback or escalation path to use.

HandoverGap performs role-conditioned slot checks, blocks unsafe transfer, and generates clarification questions.

Quickstart

pip install handovergap

handovergap demo
handovergap detect --scenario S001 --role CS
handovergap evaluate --compare

No TiDB account, OpenAI key, or external dataset is required.

Demo

Install the optional Streamlit UI:

pip install "handovergap[demo]"
handovergap serve

The demo defaults to Japanese and includes an English language switch. The default Local sample mode runs the real deterministic HandoverGap detector against bundled fictional handover cases. It compares:

  • naive_rag: answers directly;
  • hybrid_rag: adds related evidence;
  • handovergap: withholds unsafe answers and asks questions.

For a live semantic slot-filling demo with OpenAI and TiDB audit persistence:

pip install "handovergap[live]"
handovergap serve

Set OPENAI_API_KEY plus either HANDOVERGAP_TIDB_URL or the TIDB_HOST / TIDB_USER / TIDB_PASSWORD environment variables. In Live OpenAI + TiDB mode, the app asks the selected model to fill role-required slots, runs HandoverGap on those filled slots, and persists slot-fill attempts, context gaps, and transfer assessments to TiDB.

Evaluation

handovergap evaluate --compare runs the bundled synthetic HandoverGapBench mini dataset.

Method Tacit Gap Recall Unsafe Transfer Prevention Question Coverage Safe Transfer Allowance Blocked Precision
naive_rag 0.00 0.00 0.00 1.00 0.00
hybrid_rag 0.21 0.59 0.21 0.67 0.91
handovergap 1.00 0.65 1.00 1.00 1.00

These are deterministic results from the bundled 20-scenario dataset. The benchmark is synthetic and intentionally small; it demonstrates reproducible behavior rather than production accuracy.

For a small unknown holdout set with adjudicated synthetic reviewer labels and slot-filling stress profiles:

handovergap evaluate --dataset holdout --stress-filling
Method Tacit Gap Recall Unsafe Transfer Prevention Question Coverage Safe Transfer Allowance Blocked Precision
handovergap/provided 1.00 0.67 1.00 1.00 1.00
handovergap/conservative 1.00 0.67 1.00 0.67 0.67
handovergap/optimistic 0.64 0.67 0.64 1.00 1.00

The optimistic profile simulates an LLM over-filling ambiguous slots. It shows a real failure mode: recall drops, while unsafe-transfer prevention stays incomplete at 0.67.

With optional live OpenAI semantic slot filling:

python harness/validation/openai_slot_filling_check.py --dataset holdout --persist-tidb

Observed with gpt-4.1-mini: tacit gap recall 0.91, unsafe transfer prevention 0.33, safe transfer allowance 0.67, blocked precision 0.50. The detailed per-scenario output is saved to article/openai_slot_filling_results.json.

Observed with gpt-5-mini: tacit gap recall 0.45, unsafe transfer prevention 0.33, safe transfer allowance 0.67, blocked precision 0.50. The run used 1,901 input tokens and 8,136 output tokens, including 5,184 reasoning tokens, for an estimated cost of about $0.0167. This lower recall is intentional evidence in the repository: semantic slot filling is model- and prompt-sensitive, so HandoverGap should report the sensitivity instead of hiding it.

With the tuned gpt5_strict prompt profile for gpt-5-mini: tacit gap recall 1.00, unsafe transfer prevention 0.67, safe transfer allowance 1.00, blocked precision 1.00. This prompt is calibrated to the holdout evidence-summary protocol, so it is useful model-specific evidence rather than a production accuracy claim.

Japanese Streamlit demo

Optional TiDB Store

pip install "handovergap[tidb]"
handovergap schema --dialect tidb
from handovergap import TiDBStore

store = TiDBStore("mysql+pymysql://user:password@host:4000/handovergap")
store.create_schema()

The packaged schema models source evidence, memories, role requirements, slot-fill attempts, context gaps, clarification questions, transfer assessments, and evaluation runs. Live persistence methods are available for slot-fill attempts, context gaps, transfer assessments, and evaluation runs.

Live TiDB Validation

After creating a TiDB Cloud cluster, open Connect, choose a public Python/SQLAlchemy-compatible connection, generate or reset the password, and export the connection values locally:

export TIDB_HOST="..."
export TIDB_PORT="4000"
export TIDB_USER="..."
export TIDB_PASSWORD="..."
export TIDB_DB_NAME="test"
export TIDB_CA_PATH="/path/to/ca-certificates.crt"

Then run:

python harness/validation/tidb_live_check.py --create-schema

The check creates the packaged schema if needed, writes one synthetic memory, persists a slot-fill attempt, a context gap, a transfer assessment, and the holdout stress evaluation runs, then prints row counts as JSON. Do not commit .env files or TiDB credentials.

Python API

from handovergap import HandoverGapDetector, InMemoryStore

store = InMemoryStore.from_builtin_dataset()
detector = HandoverGapDetector(store)
result = detector.detect(scenario_id="S001", successor_role="CS")

print(result.transferability_status)
print(result.gaps)
print(result.questions)

Development

python3 -m venv .venv
.venv/bin/python -m pip install -e ".[dev,demo]"
.venv/bin/pytest

Limitations

  • The bundled detector and baselines are deterministic rules, not learned models.
  • HandoverGapBench mini and holdout contain synthetic scenarios.
  • Slot-filling stress profiles simulate LLM variance; they are not a replacement for a live LLM evaluation.
  • Live OpenAI slot filling is optional and not required for first-run usage.
  • Live OpenAI slot filling is model-sensitive; current holdout results differ materially between gpt-4.1-mini and gpt-5-mini.
  • The Streamlit demo uses fictional handover cases. Live mode exercises OpenAI slot filling and TiDB audit persistence, but it is still a local demo rather than a production retrieval service.
  • Semantic equivalence scoring for generated questions is not implemented in the MVP.
  • Live TiDB integration requires the optional tidb extra and a configured database.

License

MIT

日本語

HandoverGap RAGは、正しい業務記憶に不足している暗黙前提を、引き継ぎ先の役割ごとに検出します。

正しい記憶でも、引き継げるとは限らない。

pip install handovergap
handovergap demo
handovergap detect --scenario S001 --role CS
handovergap evaluate --compare

Streamlitデモは日本語がデフォルトで、英語へ切り替えられます。

pip install "handovergap[demo]"
handovergap serve

詳細な日本語ドキュメントはREADME.ja.mdを参照してください。

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

handovergap-0.1.3.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

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

handovergap-0.1.3-py3-none-any.whl (36.6 kB view details)

Uploaded Python 3

File details

Details for the file handovergap-0.1.3.tar.gz.

File metadata

  • Download URL: handovergap-0.1.3.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for handovergap-0.1.3.tar.gz
Algorithm Hash digest
SHA256 f7319ca8ac5d65e7142c4a1c5f8657eeb8c3f3367065c7c3f60bf93be3d8beb3
MD5 925e89792c56116c3b430d013ad9fe01
BLAKE2b-256 63404948365ce44cbe3a82353ce5ae851ae2a2a2e4dde532458123579330c39e

See more details on using hashes here.

File details

Details for the file handovergap-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: handovergap-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 36.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for handovergap-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bdaa7e21be42e375329614bbccbbac430a26e67e1f92b563859c61affd84c456
MD5 60141af2912904e03d740ecdad895f8f
BLAKE2b-256 c9f0f9e7fd503c189facab2720e249159c44c73b7fb05fe653484c9eca379fb8

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