@talonic/docs 0.7.1 → 0.8.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/dist/seo.js CHANGED
@@ -57,6 +57,77 @@ var API_NAV_SECTIONS = [
57
57
  { id: "webhook-verification", label: "Signature Verification" },
58
58
  { id: "webhook-retries", label: "Retry Policy" }
59
59
  ] },
60
+ { id: "resolutions", label: "Resolutions", children: [
61
+ { id: "list-resolutions", label: "List Resolutions" },
62
+ { id: "create-resolution", label: "Create Resolution" },
63
+ { id: "get-resolution", label: "Get Resolution" },
64
+ { id: "get-resolution-results", label: "Get Results" },
65
+ { id: "execute-resolution", label: "Execute Resolution" },
66
+ { id: "delete-resolution", label: "Delete Resolution" }
67
+ ] },
68
+ { id: "linking", label: "Linking", children: [
69
+ { id: "list-link-keys", label: "Link Keys" },
70
+ { id: "get-document-links", label: "Document Links" },
71
+ { id: "get-linking-graph", label: "Full Graph" },
72
+ { id: "get-document-graph", label: "Document Graph" },
73
+ { id: "classify-link-keys", label: "Classify" },
74
+ { id: "backfill-linking", label: "Backfill" },
75
+ { id: "backfill-progress", label: "Backfill Progress" },
76
+ { id: "document-case-map", label: "Document-Case Map" }
77
+ ] },
78
+ { id: "nshot", label: "N-Shot", children: [
79
+ { id: "nshot-summary", label: "Summary" },
80
+ { id: "nshot-comparisons", label: "Comparisons" },
81
+ { id: "nshot-comparison", label: "Single Comparison" },
82
+ { id: "nshot-override", label: "Override" },
83
+ { id: "nshot-judge-decision", label: "Judge Decision" }
84
+ ] },
85
+ { id: "schema-graph", label: "Schema Graph", children: [
86
+ { id: "list-schema-graph-classes", label: "List Classes" },
87
+ { id: "get-schema-graph-class", label: "Get Class" },
88
+ { id: "list-class-versions", label: "List Versions" },
89
+ { id: "get-class-version", label: "Get Version" },
90
+ { id: "list-schema-graph-diffs", label: "List Diffs" },
91
+ { id: "approve-diff", label: "Approve Diff" },
92
+ { id: "reject-diff", label: "Reject Diff" },
93
+ { id: "list-schema-graph-edges", label: "Edges" },
94
+ { id: "list-schema-graph-aliases", label: "Aliases" },
95
+ { id: "visualize-schema-graph", label: "Visualize" }
96
+ ] },
97
+ { id: "structuring", label: "Structuring", children: [
98
+ { id: "list-structuring-checks", label: "List Checks" },
99
+ { id: "create-structuring-check", label: "Create Check" },
100
+ { id: "get-structuring-check", label: "Get / Update / Delete Check" },
101
+ { id: "list-structuring-gates", label: "List Gates" },
102
+ { id: "create-structuring-gate", label: "Create Gate" },
103
+ { id: "get-structuring-gate", label: "Get / Update / Delete Gate" },
104
+ { id: "gate-rules", label: "Gate Rules" },
105
+ { id: "result-checks", label: "Result Checks" },
106
+ { id: "pending-approvals", label: "Pending Approvals" },
107
+ { id: "approve-reject-result", label: "Approve / Reject Result" },
108
+ { id: "trigger-delivery", label: "Trigger Delivery" }
109
+ ] },
110
+ { id: "telemetry", label: "Telemetry", children: [
111
+ { id: "schema-telemetry-summary", label: "Schema Summary" },
112
+ { id: "schema-telemetry-trend", label: "Schema Trend" },
113
+ { id: "schema-telemetry-fields", label: "Schema Fields" },
114
+ { id: "run-telemetry-summary", label: "Run Summary" }
115
+ ] },
116
+ { id: "validation", label: "Validation", children: [
117
+ { id: "list-golden-samples", label: "List Golden Samples" },
118
+ { id: "get-golden-sample", label: "Get / Delete Golden Sample" },
119
+ { id: "list-validation-runs", label: "List Validation Runs" },
120
+ { id: "create-validation-run", label: "Create Validation Run" },
121
+ { id: "get-validation-run", label: "Get / Delete Validation Run" },
122
+ { id: "get-validation-results", label: "Validation Results" }
123
+ ] },
124
+ { id: "credits", label: "Credits", children: [
125
+ { id: "credits-balance", label: "Balance" },
126
+ { id: "credits-history", label: "History" },
127
+ { id: "credits-usage", label: "Usage Summary" },
128
+ { id: "credits-usage-daily", label: "Daily Usage" },
129
+ { id: "credits-usage-log", label: "Usage Log" }
130
+ ] },
60
131
  { id: "errors-rate-limits", label: "Errors & Rate Limits", children: [
61
132
  { id: "error-format", label: "Error Format" },
62
133
  { id: "error-codes", label: "Error Codes" },
@@ -156,6 +227,13 @@ var API_SECTION_META = [
156
227
  { id: "sources", title: "Inputs API", description: "Manage document sources for programmatic ingestion. Each source has its own API key and supports batch processing." },
157
228
  { id: "filter-search", title: "Filter & Search API", description: "Field autocomplete, document filtering with composable conditions, global omnisearch, and saved filter management." },
158
229
  { id: "webhooks", title: "Webhooks", description: "Real-time event notifications with HMAC-SHA256 signed payloads, delivery tracking, and exponential backoff retries." },
230
+ { id: "resolutions", title: "Resolutions API", description: "Resolution runs \u2014 apply field normalization, transforms, and lookup cascades to extracted data. List, create, execute, and delete resolution runs." },
231
+ { id: "linking", title: "Linking API", description: "Document linking graph \u2014 link keys, document links, entity graph, classification, backfill operations, and document-case mapping." },
232
+ { id: "nshot", title: "N-Shot API", description: "N-Shot comparison endpoints for job runs \u2014 summary, field comparisons, overrides, and AI/human judge decisions." },
233
+ { id: "schema-graph", title: "Schema Graph API", description: "Schema class ontology \u2014 versioned classes, diffs with approval/rejection workflow, inter-class edges, aliases, and D3-compatible visualization." },
234
+ { id: "structuring", title: "Structuring API", description: "Validation checks CRUD, approval gates with configurable rules, result check outcomes, pending approvals queue, and delivery triggers." },
235
+ { id: "validation", title: "Validation API", description: "Golden sample management and validation runs for measuring extraction accuracy against ground truth datasets." },
236
+ { id: "credits", title: "Credits API", description: "Credit balance, transaction history, aggregate usage summaries, daily usage breakdown, and per-request usage log." },
159
237
  { id: "errors-rate-limits", title: "Errors & Rate Limits", description: "Error response format, error codes, rate limit tiers by plan, and rate limit headers." }
160
238
  ];
161
239
  var PLATFORM_SECTION_META = [
@@ -272,6 +350,265 @@ var OPENAPI_SPEC = {
272
350
  "/v1/sources/{id}/documents": {
273
351
  get: { operationId: "listSourceDocuments", summary: "List documents in a source", tags: ["Sources"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Paginated documents" } } },
274
352
  post: { operationId: "ingestDocument", summary: "Ingest a document into a source", tags: ["Sources"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Ingested document" } } }
353
+ },
354
+ // Resolutions
355
+ "/v1/resolutions": {
356
+ get: { operationId: "listResolutions", summary: "List resolution runs", tags: ["Resolutions"], responses: { "200": { description: "Paginated list of resolution runs" } } },
357
+ post: { operationId: "createResolution", summary: "Create a resolution run", tags: ["Resolutions"], responses: { "201": { description: "Resolution run created" } } }
358
+ },
359
+ "/v1/resolutions/{id}": {
360
+ get: { operationId: "getResolution", summary: "Get a resolution run", tags: ["Resolutions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Resolution run detail" } } },
361
+ delete: { operationId: "deleteResolution", summary: "Delete a resolution run", tags: ["Resolutions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Resolution run deleted" } } }
362
+ },
363
+ "/v1/resolutions/{id}/results": {
364
+ get: { operationId: "getResolutionResults", summary: "Get resolution run results", tags: ["Resolutions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Resolution results" } } }
365
+ },
366
+ "/v1/resolutions/{id}/execute": {
367
+ post: { operationId: "executeResolution", summary: "Execute a resolution run", tags: ["Resolutions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Resolution execution started" } } }
368
+ },
369
+ // Linking
370
+ "/v1/linking/link-keys": {
371
+ get: { operationId: "listLinkKeys", summary: "List link keys", tags: ["Linking"], responses: { "200": { description: "List of link keys" } } }
372
+ },
373
+ "/v1/linking/documents/{id}/links": {
374
+ get: { operationId: "getDocumentLinks", summary: "Get links for a document", tags: ["Linking"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Document links" } } }
375
+ },
376
+ "/v1/linking/graph": {
377
+ get: { operationId: "getLinkingGraph", summary: "Get the full linking graph", tags: ["Linking"], responses: { "200": { description: "Full linking graph" } } }
378
+ },
379
+ "/v1/linking/graph/documents/{id}": {
380
+ get: { operationId: "getDocumentGraph", summary: "Get graph neighbourhood for a document", tags: ["Linking"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Document-centric subgraph" } } }
381
+ },
382
+ "/v1/linking/classify": {
383
+ post: { operationId: "classifyLinkKeys", summary: "Classify link keys", tags: ["Linking"], responses: { "200": { description: "Classification results" } } }
384
+ },
385
+ "/v1/linking/backfill": {
386
+ post: { operationId: "backfillLinking", summary: "Backfill linking data", tags: ["Linking"], responses: { "202": { description: "Backfill started" } } }
387
+ },
388
+ "/v1/linking/backfill/progress": {
389
+ get: { operationId: "getBackfillProgress", summary: "Get backfill progress", tags: ["Linking"], responses: { "200": { description: "Backfill progress" } } }
390
+ },
391
+ "/v1/linking/document-case-map": {
392
+ get: { operationId: "getDocumentCaseMap", summary: "Get document-to-case mapping", tags: ["Linking"], responses: { "200": { description: "Document-case mapping" } } }
393
+ },
394
+ // N-Shot
395
+ "/v1/jobs/runs/{runId}/nshot/summary": {
396
+ get: { operationId: "getNshotSummary", summary: "Get N-Shot summary for a run", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "N-Shot summary" } } }
397
+ },
398
+ "/v1/jobs/runs/{runId}/nshot/comparisons": {
399
+ get: { operationId: "listNshotComparisons", summary: "List N-Shot comparisons", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "List of comparisons" } } }
400
+ },
401
+ "/v1/jobs/runs/{runId}/nshot/comparison": {
402
+ get: { operationId: "getNshotComparison", summary: "Get a specific N-Shot comparison", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Single comparison result" } } }
403
+ },
404
+ "/v1/jobs/runs/{runId}/nshot/override": {
405
+ post: { operationId: "nshotOverride", summary: "Override an N-Shot value", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Override applied" } } }
406
+ },
407
+ "/v1/jobs/runs/{runId}/nshot/judge-decision": {
408
+ post: { operationId: "nshotJudgeDecision", summary: "Submit a judge decision for N-Shot", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Judge decision recorded" } } }
409
+ },
410
+ // Schema Graph
411
+ "/v1/schema-graph/classes": {
412
+ get: { operationId: "listSchemaGraphClasses", summary: "List schema graph classes", tags: ["Schema Graph"], responses: { "200": { description: "List of schema graph classes" } } }
413
+ },
414
+ "/v1/schema-graph/classes/{id}": {
415
+ get: { operationId: "getSchemaGraphClass", summary: "Get a schema graph class", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Schema graph class detail" } } }
416
+ },
417
+ "/v1/schema-graph/classes/{id}/versions": {
418
+ get: { operationId: "listSchemaGraphClassVersions", summary: "List versions of a schema graph class", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "List of class versions" } } }
419
+ },
420
+ "/v1/schema-graph/classes/{id}/versions/{version}": {
421
+ get: { operationId: "getSchemaGraphClassVersion", summary: "Get a specific class version", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }, { name: "version", in: "path", required: true, schema: { type: "integer" } }], responses: { "200": { description: "Class version detail" } } }
422
+ },
423
+ "/v1/schema-graph/diffs": {
424
+ get: { operationId: "listSchemaGraphDiffs", summary: "List schema graph diffs", tags: ["Schema Graph"], responses: { "200": { description: "List of diffs" } } }
425
+ },
426
+ "/v1/schema-graph/diffs/{id}/approve": {
427
+ post: { operationId: "approveSchemaGraphDiff", summary: "Approve a schema graph diff", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Diff approved" } } }
428
+ },
429
+ "/v1/schema-graph/diffs/{id}/reject": {
430
+ post: { operationId: "rejectSchemaGraphDiff", summary: "Reject a schema graph diff", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Diff rejected" } } }
431
+ },
432
+ "/v1/schema-graph/edges": {
433
+ get: { operationId: "listSchemaGraphEdges", summary: "List schema graph edges", tags: ["Schema Graph"], responses: { "200": { description: "List of edges" } } }
434
+ },
435
+ "/v1/schema-graph/aliases": {
436
+ get: { operationId: "listSchemaGraphAliases", summary: "List schema graph aliases", tags: ["Schema Graph"], responses: { "200": { description: "List of aliases" } } }
437
+ },
438
+ "/v1/schema-graph/visualize": {
439
+ get: { operationId: "visualizeSchemaGraph", summary: "Get schema graph visualization data", tags: ["Schema Graph"], responses: { "200": { description: "Visualization data" } } }
440
+ },
441
+ // Structuring
442
+ "/v1/structuring/checks": {
443
+ get: { operationId: "listStructuringChecks", summary: "List structuring checks", tags: ["Structuring"], responses: { "200": { description: "Paginated list of structuring checks" } } },
444
+ post: { operationId: "createStructuringCheck", summary: "Create a structuring check", tags: ["Structuring"], responses: { "201": { description: "Structuring check created" } } }
445
+ },
446
+ "/v1/structuring/checks/{id}": {
447
+ get: { operationId: "getStructuringCheck", summary: "Get a structuring check", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Structuring check detail" } } },
448
+ put: { operationId: "updateStructuringCheck", summary: "Update a structuring check", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Structuring check updated" } } },
449
+ delete: { operationId: "deleteStructuringCheck", summary: "Delete a structuring check", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Structuring check deleted" } } }
450
+ },
451
+ "/v1/structuring/gates": {
452
+ get: { operationId: "listStructuringGates", summary: "List approval gates", tags: ["Structuring"], responses: { "200": { description: "Paginated list of approval gates" } } },
453
+ post: { operationId: "createStructuringGate", summary: "Create an approval gate", tags: ["Structuring"], responses: { "201": { description: "Approval gate created" } } }
454
+ },
455
+ "/v1/structuring/gates/{id}": {
456
+ get: { operationId: "getStructuringGate", summary: "Get an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Approval gate detail" } } },
457
+ put: { operationId: "updateStructuringGate", summary: "Update an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Approval gate updated" } } },
458
+ delete: { operationId: "deleteStructuringGate", summary: "Delete an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Approval gate deleted" } } }
459
+ },
460
+ "/v1/structuring/gates/{id}/rules": {
461
+ post: { operationId: "addStructuringGateRule", summary: "Add a rule to an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "201": { description: "Rule added" } } },
462
+ delete: { operationId: "deleteStructuringGateRule", summary: "Remove a rule from an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Rule removed" } } }
463
+ },
464
+ "/v1/structuring/results/{id}/checks": {
465
+ get: { operationId: "getStructuringResultChecks", summary: "Get check results for a structuring result", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Check results" } } }
466
+ },
467
+ "/v1/structuring/approvals/pending": {
468
+ get: { operationId: "listPendingApprovals", summary: "List pending approvals", tags: ["Structuring"], responses: { "200": { description: "Paginated list of pending approvals" } } }
469
+ },
470
+ "/v1/structuring/approvals/{id}/approve": {
471
+ post: { operationId: "approveStructuringResult", summary: "Approve a structuring result", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Result approved" } } }
472
+ },
473
+ "/v1/structuring/approvals/{id}/reject": {
474
+ post: { operationId: "rejectStructuringResult", summary: "Reject a structuring result", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Result rejected" } } }
475
+ },
476
+ "/v1/structuring/delivery/{runId}": {
477
+ post: { operationId: "triggerStructuringDelivery", summary: "Trigger delivery for a structuring run", tags: ["Structuring"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Delivery triggered" } } }
478
+ },
479
+ // Telemetry
480
+ "/v1/telemetry/schemas/{id}/summary": {
481
+ get: { operationId: "getTelemetrySchemaSummary", summary: "Get telemetry summary for a schema", tags: ["Telemetry"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Schema telemetry summary" } } }
482
+ },
483
+ "/v1/telemetry/schemas/{id}/trend": {
484
+ get: { operationId: "getTelemetrySchemaTrend", summary: "Get telemetry trend for a schema", tags: ["Telemetry"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Schema telemetry trend" } } }
485
+ },
486
+ "/v1/telemetry/schemas/{id}/fields": {
487
+ get: { operationId: "getTelemetrySchemaFields", summary: "Get per-field telemetry for a schema", tags: ["Telemetry"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Per-field telemetry" } } }
488
+ },
489
+ "/v1/telemetry/runs/{id}/summary": {
490
+ get: { operationId: "getTelemetryRunSummary", summary: "Get telemetry summary for a run", tags: ["Telemetry"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Run telemetry summary" } } }
491
+ },
492
+ // Validation
493
+ "/v1/validation/golden-samples": {
494
+ get: { operationId: "listGoldenSamples", summary: "List golden samples", tags: ["Validation"], responses: { "200": { description: "Paginated list of golden samples" } } }
495
+ },
496
+ "/v1/validation/golden-samples/{id}": {
497
+ get: { operationId: "getGoldenSample", summary: "Get a golden sample", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Golden sample detail" } } },
498
+ delete: { operationId: "deleteGoldenSample", summary: "Delete a golden sample", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Golden sample deleted" } } }
499
+ },
500
+ "/v1/validation/runs": {
501
+ get: { operationId: "listValidationRuns", summary: "List validation runs", tags: ["Validation"], responses: { "200": { description: "Paginated list of validation runs" } } },
502
+ post: { operationId: "createValidationRun", summary: "Create a validation run", tags: ["Validation"], responses: { "201": { description: "Validation run created" } } }
503
+ },
504
+ "/v1/validation/runs/{id}": {
505
+ get: { operationId: "getValidationRun", summary: "Get a validation run", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Validation run detail" } } },
506
+ delete: { operationId: "deleteValidationRun", summary: "Delete a validation run", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Validation run deleted" } } }
507
+ },
508
+ "/v1/validation/runs/{id}/results": {
509
+ get: { operationId: "getValidationRunResults", summary: "Get validation run results", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Validation run results" } } }
510
+ },
511
+ // Credits
512
+ "/v1/credits/balance": {
513
+ get: { operationId: "getCreditsBalance", summary: "Get credit balance", tags: ["Credits"], responses: { "200": { description: "Credit balance" } } }
514
+ },
515
+ "/v1/credits/history": {
516
+ get: { operationId: "getCreditsHistory", summary: "Get credit history", tags: ["Credits"], responses: { "200": { description: "Paginated credit history" } } }
517
+ },
518
+ "/v1/credits/usage": {
519
+ get: { operationId: "getCreditsUsage", summary: "Get credit usage summary", tags: ["Credits"], responses: { "200": { description: "Credit usage summary" } } }
520
+ },
521
+ "/v1/credits/usage/daily": {
522
+ get: { operationId: "getCreditsUsageDaily", summary: "Get daily credit usage", tags: ["Credits"], responses: { "200": { description: "Daily credit usage" } } }
523
+ },
524
+ "/v1/credits/usage/log": {
525
+ get: { operationId: "getCreditsUsageLog", summary: "Get credit usage log", tags: ["Credits"], responses: { "200": { description: "Paginated usage log" } } }
526
+ },
527
+ // Expanded: Cases
528
+ "/v1/cases/{key}/status": {
529
+ patch: { operationId: "updateCaseStatus", summary: "Update case status", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Case status updated" } } }
530
+ },
531
+ "/v1/cases/{key}/edges": {
532
+ get: { operationId: "getCaseEdges", summary: "Get case edges", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Case edges" } } }
533
+ },
534
+ "/v1/cases/edges/confirm": {
535
+ post: { operationId: "confirmCaseEdge", summary: "Confirm a case edge", tags: ["Cases"], responses: { "200": { description: "Edge confirmed" } } }
536
+ },
537
+ "/v1/cases/edges/reject": {
538
+ post: { operationId: "rejectCaseEdge", summary: "Reject a case edge", tags: ["Cases"], responses: { "200": { description: "Edge rejected" } } }
539
+ },
540
+ "/v1/cases/{key}/split": {
541
+ post: { operationId: "splitCase", summary: "Split a case", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Case split" } } }
542
+ },
543
+ "/v1/cases/{key}/merge": {
544
+ post: { operationId: "mergeCases", summary: "Merge cases", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Cases merged" } } }
545
+ },
546
+ "/v1/cases/{key}/completeness": {
547
+ get: { operationId: "getCaseCompleteness", summary: "Get case completeness", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Completeness assessment" } } }
548
+ },
549
+ "/v1/cases/{key}/pin": {
550
+ post: { operationId: "pinCaseDocuments", summary: "Pin documents to a case", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Documents pinned" } } }
551
+ },
552
+ "/v1/cases/{key}/documents": {
553
+ delete: { operationId: "removeCaseDocuments", summary: "Remove documents from a case", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Documents removed" } } }
554
+ },
555
+ // Expanded: Batches
556
+ "/v1/batches/{id}/sync": {
557
+ post: { operationId: "syncBatch", summary: "Sync batch status with provider", tags: ["Batches"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Batch synced" } } }
558
+ },
559
+ "/v1/batches/{id}/cancel": {
560
+ post: { operationId: "cancelBatch", summary: "Cancel a batch inference run", tags: ["Batches"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Batch cancelled" } } }
561
+ },
562
+ // Expanded: Matching
563
+ "/v1/matching/smart-run": {
564
+ post: { operationId: "triggerSmartMatchingRun", summary: "Trigger a smart matching run", tags: ["Matching"], responses: { "201": { description: "Smart matching run queued" } } }
565
+ },
566
+ "/v1/matching/ai-resolve": {
567
+ post: { operationId: "aiResolveMatching", summary: "AI-resolve ambiguous matches", tags: ["Matching"], responses: { "200": { description: "AI resolution results" } } }
568
+ },
569
+ "/v1/matching/strategies": {
570
+ get: { operationId: "listMatchingStrategies", summary: "List matching strategies", tags: ["Matching"], responses: { "200": { description: "List of matching strategies" } } },
571
+ post: { operationId: "createMatchingStrategy", summary: "Create a matching strategy", tags: ["Matching"], responses: { "201": { description: "Matching strategy created" } } }
572
+ },
573
+ "/v1/matching/strategies/{id}": {
574
+ get: { operationId: "getMatchingStrategy", summary: "Get a matching strategy", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching strategy detail" } } },
575
+ put: { operationId: "updateMatchingStrategy", summary: "Update a matching strategy", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching strategy updated" } } },
576
+ delete: { operationId: "deleteMatchingStrategy", summary: "Delete a matching strategy", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching strategy deleted" } } }
577
+ },
578
+ "/v1/matching/runs/{id}/results": {
579
+ get: { operationId: "getMatchingRunResults", summary: "Get matching run results", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching run results" } } }
580
+ },
581
+ "/v1/matching/runs/{id}/progress": {
582
+ get: { operationId: "getMatchingRunProgress", summary: "Get matching run progress", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching run progress" } } }
583
+ },
584
+ "/v1/matching/review": {
585
+ post: { operationId: "submitMatchingReview", summary: "Submit matching review decisions", tags: ["Matching"], responses: { "200": { description: "Review decisions applied" } } }
586
+ },
587
+ // Expanded: Review
588
+ "/v1/review/assign": {
589
+ post: { operationId: "assignReview", summary: "Assign review records", tags: ["Review"], responses: { "200": { description: "Records assigned" } } }
590
+ },
591
+ "/v1/review/stats": {
592
+ get: { operationId: "getReviewStats", summary: "Get review queue statistics", tags: ["Review"], responses: { "200": { description: "Review statistics" } } }
593
+ },
594
+ // Expanded: Quality
595
+ "/v1/quality/ground-truth/{id}/entries": {
596
+ get: { operationId: "listGroundTruthEntries", summary: "List ground truth entries", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Paginated list of entries" } } },
597
+ post: { operationId: "createGroundTruthEntry", summary: "Add a ground truth entry", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "201": { description: "Entry created" } } }
598
+ },
599
+ "/v1/quality/ground-truth/{id}/entries/{entryId}": {
600
+ put: { operationId: "updateGroundTruthEntry", summary: "Update a ground truth entry", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }, { name: "entryId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Entry updated" } } },
601
+ delete: { operationId: "deleteGroundTruthEntry", summary: "Delete a ground truth entry", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }, { name: "entryId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Entry deleted" } } }
602
+ },
603
+ "/v1/quality/benchmarks/{id}/results": {
604
+ get: { operationId: "getBenchmarkResults", summary: "Get benchmark results", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Benchmark results" } } }
605
+ },
606
+ "/v1/quality/benchmarks/{id}/compare": {
607
+ get: { operationId: "compareBenchmarks", summary: "Compare two benchmark runs", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Benchmark comparison" } } }
608
+ },
609
+ // Expanded: Reference Data
610
+ "/v1/reference-data/create": {
611
+ post: { operationId: "createReferenceDataJson", summary: "Create reference data from JSON", tags: ["Reference Data"], responses: { "201": { description: "Reference dataset created" } } }
275
612
  }
276
613
  }
277
614
  };
@@ -401,9 +738,22 @@ Key endpoints:
401
738
  - GET /v1/documents \u2014 List with cursor pagination; GET /v1/documents/:id/markdown for OCR text
402
739
  - GET /v1/extractions \u2014 Query results and field corrections
403
740
  - POST /v1/schemas \u2014 Create/manage extraction schemas
404
- - GET /v1/jobs \u2014 Track async jobs and results
741
+ - GET /v1/jobs \u2014 Track async jobs and results; N-Shot comparisons, overrides, judge decisions
405
742
  - POST /v1/sources \u2014 Manage API sources and document ingest
406
743
  - POST /v1/webhooks \u2014 Configure webhook endpoints
744
+ - /v1/resolutions \u2014 Resolution runs: list, create, get, execute, delete, results
745
+ - /v1/linking \u2014 Link keys, document links, entity graph, classify, backfill, document-case map
746
+ - /v1/schema-graph \u2014 Schema classes, versions, diffs (approve/reject), edges, aliases, visualize
747
+ - /v1/structuring \u2014 Validation checks CRUD, approval gates CRUD with rules, result checks, pending approvals, approve/reject, delivery trigger
748
+ - /v1/telemetry \u2014 Per-schema and per-run summaries, trends, field-level breakdowns
749
+ - /v1/validation \u2014 Golden samples (list, get, delete), validation runs (list, create, get, delete, results)
750
+ - /v1/credits \u2014 Balance, history, usage summary, daily usage, per-request usage log
751
+ - /v1/cases \u2014 Status updates, edges, edge confirm/reject, split/merge, completeness, pin/remove documents
752
+ - /v1/batches \u2014 Sync with provider, cancel
753
+ - /v1/matching \u2014 Smart run, AI resolve, strategies CRUD, run results/progress, review
754
+ - /v1/review \u2014 Assign, stats
755
+ - /v1/quality \u2014 Ground truth entries CRUD, benchmark results, benchmark comparison
756
+ - /v1/reference-data \u2014 JSON upload (POST create)
407
757
 
408
758
  Webhook events: extraction.completed, job.completed, export.completed, validation.completed. All HMAC-SHA256 signed with retry on failure.
409
759
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@talonic/docs",
3
- "version": "0.7.1",
3
+ "version": "0.8.0",
4
4
  "description": "Talonic documentation components — API Reference & Platform Guide",
5
5
  "license": "UNLICENSED",
6
6
  "private": false,