contexttrace 0.9.0__tar.gz → 1.0.0__tar.gz

{contexttrace-0.9.0 → contexttrace-1.0.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: contexttrace
-Version: 0.9.0
-Summary: Local-first SDK and CLI for RAG and agent reliability tracing, citation checks, and failure diagnosis.
+Version: 1.0.0
+Summary: Local-first evidence-chain debugger for RAG and AI agent claim grounding, citation checks, root-cause diagnosis, and regression tests.
 Author: ContextTrace contributors
 License: MIT
 Project-URL: Homepage, https://github.com/samarth1412/Context-Trace
@@ -10,7 +10,7 @@ Project-URL: Repository, https://github.com/samarth1412/Context-Trace
 Project-URL: Issues, https://github.com/samarth1412/Context-Trace/issues
 Project-URL: Changelog, https://github.com/samarth1412/Context-Trace/blob/main/CHANGELOG.md
 Keywords: rag,llm,retrieval-augmented-generation,citations,evaluation,observability,agents,cli,sqlite
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
@@ -69,15 +69,21 @@ Requires-Dist: pytest>=8.0; extra == "test"
 
 # ContextTrace
 
-**Local-first evidence-chain debugging for RAG and AI agents.**
+**Local-first evidence-chain forensics for RAG and AI agents.**
 
-ContextTrace shows where an answer stopped being grounded in the evidence you gave it:
+ContextTrace is a Python SDK and CLI for tracing a failed answer from the user
+query through retrieved context, answer claims, citations, verdicts, root cause,
+repair guidance, and CI regression tests.
 
 ```text
-query -> retrieved context -> answer claims -> citations -> verdicts -> root cause
+query -> retrieved context -> answer claims -> citations -> verdicts -> root cause -> regression test
 ```
 
-It is a Python SDK and CLI, not a hosted dashboard. Traces, reports, judge cache, and SQLite state stay local by default.
+Use it when a RAG or agent score is not enough: ContextTrace points at the
+unsupported or contradicted claim, the evidence span and citation involved, why
+the failure likely happened, and how to keep it from coming back. It is not a
+hosted dashboard. Traces, reports, judge cache, and SQLite state stay local by
+default.
 
 ## Install
 
@@ -122,6 +128,7 @@ Run local evidence checks:
 ```bash
 contexttrace inspect trace.json
 contexttrace verify trace.json --report
+contexttrace diagnose trace.json --report
 contexttrace qa trace.json --corpus docs/ --report
 ```
 
@@ -129,6 +136,46 @@ ContextTrace classifies each claim as `supported`, `partially_supported`, `unsup
 
 Important: `supported` means grounded by the selected evidence span. It does not mean independently true, current, or authoritative.
 
+## Diagnose An Agent Trace
+
+`diagnose` also accepts agent step traces and localizes tool/final-answer
+failures:
+
+```json
+{
+  "goal": "Book a meeting with Alex",
+  "steps": [
+    {
+      "type": "tool_call",
+      "tool": "calendar.search",
+      "args": {"date": "Friday"},
+      "result": "No availability"
+    },
+    {
+      "type": "final_answer",
+      "content": "I booked it for Friday."
+    }
+  ]
+}
+```
+
+```bash
+contexttrace diagnose examples/diagnose_agent_trace.json --report --fail-on high_risk
+```
+
+The diagnosis flags `tool_result_contradicted_by_final_answer` and suggests
+gating final-answer generation on tool-result status.
+
+Turn that diagnosis into a CI regression test:
+
+```bash
+contexttrace diagnose examples/diagnose_agent_trace.json \
+  --generate-test \
+  --test-out tests/contexttrace/test_calendar_agent_diagnosis.py
+
+pytest tests/contexttrace/test_calendar_agent_diagnosis.py
+```
+
 ## Local Verification Modes
 
 | Mode | Use When |

{contexttrace-0.9.0 → contexttrace-1.0.0}/README.md

@@ -1,213 +1,260 @@
-# ContextTrace
+# ContextTrace
+
+**Local-first evidence-chain forensics for RAG and AI agents.**
 
-**Local-first evidence-chain debugging for RAG and AI agents.**
-
-ContextTrace shows where an answer stopped being grounded in the evidence you gave it:
-
-```text
-query -> retrieved context -> answer claims -> citations -> verdicts -> root cause
-```
-
-It is a Python SDK and CLI, not a hosted dashboard. Traces, reports, judge cache, and SQLite state stay local by default.
-
-## Install
-
-```bash
-pip install contexttrace
-contexttrace init
-```
-
-## Quickstart
-
-```bash
-contexttrace verify-demo unsupported_claim --report
-contexttrace demo --dataset refund_policy
-contexttrace report --last --open
-```
-
-Default local storage:
+ContextTrace is a Python SDK and CLI for tracing a failed answer from the user
+query through retrieved context, answer claims, citations, verdicts, root cause,
+repair guidance, and CI regression tests.
 
 ```text
-.contexttrace/contexttrace.db
-```
-
-## Verify A RAG Trace
-
-Create a portable trace with a query, answer, retrieved contexts, and optional citations:
-
-```json
-{
-  "query": "How long does refund processing take?",
-  "answer": "Refunds are processed within 5 business days.",
-  "contexts": [
-    {
-      "id": "policy",
-      "text": "Customers may request refunds within 30 days of purchase."
-    }
-  ]
-}
-```
-
-Run local evidence checks:
-
-```bash
-contexttrace inspect trace.json
-contexttrace verify trace.json --report
-contexttrace qa trace.json --corpus docs/ --report
-```
-
-ContextTrace classifies each claim as `supported`, `partially_supported`, `unsupported`, `unverifiable`, or `contradicted`, then exposes separate statuses for support, truth, source freshness, citation quality, and likely fix.
-
-Important: `supported` means grounded by the selected evidence span. It does not mean independently true, current, or authoritative.
-
-## Local Verification Modes
-
-| Mode | Use When |
-| --- | --- |
-| `lexical` | Fast default checks with no optional dependencies. |
-| `semantic` | Local paraphrase and role-aware contradiction checks. |
-| `local_ml` | Offline hash-embedding similarity, optionally backed by a local SentenceTransformers model. |
-| `nli` | Local claim+span entailment or contradiction with a local Transformers or ONNX NLI model. |
-| `judge` | Higher-accuracy local LLM judging through Ollama, LM Studio, vLLM, or a local OpenAI-compatible server. The judge sees selected evidence spans, not the full answer prose. |
-
-Run the stronger local non-LLM verifier:
-
-```bash
-contexttrace verify trace.json --mode local_ml --report
-contexttrace verify-benchmark --mode local_ml --case-set all
-```
-
-Optional neural local-ML support never downloads models automatically:
-
-```bash
-pip install "contexttrace[local-ml]"
-set CONTEXTTRACE_LOCAL_ML_MODEL_PATH=C:/models/bge-small-en-v1.5
-```
-
-Run local NLI when you want mechanical claim-versus-span entailment:
-
-```bash
-pip install "contexttrace[nli]"
-set CONTEXTTRACE_NLI_MODEL_PATH=C:/models/deberta-v3-nli
-contexttrace verify trace.json --mode nli --report
-contexttrace nli-calibrate --case-set all --report
-```
-
-Run a local judge with Ollama:
-
-```bash
-set CONTEXTTRACE_JUDGE_PROVIDER=ollama
-set CONTEXTTRACE_JUDGE_MODEL=llama3.1
-
-contexttrace verify trace.json --mode judge --report
-contexttrace judge-calibrate --case-set all --report
-```
-
-Remote judges are blocked while `local_only: true` is active. To use a remote judge, explicitly disable local-only mode and configure the provider/API key.
-
-## Diagnose And Regression-Test
-
-```bash
-# Find whether support existed elsewhere in the corpus.
-contexttrace audit trace.json --corpus docs/ --report
-
-# Compare a baseline and current answer after a prompt, model, or retriever change.
-contexttrace compare baseline.json current.json --report
-
-# Turn saved failures into replayable endpoint tests.
-contexttrace suite create traces/failure.json --out contexttrace-suite.json
-contexttrace suite run contexttrace-suite.json --endpoint http://localhost:8000/query --report
-```
-
-Common root causes include `retrieval_miss`, `reranking_failure`, `chunking_issue`, `corpus_gap`, `answer_overreach`, `stale_source`, `citation_mismatch`, and `should_have_abstained`.
-
-`support_status`, `truth_status`, and `source_status` stay separate so a claim can be grounded by a source while the source itself remains stale, wrong, or unassessed.
-
-Source metadata can include `source_authority`, `source_timestamp`, `source_version`, `canonical`, or `canonical_source`. ContextTrace uses those local fields to flag `grounded_but_stale`, `grounded_but_conflicted`, `grounded_by_low_authority_source`, or `supported_by_canonical_source`.
-
-## Capture Existing Systems
-
-Capture one live endpoint response:
-
-```bash
-contexttrace capture endpoint \
-  --endpoint http://localhost:8000/query \
-  --query "What is the refund policy?" \
-  --answer-path $.answer \
-  --contexts-path $.contexts \
-  --citations-path $.citations \
-  --out traces/refund_trace.json \
-  --verify \
-  --report
-```
-
-Or capture artifacts from Python:
-
-```python
-from contexttrace import capture_rag_trace, write_rag_trace
-
-trace = capture_rag_trace(
-    query=question,
-    answer=answer,
-    contexts=retrieved_docs,
-    metadata={"system": "support-rag"},
-)
-write_rag_trace(trace, "trace.json")
+query -> retrieved context -> answer claims -> citations -> verdicts -> root cause -> regression test
 ```
 
-## SDK Example
-
-```python
-from contexttrace import ContextTrace
-
-ct = ContextTrace(project="support-rag")
-
-with ct.trace(query="What is the refund policy?") as trace:
-    chunks = retriever.search("What is the refund policy?")
-    trace.log_retrieval(chunks)
-    trace.log_context(chunks[:5])
-
-    answer = llm.generate("What is the refund policy?", chunks[:5])
-    trace.log_answer(answer, usage={"total_tokens": 1200})
-    trace.log_citations([
-        {"claim": "Refunds are available within 30 days.", "source_chunk_id": "chunk_12"}
-    ])
-
-    result = trace.evaluate()
-    print(result["failure"]["failure_type"])
-```
-
-## Integrations
-
-```bash
-pip install "contexttrace[langchain]"
-pip install "contexttrace[llamaindex]"
-pip install "contexttrace[fastapi]"
-pip install "contexttrace[langgraph]"
-pip install "contexttrace[otel]"
-pip install "contexttrace[all]"
-```
-
-Includes LangChain, LlamaIndex, FastAPI, LangGraph, and OpenTelemetry hooks.
-
-## Privacy
-
-ContextTrace makes no network calls unless you point it at an endpoint or configure a judge provider. Local controls include:
-
-- `local_only: true`
-- `log_chunk_text: false`
-- `log_answer_text: false`
-- `storage_path`
-- `judge_cache_enabled: true`
-- `judge_cache_path: .contexttrace/judge_cache.json`
-
-## Limits
-
-ContextTrace is a diagnostic tool, not a correctness proof. It verifies grounding against provided evidence; it does not certify real-world truth. Claim extraction is rule-based, contradiction detection is conservative, and high-stakes outputs still need human review.
-
-## Links
-
-- Repository: https://github.com/samarth1412/Context-Trace
-- Documentation: https://github.com/samarth1412/Context-Trace/tree/main/docs
-- Issues: https://github.com/samarth1412/Context-Trace/issues
-- Changelog: https://github.com/samarth1412/Context-Trace/blob/main/CHANGELOG.md
+Use it when a RAG or agent score is not enough: ContextTrace points at the
+unsupported or contradicted claim, the evidence span and citation involved, why
+the failure likely happened, and how to keep it from coming back. It is not a
+hosted dashboard. Traces, reports, judge cache, and SQLite state stay local by
+default.
+
+## Install
+
+```bash
+pip install contexttrace
+contexttrace init
+```
+
+## Quickstart
+
+```bash
+contexttrace verify-demo unsupported_claim --report
+contexttrace demo --dataset refund_policy
+contexttrace report --last --open
+```
+
+Default local storage:
+
+```text
+.contexttrace/contexttrace.db
+```
+
+## Verify A RAG Trace
+
+Create a portable trace with a query, answer, retrieved contexts, and optional citations:
+
+```json
+{
+  "query": "How long does refund processing take?",
+  "answer": "Refunds are processed within 5 business days.",
+  "contexts": [
+    {
+      "id": "policy",
+      "text": "Customers may request refunds within 30 days of purchase."
+    }
+  ]
+}
+```
+
+Run local evidence checks:
+
+```bash
+contexttrace inspect trace.json
+contexttrace verify trace.json --report
+contexttrace diagnose trace.json --report
+contexttrace qa trace.json --corpus docs/ --report
+```
+
+ContextTrace classifies each claim as `supported`, `partially_supported`, `unsupported`, `unverifiable`, or `contradicted`, then exposes separate statuses for support, truth, source freshness, citation quality, and likely fix.
+
+Important: `supported` means grounded by the selected evidence span. It does not mean independently true, current, or authoritative.
+
+## Diagnose An Agent Trace
+
+`diagnose` also accepts agent step traces and localizes tool/final-answer
+failures:
+
+```json
+{
+  "goal": "Book a meeting with Alex",
+  "steps": [
+    {
+      "type": "tool_call",
+      "tool": "calendar.search",
+      "args": {"date": "Friday"},
+      "result": "No availability"
+    },
+    {
+      "type": "final_answer",
+      "content": "I booked it for Friday."
+    }
+  ]
+}
+```
+
+```bash
+contexttrace diagnose examples/diagnose_agent_trace.json --report --fail-on high_risk
+```
+
+The diagnosis flags `tool_result_contradicted_by_final_answer` and suggests
+gating final-answer generation on tool-result status.
+
+Turn that diagnosis into a CI regression test:
+
+```bash
+contexttrace diagnose examples/diagnose_agent_trace.json \
+  --generate-test \
+  --test-out tests/contexttrace/test_calendar_agent_diagnosis.py
+
+pytest tests/contexttrace/test_calendar_agent_diagnosis.py
+```
+
+## Local Verification Modes
+
+| Mode | Use When |
+| --- | --- |
+| `lexical` | Fast default checks with no optional dependencies. |
+| `semantic` | Local paraphrase and role-aware contradiction checks. |
+| `local_ml` | Offline hash-embedding similarity, optionally backed by a local SentenceTransformers model. |
+| `nli` | Local claim+span entailment or contradiction with a local Transformers or ONNX NLI model. |
+| `judge` | Higher-accuracy local LLM judging through Ollama, LM Studio, vLLM, or a local OpenAI-compatible server. The judge sees selected evidence spans, not the full answer prose. |
+
+Run the stronger local non-LLM verifier:
+
+```bash
+contexttrace verify trace.json --mode local_ml --report
+contexttrace verify-benchmark --mode local_ml --case-set all
+```
+
+Optional neural local-ML support never downloads models automatically:
+
+```bash
+pip install "contexttrace[local-ml]"
+set CONTEXTTRACE_LOCAL_ML_MODEL_PATH=C:/models/bge-small-en-v1.5
+```
+
+Run local NLI when you want mechanical claim-versus-span entailment:
+
+```bash
+pip install "contexttrace[nli]"
+set CONTEXTTRACE_NLI_MODEL_PATH=C:/models/deberta-v3-nli
+contexttrace verify trace.json --mode nli --report
+contexttrace nli-calibrate --case-set all --report
+```
+
+Run a local judge with Ollama:
+
+```bash
+set CONTEXTTRACE_JUDGE_PROVIDER=ollama
+set CONTEXTTRACE_JUDGE_MODEL=llama3.1
+
+contexttrace verify trace.json --mode judge --report
+contexttrace judge-calibrate --case-set all --report
+```
+
+Remote judges are blocked while `local_only: true` is active. To use a remote judge, explicitly disable local-only mode and configure the provider/API key.
+
+## Diagnose And Regression-Test
+
+```bash
+# Find whether support existed elsewhere in the corpus.
+contexttrace audit trace.json --corpus docs/ --report
+
+# Compare a baseline and current answer after a prompt, model, or retriever change.
+contexttrace compare baseline.json current.json --report
+
+# Turn saved failures into replayable endpoint tests.
+contexttrace suite create traces/failure.json --out contexttrace-suite.json
+contexttrace suite run contexttrace-suite.json --endpoint http://localhost:8000/query --report
+```
+
+Common root causes include `retrieval_miss`, `reranking_failure`, `chunking_issue`, `corpus_gap`, `answer_overreach`, `stale_source`, `citation_mismatch`, and `should_have_abstained`.
+
+`support_status`, `truth_status`, and `source_status` stay separate so a claim can be grounded by a source while the source itself remains stale, wrong, or unassessed.
+
+Source metadata can include `source_authority`, `source_timestamp`, `source_version`, `canonical`, or `canonical_source`. ContextTrace uses those local fields to flag `grounded_but_stale`, `grounded_but_conflicted`, `grounded_by_low_authority_source`, or `supported_by_canonical_source`.
+
+## Capture Existing Systems
+
+Capture one live endpoint response:
+
+```bash
+contexttrace capture endpoint \
+  --endpoint http://localhost:8000/query \
+  --query "What is the refund policy?" \
+  --answer-path $.answer \
+  --contexts-path $.contexts \
+  --citations-path $.citations \
+  --out traces/refund_trace.json \
+  --verify \
+  --report
+```
+
+Or capture artifacts from Python:
+
+```python
+from contexttrace import capture_rag_trace, write_rag_trace
+
+trace = capture_rag_trace(
+    query=question,
+    answer=answer,
+    contexts=retrieved_docs,
+    metadata={"system": "support-rag"},
+)
+write_rag_trace(trace, "trace.json")
+```
+
+## SDK Example
+
+```python
+from contexttrace import ContextTrace
+
+ct = ContextTrace(project="support-rag")
+
+with ct.trace(query="What is the refund policy?") as trace:
+    chunks = retriever.search("What is the refund policy?")
+    trace.log_retrieval(chunks)
+    trace.log_context(chunks[:5])
+
+    answer = llm.generate("What is the refund policy?", chunks[:5])
+    trace.log_answer(answer, usage={"total_tokens": 1200})
+    trace.log_citations([
+        {"claim": "Refunds are available within 30 days.", "source_chunk_id": "chunk_12"}
+    ])
+
+    result = trace.evaluate()
+    print(result["failure"]["failure_type"])
+```
+
+## Integrations
+
+```bash
+pip install "contexttrace[langchain]"
+pip install "contexttrace[llamaindex]"
+pip install "contexttrace[fastapi]"
+pip install "contexttrace[langgraph]"
+pip install "contexttrace[otel]"
+pip install "contexttrace[all]"
+```
+
+Includes LangChain, LlamaIndex, FastAPI, LangGraph, and OpenTelemetry hooks.
+
+## Privacy
+
+ContextTrace makes no network calls unless you point it at an endpoint or configure a judge provider. Local controls include:
+
+- `local_only: true`
+- `log_chunk_text: false`
+- `log_answer_text: false`
+- `storage_path`
+- `judge_cache_enabled: true`
+- `judge_cache_path: .contexttrace/judge_cache.json`
+
+## Limits
+
+ContextTrace is a diagnostic tool, not a correctness proof. It verifies grounding against provided evidence; it does not certify real-world truth. Claim extraction is rule-based, contradiction detection is conservative, and high-stakes outputs still need human review.
+
+## Links
+
+- Repository: https://github.com/samarth1412/Context-Trace
+- Documentation: https://github.com/samarth1412/Context-Trace/tree/main/docs
+- Issues: https://github.com/samarth1412/Context-Trace/issues
+- Changelog: https://github.com/samarth1412/Context-Trace/blob/main/CHANGELOG.md

{contexttrace-0.9.0 → contexttrace-1.0.0}/contexttrace/__init__.py

@@ -3,6 +3,8 @@ from contexttrace.capture import capture_rag_trace, langchain_documents_to_conte
 from contexttrace.capture_endpoint import EndpointCapture, capture_endpoint_trace, capture_response_trace
 from contexttrace.client import AsyncContextTrace, ContextTrace
 from contexttrace.config import ContextTraceConfig
+from contexttrace.diagnose import diagnose_payload, diagnose_trace_file, write_diagnosis_regression_test
+from contexttrace.diagnose_report import DiagnoseReportGenerator
 from contexttrace.errors import (
     ContextTraceConfigError,
     ContextTraceError,
@@ -29,6 +31,7 @@ __all__ = [
     "ContextTraceLocalError",
     "ContextTraceLangGraphTracer",
     "ContextTraceLlamaIndexCallbackHandler",
+    "DiagnoseReportGenerator",
     "EndpointCapture",
     "OpenTelemetryExporter",
     "ReliabilityScore",
@@ -37,6 +40,9 @@ __all__ = [
     "capture_rag_trace",
     "capture_endpoint_trace",
     "capture_response_trace",
+    "diagnose_payload",
+    "diagnose_trace_file",
+    "write_diagnosis_regression_test",
     "export_contexttrace_trace",
     "langchain_documents_to_contexts",
     "write_rag_trace",

contexttrace-1.0.0/contexttrace/_version.py

@@ -0,0 +1 @@
+__version__ = "1.0.0"