stutiagrawal commited on
Commit
16f7cf4
Β·
1 Parent(s): ca4ed58

update README

Browse files
Files changed (1) hide show
  1. README.md +16 -13
README.md CHANGED
@@ -1,7 +1,7 @@
1
- # ClaimCheck.AI β€” Agentic Fact Verification for Calls (IBM watsonx)
2
 
3
  **ClaimCheck.AI** is an agentic AI pipeline that turns meeting audio (Zoom/phone) into an evidence-backed report:
4
- 1) **ASR Agent (IBM STT)** β†’ transcript + timestamps
5
  2) **Claim Extraction (watsonx.ai LLM)** β†’ JSON claims
6
  3) **Evidence Retrieval (watsonx.ai Embeddings + FAISS + optional Rerank)** β†’ KB hits
7
  4) **Verification (watsonx.ai LLM)** β†’ supported/refuted/insufficient + citations
@@ -9,7 +9,7 @@
9
 
10
  ## ✨ Why it matters
11
  High-stakes calls contain promises and metrics (SLA, compliance, finance). ClaimCheck.AI verifies statements against your **trusted KB** so decisions are grounded in factsβ€”not memory.
12
-
13
  ---
14
 
15
  ## πŸ”§ Project structure
@@ -27,7 +27,7 @@ claim-check/
27
  β”‚ β”‚ └─ json_utils.py # robust JSON extraction from LLM outputs
28
  β”‚ β”œβ”€ schemas/ # pydantic models (Claim, Evidence, Verdict, CallReport)
29
  β”‚ β”œβ”€ services/
30
- β”‚ β”‚ └─ asr.py # IBM Speech to Text or Whisper (fallback)
31
  β”‚ └─ main.py # FastAPI: /health, /process-audio, /process-transcript
32
  β”œβ”€ kb/
33
  β”‚ β”œβ”€ snippets.jsonl # your knowledge base (facts; one JSON per line)
@@ -117,12 +117,18 @@ curl http://127.0.0.1:8000/health/ibm
117
 
118
  ## 🧠 How it works (agentic)
119
 
120
- - **ASR Agent (IBM STT):** audio β†’ timestamped segments (+ diarization)
121
- - **Claim Extractor (watsonx.ai):** segments β†’ `{id, text, speaker, start, end}`
122
- - **Retriever (Embeddings + FAISS + Rerank):** claim β†’ top KB snippets
123
- - **Verifier (watsonx.ai):** claim + evidence β†’ verdict + rationale + citation_ids
124
- - **Summarizer (watsonx.ai):** executive summary + action items
125
- - **Output:** `CallReport` JSON; easy to render as PDF/HTML
 
 
 
 
 
 
126
 
127
  ---
128
 
@@ -139,7 +145,4 @@ curl http://127.0.0.1:8000/health/ibm
139
  - **OpenMP error (macOS)** β†’ set `KMP_DUPLICATE_LIB_OK=TRUE` and `OMP_NUM_THREADS=1`.
140
  - **JSON parse errors** β†’ we use a robust extractor; check server logs `[RAW OUTPUT]`.
141
 
142
- ---
143
 
144
- ## πŸ“„ License
145
- MIT (or your choice). See `LICENSE`.
 
1
+ # ClaimCheck.AI β€” Agentic Fact Verification for Calls
2
 
3
  **ClaimCheck.AI** is an agentic AI pipeline that turns meeting audio (Zoom/phone) into an evidence-backed report:
4
+ 1) **ASR Agent** β†’ transcript + timestamps
5
  2) **Claim Extraction (watsonx.ai LLM)** β†’ JSON claims
6
  3) **Evidence Retrieval (watsonx.ai Embeddings + FAISS + optional Rerank)** β†’ KB hits
7
  4) **Verification (watsonx.ai LLM)** β†’ supported/refuted/insufficient + citations
 
9
 
10
  ## ✨ Why it matters
11
  High-stakes calls contain promises and metrics (SLA, compliance, finance). ClaimCheck.AI verifies statements against your **trusted KB** so decisions are grounded in factsβ€”not memory.
12
+ git branch -M main
13
  ---
14
 
15
  ## πŸ”§ Project structure
 
27
  β”‚ β”‚ └─ json_utils.py # robust JSON extraction from LLM outputs
28
  β”‚ β”œβ”€ schemas/ # pydantic models (Claim, Evidence, Verdict, CallReport)
29
  β”‚ β”œβ”€ services/
30
+ β”‚ β”‚ └─ asr.py # Speech to Text model
31
  β”‚ └─ main.py # FastAPI: /health, /process-audio, /process-transcript
32
  β”œβ”€ kb/
33
  β”‚ β”œβ”€ snippets.jsonl # your knowledge base (facts; one JSON per line)
 
117
 
118
  ## 🧠 How it works (agentic)
119
 
120
+ ## 🧠 Core Concepts and Models
121
+
122
+ ClaimCheck.AI combines modern **agentic AI** orchestration with core NLP, IR, and speech processing techniques. Each agent is powered by a specific model or algorithm:
123
+
124
+ | Agent | Function | Model/Tool Used | Concepts |
125
+ |---------------|--------------------------------------|-----------------------------------------------|----------|
126
+ | ASR Agent | Audio transcription + timestamps | `IBM Speech-to-Text` or `Whisper` | Automatic Speech Recognition (ASR), Diarization |
127
+ | Claim Extractor | Turns transcript β†’ atomic claims | `watsonx.ai` Prompt Lab + `granite-3-8b-instruct` | Information Extraction, Prompt Engineering |
128
+ | Retriever | Find matching KB facts | `granite-embedding-107m-multilingual`, FAISS, optional `slate-30m-rtrvr` | Embedding-based Retrieval, Vector Search, Reranking |
129
+ | Verifier | Evaluate support/refute status | `granite-3-8b-instruct` | Fact Verification, Retrieval-Augmented Generation (RAG) |
130
+ | Summarizer | Generate exec summary + action items | `granite-3-8b-instruct` | Abstractive Summarization, Plan Extraction |
131
+
132
 
133
  ---
134
 
 
145
  - **OpenMP error (macOS)** β†’ set `KMP_DUPLICATE_LIB_OK=TRUE` and `OMP_NUM_THREADS=1`.
146
  - **JSON parse errors** β†’ we use a robust extractor; check server logs `[RAW OUTPUT]`.
147
 
 
148