@talonic/docs 0.16.0 → 0.17.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/index.js +1127 -208
- package/dist/index.js.map +1 -1
- package/dist/seo.js +21 -26
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -568,7 +568,16 @@ var NAV_SECTIONS = [
|
|
|
568
568
|
label: "Cases",
|
|
569
569
|
children: [
|
|
570
570
|
{ id: "list-cases", label: "List Cases" },
|
|
571
|
-
{ id: "get-case", label: "Get Case" }
|
|
571
|
+
{ id: "get-case", label: "Get Case" },
|
|
572
|
+
{ id: "update-case-status", label: "Update Status" },
|
|
573
|
+
{ id: "case-edges", label: "Edges" },
|
|
574
|
+
{ id: "confirm-case-edge", label: "Confirm Edge" },
|
|
575
|
+
{ id: "reject-case-edge", label: "Reject Edge" },
|
|
576
|
+
{ id: "split-case", label: "Split Case" },
|
|
577
|
+
{ id: "merge-cases", label: "Merge Cases" },
|
|
578
|
+
{ id: "case-completeness", label: "Completeness" },
|
|
579
|
+
{ id: "pin-case-document", label: "Pin Documents" },
|
|
580
|
+
{ id: "unpin-case-document", label: "Remove Documents" }
|
|
572
581
|
]
|
|
573
582
|
},
|
|
574
583
|
{
|
|
@@ -614,15 +623,20 @@ var NAV_SECTIONS = [
|
|
|
614
623
|
children: [
|
|
615
624
|
{ id: "list-review", label: "List Queue" },
|
|
616
625
|
{ id: "review-action", label: "Take Action" },
|
|
617
|
-
{ id: "review-batch", label: "Batch Action" }
|
|
626
|
+
{ id: "review-batch", label: "Batch Action" },
|
|
627
|
+
{ id: "review-stats", label: "Stats" },
|
|
628
|
+
{ id: "review-assign", label: "Assign" }
|
|
618
629
|
]
|
|
619
630
|
},
|
|
620
631
|
{
|
|
621
632
|
id: "quality",
|
|
622
633
|
label: "Quality",
|
|
623
634
|
children: [
|
|
624
|
-
{ id: "list-ground-truth", label: "Ground Truth" },
|
|
625
|
-
{ id: "list-benchmarks", label: "Benchmarks" }
|
|
635
|
+
{ id: "list-quality-ground-truth", label: "Ground Truth" },
|
|
636
|
+
{ id: "list-benchmarks", label: "Benchmarks" },
|
|
637
|
+
{ id: "add-ground-truth-entry", label: "Add Ground-Truth Entry" },
|
|
638
|
+
{ id: "delete-ground-truth-entry", label: "Delete Ground-Truth Entry" },
|
|
639
|
+
{ id: "benchmark-results", label: "Benchmark Results" }
|
|
626
640
|
]
|
|
627
641
|
},
|
|
628
642
|
{
|
|
@@ -635,7 +649,15 @@ var NAV_SECTIONS = [
|
|
|
635
649
|
{ id: "delete-matching-config", label: "Delete Config" },
|
|
636
650
|
{ id: "run-matching", label: "Run Matching" },
|
|
637
651
|
{ id: "list-matching-runs", label: "List Runs" },
|
|
638
|
-
{ id: "cancel-matching-run", label: "Cancel Run" }
|
|
652
|
+
{ id: "cancel-matching-run", label: "Cancel Run" },
|
|
653
|
+
{ id: "smart-run", label: "Smart Run" },
|
|
654
|
+
{ id: "ai-resolve", label: "AI Resolve" },
|
|
655
|
+
{ id: "generate-strategy", label: "Create Strategy" },
|
|
656
|
+
{ id: "get-strategy", label: "Get Strategy" },
|
|
657
|
+
{ id: "update-strategy", label: "Update Strategy" },
|
|
658
|
+
{ id: "match-results", label: "Run Results" },
|
|
659
|
+
{ id: "match-progress", label: "Run Progress" },
|
|
660
|
+
{ id: "review-match", label: "Submit Review" }
|
|
639
661
|
]
|
|
640
662
|
},
|
|
641
663
|
{
|
|
@@ -643,7 +665,9 @@ var NAV_SECTIONS = [
|
|
|
643
665
|
label: "Batches",
|
|
644
666
|
children: [
|
|
645
667
|
{ id: "list-batches", label: "List Batches" },
|
|
646
|
-
{ id: "get-batch", label: "Get Batch" }
|
|
668
|
+
{ id: "get-batch", label: "Get Batch" },
|
|
669
|
+
{ id: "batch-sync", label: "Sync Status" },
|
|
670
|
+
{ id: "batch-cancel", label: "Cancel Batch" }
|
|
647
671
|
]
|
|
648
672
|
},
|
|
649
673
|
{
|
|
@@ -685,6 +709,109 @@ var NAV_SECTIONS = [
|
|
|
685
709
|
{ id: "webhook-retries", label: "Retry Policy" }
|
|
686
710
|
]
|
|
687
711
|
},
|
|
712
|
+
{
|
|
713
|
+
id: "resolutions",
|
|
714
|
+
label: "Resolutions",
|
|
715
|
+
children: [
|
|
716
|
+
{ id: "list-resolutions", label: "List Resolutions" },
|
|
717
|
+
{ id: "create-resolution", label: "Create Resolution" },
|
|
718
|
+
{ id: "get-resolution", label: "Get Resolution" },
|
|
719
|
+
{ id: "get-resolution-results", label: "Get Results" },
|
|
720
|
+
{ id: "execute-resolution", label: "Execute Resolution" },
|
|
721
|
+
{ id: "delete-resolution", label: "Delete Resolution" }
|
|
722
|
+
]
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
id: "linking",
|
|
726
|
+
label: "Linking",
|
|
727
|
+
children: [
|
|
728
|
+
{ id: "list-link-keys", label: "Link Keys" },
|
|
729
|
+
{ id: "get-document-links", label: "Document Links" },
|
|
730
|
+
{ id: "get-linking-graph", label: "Full Graph" },
|
|
731
|
+
{ id: "get-document-graph", label: "Document Graph" },
|
|
732
|
+
{ id: "classify-link-keys", label: "Classify" },
|
|
733
|
+
{ id: "backfill-linking", label: "Backfill" },
|
|
734
|
+
{ id: "backfill-progress", label: "Backfill Progress" },
|
|
735
|
+
{ id: "document-case-map", label: "Document-Case Map" }
|
|
736
|
+
]
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
id: "nshot",
|
|
740
|
+
label: "N-Shot",
|
|
741
|
+
children: [
|
|
742
|
+
{ id: "nshot-summary", label: "Summary" },
|
|
743
|
+
{ id: "nshot-comparisons", label: "Comparisons" },
|
|
744
|
+
{ id: "nshot-comparison", label: "Single Comparison" },
|
|
745
|
+
{ id: "nshot-override", label: "Override" },
|
|
746
|
+
{ id: "nshot-judge-decision", label: "Judge Decision" }
|
|
747
|
+
]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "schema-graph",
|
|
751
|
+
label: "Schema Graph",
|
|
752
|
+
children: [
|
|
753
|
+
{ id: "list-schema-graph-classes", label: "List Classes" },
|
|
754
|
+
{ id: "get-schema-graph-class", label: "Get Class" },
|
|
755
|
+
{ id: "list-class-versions", label: "List Versions" },
|
|
756
|
+
{ id: "get-class-version", label: "Get Version" },
|
|
757
|
+
{ id: "list-schema-graph-diffs", label: "List Diffs" },
|
|
758
|
+
{ id: "approve-diff", label: "Approve Diff" },
|
|
759
|
+
{ id: "reject-diff", label: "Reject Diff" },
|
|
760
|
+
{ id: "list-schema-graph-edges", label: "Edges" },
|
|
761
|
+
{ id: "list-schema-graph-aliases", label: "Aliases" },
|
|
762
|
+
{ id: "visualize-schema-graph", label: "Visualize" }
|
|
763
|
+
]
|
|
764
|
+
},
|
|
765
|
+
{
|
|
766
|
+
id: "structuring",
|
|
767
|
+
label: "Structuring",
|
|
768
|
+
children: [
|
|
769
|
+
{ id: "list-structuring-checks", label: "List Checks" },
|
|
770
|
+
{ id: "create-structuring-check", label: "Create Check" },
|
|
771
|
+
{ id: "get-structuring-check", label: "Get / Update / Delete Check" },
|
|
772
|
+
{ id: "list-structuring-gates", label: "List Gates" },
|
|
773
|
+
{ id: "create-structuring-gate", label: "Create Gate" },
|
|
774
|
+
{ id: "get-structuring-gate", label: "Get / Update / Delete Gate" },
|
|
775
|
+
{ id: "gate-rules", label: "Gate Rules" },
|
|
776
|
+
{ id: "result-checks", label: "Result Checks" },
|
|
777
|
+
{ id: "pending-approvals", label: "Pending Approvals" },
|
|
778
|
+
{ id: "approve-reject-result", label: "Approve / Reject Result" },
|
|
779
|
+
{ id: "trigger-delivery", label: "Trigger Delivery" }
|
|
780
|
+
]
|
|
781
|
+
},
|
|
782
|
+
{
|
|
783
|
+
id: "telemetry",
|
|
784
|
+
label: "Telemetry",
|
|
785
|
+
children: [
|
|
786
|
+
{ id: "schema-telemetry-summary", label: "Schema Summary" },
|
|
787
|
+
{ id: "schema-telemetry-trend", label: "Schema Trend" },
|
|
788
|
+
{ id: "schema-telemetry-fields", label: "Schema Fields" },
|
|
789
|
+
{ id: "run-telemetry-summary", label: "Run Summary" }
|
|
790
|
+
]
|
|
791
|
+
},
|
|
792
|
+
{
|
|
793
|
+
id: "validation",
|
|
794
|
+
label: "Validation",
|
|
795
|
+
children: [
|
|
796
|
+
{ id: "list-ground-truth", label: "List Ground-Truth Datasets" },
|
|
797
|
+
{ id: "get-ground-truth", label: "Get / Delete Ground-Truth Dataset" },
|
|
798
|
+
{ id: "list-validation-runs", label: "List Validation Runs" },
|
|
799
|
+
{ id: "create-validation-run", label: "Create Validation Run" },
|
|
800
|
+
{ id: "get-validation-run", label: "Get / Delete Validation Run" },
|
|
801
|
+
{ id: "get-validation-results", label: "Validation Results" }
|
|
802
|
+
]
|
|
803
|
+
},
|
|
804
|
+
{
|
|
805
|
+
id: "credits",
|
|
806
|
+
label: "Credits",
|
|
807
|
+
children: [
|
|
808
|
+
{ id: "credits-balance", label: "Balance" },
|
|
809
|
+
{ id: "credits-history", label: "History" },
|
|
810
|
+
{ id: "credits-usage", label: "Usage Summary" },
|
|
811
|
+
{ id: "credits-usage-daily", label: "Daily Usage" },
|
|
812
|
+
{ id: "credits-usage-log", label: "Usage Log" }
|
|
813
|
+
]
|
|
814
|
+
},
|
|
688
815
|
{
|
|
689
816
|
id: "agent",
|
|
690
817
|
label: "Agent",
|
|
@@ -2209,6 +2336,168 @@ function ApiReference({ LinkComponent }) {
|
|
|
2209
2336
|
}` })
|
|
2210
2337
|
}
|
|
2211
2338
|
) }),
|
|
2339
|
+
/* @__PURE__ */ jsx5("div", { id: "update-case-status", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
2340
|
+
EndpointBlock,
|
|
2341
|
+
{
|
|
2342
|
+
method: "PATCH",
|
|
2343
|
+
path: "/v1/cases/{key}/status",
|
|
2344
|
+
summary: "Update case status.",
|
|
2345
|
+
children: /* @__PURE__ */ jsx5(
|
|
2346
|
+
ParamTable,
|
|
2347
|
+
{
|
|
2348
|
+
title: "Body parameters",
|
|
2349
|
+
params: [
|
|
2350
|
+
{ name: "status", type: "string", required: true, description: "New status (e.g. open, in_review, resolved, archived)." }
|
|
2351
|
+
]
|
|
2352
|
+
}
|
|
2353
|
+
)
|
|
2354
|
+
}
|
|
2355
|
+
) }),
|
|
2356
|
+
/* @__PURE__ */ jsx5("div", { id: "case-edges", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
2357
|
+
EndpointBlock,
|
|
2358
|
+
{
|
|
2359
|
+
method: "GET",
|
|
2360
|
+
path: "/v1/cases/{key}/edges",
|
|
2361
|
+
summary: "Get case edges.",
|
|
2362
|
+
description: "Returns the entity edges (evidence chain) connecting documents within the case.",
|
|
2363
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
2364
|
+
"data": [
|
|
2365
|
+
{
|
|
2366
|
+
"source_document_id": "uuid",
|
|
2367
|
+
"target_document_id": "uuid",
|
|
2368
|
+
"entity_value": "string",
|
|
2369
|
+
"entity_type": "string",
|
|
2370
|
+
"confidence": 0.92
|
|
2371
|
+
}
|
|
2372
|
+
]
|
|
2373
|
+
}` })
|
|
2374
|
+
}
|
|
2375
|
+
) }),
|
|
2376
|
+
/* @__PURE__ */ jsx5("div", { id: "confirm-case-edge", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
2377
|
+
EndpointBlock,
|
|
2378
|
+
{
|
|
2379
|
+
method: "POST",
|
|
2380
|
+
path: "/v1/cases/{key}/edges/{edgeId}/confirm",
|
|
2381
|
+
summary: "Confirm a case edge.",
|
|
2382
|
+
description: "Confirm a proposed entity edge between documents in this case. No request body \u2014 both identifiers come from the path.",
|
|
2383
|
+
children: /* @__PURE__ */ jsx5(
|
|
2384
|
+
ParamTable,
|
|
2385
|
+
{
|
|
2386
|
+
title: "Path parameters",
|
|
2387
|
+
params: [
|
|
2388
|
+
{ name: "key", type: "string", required: true, description: "Case key." },
|
|
2389
|
+
{ name: "edgeId", type: "uuid", required: true, description: "Edge identifier from the case edges list." }
|
|
2390
|
+
]
|
|
2391
|
+
}
|
|
2392
|
+
)
|
|
2393
|
+
}
|
|
2394
|
+
) }),
|
|
2395
|
+
/* @__PURE__ */ jsx5("div", { id: "reject-case-edge", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
2396
|
+
EndpointBlock,
|
|
2397
|
+
{
|
|
2398
|
+
method: "POST",
|
|
2399
|
+
path: "/v1/cases/{key}/edges/{edgeId}/reject",
|
|
2400
|
+
summary: "Reject a case edge.",
|
|
2401
|
+
description: "Reject a proposed entity edge between documents in this case. No request body \u2014 both identifiers come from the path.",
|
|
2402
|
+
children: /* @__PURE__ */ jsx5(
|
|
2403
|
+
ParamTable,
|
|
2404
|
+
{
|
|
2405
|
+
title: "Path parameters",
|
|
2406
|
+
params: [
|
|
2407
|
+
{ name: "key", type: "string", required: true, description: "Case key." },
|
|
2408
|
+
{ name: "edgeId", type: "uuid", required: true, description: "Edge identifier from the case edges list." }
|
|
2409
|
+
]
|
|
2410
|
+
}
|
|
2411
|
+
)
|
|
2412
|
+
}
|
|
2413
|
+
) }),
|
|
2414
|
+
/* @__PURE__ */ jsx5("div", { id: "split-case", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
2415
|
+
EndpointBlock,
|
|
2416
|
+
{
|
|
2417
|
+
method: "POST",
|
|
2418
|
+
path: "/v1/cases/{key}/split",
|
|
2419
|
+
summary: "Split a case into two separate cases by partitioning its documents into two groups.",
|
|
2420
|
+
children: /* @__PURE__ */ jsx5(
|
|
2421
|
+
ParamTable,
|
|
2422
|
+
{
|
|
2423
|
+
title: "Body parameters",
|
|
2424
|
+
params: [
|
|
2425
|
+
{ name: "partition_a", type: "uuid[]", required: true, description: "Document IDs that stay in the original case." },
|
|
2426
|
+
{ name: "partition_b", type: "uuid[]", required: true, description: "Document IDs that move to the newly-created case." }
|
|
2427
|
+
]
|
|
2428
|
+
}
|
|
2429
|
+
)
|
|
2430
|
+
}
|
|
2431
|
+
) }),
|
|
2432
|
+
/* @__PURE__ */ jsx5("div", { id: "merge-cases", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
2433
|
+
EndpointBlock,
|
|
2434
|
+
{
|
|
2435
|
+
method: "POST",
|
|
2436
|
+
path: "/v1/cases/merge",
|
|
2437
|
+
summary: "Merge two cases by passing both case keys in the request body.",
|
|
2438
|
+
children: /* @__PURE__ */ jsx5(
|
|
2439
|
+
ParamTable,
|
|
2440
|
+
{
|
|
2441
|
+
title: "Body parameters",
|
|
2442
|
+
params: [
|
|
2443
|
+
{ name: "case_key_a", type: "string", required: true, description: "First case key \u2014 receives the merged documents." },
|
|
2444
|
+
{ name: "case_key_b", type: "string", required: true, description: "Second case key \u2014 its documents are folded into case A." }
|
|
2445
|
+
]
|
|
2446
|
+
}
|
|
2447
|
+
)
|
|
2448
|
+
}
|
|
2449
|
+
) }),
|
|
2450
|
+
/* @__PURE__ */ jsx5("div", { id: "case-completeness", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
2451
|
+
EndpointBlock,
|
|
2452
|
+
{
|
|
2453
|
+
method: "GET",
|
|
2454
|
+
path: "/v1/cases/{key}/completeness",
|
|
2455
|
+
summary: "Get case completeness.",
|
|
2456
|
+
description: "Returns a completeness assessment for the case (expected vs. present document types, missing fields).",
|
|
2457
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
2458
|
+
"completeness_score": 0.83,
|
|
2459
|
+
"expected_document_types": ["invoice", "purchase_order", "receipt"],
|
|
2460
|
+
"present_document_types": ["invoice", "purchase_order"],
|
|
2461
|
+
"missing_document_types": ["receipt"]
|
|
2462
|
+
}` })
|
|
2463
|
+
}
|
|
2464
|
+
) }),
|
|
2465
|
+
/* @__PURE__ */ jsx5("div", { id: "pin-case-document", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
2466
|
+
EndpointBlock,
|
|
2467
|
+
{
|
|
2468
|
+
method: "POST",
|
|
2469
|
+
path: "/v1/cases/{key}/documents/{docId}/pin",
|
|
2470
|
+
summary: "Manually pin a document to a case so it persists across re-clustering.",
|
|
2471
|
+
children: /* @__PURE__ */ jsx5(
|
|
2472
|
+
ParamTable,
|
|
2473
|
+
{
|
|
2474
|
+
title: "Path parameters",
|
|
2475
|
+
params: [
|
|
2476
|
+
{ name: "key", type: "string", required: true, description: "Case key." },
|
|
2477
|
+
{ name: "docId", type: "uuid", required: true, description: "Document identifier to pin." }
|
|
2478
|
+
]
|
|
2479
|
+
}
|
|
2480
|
+
)
|
|
2481
|
+
}
|
|
2482
|
+
) }),
|
|
2483
|
+
/* @__PURE__ */ jsx5("div", { id: "unpin-case-document", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
2484
|
+
EndpointBlock,
|
|
2485
|
+
{
|
|
2486
|
+
method: "DELETE",
|
|
2487
|
+
path: "/v1/cases/{key}/documents/{docId}",
|
|
2488
|
+
summary: "Remove a manually-pinned document from a case.",
|
|
2489
|
+
children: /* @__PURE__ */ jsx5(
|
|
2490
|
+
ParamTable,
|
|
2491
|
+
{
|
|
2492
|
+
title: "Path parameters",
|
|
2493
|
+
params: [
|
|
2494
|
+
{ name: "key", type: "string", required: true, description: "Case key." },
|
|
2495
|
+
{ name: "docId", type: "uuid", required: true, description: "Document identifier to remove." }
|
|
2496
|
+
]
|
|
2497
|
+
}
|
|
2498
|
+
)
|
|
2499
|
+
}
|
|
2500
|
+
) }),
|
|
2212
2501
|
/* @__PURE__ */ jsx5(SectionHeading, { id: "fields", children: "Fields" }),
|
|
2213
2502
|
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "The field registry is the knowledge graph of all discovered fields. Fields are semantically clustered and promoted through tiers as they appear across documents." }),
|
|
2214
2503
|
/* @__PURE__ */ jsx5("div", { id: "list-fields", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
@@ -2685,9 +2974,53 @@ function ApiReference({ LinkComponent }) {
|
|
|
2685
2974
|
]
|
|
2686
2975
|
}
|
|
2687
2976
|
) }),
|
|
2977
|
+
/* @__PURE__ */ jsx5("div", { id: "review-stats", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
2978
|
+
EndpointBlock,
|
|
2979
|
+
{
|
|
2980
|
+
method: "GET",
|
|
2981
|
+
path: "/v1/review/stats",
|
|
2982
|
+
summary: "Get review queue statistics.",
|
|
2983
|
+
description: "Returns aggregate statistics about the review queue (pending, approved, rejected counts).",
|
|
2984
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
2985
|
+
"pending": 23,
|
|
2986
|
+
"approved": 142,
|
|
2987
|
+
"rejected": 8,
|
|
2988
|
+
"total": 173
|
|
2989
|
+
}` })
|
|
2990
|
+
}
|
|
2991
|
+
) }),
|
|
2992
|
+
/* @__PURE__ */ jsx5("div", { id: "review-assign", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
2993
|
+
EndpointBlock,
|
|
2994
|
+
{
|
|
2995
|
+
method: "POST",
|
|
2996
|
+
path: "/v1/review/{id}/assign",
|
|
2997
|
+
summary: "Assign a review record to a user (or unassign with null).",
|
|
2998
|
+
description: "Set the assignee on a single review record. Pass user_id: null to unassign.",
|
|
2999
|
+
children: [
|
|
3000
|
+
/* @__PURE__ */ jsx5(
|
|
3001
|
+
ParamTable,
|
|
3002
|
+
{
|
|
3003
|
+
title: "Path parameters",
|
|
3004
|
+
params: [
|
|
3005
|
+
{ name: "id", type: "uuid", required: true, description: "Review record identifier." }
|
|
3006
|
+
]
|
|
3007
|
+
}
|
|
3008
|
+
),
|
|
3009
|
+
/* @__PURE__ */ jsx5(
|
|
3010
|
+
ParamTable,
|
|
3011
|
+
{
|
|
3012
|
+
title: "Body parameters",
|
|
3013
|
+
params: [
|
|
3014
|
+
{ name: "user_id", type: "uuid | null", required: true, description: "User ID of the assignee, or null to unassign." }
|
|
3015
|
+
]
|
|
3016
|
+
}
|
|
3017
|
+
)
|
|
3018
|
+
]
|
|
3019
|
+
}
|
|
3020
|
+
) }),
|
|
2688
3021
|
/* @__PURE__ */ jsx5(SectionHeading, { id: "quality", children: "Quality" }),
|
|
2689
3022
|
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "Manage ground truth datasets and benchmark extraction quality over time." }),
|
|
2690
|
-
/* @__PURE__ */ jsx5("div", { id: "list-ground-truth", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3023
|
+
/* @__PURE__ */ jsx5("div", { id: "list-quality-ground-truth", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
2691
3024
|
EndpointBlock,
|
|
2692
3025
|
{
|
|
2693
3026
|
method: "GET",
|
|
@@ -2724,6 +3057,63 @@ function ApiReference({ LinkComponent }) {
|
|
|
2724
3057
|
"run_at": "2024-09-10T00:00:00Z"
|
|
2725
3058
|
}
|
|
2726
3059
|
]
|
|
3060
|
+
}` })
|
|
3061
|
+
}
|
|
3062
|
+
) }),
|
|
3063
|
+
/* @__PURE__ */ jsx5("div", { id: "add-ground-truth-entry", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3064
|
+
EndpointBlock,
|
|
3065
|
+
{
|
|
3066
|
+
method: "POST",
|
|
3067
|
+
path: "/v1/quality/ground-truth/{datasetId}/entries",
|
|
3068
|
+
summary: "Add an entry to a ground truth dataset.",
|
|
3069
|
+
children: [
|
|
3070
|
+
/* @__PURE__ */ jsx5(
|
|
3071
|
+
ParamTable,
|
|
3072
|
+
{
|
|
3073
|
+
title: "Body parameters",
|
|
3074
|
+
params: [
|
|
3075
|
+
{ name: "document_id", type: "uuid", description: "Optional document associated with the entry." },
|
|
3076
|
+
{ name: "expected_data", type: "object", required: true, description: "The known-correct field values for this document." },
|
|
3077
|
+
{ name: "notes", type: "string", description: "Optional reviewer notes." }
|
|
3078
|
+
]
|
|
3079
|
+
}
|
|
3080
|
+
),
|
|
3081
|
+
/* @__PURE__ */ jsx5(CodeBlock, { title: "Response (201)", children: `{
|
|
3082
|
+
"id": "uuid",
|
|
3083
|
+
"document_id": "uuid",
|
|
3084
|
+
"expected_data": { "vendor_name": "Acme Corp", "total": 1234.56 },
|
|
3085
|
+
"notes": null,
|
|
3086
|
+
"created_at": "2024-09-14T10:32:00Z"
|
|
3087
|
+
}` })
|
|
3088
|
+
]
|
|
3089
|
+
}
|
|
3090
|
+
) }),
|
|
3091
|
+
/* @__PURE__ */ jsx5("div", { id: "delete-ground-truth-entry", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3092
|
+
EndpointBlock,
|
|
3093
|
+
{
|
|
3094
|
+
method: "DELETE",
|
|
3095
|
+
path: "/v1/quality/ground-truth/{datasetId}/entries/{entryId}",
|
|
3096
|
+
summary: "Delete a ground truth entry."
|
|
3097
|
+
}
|
|
3098
|
+
) }),
|
|
3099
|
+
/* @__PURE__ */ jsx5("div", { id: "benchmark-results", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3100
|
+
EndpointBlock,
|
|
3101
|
+
{
|
|
3102
|
+
method: "GET",
|
|
3103
|
+
path: "/v1/quality/benchmarks/{id}/results",
|
|
3104
|
+
summary: "Get benchmark results.",
|
|
3105
|
+
description: "Returns per-document accuracy results for a benchmark run.",
|
|
3106
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
3107
|
+
"data": [
|
|
3108
|
+
{
|
|
3109
|
+
"id": "uuid",
|
|
3110
|
+
"document_id": "uuid",
|
|
3111
|
+
"ground_truth_entry_id": "uuid",
|
|
3112
|
+
"accuracy": 0.94,
|
|
3113
|
+
"field_results": { "vendor_name": "pass", "total": "fail" },
|
|
3114
|
+
"created_at": "2024-09-10T00:00:00Z"
|
|
3115
|
+
}
|
|
3116
|
+
]
|
|
2727
3117
|
}` })
|
|
2728
3118
|
}
|
|
2729
3119
|
) }),
|
|
@@ -2874,55 +3264,219 @@ function ApiReference({ LinkComponent }) {
|
|
|
2874
3264
|
}` })
|
|
2875
3265
|
}
|
|
2876
3266
|
) }),
|
|
2877
|
-
/* @__PURE__ */ jsx5(
|
|
2878
|
-
/* @__PURE__ */ jsxs5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: [
|
|
2879
|
-
"Batch inference processes documents at 50% cost with up to 48-hour delivery. Upload documents with ",
|
|
2880
|
-
/* @__PURE__ */ jsx5(InlineCode, { children: "processing_mode=batch" }),
|
|
2881
|
-
" to use batch extraction."
|
|
2882
|
-
] }),
|
|
2883
|
-
/* @__PURE__ */ jsx5("div", { id: "list-batches", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3267
|
+
/* @__PURE__ */ jsx5("div", { id: "smart-run", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
2884
3268
|
EndpointBlock,
|
|
2885
3269
|
{
|
|
2886
|
-
method: "
|
|
2887
|
-
path: "/v1/
|
|
2888
|
-
summary: "
|
|
3270
|
+
method: "POST",
|
|
3271
|
+
path: "/v1/matching/configs/{id}/smart-run",
|
|
3272
|
+
summary: "Run a generated AI strategy against a matching config.",
|
|
3273
|
+
description: "Execute a previously-generated strategy on the documents scoped by the matching config. The strategy is generated separately via /v1/matching/strategies/generate.",
|
|
2889
3274
|
children: [
|
|
2890
3275
|
/* @__PURE__ */ jsx5(
|
|
2891
3276
|
ParamTable,
|
|
2892
3277
|
{
|
|
2893
|
-
title: "
|
|
3278
|
+
title: "Path parameters",
|
|
2894
3279
|
params: [
|
|
2895
|
-
{ name: "
|
|
2896
|
-
|
|
2897
|
-
|
|
3280
|
+
{ name: "id", type: "uuid", required: true, description: "Matching configuration identifier." }
|
|
3281
|
+
]
|
|
3282
|
+
}
|
|
3283
|
+
),
|
|
3284
|
+
/* @__PURE__ */ jsx5(
|
|
3285
|
+
ParamTable,
|
|
3286
|
+
{
|
|
3287
|
+
title: "Body parameters",
|
|
3288
|
+
params: [
|
|
3289
|
+
{ name: "strategy_id", type: "uuid", required: true, description: "Generated strategy to execute against this config." }
|
|
3290
|
+
]
|
|
3291
|
+
}
|
|
3292
|
+
)
|
|
3293
|
+
]
|
|
3294
|
+
}
|
|
3295
|
+
) }),
|
|
3296
|
+
/* @__PURE__ */ jsx5("div", { id: "ai-resolve", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3297
|
+
EndpointBlock,
|
|
3298
|
+
{
|
|
3299
|
+
method: "POST",
|
|
3300
|
+
path: "/v1/matching/runs/{id}/ai-resolve",
|
|
3301
|
+
summary: "AI-resolve a matching run's review band.",
|
|
3302
|
+
description: "Triggers AI-driven resolution on a completed run's review-band candidates. The run must already have an associated strategy; no request body.",
|
|
3303
|
+
children: [
|
|
3304
|
+
/* @__PURE__ */ jsx5(
|
|
3305
|
+
ParamTable,
|
|
3306
|
+
{
|
|
3307
|
+
title: "Path parameters",
|
|
3308
|
+
params: [
|
|
3309
|
+
{ name: "id", type: "uuid", required: true, description: "Matching run identifier." }
|
|
2898
3310
|
]
|
|
2899
3311
|
}
|
|
2900
3312
|
),
|
|
2901
3313
|
/* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
2902
|
-
"
|
|
2903
|
-
|
|
2904
|
-
|
|
2905
|
-
"status": "processing",
|
|
2906
|
-
"item_count": 150,
|
|
2907
|
-
"completed_count": 87,
|
|
2908
|
-
"submitted_at": "2024-09-14T08:00:00Z"
|
|
2909
|
-
}
|
|
2910
|
-
],
|
|
2911
|
-
"pagination": { "page": 1, "per_page": 50, "total": 5 }
|
|
3314
|
+
"id": "uuid",
|
|
3315
|
+
"status": "ai_resolving",
|
|
3316
|
+
"message": "AI resolution started."
|
|
2912
3317
|
}` })
|
|
2913
3318
|
]
|
|
2914
3319
|
}
|
|
2915
3320
|
) }),
|
|
2916
|
-
/* @__PURE__ */ jsx5("div", { id: "
|
|
3321
|
+
/* @__PURE__ */ jsx5("div", { id: "generate-strategy", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
2917
3322
|
EndpointBlock,
|
|
2918
3323
|
{
|
|
2919
|
-
method: "
|
|
2920
|
-
path: "/v1/
|
|
2921
|
-
summary: "
|
|
2922
|
-
|
|
2923
|
-
|
|
2924
|
-
|
|
2925
|
-
|
|
3324
|
+
method: "POST",
|
|
3325
|
+
path: "/v1/matching/strategies/generate",
|
|
3326
|
+
summary: "Generate a matching strategy from reference data and a target descriptor.",
|
|
3327
|
+
description: "Synthesize a draft matching strategy by analysing the reference dataset shape and the supplied target descriptor. The returned strategy is then executed against a config via /v1/matching/configs/{id}/smart-run.",
|
|
3328
|
+
children: /* @__PURE__ */ jsx5(
|
|
3329
|
+
ParamTable,
|
|
3330
|
+
{
|
|
3331
|
+
title: "Body parameters",
|
|
3332
|
+
params: [
|
|
3333
|
+
{ name: "reference_data_id", type: "uuid", required: true, description: "Reference dataset to use as the source of truth." },
|
|
3334
|
+
{ name: "target_type", type: "string", required: true, description: 'Target scope type \u2014 typically "run", "schema", or "document_filter".' },
|
|
3335
|
+
{ name: "target_value", type: "object", description: "Target descriptor payload \u2014 shape depends on target_type." },
|
|
3336
|
+
{ name: "user_prompt", type: "string", description: "Optional natural-language guidance to steer strategy synthesis." }
|
|
3337
|
+
]
|
|
3338
|
+
}
|
|
3339
|
+
)
|
|
3340
|
+
}
|
|
3341
|
+
) }),
|
|
3342
|
+
/* @__PURE__ */ jsx5("div", { id: "get-strategy", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3343
|
+
EndpointBlock,
|
|
3344
|
+
{
|
|
3345
|
+
method: "GET",
|
|
3346
|
+
path: "/v1/matching/strategies/{id}",
|
|
3347
|
+
summary: "Get a matching strategy."
|
|
3348
|
+
}
|
|
3349
|
+
) }),
|
|
3350
|
+
/* @__PURE__ */ jsx5("div", { id: "update-strategy", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3351
|
+
EndpointBlock,
|
|
3352
|
+
{
|
|
3353
|
+
method: "PATCH",
|
|
3354
|
+
path: "/v1/matching/strategies/{id}",
|
|
3355
|
+
summary: "Update a matching strategy.",
|
|
3356
|
+
description: "Patch an existing strategy. Every property is optional; only the keys present on the body are merged into the strategy.",
|
|
3357
|
+
children: /* @__PURE__ */ jsx5(
|
|
3358
|
+
ParamTable,
|
|
3359
|
+
{
|
|
3360
|
+
title: "Body parameters",
|
|
3361
|
+
params: [
|
|
3362
|
+
{ name: "reasoning_summary", type: "string", description: "Updated synthesis rationale." },
|
|
3363
|
+
{ name: "cardinality", type: "object", description: "Updated cardinality descriptor." },
|
|
3364
|
+
{ name: "data_quality_notes", type: "string[]", description: "Updated note list." },
|
|
3365
|
+
{ name: "blocking_keys", type: "object[]", description: "Updated blocking-key set." },
|
|
3366
|
+
{ name: "blocking_strategy", type: "string", description: 'Either "parallel" or "ordered_fallback".' },
|
|
3367
|
+
{ name: "hard_filters", type: "object[]", description: "Updated hard-filter list." },
|
|
3368
|
+
{ name: "field_rules", type: "object[]", description: "Updated field-rule list." },
|
|
3369
|
+
{ name: "thresholds", type: "object", description: "Updated confidence thresholds." },
|
|
3370
|
+
{ name: "edge_cases", type: "object[]", description: "Updated edge-case list." }
|
|
3371
|
+
]
|
|
3372
|
+
}
|
|
3373
|
+
)
|
|
3374
|
+
}
|
|
3375
|
+
) }),
|
|
3376
|
+
/* @__PURE__ */ jsx5("div", { id: "match-results", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3377
|
+
EndpointBlock,
|
|
3378
|
+
{
|
|
3379
|
+
method: "GET",
|
|
3380
|
+
path: "/v1/matching/runs/{id}/results",
|
|
3381
|
+
summary: "Get matching run results.",
|
|
3382
|
+
description: "Returns per-document match results with top candidates and field-level evidence."
|
|
3383
|
+
}
|
|
3384
|
+
) }),
|
|
3385
|
+
/* @__PURE__ */ jsx5("div", { id: "match-progress", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3386
|
+
EndpointBlock,
|
|
3387
|
+
{
|
|
3388
|
+
method: "GET",
|
|
3389
|
+
path: "/v1/matching/runs/{id}/progress",
|
|
3390
|
+
summary: "Get matching run progress.",
|
|
3391
|
+
description: "Returns the processing progress for an in-flight matching run.",
|
|
3392
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
3393
|
+
"status": "running",
|
|
3394
|
+
"processed": 87,
|
|
3395
|
+
"total": 150,
|
|
3396
|
+
"percentage": 58.0
|
|
3397
|
+
}` })
|
|
3398
|
+
}
|
|
3399
|
+
) }),
|
|
3400
|
+
/* @__PURE__ */ jsx5("div", { id: "review-match", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3401
|
+
EndpointBlock,
|
|
3402
|
+
{
|
|
3403
|
+
method: "POST",
|
|
3404
|
+
path: "/v1/matching/runs/{runId}/results/{resultId}/review",
|
|
3405
|
+
summary: "Review a single match result.",
|
|
3406
|
+
description: "Apply an approve/reject decision (or attach reviewer notes) to a single match result within a matching run.",
|
|
3407
|
+
children: [
|
|
3408
|
+
/* @__PURE__ */ jsx5(
|
|
3409
|
+
ParamTable,
|
|
3410
|
+
{
|
|
3411
|
+
title: "Path parameters",
|
|
3412
|
+
params: [
|
|
3413
|
+
{ name: "runId", type: "uuid", required: true, description: "Matching run identifier." },
|
|
3414
|
+
{ name: "resultId", type: "uuid", required: true, description: "Match result identifier within the run." }
|
|
3415
|
+
]
|
|
3416
|
+
}
|
|
3417
|
+
),
|
|
3418
|
+
/* @__PURE__ */ jsx5(
|
|
3419
|
+
ParamTable,
|
|
3420
|
+
{
|
|
3421
|
+
title: "Body parameters",
|
|
3422
|
+
params: [
|
|
3423
|
+
{ name: "status", type: "string", required: true, description: 'Reviewer decision \u2014 typically "approved" or "rejected".' },
|
|
3424
|
+
{ name: "notes", type: "string", description: "Optional reviewer note attached to the decision." }
|
|
3425
|
+
]
|
|
3426
|
+
}
|
|
3427
|
+
)
|
|
3428
|
+
]
|
|
3429
|
+
}
|
|
3430
|
+
) }),
|
|
3431
|
+
/* @__PURE__ */ jsx5(SectionHeading, { id: "batches", children: "Batches" }),
|
|
3432
|
+
/* @__PURE__ */ jsxs5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: [
|
|
3433
|
+
"Batch inference processes documents at 50% cost with up to 48-hour delivery. Upload documents with ",
|
|
3434
|
+
/* @__PURE__ */ jsx5(InlineCode, { children: "processing_mode=batch" }),
|
|
3435
|
+
" to use batch extraction."
|
|
3436
|
+
] }),
|
|
3437
|
+
/* @__PURE__ */ jsx5("div", { id: "list-batches", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3438
|
+
EndpointBlock,
|
|
3439
|
+
{
|
|
3440
|
+
method: "GET",
|
|
3441
|
+
path: "/v1/batches",
|
|
3442
|
+
summary: "List extraction batches.",
|
|
3443
|
+
children: [
|
|
3444
|
+
/* @__PURE__ */ jsx5(
|
|
3445
|
+
ParamTable,
|
|
3446
|
+
{
|
|
3447
|
+
title: "Query parameters",
|
|
3448
|
+
params: [
|
|
3449
|
+
{ name: "status", type: "string", description: "Filter: accumulating, submitted, processing, completed, failed." },
|
|
3450
|
+
{ name: "page", type: "integer", default: "1", description: "Page number." },
|
|
3451
|
+
{ name: "per_page", type: "integer", default: "50", description: "Results per page." }
|
|
3452
|
+
]
|
|
3453
|
+
}
|
|
3454
|
+
),
|
|
3455
|
+
/* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
3456
|
+
"data": [
|
|
3457
|
+
{
|
|
3458
|
+
"id": "batch_7n3k9m",
|
|
3459
|
+
"status": "processing",
|
|
3460
|
+
"item_count": 150,
|
|
3461
|
+
"completed_count": 87,
|
|
3462
|
+
"submitted_at": "2024-09-14T08:00:00Z"
|
|
3463
|
+
}
|
|
3464
|
+
],
|
|
3465
|
+
"pagination": { "page": 1, "per_page": 50, "total": 5 }
|
|
3466
|
+
}` })
|
|
3467
|
+
]
|
|
3468
|
+
}
|
|
3469
|
+
) }),
|
|
3470
|
+
/* @__PURE__ */ jsx5("div", { id: "get-batch", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3471
|
+
EndpointBlock,
|
|
3472
|
+
{
|
|
3473
|
+
method: "GET",
|
|
3474
|
+
path: "/v1/batches/:id",
|
|
3475
|
+
summary: "Get batch detail with item-level status.",
|
|
3476
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
3477
|
+
"id": "batch_7n3k9m",
|
|
3478
|
+
"status": "processing",
|
|
3479
|
+
"item_count": 150,
|
|
2926
3480
|
"completed_count": 87,
|
|
2927
3481
|
"items": [
|
|
2928
3482
|
{ "document_id": "doc_3j7x9p2q", "status": "completed" },
|
|
@@ -2932,6 +3486,24 @@ function ApiReference({ LinkComponent }) {
|
|
|
2932
3486
|
}` })
|
|
2933
3487
|
}
|
|
2934
3488
|
) }),
|
|
3489
|
+
/* @__PURE__ */ jsx5("div", { id: "batch-sync", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3490
|
+
EndpointBlock,
|
|
3491
|
+
{
|
|
3492
|
+
method: "POST",
|
|
3493
|
+
path: "/v1/batches/{id}/sync",
|
|
3494
|
+
summary: "Sync batch status with provider.",
|
|
3495
|
+
description: "Force a status sync with the batch inference provider (Anthropic or Bedrock)."
|
|
3496
|
+
}
|
|
3497
|
+
) }),
|
|
3498
|
+
/* @__PURE__ */ jsx5("div", { id: "batch-cancel", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3499
|
+
EndpointBlock,
|
|
3500
|
+
{
|
|
3501
|
+
method: "POST",
|
|
3502
|
+
path: "/v1/batches/{id}/cancel",
|
|
3503
|
+
summary: "Cancel a batch inference run.",
|
|
3504
|
+
description: "Cancel an in-flight batch. Only batches in accumulating or submitted status can be cancelled."
|
|
3505
|
+
}
|
|
3506
|
+
) }),
|
|
2935
3507
|
/* @__PURE__ */ jsx5(SectionHeading, { id: "usage", children: "Usage" }),
|
|
2936
3508
|
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "Track API usage, document processing costs, and token consumption." }),
|
|
2937
3509
|
/* @__PURE__ */ jsx5("div", { id: "get-usage", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
@@ -3316,29 +3888,72 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3316
3888
|
/* @__PURE__ */ jsx5("p", { className: "text-[14px] text-void-text-muted leading-relaxed", children: "After 4 failed attempts, the delivery is marked as failed. You can check delivery status and replay events from the dashboard." }),
|
|
3317
3889
|
/* @__PURE__ */ jsx5(SectionHeading, { id: "resolutions", children: "Resolutions" }),
|
|
3318
3890
|
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "Resolution runs apply field normalization, lookup cascades, and value transforms to extracted data. Create a resolution from a completed job run to standardise field values against reference data." }),
|
|
3319
|
-
/* @__PURE__ */ jsx5("div", { id: "list-resolutions", className: "scroll-mt-6", children: /* @__PURE__ */
|
|
3891
|
+
/* @__PURE__ */ jsx5("div", { id: "list-resolutions", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3320
3892
|
EndpointBlock,
|
|
3321
3893
|
{
|
|
3322
3894
|
method: "GET",
|
|
3323
3895
|
path: "/v1/resolutions",
|
|
3324
3896
|
summary: "List resolution runs, optionally filtered by status or source run.",
|
|
3325
3897
|
description: "Requires read scope.",
|
|
3326
|
-
children:
|
|
3327
|
-
|
|
3328
|
-
|
|
3329
|
-
|
|
3898
|
+
children: [
|
|
3899
|
+
/* @__PURE__ */ jsx5(
|
|
3900
|
+
ParamTable,
|
|
3901
|
+
{
|
|
3902
|
+
title: "Query parameters",
|
|
3903
|
+
params: [
|
|
3904
|
+
{ name: "limit", type: "integer", default: "20", description: "Maximum number of items to return (1\u2013100)." },
|
|
3905
|
+
{ name: "cursor", type: "string", description: "Opaque pagination cursor." },
|
|
3906
|
+
{ name: "order", type: "string", default: "desc", description: "Sort order by creation date (asc | desc)." },
|
|
3907
|
+
{ name: "status", type: "string", required: false, description: "Filter by run status." },
|
|
3908
|
+
{ name: "source_run_id", type: "uuid", required: false, description: "Filter by originating job run." }
|
|
3909
|
+
]
|
|
3910
|
+
}
|
|
3911
|
+
),
|
|
3912
|
+
/* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
3913
|
+
"data": [
|
|
3914
|
+
{
|
|
3915
|
+
"id": "uuid",
|
|
3916
|
+
"source_run_id": "uuid",
|
|
3917
|
+
"status": "completed",
|
|
3918
|
+
"documents_processed": 142,
|
|
3919
|
+
"created_at": "2024-09-14T10:32:00Z",
|
|
3920
|
+
"completed_at": "2024-09-14T10:35:42Z",
|
|
3921
|
+
"links": { "self": "/v1/resolutions/uuid", "results": "/v1/resolutions/uuid/results" }
|
|
3922
|
+
}
|
|
3923
|
+
],
|
|
3924
|
+
"pagination": { "next_cursor": null }
|
|
3925
|
+
}` })
|
|
3926
|
+
]
|
|
3330
3927
|
}
|
|
3331
3928
|
) }),
|
|
3332
|
-
/* @__PURE__ */ jsx5("div", { id: "create-resolution", className: "scroll-mt-6", children: /* @__PURE__ */
|
|
3929
|
+
/* @__PURE__ */ jsx5("div", { id: "create-resolution", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3333
3930
|
EndpointBlock,
|
|
3334
3931
|
{
|
|
3335
3932
|
method: "POST",
|
|
3336
3933
|
path: "/v1/resolutions",
|
|
3337
3934
|
summary: "Create a resolution run from a completed job.",
|
|
3338
|
-
description: "Requires write scope.
|
|
3339
|
-
children:
|
|
3935
|
+
description: "Requires write scope. Start a new resolution run targeting documents from a specific source run.",
|
|
3936
|
+
children: [
|
|
3937
|
+
/* @__PURE__ */ jsx5(
|
|
3938
|
+
ParamTable,
|
|
3939
|
+
{
|
|
3940
|
+
title: "Body parameters",
|
|
3941
|
+
params: [
|
|
3942
|
+
{ name: "source_run_id", type: "uuid", required: true, description: "ID of the source run to resolve against." }
|
|
3943
|
+
]
|
|
3944
|
+
}
|
|
3945
|
+
),
|
|
3946
|
+
/* @__PURE__ */ jsx5(CodeBlock, { title: "Request body", children: `{
|
|
3340
3947
|
"source_run_id": "run_abc123"
|
|
3948
|
+
}` }),
|
|
3949
|
+
/* @__PURE__ */ jsx5(CodeBlock, { title: "Response (201)", children: `{
|
|
3950
|
+
"id": "uuid",
|
|
3951
|
+
"source_run_id": "uuid",
|
|
3952
|
+
"status": "pending",
|
|
3953
|
+
"created_at": "2024-09-14T10:32:00Z",
|
|
3954
|
+
"links": { "self": "/v1/resolutions/uuid", "results": "/v1/resolutions/uuid/results" }
|
|
3341
3955
|
}` })
|
|
3956
|
+
]
|
|
3342
3957
|
}
|
|
3343
3958
|
) }),
|
|
3344
3959
|
/* @__PURE__ */ jsx5("div", { id: "get-resolution", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3356,7 +3971,7 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3356
3971
|
method: "GET",
|
|
3357
3972
|
path: "/v1/resolutions/{id}/results",
|
|
3358
3973
|
summary: "Get per-field resolution results showing original and resolved values.",
|
|
3359
|
-
description: "Requires read scope.",
|
|
3974
|
+
description: "Requires read scope. Returns the resolved data for all documents in the resolution run.",
|
|
3360
3975
|
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
3361
3976
|
"data": [
|
|
3362
3977
|
{
|
|
@@ -3390,14 +4005,14 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3390
4005
|
}
|
|
3391
4006
|
) }),
|
|
3392
4007
|
/* @__PURE__ */ jsx5(SectionHeading, { id: "linking", children: "Linking" }),
|
|
3393
|
-
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "The linking graph connects documents through shared entity values \u2014 an invoice and a contract sharing the same customer ID are linked.
|
|
4008
|
+
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "The linking graph connects documents through shared entity values \u2014 an invoice and a contract sharing the same customer ID are linked. The API exposes the bipartite document-entity graph: link keys (field-level entity identifiers), document-level links, the full graph, document-centric subgraphs, classification (identity, transaction, reference), backfill, and document-to-case mapping." }),
|
|
3394
4009
|
/* @__PURE__ */ jsx5("div", { id: "list-link-keys", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3395
4010
|
EndpointBlock,
|
|
3396
4011
|
{
|
|
3397
4012
|
method: "GET",
|
|
3398
4013
|
path: "/v1/linking/link-keys",
|
|
3399
4014
|
summary: "List all discovered link keys with their classification category and frequency.",
|
|
3400
|
-
description: "Requires read scope.",
|
|
4015
|
+
description: "Requires read scope. Returns all configured link keys (field-level entity identifiers used for document linking).",
|
|
3401
4016
|
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
3402
4017
|
"data": [
|
|
3403
4018
|
{
|
|
@@ -3416,7 +4031,17 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3416
4031
|
method: "GET",
|
|
3417
4032
|
path: "/v1/linking/documents/{id}/links",
|
|
3418
4033
|
summary: "Get all links for a specific document.",
|
|
3419
|
-
description: "Requires read scope."
|
|
4034
|
+
description: "Requires read scope. Returns all entity links discovered for a specific document.",
|
|
4035
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4036
|
+
"data": [
|
|
4037
|
+
{
|
|
4038
|
+
"entity_value": "Acme Corp",
|
|
4039
|
+
"entity_type": "vendor",
|
|
4040
|
+
"link_key": "vendor_name",
|
|
4041
|
+
"linked_document_ids": ["uuid", "uuid"]
|
|
4042
|
+
}
|
|
4043
|
+
]
|
|
4044
|
+
}` })
|
|
3420
4045
|
}
|
|
3421
4046
|
) }),
|
|
3422
4047
|
/* @__PURE__ */ jsx5("div", { id: "get-linking-graph", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3425,7 +4050,11 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3425
4050
|
method: "GET",
|
|
3426
4051
|
path: "/v1/linking/graph",
|
|
3427
4052
|
summary: "Get the full document linking graph as nodes and edges.",
|
|
3428
|
-
description: "Requires read scope. Can be large for workspaces with many documents."
|
|
4053
|
+
description: "Requires read scope. Returns the bipartite document-entity graph for the customer. Can be large for workspaces with many documents.",
|
|
4054
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4055
|
+
"nodes": [...],
|
|
4056
|
+
"edges": [...]
|
|
4057
|
+
}` })
|
|
3429
4058
|
}
|
|
3430
4059
|
) }),
|
|
3431
4060
|
/* @__PURE__ */ jsx5("div", { id: "get-document-graph", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3434,7 +4063,7 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3434
4063
|
method: "GET",
|
|
3435
4064
|
path: "/v1/linking/graph/documents/{id}",
|
|
3436
4065
|
summary: "Get the graph neighbourhood for a single document.",
|
|
3437
|
-
description: "Requires read scope.",
|
|
4066
|
+
description: "Requires read scope. Returns the subgraph of entities and linked documents for a specific document.",
|
|
3438
4067
|
children: /* @__PURE__ */ jsx5(ParamTable, { params: [
|
|
3439
4068
|
{ name: "depth", type: "integer", required: false, description: "Graph traversal depth (default 2)." }
|
|
3440
4069
|
] })
|
|
@@ -3446,7 +4075,11 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3446
4075
|
method: "POST",
|
|
3447
4076
|
path: "/v1/linking/classify",
|
|
3448
4077
|
summary: "Classify link keys into categories using AI.",
|
|
3449
|
-
description: "Requires write scope. Runs asynchronously."
|
|
4078
|
+
description: "Requires write scope. Runs AI classification on ambiguous fields to determine their link key category (identity, transaction, reference). Runs asynchronously.",
|
|
4079
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4080
|
+
"classified": 12,
|
|
4081
|
+
"results": [...]
|
|
4082
|
+
}` })
|
|
3450
4083
|
}
|
|
3451
4084
|
) }),
|
|
3452
4085
|
/* @__PURE__ */ jsx5("div", { id: "backfill-linking", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3455,7 +4088,11 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3455
4088
|
method: "POST",
|
|
3456
4089
|
path: "/v1/linking/backfill",
|
|
3457
4090
|
summary: "Backfill link values across all documents.",
|
|
3458
|
-
description: "Requires write scope.
|
|
4091
|
+
description: "Requires write scope. Triggers a backfill of the linking graph for all documents \u2014 useful after link key configuration changes. Returns 202; poll progress via the backfill progress endpoint.",
|
|
4092
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response (202)", children: `{
|
|
4093
|
+
"status": "started",
|
|
4094
|
+
"message": "Backfill queued."
|
|
4095
|
+
}` })
|
|
3459
4096
|
}
|
|
3460
4097
|
) }),
|
|
3461
4098
|
/* @__PURE__ */ jsx5("div", { id: "backfill-progress", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3464,7 +4101,13 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3464
4101
|
method: "GET",
|
|
3465
4102
|
path: "/v1/linking/backfill/progress",
|
|
3466
4103
|
summary: "Get backfill progress.",
|
|
3467
|
-
description: "Requires read scope."
|
|
4104
|
+
description: "Requires read scope. Returns the current progress of an in-flight backfill operation.",
|
|
4105
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4106
|
+
"status": "running",
|
|
4107
|
+
"processed": 187,
|
|
4108
|
+
"total": 540,
|
|
4109
|
+
"started_at": "2024-09-14T10:32:00Z"
|
|
4110
|
+
}` })
|
|
3468
4111
|
}
|
|
3469
4112
|
) }),
|
|
3470
4113
|
/* @__PURE__ */ jsx5("div", { id: "document-case-map", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3473,18 +4116,32 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3473
4116
|
method: "GET",
|
|
3474
4117
|
path: "/v1/linking/document-case-map",
|
|
3475
4118
|
summary: "Get the mapping of documents to their resolved cases.",
|
|
3476
|
-
description: "Requires read scope."
|
|
4119
|
+
description: "Requires read scope. Returns a mapping of document IDs to their assigned case keys.",
|
|
4120
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4121
|
+
"data": {
|
|
4122
|
+
"doc_uuid_1": "case_x7k9m2",
|
|
4123
|
+
"doc_uuid_2": "case_x7k9m2"
|
|
4124
|
+
}
|
|
4125
|
+
}` })
|
|
3477
4126
|
}
|
|
3478
4127
|
) }),
|
|
3479
4128
|
/* @__PURE__ */ jsx5(SectionHeading, { id: "nshot", children: "N-Shot" }),
|
|
3480
|
-
/* @__PURE__ */
|
|
4129
|
+
/* @__PURE__ */ jsxs5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: [
|
|
4130
|
+
"N-Shot endpoints provide field-level comparisons between job runs \u2014 useful for evaluating extraction quality across schema versions. Submit judge decisions (human or AI) to record which run produced the better result. All routes are nested under ",
|
|
4131
|
+
/* @__PURE__ */ jsxs5(InlineCode, { children: [
|
|
4132
|
+
"/v1/jobs/runs/",
|
|
4133
|
+
"{runId}",
|
|
4134
|
+
"/nshot/..."
|
|
4135
|
+
] }),
|
|
4136
|
+
"."
|
|
4137
|
+
] }),
|
|
3481
4138
|
/* @__PURE__ */ jsx5("div", { id: "nshot-summary", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3482
4139
|
EndpointBlock,
|
|
3483
4140
|
{
|
|
3484
4141
|
method: "GET",
|
|
3485
4142
|
path: "/v1/jobs/runs/{runId}/nshot/summary",
|
|
3486
4143
|
summary: "Get an aggregate N-Shot summary for a run.",
|
|
3487
|
-
description: "Requires read scope."
|
|
4144
|
+
description: "Requires read scope. Returns an aggregate summary of N-Shot comparisons for a job run."
|
|
3488
4145
|
}
|
|
3489
4146
|
) }),
|
|
3490
4147
|
/* @__PURE__ */ jsx5("div", { id: "nshot-comparisons", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3493,7 +4150,7 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3493
4150
|
method: "GET",
|
|
3494
4151
|
path: "/v1/jobs/runs/{runId}/nshot/comparisons",
|
|
3495
4152
|
summary: "List per-document field comparisons.",
|
|
3496
|
-
description: "Requires read scope."
|
|
4153
|
+
description: "Requires read scope. Returns all N-Shot comparisons for a job run."
|
|
3497
4154
|
}
|
|
3498
4155
|
) }),
|
|
3499
4156
|
/* @__PURE__ */ jsx5("div", { id: "nshot-comparison", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3502,7 +4159,17 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3502
4159
|
method: "GET",
|
|
3503
4160
|
path: "/v1/jobs/runs/{runId}/nshot/comparison",
|
|
3504
4161
|
summary: "Get a specific field comparison.",
|
|
3505
|
-
description: "Requires read scope."
|
|
4162
|
+
description: "Requires read scope. Returns a single N-Shot comparison filtered by document and field.",
|
|
4163
|
+
children: /* @__PURE__ */ jsx5(
|
|
4164
|
+
ParamTable,
|
|
4165
|
+
{
|
|
4166
|
+
title: "Query parameters",
|
|
4167
|
+
params: [
|
|
4168
|
+
{ name: "document_id", type: "uuid", required: true, description: "Document ID to compare." },
|
|
4169
|
+
{ name: "field_name", type: "string", required: true, description: "Field name to compare." }
|
|
4170
|
+
]
|
|
4171
|
+
}
|
|
4172
|
+
)
|
|
3506
4173
|
}
|
|
3507
4174
|
) }),
|
|
3508
4175
|
/* @__PURE__ */ jsx5("div", { id: "nshot-override", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3511,7 +4178,18 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3511
4178
|
method: "POST",
|
|
3512
4179
|
path: "/v1/jobs/runs/{runId}/nshot/override",
|
|
3513
4180
|
summary: "Override an N-Shot value for a specific field.",
|
|
3514
|
-
description: "Requires write scope."
|
|
4181
|
+
description: "Requires write scope. Manually override the N-Shot selected value for a document-field pair.",
|
|
4182
|
+
children: /* @__PURE__ */ jsx5(
|
|
4183
|
+
ParamTable,
|
|
4184
|
+
{
|
|
4185
|
+
title: "Body parameters",
|
|
4186
|
+
params: [
|
|
4187
|
+
{ name: "document_id", type: "uuid", required: true, description: "Document ID." },
|
|
4188
|
+
{ name: "field_name", type: "string", required: true, description: "Field name." },
|
|
4189
|
+
{ name: "value", type: "any", required: true, description: "The override value to apply." }
|
|
4190
|
+
]
|
|
4191
|
+
}
|
|
4192
|
+
)
|
|
3515
4193
|
}
|
|
3516
4194
|
) }),
|
|
3517
4195
|
/* @__PURE__ */ jsx5("div", { id: "nshot-judge-decision", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3520,18 +4198,43 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3520
4198
|
method: "POST",
|
|
3521
4199
|
path: "/v1/jobs/runs/{runId}/nshot/judge-decision",
|
|
3522
4200
|
summary: "Submit a judge decision (human or AI) for an N-Shot comparison.",
|
|
3523
|
-
description: "Requires write scope."
|
|
4201
|
+
description: "Requires write scope. Records which N-Shot candidate is correct.",
|
|
4202
|
+
children: /* @__PURE__ */ jsx5(
|
|
4203
|
+
ParamTable,
|
|
4204
|
+
{
|
|
4205
|
+
title: "Body parameters",
|
|
4206
|
+
params: [
|
|
4207
|
+
{ name: "document_id", type: "uuid", required: true, description: "Document ID." },
|
|
4208
|
+
{ name: "field_name", type: "string", required: true, description: "Field name." },
|
|
4209
|
+
{ name: "decision", type: "string", required: true, description: "The judge's selected value or verdict." }
|
|
4210
|
+
]
|
|
4211
|
+
}
|
|
4212
|
+
)
|
|
3524
4213
|
}
|
|
3525
4214
|
) }),
|
|
3526
4215
|
/* @__PURE__ */ jsx5(SectionHeading, { id: "schema-graph", children: "Schema Graph" }),
|
|
3527
|
-
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "The schema graph is a versioned ontology of document classes discovered across your workspace. Each class captures a document type's canonical fields.
|
|
4216
|
+
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "The schema graph is a versioned ontology of document classes discovered across your workspace. Each class captures a document type's canonical fields. The API exposes versioned classes, diffs proposed between versions (with approve/reject workflow), inter-class edges, aliases, and a D3-compatible visualization payload." }),
|
|
3528
4217
|
/* @__PURE__ */ jsx5("div", { id: "list-schema-graph-classes", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3529
4218
|
EndpointBlock,
|
|
3530
4219
|
{
|
|
3531
4220
|
method: "GET",
|
|
3532
4221
|
path: "/v1/schema-graph/classes",
|
|
3533
4222
|
summary: "List all schema graph classes.",
|
|
3534
|
-
description: "Requires read scope."
|
|
4223
|
+
description: "Requires read scope. Returns all classes in the schema graph ontology.",
|
|
4224
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4225
|
+
"data": [
|
|
4226
|
+
{
|
|
4227
|
+
"id": "uuid",
|
|
4228
|
+
"name": "Invoice",
|
|
4229
|
+
"description": "Standard invoice schema",
|
|
4230
|
+
"version": 3,
|
|
4231
|
+
"field_count": 12,
|
|
4232
|
+
"created_at": "2024-08-01T00:00:00Z",
|
|
4233
|
+
"updated_at": "2024-09-14T00:00:00Z",
|
|
4234
|
+
"links": { "self": "/v1/schema-graph/classes/uuid", "versions": "/v1/schema-graph/classes/uuid/versions" }
|
|
4235
|
+
}
|
|
4236
|
+
]
|
|
4237
|
+
}` })
|
|
3535
4238
|
}
|
|
3536
4239
|
) }),
|
|
3537
4240
|
/* @__PURE__ */ jsx5("div", { id: "get-schema-graph-class", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3549,7 +4252,16 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3549
4252
|
method: "GET",
|
|
3550
4253
|
path: "/v1/schema-graph/classes/{id}/versions",
|
|
3551
4254
|
summary: "List all versions of a schema graph class.",
|
|
3552
|
-
description: "Requires read scope."
|
|
4255
|
+
description: "Requires read scope. Returns all published versions of a class, ordered by version number descending.",
|
|
4256
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4257
|
+
"data": [
|
|
4258
|
+
{
|
|
4259
|
+
"version": 3,
|
|
4260
|
+
"fields": [...],
|
|
4261
|
+
"created_at": "2024-09-01T00:00:00Z"
|
|
4262
|
+
}
|
|
4263
|
+
]
|
|
4264
|
+
}` })
|
|
3553
4265
|
}
|
|
3554
4266
|
) }),
|
|
3555
4267
|
/* @__PURE__ */ jsx5("div", { id: "get-class-version", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3567,25 +4279,39 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3567
4279
|
method: "GET",
|
|
3568
4280
|
path: "/v1/schema-graph/diffs",
|
|
3569
4281
|
summary: "List pending, approved, and rejected diffs.",
|
|
3570
|
-
description: "Requires read scope."
|
|
4282
|
+
description: "Requires read scope. Returns pending and processed diffs between class versions.",
|
|
4283
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4284
|
+
"data": [
|
|
4285
|
+
{
|
|
4286
|
+
"id": "uuid",
|
|
4287
|
+
"class_id": "uuid",
|
|
4288
|
+
"from_version": 2,
|
|
4289
|
+
"to_version": 3,
|
|
4290
|
+
"status": "pending",
|
|
4291
|
+
"changes": [...],
|
|
4292
|
+
"created_at": "2024-09-14T10:00:00Z",
|
|
4293
|
+
"decided_at": null
|
|
4294
|
+
}
|
|
4295
|
+
]
|
|
4296
|
+
}` })
|
|
3571
4297
|
}
|
|
3572
4298
|
) }),
|
|
3573
|
-
/* @__PURE__ */ jsx5("div", { id: "approve-
|
|
4299
|
+
/* @__PURE__ */ jsx5("div", { id: "approve-diff", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3574
4300
|
EndpointBlock,
|
|
3575
4301
|
{
|
|
3576
4302
|
method: "POST",
|
|
3577
4303
|
path: "/v1/schema-graph/diffs/{id}/approve",
|
|
3578
4304
|
summary: "Approve a pending diff, promoting it to the next class version.",
|
|
3579
|
-
description: "Requires write scope."
|
|
4305
|
+
description: "Requires write scope. Promotes the changes to the live class version."
|
|
3580
4306
|
}
|
|
3581
4307
|
) }),
|
|
3582
|
-
/* @__PURE__ */ jsx5("div", { id: "reject-
|
|
4308
|
+
/* @__PURE__ */ jsx5("div", { id: "reject-diff", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3583
4309
|
EndpointBlock,
|
|
3584
4310
|
{
|
|
3585
4311
|
method: "POST",
|
|
3586
4312
|
path: "/v1/schema-graph/diffs/{id}/reject",
|
|
3587
4313
|
summary: "Reject a pending diff.",
|
|
3588
|
-
description: "Requires write scope."
|
|
4314
|
+
description: "Requires write scope. Discards the proposed changes."
|
|
3589
4315
|
}
|
|
3590
4316
|
) }),
|
|
3591
4317
|
/* @__PURE__ */ jsx5("div", { id: "list-schema-graph-edges", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3594,7 +4320,17 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3594
4320
|
method: "GET",
|
|
3595
4321
|
path: "/v1/schema-graph/edges",
|
|
3596
4322
|
summary: "List inter-class edges in the schema graph.",
|
|
3597
|
-
description: "Requires read scope."
|
|
4323
|
+
description: "Requires read scope. Returns all edges (relationships) between schema graph classes.",
|
|
4324
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4325
|
+
"data": [
|
|
4326
|
+
{
|
|
4327
|
+
"source_class_id": "uuid",
|
|
4328
|
+
"target_class_id": "uuid",
|
|
4329
|
+
"relationship": "references",
|
|
4330
|
+
"weight": 0.87
|
|
4331
|
+
}
|
|
4332
|
+
]
|
|
4333
|
+
}` })
|
|
3598
4334
|
}
|
|
3599
4335
|
) }),
|
|
3600
4336
|
/* @__PURE__ */ jsx5("div", { id: "list-schema-graph-aliases", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3603,7 +4339,12 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3603
4339
|
method: "GET",
|
|
3604
4340
|
path: "/v1/schema-graph/aliases",
|
|
3605
4341
|
summary: "List schema graph class aliases.",
|
|
3606
|
-
description: "Requires read scope."
|
|
4342
|
+
description: "Requires read scope. Returns all class aliases (alternative names mapping to canonical class IDs).",
|
|
4343
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4344
|
+
"data": [
|
|
4345
|
+
{ "alias": "Bill", "class_id": "uuid", "class_name": "Invoice" }
|
|
4346
|
+
]
|
|
4347
|
+
}` })
|
|
3607
4348
|
}
|
|
3608
4349
|
) }),
|
|
3609
4350
|
/* @__PURE__ */ jsx5("div", { id: "visualize-schema-graph", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3612,11 +4353,11 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3612
4353
|
method: "GET",
|
|
3613
4354
|
path: "/v1/schema-graph/visualize",
|
|
3614
4355
|
summary: "Get D3-compatible visualization data for the schema graph.",
|
|
3615
|
-
description: "Requires read scope."
|
|
4356
|
+
description: "Requires read scope. Returns nodes and edges formatted for graph visualization."
|
|
3616
4357
|
}
|
|
3617
4358
|
) }),
|
|
3618
4359
|
/* @__PURE__ */ jsx5(SectionHeading, { id: "structuring", children: "Structuring" }),
|
|
3619
|
-
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "The structuring pipeline validates extracted data through configurable checks and approval gates. Checks define validation rules; gates aggregate checks and determine whether records require manual approval before delivery." }),
|
|
4360
|
+
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "The structuring pipeline validates extracted data through configurable checks and approval gates. Checks define validation rules; gates aggregate checks and determine whether records require manual approval before delivery. Also exposes per-result check outcomes, the pending-approvals queue, approve/reject actions, and the manual delivery trigger for an approved run." }),
|
|
3620
4361
|
/* @__PURE__ */ jsx5(SubHeading, { id: "structuring-checks", children: "Checks" }),
|
|
3621
4362
|
/* @__PURE__ */ jsx5("div", { id: "list-structuring-checks", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3622
4363
|
EndpointBlock,
|
|
@@ -3624,17 +4365,42 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3624
4365
|
method: "GET",
|
|
3625
4366
|
path: "/v1/structuring/checks",
|
|
3626
4367
|
summary: "List validation checks.",
|
|
3627
|
-
description: "Requires read scope."
|
|
4368
|
+
description: "Requires read scope. Returns all configured validation checks for the customer.",
|
|
4369
|
+
children: /* @__PURE__ */ jsx5(
|
|
4370
|
+
ParamTable,
|
|
4371
|
+
{
|
|
4372
|
+
title: "Query parameters",
|
|
4373
|
+
params: [
|
|
4374
|
+
{ name: "limit", type: "integer", default: "20", description: "Maximum number of items to return (1\u2013100)." },
|
|
4375
|
+
{ name: "cursor", type: "string", description: "Opaque pagination cursor." },
|
|
4376
|
+
{ name: "order", type: "string", default: "desc", description: "Sort order by creation date (asc | desc)." }
|
|
4377
|
+
]
|
|
4378
|
+
}
|
|
4379
|
+
)
|
|
3628
4380
|
}
|
|
3629
4381
|
) }),
|
|
3630
|
-
/* @__PURE__ */ jsx5("div", { id: "create-structuring-check", className: "scroll-mt-6", children: /* @__PURE__ */
|
|
4382
|
+
/* @__PURE__ */ jsx5("div", { id: "create-structuring-check", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3631
4383
|
EndpointBlock,
|
|
3632
4384
|
{
|
|
3633
4385
|
method: "POST",
|
|
3634
4386
|
path: "/v1/structuring/checks",
|
|
3635
4387
|
summary: "Create a validation check.",
|
|
3636
4388
|
description: "Requires write scope.",
|
|
3637
|
-
children:
|
|
4389
|
+
children: [
|
|
4390
|
+
/* @__PURE__ */ jsx5(
|
|
4391
|
+
ParamTable,
|
|
4392
|
+
{
|
|
4393
|
+
title: "Body parameters",
|
|
4394
|
+
params: [
|
|
4395
|
+
{ name: "name", type: "string", required: true, description: "Check name." },
|
|
4396
|
+
{ name: "description", type: "string", description: "Optional description." },
|
|
4397
|
+
{ name: "type", type: "string", required: true, description: "Check type: field_format, value_range, cross_field, ai_coherence." },
|
|
4398
|
+
{ name: "config", type: "object", description: "Type-specific configuration." },
|
|
4399
|
+
{ name: "enabled", type: "boolean", default: "true", description: "Whether the check runs against new results." }
|
|
4400
|
+
]
|
|
4401
|
+
}
|
|
4402
|
+
),
|
|
4403
|
+
/* @__PURE__ */ jsx5(CodeBlock, { title: "Request body", children: `{
|
|
3638
4404
|
"name": "Amount range check",
|
|
3639
4405
|
"type": "value_range",
|
|
3640
4406
|
"config": {
|
|
@@ -3643,6 +4409,7 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3643
4409
|
"max": 1000000
|
|
3644
4410
|
}
|
|
3645
4411
|
}` })
|
|
4412
|
+
]
|
|
3646
4413
|
}
|
|
3647
4414
|
) }),
|
|
3648
4415
|
/* @__PURE__ */ jsx5("div", { id: "get-structuring-check", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3650,26 +4417,8 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3650
4417
|
{
|
|
3651
4418
|
method: "GET",
|
|
3652
4419
|
path: "/v1/structuring/checks/{id}",
|
|
3653
|
-
summary: "Get a
|
|
3654
|
-
description: "
|
|
3655
|
-
}
|
|
3656
|
-
) }),
|
|
3657
|
-
/* @__PURE__ */ jsx5("div", { id: "update-structuring-check", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3658
|
-
EndpointBlock,
|
|
3659
|
-
{
|
|
3660
|
-
method: "PUT",
|
|
3661
|
-
path: "/v1/structuring/checks/{id}",
|
|
3662
|
-
summary: "Update a validation check.",
|
|
3663
|
-
description: "Requires write scope."
|
|
3664
|
-
}
|
|
3665
|
-
) }),
|
|
3666
|
-
/* @__PURE__ */ jsx5("div", { id: "delete-structuring-check", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3667
|
-
EndpointBlock,
|
|
3668
|
-
{
|
|
3669
|
-
method: "DELETE",
|
|
3670
|
-
path: "/v1/structuring/checks/{id}",
|
|
3671
|
-
summary: "Delete a validation check.",
|
|
3672
|
-
description: "Requires write scope."
|
|
4420
|
+
summary: "Get / update / delete a structuring check.",
|
|
4421
|
+
description: "Same path supports GET (detail, requires read scope), PUT (update \u2014 same body shape as create, requires write scope), and DELETE (requires write scope)."
|
|
3673
4422
|
}
|
|
3674
4423
|
) }),
|
|
3675
4424
|
/* @__PURE__ */ jsx5(SubHeading, { id: "structuring-gates", children: "Approval Gates" }),
|
|
@@ -3679,7 +4428,7 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3679
4428
|
method: "GET",
|
|
3680
4429
|
path: "/v1/structuring/gates",
|
|
3681
4430
|
summary: "List approval gates.",
|
|
3682
|
-
description: "Requires read scope."
|
|
4431
|
+
description: "Requires read scope. Returns all configured approval gates for the customer."
|
|
3683
4432
|
}
|
|
3684
4433
|
) }),
|
|
3685
4434
|
/* @__PURE__ */ jsx5("div", { id: "create-structuring-gate", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3688,7 +4437,18 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3688
4437
|
method: "POST",
|
|
3689
4438
|
path: "/v1/structuring/gates",
|
|
3690
4439
|
summary: "Create an approval gate.",
|
|
3691
|
-
description: "Requires write scope."
|
|
4440
|
+
description: "Requires write scope.",
|
|
4441
|
+
children: /* @__PURE__ */ jsx5(
|
|
4442
|
+
ParamTable,
|
|
4443
|
+
{
|
|
4444
|
+
title: "Body parameters",
|
|
4445
|
+
params: [
|
|
4446
|
+
{ name: "name", type: "string", required: true, description: "Gate name." },
|
|
4447
|
+
{ name: "description", type: "string", description: "Optional description." },
|
|
4448
|
+
{ name: "schema_id", type: "uuid", description: "Optional schema scope for the gate." }
|
|
4449
|
+
]
|
|
4450
|
+
}
|
|
4451
|
+
)
|
|
3692
4452
|
}
|
|
3693
4453
|
) }),
|
|
3694
4454
|
/* @__PURE__ */ jsx5("div", { id: "get-structuring-gate", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3696,94 +4456,169 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3696
4456
|
{
|
|
3697
4457
|
method: "GET",
|
|
3698
4458
|
path: "/v1/structuring/gates/{id}",
|
|
3699
|
-
summary: "Get an approval gate
|
|
3700
|
-
description: "
|
|
4459
|
+
summary: "Get / update / delete an approval gate.",
|
|
4460
|
+
description: "Same path supports GET (detail with rules, requires read scope), PUT (update, requires write scope), and DELETE (requires write scope)."
|
|
3701
4461
|
}
|
|
3702
4462
|
) }),
|
|
3703
|
-
/* @__PURE__ */
|
|
4463
|
+
/* @__PURE__ */ jsxs5("div", { id: "gate-rules", className: "scroll-mt-6", children: [
|
|
4464
|
+
/* @__PURE__ */ jsx5(
|
|
4465
|
+
EndpointBlock,
|
|
4466
|
+
{
|
|
4467
|
+
method: "POST",
|
|
4468
|
+
path: "/v1/structuring/gates/{id}/rules",
|
|
4469
|
+
summary: "Add a rule to an approval gate.",
|
|
4470
|
+
description: "Requires write scope.",
|
|
4471
|
+
children: /* @__PURE__ */ jsx5(
|
|
4472
|
+
ParamTable,
|
|
4473
|
+
{
|
|
4474
|
+
title: "Body parameters",
|
|
4475
|
+
params: [
|
|
4476
|
+
{ name: "type", type: "string", required: true, description: "Rule type (e.g. min_confidence, validation_pass_rate, field_coverage)." },
|
|
4477
|
+
{ name: "threshold", type: "number", required: true, description: "Numeric threshold value." }
|
|
4478
|
+
]
|
|
4479
|
+
}
|
|
4480
|
+
)
|
|
4481
|
+
}
|
|
4482
|
+
),
|
|
4483
|
+
/* @__PURE__ */ jsx5(
|
|
4484
|
+
EndpointBlock,
|
|
4485
|
+
{
|
|
4486
|
+
method: "DELETE",
|
|
4487
|
+
path: "/v1/structuring/gates/{gateId}/rules/{ruleId}",
|
|
4488
|
+
summary: "Remove a rule from an approval gate.",
|
|
4489
|
+
description: "Requires write scope. Soft-deletes a rule. Both identifiers come from the path; no request body.",
|
|
4490
|
+
children: /* @__PURE__ */ jsx5(
|
|
4491
|
+
ParamTable,
|
|
4492
|
+
{
|
|
4493
|
+
title: "Path parameters",
|
|
4494
|
+
params: [
|
|
4495
|
+
{ name: "gateId", type: "uuid", required: true, description: "Parent approval gate identifier." },
|
|
4496
|
+
{ name: "ruleId", type: "uuid", required: true, description: "Rule identifier to remove." }
|
|
4497
|
+
]
|
|
4498
|
+
}
|
|
4499
|
+
)
|
|
4500
|
+
}
|
|
4501
|
+
)
|
|
4502
|
+
] }),
|
|
4503
|
+
/* @__PURE__ */ jsx5("div", { id: "result-checks", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3704
4504
|
EndpointBlock,
|
|
3705
4505
|
{
|
|
3706
|
-
method: "
|
|
3707
|
-
path: "/v1/structuring/
|
|
3708
|
-
summary: "
|
|
3709
|
-
description: "Requires
|
|
4506
|
+
method: "GET",
|
|
4507
|
+
path: "/v1/structuring/results/{id}/checks",
|
|
4508
|
+
summary: "Get check results for a structuring result.",
|
|
4509
|
+
description: "Requires read scope. Returns the validation check outcomes for a specific structuring result.",
|
|
4510
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4511
|
+
"data": [
|
|
4512
|
+
{
|
|
4513
|
+
"check_id": "uuid",
|
|
4514
|
+
"check_name": "vendor_present",
|
|
4515
|
+
"passed": true,
|
|
4516
|
+
"message": null
|
|
4517
|
+
}
|
|
4518
|
+
]
|
|
4519
|
+
}` })
|
|
3710
4520
|
}
|
|
3711
4521
|
) }),
|
|
3712
|
-
/* @__PURE__ */ jsx5("div", { id: "
|
|
4522
|
+
/* @__PURE__ */ jsx5("div", { id: "pending-approvals", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3713
4523
|
EndpointBlock,
|
|
3714
4524
|
{
|
|
3715
|
-
method: "
|
|
3716
|
-
path: "/v1/structuring/
|
|
3717
|
-
summary: "
|
|
3718
|
-
description: "Requires
|
|
4525
|
+
method: "GET",
|
|
4526
|
+
path: "/v1/structuring/approvals/pending",
|
|
4527
|
+
summary: "List pending approvals.",
|
|
4528
|
+
description: "Requires read scope. Returns structuring results awaiting manual approval."
|
|
4529
|
+
}
|
|
4530
|
+
) }),
|
|
4531
|
+
/* @__PURE__ */ jsx5("div", { id: "approve-reject-result", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
4532
|
+
EndpointBlock,
|
|
4533
|
+
{
|
|
4534
|
+
method: "POST",
|
|
4535
|
+
path: "/v1/structuring/approvals/{id}/approve",
|
|
4536
|
+
summary: "Approve / reject a structuring result.",
|
|
4537
|
+
description: "Requires write scope. POST /approve approves the result; POST /reject rejects it. Both return { id, status }."
|
|
4538
|
+
}
|
|
4539
|
+
) }),
|
|
4540
|
+
/* @__PURE__ */ jsx5("div", { id: "trigger-delivery", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
4541
|
+
EndpointBlock,
|
|
4542
|
+
{
|
|
4543
|
+
method: "POST",
|
|
4544
|
+
path: "/v1/structuring/delivery/{runId}",
|
|
4545
|
+
summary: "Trigger delivery for a structuring run.",
|
|
4546
|
+
description: "Requires write scope. Emit delivery signals for all approved results in the run.",
|
|
4547
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4548
|
+
"delivered": 142,
|
|
4549
|
+
"skipped": 8
|
|
4550
|
+
}` })
|
|
3719
4551
|
}
|
|
3720
4552
|
) }),
|
|
3721
4553
|
/* @__PURE__ */ jsx5(SectionHeading, { id: "telemetry", children: "Telemetry" }),
|
|
3722
|
-
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "
|
|
3723
|
-
/* @__PURE__ */ jsx5("div", { id: "telemetry-
|
|
4554
|
+
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "Telemetry endpoints aggregate structuring metrics (capture hit rate, synthesize rate, strategy distribution, tier funnel) per schema or per run." }),
|
|
4555
|
+
/* @__PURE__ */ jsx5("div", { id: "schema-telemetry-summary", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3724
4556
|
EndpointBlock,
|
|
3725
4557
|
{
|
|
3726
4558
|
method: "GET",
|
|
3727
4559
|
path: "/v1/telemetry/schemas/{id}/summary",
|
|
3728
4560
|
summary: "Get aggregate metrics for a schema across all runs.",
|
|
3729
|
-
description: "Requires read scope."
|
|
4561
|
+
description: "Requires read scope. Aggregate structuring metrics for a schema \u2014 capture hit rate, synthesize rate, strategy distribution, tier funnel."
|
|
3730
4562
|
}
|
|
3731
4563
|
) }),
|
|
3732
|
-
/* @__PURE__ */ jsx5("div", { id: "telemetry-
|
|
4564
|
+
/* @__PURE__ */ jsx5("div", { id: "schema-telemetry-trend", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3733
4565
|
EndpointBlock,
|
|
3734
4566
|
{
|
|
3735
4567
|
method: "GET",
|
|
3736
4568
|
path: "/v1/telemetry/schemas/{id}/trend",
|
|
3737
4569
|
summary: "Get metric trends over time for a schema.",
|
|
3738
|
-
description: "Requires read scope."
|
|
4570
|
+
description: "Requires read scope. Time-series telemetry data for a schema over recent runs."
|
|
3739
4571
|
}
|
|
3740
4572
|
) }),
|
|
3741
|
-
/* @__PURE__ */ jsx5("div", { id: "telemetry-
|
|
4573
|
+
/* @__PURE__ */ jsx5("div", { id: "schema-telemetry-fields", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3742
4574
|
EndpointBlock,
|
|
3743
4575
|
{
|
|
3744
4576
|
method: "GET",
|
|
3745
4577
|
path: "/v1/telemetry/schemas/{id}/fields",
|
|
3746
4578
|
summary: "Get per-field structuring metrics for a schema.",
|
|
3747
|
-
description: "Requires read scope."
|
|
4579
|
+
description: "Requires read scope. Field-level structuring metrics \u2014 per-field state distribution, capture rates, and strategy breakdown."
|
|
3748
4580
|
}
|
|
3749
4581
|
) }),
|
|
3750
|
-
/* @__PURE__ */ jsx5("div", { id: "telemetry-
|
|
4582
|
+
/* @__PURE__ */ jsx5("div", { id: "run-telemetry-summary", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3751
4583
|
EndpointBlock,
|
|
3752
4584
|
{
|
|
3753
4585
|
method: "GET",
|
|
3754
4586
|
path: "/v1/telemetry/runs/{id}/summary",
|
|
3755
4587
|
summary: "Get structuring metrics for a single run.",
|
|
3756
|
-
description: "Requires read scope."
|
|
4588
|
+
description: "Requires read scope. Aggregate structuring metrics for a specific job run."
|
|
3757
4589
|
}
|
|
3758
4590
|
) }),
|
|
3759
4591
|
/* @__PURE__ */ jsx5(SectionHeading, { id: "validation", children: "Validation" }),
|
|
3760
|
-
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "
|
|
3761
|
-
/* @__PURE__ */ jsx5(SubHeading, { id: "
|
|
3762
|
-
/* @__PURE__ */ jsx5("div", { id: "list-
|
|
4592
|
+
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "Validation runs measure extraction accuracy against ground-truth datasets. Manage datasets and runs, and retrieve per-document and per-field accuracy results. Create a ground-truth set, then run validations to compare extracted values against expected values." }),
|
|
4593
|
+
/* @__PURE__ */ jsx5(SubHeading, { id: "ground-truth-datasets", children: "Ground-Truth Datasets" }),
|
|
4594
|
+
/* @__PURE__ */ jsx5("div", { id: "list-ground-truth", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3763
4595
|
EndpointBlock,
|
|
3764
4596
|
{
|
|
3765
4597
|
method: "GET",
|
|
3766
4598
|
path: "/v1/validation/ground-truth",
|
|
3767
|
-
summary: "List
|
|
3768
|
-
description: "Requires read scope."
|
|
4599
|
+
summary: "List ground-truth datasets.",
|
|
4600
|
+
description: "Requires read scope. Returns all ground-truth datasets for the customer.",
|
|
4601
|
+
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4602
|
+
"data": [
|
|
4603
|
+
{
|
|
4604
|
+
"id": "uuid",
|
|
4605
|
+
"name": "Invoice Validation Set",
|
|
4606
|
+
"description": "50 manually verified invoices",
|
|
4607
|
+
"sample_count": 50,
|
|
4608
|
+
"created_at": "2024-08-01T00:00:00Z",
|
|
4609
|
+
"links": { "self": "/v1/validation/ground-truth/uuid" }
|
|
4610
|
+
}
|
|
4611
|
+
]
|
|
4612
|
+
}` })
|
|
3769
4613
|
}
|
|
3770
4614
|
) }),
|
|
3771
|
-
/* @__PURE__ */ jsx5("div", { id: "get-
|
|
4615
|
+
/* @__PURE__ */ jsx5("div", { id: "get-ground-truth", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3772
4616
|
EndpointBlock,
|
|
3773
4617
|
{
|
|
3774
4618
|
method: "GET",
|
|
3775
4619
|
path: "/v1/validation/ground-truth/{id}",
|
|
3776
|
-
summary: "Get
|
|
3777
|
-
description: "
|
|
3778
|
-
}
|
|
3779
|
-
) }),
|
|
3780
|
-
/* @__PURE__ */ jsx5("div", { id: "delete-golden-sample", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3781
|
-
EndpointBlock,
|
|
3782
|
-
{
|
|
3783
|
-
method: "DELETE",
|
|
3784
|
-
path: "/v1/validation/ground-truth/{id}",
|
|
3785
|
-
summary: "Delete a golden sample set.",
|
|
3786
|
-
description: "Requires write scope."
|
|
4620
|
+
summary: "Get / delete a ground-truth dataset.",
|
|
4621
|
+
description: "Same path supports GET (detail with expected values, requires read scope) and DELETE (requires write scope)."
|
|
3787
4622
|
}
|
|
3788
4623
|
) }),
|
|
3789
4624
|
/* @__PURE__ */ jsx5(SubHeading, { id: "validation-runs", children: "Validation Runs" }),
|
|
@@ -3796,18 +4631,40 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3796
4631
|
description: "Requires read scope."
|
|
3797
4632
|
}
|
|
3798
4633
|
) }),
|
|
3799
|
-
/* @__PURE__ */ jsx5("div", { id: "create-validation-run", className: "scroll-mt-6", children: /* @__PURE__ */
|
|
4634
|
+
/* @__PURE__ */ jsx5("div", { id: "create-validation-run", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3800
4635
|
EndpointBlock,
|
|
3801
4636
|
{
|
|
3802
4637
|
method: "POST",
|
|
3803
4638
|
path: "/v1/validation/runs",
|
|
3804
|
-
summary: "Create a validation run comparing a job against a
|
|
3805
|
-
description: "Requires write scope.",
|
|
3806
|
-
children:
|
|
4639
|
+
summary: "Create a validation run comparing a job against a ground-truth dataset.",
|
|
4640
|
+
description: "Requires write scope. Starts a new validation run against a ground-truth dataset.",
|
|
4641
|
+
children: [
|
|
4642
|
+
/* @__PURE__ */ jsx5(
|
|
4643
|
+
ParamTable,
|
|
4644
|
+
{
|
|
4645
|
+
title: "Body parameters",
|
|
4646
|
+
params: [
|
|
4647
|
+
{ name: "golden_sample_id", type: "uuid", required: true, description: "Ground-truth dataset to validate against (column name retained for backwards compatibility)." },
|
|
4648
|
+
{ name: "dataspace_run_id", type: "uuid", description: "Optional job run to validate." },
|
|
4649
|
+
{ name: "schema_id", type: "uuid", description: "Optional schema to scope the validation." },
|
|
4650
|
+
{ name: "name", type: "string", description: "Optional human-readable name." }
|
|
4651
|
+
]
|
|
4652
|
+
}
|
|
4653
|
+
),
|
|
4654
|
+
/* @__PURE__ */ jsx5(CodeBlock, { title: "Request body", children: `{
|
|
3807
4655
|
"dataspace_run_id": "run_abc123",
|
|
3808
4656
|
"golden_sample_id": "gs_xyz789",
|
|
3809
4657
|
"name": "Q1 Invoice accuracy check"
|
|
4658
|
+
}` }),
|
|
4659
|
+
/* @__PURE__ */ jsx5(CodeBlock, { title: "Response (201)", children: `{
|
|
4660
|
+
"id": "uuid",
|
|
4661
|
+
"golden_sample_id": "uuid",
|
|
4662
|
+
"schema_id": "uuid",
|
|
4663
|
+
"status": "pending",
|
|
4664
|
+
"created_at": "2024-09-14T10:32:00Z",
|
|
4665
|
+
"links": { "self": "/v1/validation/runs/uuid", "results": "/v1/validation/runs/uuid/results" }
|
|
3810
4666
|
}` })
|
|
4667
|
+
]
|
|
3811
4668
|
}
|
|
3812
4669
|
) }),
|
|
3813
4670
|
/* @__PURE__ */ jsx5("div", { id: "get-validation-run", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
@@ -3815,8 +4672,8 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3815
4672
|
{
|
|
3816
4673
|
method: "GET",
|
|
3817
4674
|
path: "/v1/validation/runs/{id}",
|
|
3818
|
-
summary: "Get a validation run
|
|
3819
|
-
description: "
|
|
4675
|
+
summary: "Get / delete a validation run.",
|
|
4676
|
+
description: "Same path supports GET (detail with accuracy summary, requires read scope) and DELETE (requires write scope)."
|
|
3820
4677
|
}
|
|
3821
4678
|
) }),
|
|
3822
4679
|
/* @__PURE__ */ jsx5("div", { id: "get-validation-results", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
@@ -3825,13 +4682,15 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3825
4682
|
method: "GET",
|
|
3826
4683
|
path: "/v1/validation/runs/{id}/results",
|
|
3827
4684
|
summary: "Get per-field validation results.",
|
|
3828
|
-
description: "Requires read scope.",
|
|
4685
|
+
description: "Requires read scope. Returns per-document and per-field accuracy results for the validation run.",
|
|
3829
4686
|
children: [
|
|
3830
4687
|
/* @__PURE__ */ jsx5(ParamTable, { params: [
|
|
3831
4688
|
{ name: "judged_only", type: "string", required: false, description: 'Set to "true" to return only judged results.' }
|
|
3832
4689
|
] }),
|
|
3833
4690
|
/* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
3834
|
-
"
|
|
4691
|
+
"accuracy_overall": 0.94,
|
|
4692
|
+
"accuracy_by_field": { "vendor_name": 0.98, "total": 0.91 },
|
|
4693
|
+
"results": [
|
|
3835
4694
|
{
|
|
3836
4695
|
"document_id": "doc_abc123",
|
|
3837
4696
|
"field_name": "invoice_number",
|
|
@@ -3846,24 +4705,15 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3846
4705
|
]
|
|
3847
4706
|
}
|
|
3848
4707
|
) }),
|
|
3849
|
-
/* @__PURE__ */ jsx5("div", { id: "delete-validation-run", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3850
|
-
EndpointBlock,
|
|
3851
|
-
{
|
|
3852
|
-
method: "DELETE",
|
|
3853
|
-
path: "/v1/validation/runs/{id}",
|
|
3854
|
-
summary: "Delete a validation run.",
|
|
3855
|
-
description: "Requires write scope."
|
|
3856
|
-
}
|
|
3857
|
-
) }),
|
|
3858
4708
|
/* @__PURE__ */ jsx5(SectionHeading, { id: "credits", children: "Credits" }),
|
|
3859
|
-
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "
|
|
4709
|
+
/* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "Credit endpoints expose the current balance, transaction history, aggregate usage summaries, daily usage, and a per-request usage log with model and token counts. Track credit balance and usage breakdowns by operation type and time period." }),
|
|
3860
4710
|
/* @__PURE__ */ jsx5("div", { id: "credits-balance", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
|
|
3861
4711
|
EndpointBlock,
|
|
3862
4712
|
{
|
|
3863
4713
|
method: "GET",
|
|
3864
4714
|
path: "/v1/credits/balance",
|
|
3865
4715
|
summary: "Get current credit balance.",
|
|
3866
|
-
description: "Requires read scope.",
|
|
4716
|
+
description: "Requires read scope. Returns the current credit balance for the authenticated customer.",
|
|
3867
4717
|
children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
3868
4718
|
"balance": 4250.00,
|
|
3869
4719
|
"currency": "USD",
|
|
@@ -3871,52 +4721,126 @@ function verifyWebhook(payload, signature, secret) {
|
|
|
3871
4721
|
}` })
|
|
3872
4722
|
}
|
|
3873
4723
|
) }),
|
|
3874
|
-
/* @__PURE__ */ jsx5("div", { id: "credits-history", className: "scroll-mt-6", children: /* @__PURE__ */
|
|
4724
|
+
/* @__PURE__ */ jsx5("div", { id: "credits-history", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3875
4725
|
EndpointBlock,
|
|
3876
4726
|
{
|
|
3877
4727
|
method: "GET",
|
|
3878
4728
|
path: "/v1/credits/history",
|
|
3879
4729
|
summary: "Get credit transaction history.",
|
|
3880
|
-
description: "Requires read scope.",
|
|
3881
|
-
children:
|
|
3882
|
-
|
|
3883
|
-
|
|
3884
|
-
|
|
4730
|
+
description: "Requires read scope. Returns credit transaction history (purchases, deductions, adjustments).",
|
|
4731
|
+
children: [
|
|
4732
|
+
/* @__PURE__ */ jsx5(
|
|
4733
|
+
ParamTable,
|
|
4734
|
+
{
|
|
4735
|
+
title: "Query parameters",
|
|
4736
|
+
params: [
|
|
4737
|
+
{ name: "limit", type: "integer", required: false, description: "Max items to return (default 20)." },
|
|
4738
|
+
{ name: "cursor", type: "string", required: false, description: "Pagination cursor." }
|
|
4739
|
+
]
|
|
4740
|
+
}
|
|
4741
|
+
),
|
|
4742
|
+
/* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4743
|
+
"data": [
|
|
4744
|
+
{
|
|
4745
|
+
"id": "uuid",
|
|
4746
|
+
"type": "deduction",
|
|
4747
|
+
"amount": -0.18,
|
|
4748
|
+
"description": "Extraction: doc_3j7x9p2q",
|
|
4749
|
+
"created_at": "2024-09-14T10:32:00Z"
|
|
4750
|
+
}
|
|
4751
|
+
],
|
|
4752
|
+
"pagination": { "next_cursor": null }
|
|
4753
|
+
}` })
|
|
4754
|
+
]
|
|
3885
4755
|
}
|
|
3886
4756
|
) }),
|
|
3887
|
-
/* @__PURE__ */ jsx5("div", { id: "credits-usage
|
|
4757
|
+
/* @__PURE__ */ jsx5("div", { id: "credits-usage", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3888
4758
|
EndpointBlock,
|
|
3889
4759
|
{
|
|
3890
4760
|
method: "GET",
|
|
3891
|
-
path: "/v1/credits/usage
|
|
3892
|
-
summary: "Get aggregate usage summary by
|
|
3893
|
-
description: "Requires read scope.",
|
|
3894
|
-
children:
|
|
3895
|
-
|
|
3896
|
-
|
|
3897
|
-
|
|
4761
|
+
path: "/v1/credits/usage",
|
|
4762
|
+
summary: "Get aggregate credit usage summary by feature.",
|
|
4763
|
+
description: "Requires read scope. Returns aggregate credit usage broken down by feature.",
|
|
4764
|
+
children: [
|
|
4765
|
+
/* @__PURE__ */ jsx5(
|
|
4766
|
+
ParamTable,
|
|
4767
|
+
{
|
|
4768
|
+
title: "Query parameters",
|
|
4769
|
+
params: [
|
|
4770
|
+
{ name: "from", type: "string", description: "Start of the period (ISO 8601, default 30 days ago)." },
|
|
4771
|
+
{ name: "to", type: "string", description: "End of the period (ISO 8601, default now)." }
|
|
4772
|
+
]
|
|
4773
|
+
}
|
|
4774
|
+
),
|
|
4775
|
+
/* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4776
|
+
"total_used": 18.42,
|
|
4777
|
+
"breakdown": [
|
|
4778
|
+
{ "feature": "extraction", "credits_used": 12.30, "call_count": 1842 },
|
|
4779
|
+
{ "feature": "matching", "credits_used": 6.12, "call_count": 920 }
|
|
4780
|
+
]
|
|
4781
|
+
}` })
|
|
4782
|
+
]
|
|
3898
4783
|
}
|
|
3899
4784
|
) }),
|
|
3900
|
-
/* @__PURE__ */ jsx5("div", { id: "credits-daily
|
|
4785
|
+
/* @__PURE__ */ jsx5("div", { id: "credits-usage-daily", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3901
4786
|
EndpointBlock,
|
|
3902
4787
|
{
|
|
3903
4788
|
method: "GET",
|
|
3904
|
-
path: "/v1/credits/daily
|
|
3905
|
-
summary: "Get daily usage breakdown.",
|
|
3906
|
-
description: "Requires read scope."
|
|
4789
|
+
path: "/v1/credits/usage/daily",
|
|
4790
|
+
summary: "Get daily credit usage breakdown.",
|
|
4791
|
+
description: "Requires read scope. Returns per-day credit usage for the specified period (default last 30 days).",
|
|
4792
|
+
children: [
|
|
4793
|
+
/* @__PURE__ */ jsx5(
|
|
4794
|
+
ParamTable,
|
|
4795
|
+
{
|
|
4796
|
+
title: "Query parameters",
|
|
4797
|
+
params: [
|
|
4798
|
+
{ name: "from", type: "string", description: "Start of the period (ISO 8601)." },
|
|
4799
|
+
{ name: "to", type: "string", description: "End of the period (ISO 8601)." }
|
|
4800
|
+
]
|
|
4801
|
+
}
|
|
4802
|
+
),
|
|
4803
|
+
/* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4804
|
+
"data": [
|
|
4805
|
+
{ "date": "2024-09-14", "credits_used": 0.62, "call_count": 87 }
|
|
4806
|
+
]
|
|
4807
|
+
}` })
|
|
4808
|
+
]
|
|
3907
4809
|
}
|
|
3908
4810
|
) }),
|
|
3909
|
-
/* @__PURE__ */ jsx5("div", { id: "credits-usage-log", className: "scroll-mt-6", children: /* @__PURE__ */
|
|
4811
|
+
/* @__PURE__ */ jsx5("div", { id: "credits-usage-log", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
|
|
3910
4812
|
EndpointBlock,
|
|
3911
4813
|
{
|
|
3912
4814
|
method: "GET",
|
|
3913
|
-
path: "/v1/credits/usage
|
|
4815
|
+
path: "/v1/credits/usage/log",
|
|
3914
4816
|
summary: "Get per-request usage log with token counts and cost estimates.",
|
|
3915
|
-
description: "Requires read scope.",
|
|
3916
|
-
children:
|
|
3917
|
-
|
|
3918
|
-
|
|
3919
|
-
|
|
4817
|
+
description: "Requires read scope. Returns a detailed per-request usage log with model, tokens, and cost.",
|
|
4818
|
+
children: [
|
|
4819
|
+
/* @__PURE__ */ jsx5(
|
|
4820
|
+
ParamTable,
|
|
4821
|
+
{
|
|
4822
|
+
title: "Query parameters",
|
|
4823
|
+
params: [
|
|
4824
|
+
{ name: "limit", type: "integer", required: false, description: "Max items to return (default 50)." },
|
|
4825
|
+
{ name: "cursor", type: "string", required: false, description: "Pagination cursor." }
|
|
4826
|
+
]
|
|
4827
|
+
}
|
|
4828
|
+
),
|
|
4829
|
+
/* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
|
|
4830
|
+
"data": [
|
|
4831
|
+
{
|
|
4832
|
+
"id": "uuid",
|
|
4833
|
+
"operation_type": "extraction",
|
|
4834
|
+
"model": "claude-sonnet",
|
|
4835
|
+
"input_tokens": 4280,
|
|
4836
|
+
"output_tokens": 612,
|
|
4837
|
+
"cost_credits": 0.012,
|
|
4838
|
+
"created_at": "2024-09-14T10:32:00Z"
|
|
4839
|
+
}
|
|
4840
|
+
],
|
|
4841
|
+
"pagination": { "next_cursor": null }
|
|
4842
|
+
}` })
|
|
4843
|
+
]
|
|
3920
4844
|
}
|
|
3921
4845
|
) }),
|
|
3922
4846
|
/* @__PURE__ */ jsx5(SectionHeading, { id: "agent", children: "Agent" }),
|
|
@@ -5485,49 +6409,44 @@ var API_NAV_SECTIONS = [
|
|
|
5485
6409
|
{ id: "list-class-versions", label: "List Versions" },
|
|
5486
6410
|
{ id: "get-class-version", label: "Get Version" },
|
|
5487
6411
|
{ id: "list-schema-graph-diffs", label: "List Diffs" },
|
|
5488
|
-
{ id: "approve-
|
|
5489
|
-
{ id: "reject-
|
|
6412
|
+
{ id: "approve-diff", label: "Approve Diff" },
|
|
6413
|
+
{ id: "reject-diff", label: "Reject Diff" },
|
|
5490
6414
|
{ id: "list-schema-graph-edges", label: "Edges" },
|
|
5491
6415
|
{ id: "list-schema-graph-aliases", label: "Aliases" },
|
|
5492
6416
|
{ id: "visualize-schema-graph", label: "Visualize" }
|
|
5493
6417
|
] },
|
|
5494
6418
|
{ id: "structuring", label: "Structuring", children: [
|
|
5495
|
-
{ id: "structuring-checks", label: "Checks" },
|
|
5496
6419
|
{ id: "list-structuring-checks", label: "List Checks" },
|
|
5497
6420
|
{ id: "create-structuring-check", label: "Create Check" },
|
|
5498
|
-
{ id: "get-structuring-check", label: "Get Check" },
|
|
5499
|
-
{ id: "update-structuring-check", label: "Update Check" },
|
|
5500
|
-
{ id: "delete-structuring-check", label: "Delete Check" },
|
|
5501
|
-
{ id: "structuring-gates", label: "Approval Gates" },
|
|
6421
|
+
{ id: "get-structuring-check", label: "Get / Update / Delete Check" },
|
|
5502
6422
|
{ id: "list-structuring-gates", label: "List Gates" },
|
|
5503
6423
|
{ id: "create-structuring-gate", label: "Create Gate" },
|
|
5504
|
-
{ id: "get-structuring-gate", label: "Get Gate" },
|
|
5505
|
-
{ id: "
|
|
5506
|
-
{ id: "
|
|
6424
|
+
{ id: "get-structuring-gate", label: "Get / Update / Delete Gate" },
|
|
6425
|
+
{ id: "gate-rules", label: "Gate Rules" },
|
|
6426
|
+
{ id: "result-checks", label: "Result Checks" },
|
|
6427
|
+
{ id: "pending-approvals", label: "Pending Approvals" },
|
|
6428
|
+
{ id: "approve-reject-result", label: "Approve / Reject Result" },
|
|
6429
|
+
{ id: "trigger-delivery", label: "Trigger Delivery" }
|
|
5507
6430
|
] },
|
|
5508
6431
|
{ id: "telemetry", label: "Telemetry", children: [
|
|
5509
|
-
{ id: "telemetry-
|
|
5510
|
-
{ id: "telemetry-
|
|
5511
|
-
{ id: "telemetry-
|
|
5512
|
-
{ id: "telemetry-
|
|
6432
|
+
{ id: "schema-telemetry-summary", label: "Schema Summary" },
|
|
6433
|
+
{ id: "schema-telemetry-trend", label: "Schema Trend" },
|
|
6434
|
+
{ id: "schema-telemetry-fields", label: "Schema Fields" },
|
|
6435
|
+
{ id: "run-telemetry-summary", label: "Run Summary" }
|
|
5513
6436
|
] },
|
|
5514
6437
|
{ id: "validation", label: "Validation", children: [
|
|
5515
|
-
{ id: "
|
|
5516
|
-
{ id: "
|
|
5517
|
-
{ id: "
|
|
5518
|
-
{ id: "
|
|
5519
|
-
{ id: "validation-
|
|
5520
|
-
{ id: "
|
|
5521
|
-
{ id: "create-validation-run", label: "Create Run" },
|
|
5522
|
-
{ id: "get-validation-run", label: "Get Run" },
|
|
5523
|
-
{ id: "get-validation-results", label: "Results" },
|
|
5524
|
-
{ id: "delete-validation-run", label: "Delete Run" }
|
|
6438
|
+
{ id: "list-ground-truth", label: "List Ground-Truth Datasets" },
|
|
6439
|
+
{ id: "get-ground-truth", label: "Get / Delete Ground-Truth Dataset" },
|
|
6440
|
+
{ id: "list-validation-runs", label: "List Validation Runs" },
|
|
6441
|
+
{ id: "create-validation-run", label: "Create Validation Run" },
|
|
6442
|
+
{ id: "get-validation-run", label: "Get / Delete Validation Run" },
|
|
6443
|
+
{ id: "get-validation-results", label: "Validation Results" }
|
|
5525
6444
|
] },
|
|
5526
6445
|
{ id: "credits", label: "Credits", children: [
|
|
5527
6446
|
{ id: "credits-balance", label: "Balance" },
|
|
5528
6447
|
{ id: "credits-history", label: "History" },
|
|
5529
|
-
{ id: "credits-usage
|
|
5530
|
-
{ id: "credits-daily
|
|
6448
|
+
{ id: "credits-usage", label: "Usage Summary" },
|
|
6449
|
+
{ id: "credits-usage-daily", label: "Daily Usage" },
|
|
5531
6450
|
{ id: "credits-usage-log", label: "Usage Log" }
|
|
5532
6451
|
] },
|
|
5533
6452
|
{ id: "agent", label: "Agent", children: [
|