@claritylabs/cl-sdk 0.3.1 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +471 -107
- package/dist/index.d.mts +24371 -3960
- package/dist/index.d.ts +24371 -3960
- package/dist/index.js +1439 -125
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1408 -125
- package/dist/index.mjs.map +1 -1
- package/dist/storage-sqlite.d.mts +9261 -1260
- package/dist/storage-sqlite.d.ts +9261 -1260
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# CL-
|
|
1
|
+
# CL-SDK
|
|
2
2
|
|
|
3
|
-
[Clarity Labs](https://claritylabs.inc) allows insurers to understand their clients as well as they know themselves.
|
|
3
|
+
[Clarity Labs](https://claritylabs.inc) allows insurers to understand their clients as well as they know themselves. A better understanding of clients means insurers can automate servicing to reduce costs and identify coverage gaps to cross-sell products.
|
|
4
4
|
|
|
5
|
-
CL-
|
|
5
|
+
CL-SDK is the open infrastructure layer that makes this possible — a pure TypeScript library for extracting, reasoning about, and acting on insurance documents. Provider-agnostic by design: bring any LLM, any embedding model, any storage backend.
|
|
6
6
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
@@ -25,199 +25,563 @@ npm install better-sqlite3
|
|
|
25
25
|
|
|
26
26
|
### Document Extraction
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
CL-SDK extracts structured data from insurance PDFs using a multi-agent pipeline. You provide two callback functions — `generateText` and `generateObject` — and the SDK handles the rest:
|
|
29
29
|
|
|
30
30
|
```typescript
|
|
31
31
|
import { createExtractor } from "@claritylabs/cl-sdk";
|
|
32
|
-
import { anthropic } from "@ai-sdk/anthropic"; // or any provider
|
|
33
|
-
import { generateText, generateObject } from "ai";
|
|
34
32
|
|
|
35
|
-
const
|
|
33
|
+
const extractor = createExtractor({
|
|
36
34
|
generateText: async ({ prompt, system, maxTokens }) => {
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
system,
|
|
41
|
-
maxTokens,
|
|
42
|
-
});
|
|
43
|
-
return { text, usage };
|
|
35
|
+
// Wrap your preferred LLM provider
|
|
36
|
+
const result = await yourProvider.generate({ prompt, system, maxTokens });
|
|
37
|
+
return { text: result.text, usage: result.usage };
|
|
44
38
|
},
|
|
45
39
|
generateObject: async ({ prompt, system, schema, maxTokens }) => {
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
system,
|
|
50
|
-
schema,
|
|
51
|
-
maxTokens,
|
|
52
|
-
});
|
|
53
|
-
return { object, usage };
|
|
40
|
+
// schema is a Zod schema — use it for structured output
|
|
41
|
+
const result = await yourProvider.generateStructured({ prompt, system, schema, maxTokens });
|
|
42
|
+
return { object: result.object, usage: result.usage };
|
|
54
43
|
},
|
|
55
44
|
});
|
|
56
45
|
|
|
57
|
-
const pdfBase64 = "..."; // base64-encoded PDF
|
|
58
|
-
const result = await
|
|
59
|
-
console.log(result.document); //
|
|
46
|
+
const pdfBase64 = "..."; // base64-encoded insurance PDF
|
|
47
|
+
const result = await extractor.extract(pdfBase64);
|
|
48
|
+
console.log(result.document); // Typed InsuranceDocument (policy or quote)
|
|
49
|
+
console.log(result.chunks); // DocumentChunk[] ready for vector storage
|
|
60
50
|
```
|
|
61
51
|
|
|
62
|
-
### With PDF
|
|
52
|
+
### With PDF-to-Image Conversion
|
|
63
53
|
|
|
64
|
-
For providers that don't support native PDF input:
|
|
54
|
+
For providers that don't support native PDF input (e.g., OpenAI):
|
|
65
55
|
|
|
66
56
|
```typescript
|
|
67
|
-
const
|
|
57
|
+
const extractor = createExtractor({
|
|
68
58
|
generateText: /* ... */,
|
|
69
59
|
generateObject: /* ... */,
|
|
70
60
|
convertPdfToImages: async (pdfBase64, startPage, endPage) => {
|
|
71
61
|
// Convert PDF pages to images using your preferred library
|
|
72
|
-
return [
|
|
73
|
-
{ imageBase64: "...", mimeType: "image/png" },
|
|
74
|
-
// ... one per page
|
|
75
|
-
];
|
|
62
|
+
return [{ imageBase64: "...", mimeType: "image/png" }]; // one per page
|
|
76
63
|
},
|
|
77
64
|
});
|
|
78
65
|
```
|
|
79
66
|
|
|
80
|
-
### Storage (Optional)
|
|
81
|
-
|
|
82
|
-
```typescript
|
|
83
|
-
import { createExtractor } from "@claritylabs/cl-sdk";
|
|
84
|
-
import { SQLiteDocumentStore, SQLiteMemoryStore } from "@claritylabs/cl-sdk/storage/sqlite";
|
|
85
|
-
|
|
86
|
-
const documentStore = new SQLiteDocumentStore("./docs.db");
|
|
87
|
-
const memoryStore = new SQLiteMemoryStore("./memory.db");
|
|
88
|
-
|
|
89
|
-
const extract = createExtractor({
|
|
90
|
-
generateText: /* ... */,
|
|
91
|
-
generateObject: /* ... */,
|
|
92
|
-
documentStore,
|
|
93
|
-
memoryStore,
|
|
94
|
-
});
|
|
95
|
-
```
|
|
96
|
-
|
|
97
67
|
## Architecture
|
|
98
68
|
|
|
99
|
-
### Provider-Agnostic
|
|
69
|
+
### Provider-Agnostic Callbacks
|
|
100
70
|
|
|
101
|
-
CL-
|
|
71
|
+
CL-SDK has **zero framework dependencies**. All LLM interaction happens through two callback types:
|
|
102
72
|
|
|
103
73
|
```typescript
|
|
104
74
|
type GenerateText = (params: {
|
|
105
75
|
prompt: string;
|
|
106
76
|
system?: string;
|
|
107
77
|
maxTokens: number;
|
|
108
|
-
|
|
78
|
+
providerOptions?: Record<string, unknown>;
|
|
79
|
+
}) => Promise<{ text: string; usage?: { inputTokens: number; outputTokens: number } }>;
|
|
109
80
|
|
|
110
81
|
type GenerateObject<T> = (params: {
|
|
111
82
|
prompt: string;
|
|
112
83
|
system?: string;
|
|
113
84
|
schema: ZodSchema<T>;
|
|
114
85
|
maxTokens: number;
|
|
115
|
-
|
|
86
|
+
providerOptions?: Record<string, unknown>;
|
|
87
|
+
}) => Promise<{ object: T; usage?: { inputTokens: number; outputTokens: number } }>;
|
|
116
88
|
```
|
|
117
89
|
|
|
118
|
-
Works with any provider:
|
|
90
|
+
Works with any provider: Anthropic, OpenAI, Google, Mistral, Bedrock, Azure, Ollama, etc. You write the adapter once; the SDK calls it throughout the pipeline.
|
|
119
91
|
|
|
120
92
|
### Extraction Pipeline
|
|
121
93
|
|
|
122
|
-
The
|
|
94
|
+
The extraction system uses a **coordinator/worker pattern** — a coordinator agent plans the work, specialized extractor agents execute in parallel, and a review loop ensures completeness.
|
|
95
|
+
|
|
96
|
+
```
|
|
97
|
+
┌─────────────┐ ┌─────────────┐ ┌──────────────────────┐
|
|
98
|
+
│ 1. CLASSIFY │────▶│ 2. PLAN │────▶│ 3. EXTRACT (parallel)│
|
|
99
|
+
│ │ │ │ │ │
|
|
100
|
+
│ Document │ │ Select │ │ Run focused │
|
|
101
|
+
│ type, line │ │ template, │ │ extractors against │
|
|
102
|
+
│ of business │ │ assign │ │ assigned page │
|
|
103
|
+
│ │ │ extractors │ │ ranges │
|
|
104
|
+
│ │ │ to pages │ │ │
|
|
105
|
+
└─────────────┘ └─────────────┘ └──────────┬───────────┘
|
|
106
|
+
│
|
|
107
|
+
┌─────────────┐ ┌──────────▼───────────┐
|
|
108
|
+
│ 5. ASSEMBLE │◀────│ 4. REVIEW │
|
|
109
|
+
│ │ │ │
|
|
110
|
+
│ Merge all │ │ Check completeness │
|
|
111
|
+
│ results, │ │ against template, │
|
|
112
|
+
│ validate, │ │ dispatch follow-up │
|
|
113
|
+
│ chunk │ │ extractors for gaps │
|
|
114
|
+
└─────────────┘ └──────────────────────┘
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
#### Phase 1: Classify
|
|
118
|
+
|
|
119
|
+
The coordinator sends the document to `generateObject` with the `ClassifyResultSchema`. It determines:
|
|
120
|
+
- **Document type** — policy or quote
|
|
121
|
+
- **Policy types** — one or more lines of business (e.g., `general_liability`, `workers_comp`)
|
|
122
|
+
- **Confidence score**
|
|
123
|
+
|
|
124
|
+
#### Phase 2: Plan
|
|
125
|
+
|
|
126
|
+
Based on the classification, the coordinator selects a **line-of-business template** (e.g., `workers_comp`, `cyber`, `homeowners_ho3`) that defines expected sections and page hints. It then generates an **extraction plan** — a list of tasks that map specific extractors to page ranges within the PDF.
|
|
127
|
+
|
|
128
|
+
#### Phase 3: Extract
|
|
123
129
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
130
|
+
Focused extractor agents are dispatched **in parallel** (concurrency-limited, default 2). Each extractor targets a specific data domain against its assigned page range. The 11 extractor types are:
|
|
131
|
+
|
|
132
|
+
| Extractor | What It Extracts |
|
|
133
|
+
|-----------|-----------------|
|
|
134
|
+
| `carrier_info` | Carrier name, NAIC, AM Best rating, MGA, underwriter, broker |
|
|
135
|
+
| `named_insured` | Insured name, DBA, address, entity type, FEIN, SIC/NAICS |
|
|
136
|
+
| `declarations` | Line-specific structured declarations (varies by policy type) |
|
|
137
|
+
| `coverage_limits` | Coverage names, limits, deductibles, forms, triggers |
|
|
138
|
+
| `endorsements` | Form numbers, titles, types, content, affected parties |
|
|
139
|
+
| `exclusions` | Exclusion titles, content, applicability |
|
|
140
|
+
| `conditions` | Duties after loss, cancellation, other insurance, etc. |
|
|
141
|
+
| `premium_breakdown` | Premium amounts, taxes, fees, payment plans, rating basis |
|
|
142
|
+
| `loss_history` | Loss runs, claim records, experience modification |
|
|
143
|
+
| `supplementary` | Regulatory context, contacts, TPA, claims contacts |
|
|
144
|
+
| `sections` | Raw section content (fallback for unmatched sections) |
|
|
145
|
+
|
|
146
|
+
Each extractor writes its results to an in-memory `Map`. Results accumulate across all extractors.
|
|
147
|
+
|
|
148
|
+
#### Phase 4: Review
|
|
149
|
+
|
|
150
|
+
After initial extraction, a review loop (up to `maxReviewRounds`, default 2) checks completeness against the template's expected sections. If gaps are found, additional extractor tasks are dispatched to fill missing data. This iterative refinement ensures comprehensive extraction.
|
|
151
|
+
|
|
152
|
+
#### Phase 5: Assemble
|
|
153
|
+
|
|
154
|
+
All extractor results are merged into a final validated `InsuranceDocument`, then chunked into `DocumentChunk[]` for vector storage. Chunks are deterministically IDed as `${documentId}:${type}:${index}`.
|
|
155
|
+
|
|
156
|
+
### Configuration
|
|
129
157
|
|
|
130
158
|
```typescript
|
|
131
|
-
const
|
|
159
|
+
const extractor = createExtractor({
|
|
160
|
+
// Required: LLM callbacks
|
|
132
161
|
generateText,
|
|
133
162
|
generateObject,
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
163
|
+
|
|
164
|
+
// Optional: PDF vision mode
|
|
165
|
+
convertPdfToImages: async (pdfBase64, startPage, endPage) => [...],
|
|
166
|
+
|
|
167
|
+
// Optional: storage backends
|
|
168
|
+
documentStore, // Persist extracted documents
|
|
169
|
+
memoryStore, // Vector search over chunks + conversation history
|
|
170
|
+
|
|
171
|
+
// Optional: tuning
|
|
172
|
+
concurrency: 2, // Max parallel extractors (default: 2)
|
|
173
|
+
maxReviewRounds: 2, // Review loop iterations (default: 2)
|
|
174
|
+
|
|
175
|
+
// Optional: observability
|
|
176
|
+
onTokenUsage: (usage) => console.log(`${usage.inputTokens} in, ${usage.outputTokens} out`),
|
|
177
|
+
onProgress: (message) => console.log(message),
|
|
178
|
+
log: async (message) => logger.info(message),
|
|
179
|
+
providerOptions: {}, // Passed through to every LLM call
|
|
139
180
|
});
|
|
140
181
|
```
|
|
141
182
|
|
|
142
|
-
###
|
|
183
|
+
### Line-of-Business Templates
|
|
184
|
+
|
|
185
|
+
Templates define what the extraction pipeline expects for each policy type. Each template specifies expected sections, page hints, and required vs. optional fields.
|
|
186
|
+
|
|
187
|
+
**Personal lines:** homeowners (HO-3, HO-5), renters (HO-4), condo (HO-6), dwelling fire, personal auto, personal umbrella, personal inland marine, flood (NFIP + private), earthquake, watercraft, recreational vehicle, farm/ranch, mobile home
|
|
188
|
+
|
|
189
|
+
**Commercial lines:** general liability, commercial property, commercial auto, workers' comp, umbrella/excess, professional liability, cyber, directors & officers, crime/fidelity
|
|
143
190
|
|
|
144
|
-
|
|
191
|
+
## Storage
|
|
192
|
+
|
|
193
|
+
CL-SDK defines two storage interfaces (`DocumentStore` and `MemoryStore`) and ships a reference SQLite implementation. You can implement these interfaces with any backend.
|
|
194
|
+
|
|
195
|
+
### DocumentStore
|
|
196
|
+
|
|
197
|
+
CRUD for extracted `InsuranceDocument` objects:
|
|
145
198
|
|
|
146
199
|
```typescript
|
|
147
|
-
|
|
148
|
-
InsuranceDocument
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
Declaration, // 20+ line types
|
|
154
|
-
Platform,
|
|
155
|
-
AgentContext,
|
|
156
|
-
} from "@claritylabs/cl-sdk";
|
|
200
|
+
interface DocumentStore {
|
|
201
|
+
save(doc: InsuranceDocument): Promise<void>;
|
|
202
|
+
get(id: string): Promise<InsuranceDocument | null>;
|
|
203
|
+
query(filters: DocumentFilters): Promise<InsuranceDocument[]>;
|
|
204
|
+
delete(id: string): Promise<void>;
|
|
205
|
+
}
|
|
157
206
|
```
|
|
158
207
|
|
|
159
|
-
|
|
208
|
+
Filters support: `type` (policy/quote), `carrier` (fuzzy), `insuredName` (fuzzy), `policyNumber` (exact), `quoteNumber` (exact).
|
|
209
|
+
|
|
210
|
+
### MemoryStore
|
|
211
|
+
|
|
212
|
+
Vector-searchable storage for document chunks and conversation history. Requires an `EmbedText` callback for generating embeddings:
|
|
160
213
|
|
|
161
|
-
|
|
214
|
+
```typescript
|
|
215
|
+
type EmbedText = (text: string) => Promise<number[]>;
|
|
216
|
+
|
|
217
|
+
interface MemoryStore {
|
|
218
|
+
// Document chunks with embeddings
|
|
219
|
+
addChunks(chunks: DocumentChunk[]): Promise<void>;
|
|
220
|
+
search(query: string, options?: { limit?: number; filter?: ChunkFilter }): Promise<DocumentChunk[]>;
|
|
221
|
+
|
|
222
|
+
// Conversation turns with embeddings
|
|
223
|
+
addTurn(turn: ConversationTurn): Promise<void>;
|
|
224
|
+
getHistory(conversationId: string, options?: { limit?: number }): Promise<ConversationTurn[]>;
|
|
225
|
+
searchHistory(query: string, conversationId?: string): Promise<ConversationTurn[]>;
|
|
226
|
+
}
|
|
227
|
+
```
|
|
162
228
|
|
|
163
|
-
|
|
164
|
-
|----------|-------------|
|
|
165
|
-
| `createExtractor(config)` | Create extraction engine with callbacks |
|
|
166
|
-
| `extract.extract(pdfBase64, documentId?)` | Run full extraction pipeline |
|
|
167
|
-
| `chunkDocument(text, maxChunkSize?)` | Chunk text for vector storage |
|
|
229
|
+
Search uses **cosine similarity** over embeddings to find semantically relevant chunks or conversation turns. Embedding failures are non-fatal — chunks are still stored, just not searchable by vector.
|
|
168
230
|
|
|
169
|
-
###
|
|
231
|
+
### SQLite Reference Implementation
|
|
170
232
|
|
|
171
233
|
```typescript
|
|
172
|
-
import {
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
234
|
+
import { createSqliteStore } from "@claritylabs/cl-sdk/storage/sqlite";
|
|
235
|
+
|
|
236
|
+
const store = createSqliteStore({
|
|
237
|
+
path: "./cl-sdk.db",
|
|
238
|
+
embed: async (text) => {
|
|
239
|
+
// Your embedding function (OpenAI, Cohere, local model, etc.)
|
|
240
|
+
return await yourEmbeddingProvider.embed(text);
|
|
241
|
+
},
|
|
242
|
+
});
|
|
243
|
+
|
|
244
|
+
// Use with extractor
|
|
245
|
+
const extractor = createExtractor({
|
|
246
|
+
generateText,
|
|
247
|
+
generateObject,
|
|
248
|
+
documentStore: store.documents,
|
|
249
|
+
memoryStore: store.memory,
|
|
250
|
+
});
|
|
251
|
+
|
|
252
|
+
// Or use standalone
|
|
253
|
+
await store.documents.save(document);
|
|
254
|
+
const results = await store.memory.search("what is the deductible?", { limit: 5 });
|
|
255
|
+
|
|
256
|
+
// Clean up
|
|
257
|
+
store.close();
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
## Agent System
|
|
261
|
+
|
|
262
|
+
CL-SDK includes a composable prompt system for building insurance-aware AI agents. The `buildAgentSystemPrompt` function assembles modular prompt segments based on the agent's context:
|
|
263
|
+
|
|
264
|
+
```typescript
|
|
265
|
+
import { buildAgentSystemPrompt } from "@claritylabs/cl-sdk";
|
|
178
266
|
|
|
179
267
|
const systemPrompt = buildAgentSystemPrompt({
|
|
180
|
-
platform: "email",
|
|
181
|
-
intent: "direct",
|
|
268
|
+
platform: "email", // email | chat | sms | slack | discord
|
|
269
|
+
intent: "direct", // direct | mediated | observed
|
|
182
270
|
userName: "John",
|
|
183
271
|
companyName: "Acme Insurance",
|
|
184
272
|
});
|
|
185
273
|
```
|
|
186
274
|
|
|
187
|
-
###
|
|
275
|
+
### Prompt Modules
|
|
276
|
+
|
|
277
|
+
The system prompt is composed from these modules:
|
|
278
|
+
|
|
279
|
+
| Module | Purpose |
|
|
280
|
+
|--------|---------|
|
|
281
|
+
| **identity** | Agent role, company context, professional persona |
|
|
282
|
+
| **intent** | Behavioral rules based on platform and interaction mode |
|
|
283
|
+
| **formatting** | Output formatting rules (markdown for chat, plaintext for email/SMS) |
|
|
284
|
+
| **safety** | Security guardrails, prompt injection resistance, data handling |
|
|
285
|
+
| **coverage-gaps** | Coverage gap disclosure rules (only in mediated/observed mode) |
|
|
286
|
+
| **coi-routing** | Certificate of Insurance request handling |
|
|
287
|
+
| **quotes-policies** | Guidance for distinguishing quotes vs. active policies |
|
|
288
|
+
| **conversation-memory** | Context about conversation history and document retrieval |
|
|
289
|
+
|
|
290
|
+
### Message Intent Classification
|
|
291
|
+
|
|
292
|
+
Classify incoming messages to route them appropriately:
|
|
293
|
+
|
|
294
|
+
```typescript
|
|
295
|
+
import { buildClassifyMessagePrompt } from "@claritylabs/cl-sdk";
|
|
296
|
+
|
|
297
|
+
const prompt = buildClassifyMessagePrompt("email");
|
|
298
|
+
// Returns classification prompt for intents:
|
|
299
|
+
// policy_question, coi_request, renewal_inquiry, claim_report,
|
|
300
|
+
// coverage_shopping, general, unrelated
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
## Application Processing Pipeline
|
|
304
|
+
|
|
305
|
+
The application pipeline processes insurance applications through an agentic coordinator/worker system — small focused agents handle classification, field extraction, auto-fill, question batching, reply routing, and PDF mapping. Supports persistent state and vector-based answer backfill from prior applications.
|
|
306
|
+
|
|
307
|
+
### Quick Start
|
|
308
|
+
|
|
309
|
+
```typescript
|
|
310
|
+
import { createApplicationPipeline } from "@claritylabs/cl-sdk";
|
|
311
|
+
|
|
312
|
+
const pipeline = createApplicationPipeline({
|
|
313
|
+
generateText,
|
|
314
|
+
generateObject,
|
|
315
|
+
applicationStore, // persistent state storage
|
|
316
|
+
documentStore, // for policy/quote lookups during auto-fill
|
|
317
|
+
memoryStore, // for vector-based answer backfill
|
|
318
|
+
orgContext: [ // business context for auto-fill
|
|
319
|
+
{ key: "company_name", value: "Acme Corp", category: "company_info" },
|
|
320
|
+
{ key: "company_address", value: "123 Main St", category: "company_info" },
|
|
321
|
+
],
|
|
322
|
+
});
|
|
323
|
+
|
|
324
|
+
// Process a new application PDF
|
|
325
|
+
const { state } = await pipeline.processApplication({
|
|
326
|
+
pdfBase64: "...",
|
|
327
|
+
applicationId: "app-123",
|
|
328
|
+
});
|
|
329
|
+
// state.fields → extracted fields, some already auto-filled
|
|
330
|
+
// state.batches → question batches ready for user collection
|
|
331
|
+
|
|
332
|
+
// Generate email for current batch
|
|
333
|
+
const { text: emailBody } = await pipeline.generateCurrentBatchEmail("app-123", {
|
|
334
|
+
companyName: "Acme Corp",
|
|
335
|
+
});
|
|
336
|
+
|
|
337
|
+
// Process user's reply
|
|
338
|
+
const { state: updated, fieldsFilled, responseText } = await pipeline.processReply({
|
|
339
|
+
applicationId: "app-123",
|
|
340
|
+
replyText: "1. Yes\n2. $1,000,000\n3. Check our website for revenue",
|
|
341
|
+
});
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
### Pipeline Phases
|
|
345
|
+
|
|
346
|
+
```
|
|
347
|
+
┌─────────────┐ ┌──────────────┐ ┌─────────────────────┐
|
|
348
|
+
│ 1. CLASSIFY │────>│ 2. EXTRACT │────>│ 3. BACKFILL + │
|
|
349
|
+
│ │ │ FIELDS │ │ AUTO-FILL │
|
|
350
|
+
│ Is this an │ │ │ │ (parallel) │
|
|
351
|
+
│ application? │ │ All fillable │ │ │
|
|
352
|
+
│ │ │ fields as │ │ • vector backfill │
|
|
353
|
+
│ │ │ structured │ │ • context auto-fill │
|
|
354
|
+
│ │ │ data │ │ • document search │
|
|
355
|
+
└──────────────┘ └──────────────┘ └──────────┬──────────┘
|
|
356
|
+
│
|
|
357
|
+
┌──────────────┐ ┌──────────v──────────┐
|
|
358
|
+
│ REPLY LOOP │<────│ 4. BATCH QUESTIONS │
|
|
359
|
+
│ │ │ │
|
|
360
|
+
│ Route intent │ │ Group unfilled │
|
|
361
|
+
│ Parse answers│ │ fields by topic │
|
|
362
|
+
│ Handle lookup│ │ Generate emails │
|
|
363
|
+
│ Explain field│ │ │
|
|
364
|
+
└──────┬───────┘ └─────────────────────┘
|
|
365
|
+
│
|
|
366
|
+
┌──────v───────┐
|
|
367
|
+
│ 5. CONFIRM + │
|
|
368
|
+
│ MAP PDF │
|
|
369
|
+
└──────────────┘
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### Focused Agents (8 types)
|
|
373
|
+
|
|
374
|
+
| Agent | Task | Model Size |
|
|
375
|
+
|-------|------|-----------|
|
|
376
|
+
| `classifier` | Detect if PDF is an application | Tiny |
|
|
377
|
+
| `field-extractor` | Extract all form fields | Medium |
|
|
378
|
+
| `auto-filler` | Match fields to business context | Small |
|
|
379
|
+
| `batcher` | Group fields into topic batches | Small |
|
|
380
|
+
| `reply-router` | Classify reply intent | Tiny |
|
|
381
|
+
| `answer-parser` | Extract answers from replies | Small |
|
|
382
|
+
| `lookup-filler` | Fill from policy/record lookups | Small |
|
|
383
|
+
| `email-generator` | Generate professional batch emails | Small |
|
|
384
|
+
|
|
385
|
+
### Vector-Based Answer Backfill
|
|
386
|
+
|
|
387
|
+
The `BackfillProvider` interface enables searching prior application answers and extracted document data to pre-fill new applications:
|
|
388
|
+
|
|
389
|
+
```typescript
|
|
390
|
+
interface BackfillProvider {
|
|
391
|
+
searchPriorAnswers(
|
|
392
|
+
fields: { id: string; label: string; section: string; fieldType: string }[],
|
|
393
|
+
options?: { limit?: number },
|
|
394
|
+
): Promise<PriorAnswer[]>;
|
|
395
|
+
}
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
This runs in parallel with context-based auto-fill, so the pipeline fills as many fields as possible before asking the user anything.
|
|
399
|
+
|
|
400
|
+
### Application Prompts (for advanced use)
|
|
401
|
+
|
|
402
|
+
The individual prompt functions are still exported for custom pipelines:
|
|
188
403
|
|
|
189
404
|
```typescript
|
|
190
405
|
import {
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
406
|
+
buildFieldExtractionPrompt,
|
|
407
|
+
buildAutoFillPrompt,
|
|
408
|
+
buildQuestionBatchPrompt,
|
|
409
|
+
buildAnswerParsingPrompt,
|
|
410
|
+
buildConfirmationSummaryPrompt,
|
|
411
|
+
buildBatchEmailGenerationPrompt,
|
|
412
|
+
buildReplyIntentClassificationPrompt,
|
|
413
|
+
buildFieldExplanationPrompt,
|
|
414
|
+
buildFlatPdfMappingPrompt,
|
|
415
|
+
buildAcroFormMappingPrompt,
|
|
416
|
+
buildLookupFillPrompt,
|
|
194
417
|
} from "@claritylabs/cl-sdk";
|
|
195
418
|
```
|
|
196
419
|
|
|
197
|
-
|
|
420
|
+
## Query Agent Pipeline
|
|
421
|
+
|
|
422
|
+
The query agent answers user questions against stored documents with citation-backed provenance. It mirrors the extraction pipeline's coordinator/worker pattern: a classifier decomposes questions, retrievers pull evidence in parallel, reasoners answer from evidence only, and a verifier checks grounding.
|
|
423
|
+
|
|
424
|
+
### Quick Start
|
|
425
|
+
|
|
426
|
+
```typescript
|
|
427
|
+
import { createQueryAgent } from "@claritylabs/cl-sdk";
|
|
428
|
+
|
|
429
|
+
const agent = createQueryAgent({
|
|
430
|
+
generateText,
|
|
431
|
+
generateObject,
|
|
432
|
+
documentStore, // where extracted documents are stored
|
|
433
|
+
memoryStore, // where document chunks + conversation history live
|
|
434
|
+
});
|
|
435
|
+
|
|
436
|
+
const result = await agent.query({
|
|
437
|
+
question: "What is the deductible on our GL policy?",
|
|
438
|
+
conversationId: "conv-123",
|
|
439
|
+
});
|
|
440
|
+
|
|
441
|
+
console.log(result.answer); // Natural language answer
|
|
442
|
+
console.log(result.citations); // Source references with exact quotes
|
|
443
|
+
console.log(result.confidence); // 0-1 confidence score
|
|
444
|
+
```
|
|
445
|
+
|
|
446
|
+
### Pipeline Phases
|
|
447
|
+
|
|
448
|
+
```
|
|
449
|
+
┌─────────────┐ ┌──────────────┐ ┌────────────────────┐
|
|
450
|
+
│ 1. CLASSIFY │────>│ 2. RETRIEVE │────>│ 3. REASON │
|
|
451
|
+
│ │ │ (parallel) │ │ (parallel) │
|
|
452
|
+
│ Intent + │ │ │ │ │
|
|
453
|
+
│ sub-question │ │ chunk search │ │ Answer each sub-Q │
|
|
454
|
+
│ decomposition│ │ doc lookup │ │ from evidence only │
|
|
455
|
+
│ │ │ conv history │ │ │
|
|
456
|
+
└──────────────┘ └──────────────┘ └─────────┬──────────┘
|
|
457
|
+
│
|
|
458
|
+
┌──────────────┐ ┌─────────v──────────┐
|
|
459
|
+
│ 5. RESPOND │<────│ 4. VERIFY │
|
|
460
|
+
│ │ │ │
|
|
461
|
+
│ Format with │ │ Grounding check │
|
|
462
|
+
│ citations, │ │ Consistency check │
|
|
463
|
+
│ store turn │ │ Completeness check │
|
|
464
|
+
└──────────────┘ └────────────────────┘
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
**Phase 1 — Classify:** Determines intent (`policy_question`, `coverage_comparison`, `document_search`, `claims_inquiry`, `general_knowledge`) and decomposes complex questions into atomic sub-questions. Each sub-question specifies which chunk types and document filters to use for retrieval.
|
|
468
|
+
|
|
469
|
+
**Phase 2 — Retrieve (parallel):** For each sub-question, a retriever searches chunk embeddings, does structured document lookups, and pulls conversation history — all in parallel. Returns ranked evidence items.
|
|
470
|
+
|
|
471
|
+
**Phase 3 — Reason (parallel):** For each sub-question, a reasoner receives only the retrieved evidence (never the full document) and produces a sub-answer with citations. Intent-specific prompts guide reasoning (e.g., coverage questions get prompts tuned for interpreting limits and endorsements).
|
|
472
|
+
|
|
473
|
+
**Phase 4 — Verify:** The verifier checks that every claim is grounded in a citation, sub-answers don't contradict each other, and no evidence was overlooked. If issues are found, it can trigger re-retrieval with broader context.
|
|
474
|
+
|
|
475
|
+
**Phase 5 — Respond:** Merges verified sub-answers into a single natural-language response with inline citations (`[1]`, `[2]`), deduplicates references, and stores the exchange as conversation turns.
|
|
476
|
+
|
|
477
|
+
### Configuration
|
|
478
|
+
|
|
479
|
+
```typescript
|
|
480
|
+
const agent = createQueryAgent({
|
|
481
|
+
// Required
|
|
482
|
+
generateText,
|
|
483
|
+
generateObject,
|
|
484
|
+
documentStore,
|
|
485
|
+
memoryStore,
|
|
486
|
+
|
|
487
|
+
// Optional: tuning
|
|
488
|
+
concurrency: 3, // max parallel retrievers/reasoners (default: 3)
|
|
489
|
+
maxVerifyRounds: 1, // verification loop iterations (default: 1)
|
|
490
|
+
retrievalLimit: 10, // max evidence items per sub-question (default: 10)
|
|
491
|
+
|
|
492
|
+
// Optional: observability
|
|
493
|
+
onTokenUsage: (usage) => console.log(`${usage.inputTokens} in, ${usage.outputTokens} out`),
|
|
494
|
+
onProgress: (message) => console.log(message),
|
|
495
|
+
log: async (message) => logger.info(message),
|
|
496
|
+
providerOptions: {},
|
|
497
|
+
});
|
|
498
|
+
```
|
|
499
|
+
|
|
500
|
+
### Citations
|
|
501
|
+
|
|
502
|
+
Every factual claim in the answer references its source:
|
|
503
|
+
|
|
504
|
+
```typescript
|
|
505
|
+
interface Citation {
|
|
506
|
+
index: number; // [1], [2], etc.
|
|
507
|
+
chunkId: string; // e.g. "doc-123:coverage:2"
|
|
508
|
+
documentId: string;
|
|
509
|
+
documentType?: "policy" | "quote";
|
|
510
|
+
field?: string; // e.g. "coverages[0].deductible"
|
|
511
|
+
quote: string; // exact text from source
|
|
512
|
+
relevance: number; // 0-1 similarity score
|
|
513
|
+
}
|
|
514
|
+
```
|
|
515
|
+
|
|
516
|
+
## PDF Operations
|
|
198
517
|
|
|
199
518
|
```typescript
|
|
200
519
|
import {
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
520
|
+
extractPageRange, // Extract specific pages from a PDF
|
|
521
|
+
getPdfPageCount, // Get total page count
|
|
522
|
+
getAcroFormFields, // Enumerate form fields (text, checkbox, dropdown, radio)
|
|
523
|
+
fillAcroForm, // Fill and flatten AcroForm fields
|
|
524
|
+
overlayTextOnPdf, // Overlay text at coordinates on flat PDFs
|
|
204
525
|
} from "@claritylabs/cl-sdk";
|
|
205
526
|
```
|
|
206
527
|
|
|
207
|
-
|
|
528
|
+
## Tool Definitions
|
|
529
|
+
|
|
530
|
+
Claude `tool_use`-compatible schemas for agent integrations:
|
|
531
|
+
|
|
532
|
+
```typescript
|
|
533
|
+
import {
|
|
534
|
+
AGENT_TOOLS, // All tools as an array
|
|
535
|
+
DOCUMENT_LOOKUP_TOOL, // Search/retrieve policies and quotes
|
|
536
|
+
COI_GENERATION_TOOL, // Generate Certificates of Insurance
|
|
537
|
+
COVERAGE_COMPARISON_TOOL, // Compare coverages across documents
|
|
538
|
+
} from "@claritylabs/cl-sdk";
|
|
539
|
+
```
|
|
540
|
+
|
|
541
|
+
These are schema-only definitions (input schemas + descriptions). You provide the implementations that call your storage and PDF layers.
|
|
542
|
+
|
|
543
|
+
## Document Types
|
|
544
|
+
|
|
545
|
+
All types are derived from Zod schemas, providing both runtime validation and TypeScript types:
|
|
208
546
|
|
|
209
547
|
```typescript
|
|
210
|
-
import {
|
|
548
|
+
import type {
|
|
549
|
+
InsuranceDocument, // PolicyDocument | QuoteDocument (discriminated union)
|
|
550
|
+
PolicyDocument, // Extracted policy with all enrichments
|
|
551
|
+
QuoteDocument, // Extracted quote with subjectivities, premium breakdown
|
|
552
|
+
Coverage, // Coverage name, limits, deductibles, form
|
|
553
|
+
EnrichedCoverage, // Coverage + additional metadata
|
|
554
|
+
Endorsement, // Form number, title, type, content
|
|
555
|
+
Exclusion, // Title, content, applicability
|
|
556
|
+
Condition, // Type, title, content
|
|
557
|
+
Declaration, // Line-specific declarations (19 types)
|
|
558
|
+
Platform, // email | chat | sms | slack | discord
|
|
559
|
+
AgentContext, // Platform + intent + user/company context
|
|
560
|
+
} from "@claritylabs/cl-sdk";
|
|
561
|
+
```
|
|
562
|
+
|
|
563
|
+
### Supported Policy Types
|
|
564
|
+
|
|
565
|
+
42 policy types across personal and commercial lines — including general liability, commercial property, workers' comp, cyber, D&O, homeowners (HO-3/HO-5/HO-4/HO-6), personal auto, flood (NFIP + private), earthquake, and more.
|
|
566
|
+
|
|
567
|
+
## Core Utilities
|
|
568
|
+
|
|
569
|
+
```typescript
|
|
570
|
+
import {
|
|
571
|
+
withRetry, // Exponential backoff with jitter (5 retries, 2–32s) for rate limits
|
|
572
|
+
pLimit, // Concurrency limiter for parallel async tasks
|
|
573
|
+
sanitizeNulls, // Recursively convert null → undefined (for database compatibility)
|
|
574
|
+
stripFences, // Remove markdown code fences from LLM JSON responses
|
|
575
|
+
} from "@claritylabs/cl-sdk";
|
|
211
576
|
```
|
|
212
577
|
|
|
213
578
|
## Development
|
|
214
579
|
|
|
215
580
|
```bash
|
|
216
581
|
npm install
|
|
217
|
-
npm run build # Build ESM + CJS + types
|
|
582
|
+
npm run build # Build ESM + CJS + types via tsup
|
|
218
583
|
npm run dev # Watch mode
|
|
219
|
-
npm run typecheck # Type check
|
|
220
|
-
npm run test # Run tests (vitest)
|
|
584
|
+
npm run typecheck # Type check (tsc --noEmit)
|
|
221
585
|
```
|
|
222
586
|
|
|
223
587
|
Zero framework dependencies. Peer deps: `pdf-lib`, `zod`. Optional: `better-sqlite3`.
|