@talonic/docs 0.7.1 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1539 -1
- package/dist/index.js +376 -13
- package/dist/index.js.map +1 -1
- package/dist/seo.d.ts +1539 -1
- package/dist/seo.js +351 -1
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -3512,7 +3512,7 @@ var NAV_SECTIONS2 = [
|
|
|
3512
3512
|
label: "Validation & Quality",
|
|
3513
3513
|
children: [
|
|
3514
3514
|
{ id: "validation-checks", label: "Validation Checks" },
|
|
3515
|
-
{ id: "
|
|
3515
|
+
{ id: "ground-truth", label: "Golden Samples" },
|
|
3516
3516
|
{ id: "approval-gates", label: "Approval Gates" }
|
|
3517
3517
|
]
|
|
3518
3518
|
},
|
|
@@ -3651,7 +3651,7 @@ function PlatformGuide({ LinkComponent }) {
|
|
|
3651
3651
|
/* @__PURE__ */ jsx6(PipelineStage, { label: "Quality", state: "pending" })
|
|
3652
3652
|
] }) }),
|
|
3653
3653
|
/* @__PURE__ */ jsx6("div", { className: "my-6 space-y-2", children: [
|
|
3654
|
-
{ n: "1", label: "Upload", desc: "Drag files or folders into
|
|
3654
|
+
{ n: "1", label: "Upload", desc: "Drag files or folders into Sources. 25+ formats supported. ZIP archives are unpacked automatically." },
|
|
3655
3655
|
{ n: "2", label: "Extract", desc: "Each document is processed through Document AI (OCR + annotation), classified against the document type ontology, and sent to AI for exhaustive field extraction." },
|
|
3656
3656
|
{ n: "3", label: "Graph builds", desc: "Extracted fields resolve into the Field Registry \u2014 canonical names, clusters, master instructions." },
|
|
3657
3657
|
{ n: "4", label: "Define schema", desc: "Create a template with the fields you need. Map to registry, add reference tables." },
|
|
@@ -3668,7 +3668,7 @@ function PlatformGuide({ LinkComponent }) {
|
|
|
3668
3668
|
/* @__PURE__ */ jsx6(SubHeading, { id: "getting-started", children: "Getting Started" }),
|
|
3669
3669
|
/* @__PURE__ */ jsxs6(P, { children: [
|
|
3670
3670
|
"Navigate using the sidebar. The platform is organized into three primary sections:",
|
|
3671
|
-
/* @__PURE__ */ jsx6("strong", { children: "
|
|
3671
|
+
/* @__PURE__ */ jsx6("strong", { children: " Sources" }),
|
|
3672
3672
|
" (ingest), ",
|
|
3673
3673
|
/* @__PURE__ */ jsx6("strong", { children: "Structuring" }),
|
|
3674
3674
|
" (process & validate), and ",
|
|
@@ -3677,7 +3677,7 @@ function PlatformGuide({ LinkComponent }) {
|
|
|
3677
3677
|
] }),
|
|
3678
3678
|
/* @__PURE__ */ jsx6(UiExcerpt, { title: "Sidebar Navigation", caption: "The sidebar provides access to all sections. Click the collapse button to save space. Press Cmd+K for global search.", children: /* @__PURE__ */ jsxs6("div", { className: "w-48 border border-void-border rounded-lg bg-void-bg p-3 space-y-0.5", children: [
|
|
3679
3679
|
/* @__PURE__ */ jsx6(MockNavItem, { label: "Dashboard" }),
|
|
3680
|
-
/* @__PURE__ */ jsx6(MockNavItem, { label: "
|
|
3680
|
+
/* @__PURE__ */ jsx6(MockNavItem, { label: "Sources", active: true }),
|
|
3681
3681
|
/* @__PURE__ */ jsx6(MockNavItem, { label: "Documents", indent: true }),
|
|
3682
3682
|
/* @__PURE__ */ jsx6(MockNavItem, { label: "Field Library", indent: true }),
|
|
3683
3683
|
/* @__PURE__ */ jsx6(MockNavItem, { label: "Structuring" }),
|
|
@@ -3689,21 +3689,21 @@ function PlatformGuide({ LinkComponent }) {
|
|
|
3689
3689
|
] }) }),
|
|
3690
3690
|
/* @__PURE__ */ jsxs6(Callout, { children: [
|
|
3691
3691
|
"The fastest path to results: upload documents in ",
|
|
3692
|
-
/* @__PURE__ */ jsx6("strong", { children: "
|
|
3692
|
+
/* @__PURE__ */ jsx6("strong", { children: "Sources" }),
|
|
3693
3693
|
", then go to",
|
|
3694
3694
|
" ",
|
|
3695
3695
|
/* @__PURE__ */ jsx6("strong", { children: "Structuring \u2192 Runs \u2192 New" }),
|
|
3696
3696
|
" to create your first extraction job."
|
|
3697
3697
|
] }),
|
|
3698
3698
|
/* @__PURE__ */ jsx6(SectionHeading, { id: "sources-docs", children: "Inputs & Documents" }),
|
|
3699
|
-
/* @__PURE__ */ jsx6(P, { children: "
|
|
3699
|
+
/* @__PURE__ */ jsx6(P, { children: "Sources are the entry point for all data. Every document belongs to a source \u2014 whether uploaded manually, synced from Google Drive, or ingested via API." }),
|
|
3700
3700
|
/* @__PURE__ */ jsx6(SubHeading, { id: "uploading", children: "Uploading Documents" }),
|
|
3701
3701
|
/* @__PURE__ */ jsxs6(P, { children: [
|
|
3702
|
-
"The
|
|
3702
|
+
"The Sources page provides a drag-and-drop upload interface. You can upload individual files, multiple files, or entire folders. ZIP archives are unpacked recursively. When uploading folders, the original file path is preserved as a data field (",
|
|
3703
3703
|
/* @__PURE__ */ jsx6("code", { children: "source_file_path" }),
|
|
3704
3704
|
") on each document \u2014 available for downstream processing and export."
|
|
3705
3705
|
] }),
|
|
3706
|
-
/* @__PURE__ */ jsx6(UiExcerpt, { title: "
|
|
3706
|
+
/* @__PURE__ */ jsx6(UiExcerpt, { title: "Sources \u2014 Upload Card", caption: "Drag files or folders onto the upload area. The progress indicator shows processing status in real-time.", children: /* @__PURE__ */ jsx6("div", { className: "max-w-sm", children: /* @__PURE__ */ jsxs6("div", { className: "border border-void-border rounded-lg p-4", children: [
|
|
3707
3707
|
/* @__PURE__ */ jsxs6("div", { className: "flex items-center gap-3 mb-3", children: [
|
|
3708
3708
|
/* @__PURE__ */ jsx6("div", { className: "w-10 h-10 rounded-lg bg-void-accent/10 flex items-center justify-center", children: /* @__PURE__ */ jsxs6("svg", { width: "20", height: "20", viewBox: "0 0 24 24", fill: "none", stroke: "#673AB7", strokeWidth: "1.5", strokeLinecap: "round", children: [
|
|
3709
3709
|
/* @__PURE__ */ jsx6("path", { d: "M21 15v4a2 2 0 01-2 2H5a2 2 0 01-2-2v-4" }),
|
|
@@ -3828,7 +3828,7 @@ function PlatformGuide({ LinkComponent }) {
|
|
|
3828
3828
|
/* @__PURE__ */ jsx6(SubHeading, { id: "field-registry", children: "Field Registry" }),
|
|
3829
3829
|
/* @__PURE__ */ jsxs6(P, { children: [
|
|
3830
3830
|
"Navigate to ",
|
|
3831
|
-
/* @__PURE__ */ jsx6("strong", { children: "Inputs \
|
|
3831
|
+
/* @__PURE__ */ jsx6("strong", { children: "Sources Inputs \u2192rarr; Field Library" }),
|
|
3832
3832
|
" to explore the registry. Every canonical field is displayed with its tier, data type, occurrence count, and document types."
|
|
3833
3833
|
] }),
|
|
3834
3834
|
/* @__PURE__ */ jsx6(UiExcerpt, { title: "Field Library \u2014 Registry Table", caption: "Fields are organized by tier with occurrence counts, data types, and master instruction status.", children: /* @__PURE__ */ jsx6("div", { className: "border border-void-border rounded-lg overflow-hidden", children: /* @__PURE__ */ jsxs6("table", { className: "w-full text-[12px]", children: [
|
|
@@ -4227,7 +4227,7 @@ function PlatformGuide({ LinkComponent }) {
|
|
|
4227
4227
|
/* @__PURE__ */ jsx6(P, { children: "Multiple layers of quality assurance: automated validation checks, ground truth benchmarking, and configurable approval gates." }),
|
|
4228
4228
|
/* @__PURE__ */ jsx6(SubHeading, { id: "validation-checks", children: "Validation Checks" }),
|
|
4229
4229
|
/* @__PURE__ */ jsx6(P, { children: "Schema-level quality rules run during Phase 3 of every job. Rule types: field format, value range, cross-field consistency, and AI-proposed coherence rules. Rules can be AI-proposed after a job completes, then reviewed and approved before activation." }),
|
|
4230
|
-
/* @__PURE__ */ jsx6(SubHeading, { id: "
|
|
4230
|
+
/* @__PURE__ */ jsx6(SubHeading, { id: "ground-truth", children: "Golden Samples" }),
|
|
4231
4231
|
/* @__PURE__ */ jsxs6(P, { children: [
|
|
4232
4232
|
"Manually-created reference datasets with known-correct values. Create from",
|
|
4233
4233
|
" ",
|
|
@@ -4408,9 +4408,22 @@ function PlatformGuide({ LinkComponent }) {
|
|
|
4408
4408
|
{ name: "/v1/documents", type: "CRUD", description: "Document listing, detail, and deletion with cursor pagination." },
|
|
4409
4409
|
{ name: "/v1/extractions", type: "CRUD", description: "Extraction results and field corrections." },
|
|
4410
4410
|
{ name: "/v1/schemas", type: "CRUD", description: "Schema management \u2014 create, update, delete." },
|
|
4411
|
-
{ name: "/v1/jobs", type: "CRUD", description: "Async job tracking and
|
|
4411
|
+
{ name: "/v1/jobs", type: "CRUD", description: "Async job tracking, results, and N-Shot comparisons with override and judge decisions." },
|
|
4412
4412
|
{ name: "/v1/sources", type: "CRUD", description: "API source management and document ingest." },
|
|
4413
|
-
{ name: "/v1/delivery", type: "CRUD", description: "Outbound delivery: destinations, bindings, history, DLQ, outbox, catalog." }
|
|
4413
|
+
{ name: "/v1/delivery", type: "CRUD", description: "Outbound delivery: destinations, bindings, history, DLQ, outbox, catalog." },
|
|
4414
|
+
{ name: "/v1/resolutions", type: "CRUD", description: "Resolution runs \u2014 field normalization, transforms, and lookup cascades." },
|
|
4415
|
+
{ name: "/v1/linking", type: "mixed", description: "Document linking: link keys, document links, entity graph, classification, backfill, and document-case mapping." },
|
|
4416
|
+
{ name: "/v1/schema-graph", type: "mixed", description: "Schema class ontology: versioned classes, diffs with approval workflow, edges, aliases, and visualization." },
|
|
4417
|
+
{ name: "/v1/structuring", type: "CRUD", description: "Validation checks, approval gates with rules, result checks, pending approvals, and delivery triggers." },
|
|
4418
|
+
{ name: "/v1/telemetry", type: "GET", description: "Structuring metrics: per-schema and per-run summaries, trends, and field-level breakdowns." },
|
|
4419
|
+
{ name: "/v1/validation", type: "CRUD", description: "Golden samples and validation runs for measuring extraction accuracy against ground truth." },
|
|
4420
|
+
{ name: "/v1/credits", type: "GET", description: "Credit balance, transaction history, usage summaries, daily breakdown, and per-request usage log." },
|
|
4421
|
+
{ name: "/v1/cases", type: "CRUD", description: "Cases: status updates, edge confirmation/rejection, split/merge, completeness, document pinning." },
|
|
4422
|
+
{ name: "/v1/batches", type: "mixed", description: "Batch inference: listing, detail, provider sync, and cancellation." },
|
|
4423
|
+
{ name: "/v1/matching", type: "CRUD", description: "Smart matching: configurations, strategies, smart runs, AI resolution, results, progress, and review." },
|
|
4424
|
+
{ name: "/v1/review", type: "mixed", description: "Review queue: assignment, actions, batch operations, and statistics." },
|
|
4425
|
+
{ name: "/v1/quality", type: "CRUD", description: "Ground truth datasets with entries, benchmarks with results and comparison." },
|
|
4426
|
+
{ name: "/v1/reference-data", type: "CRUD", description: "Reference datasets: file and JSON upload, row browsing, and management." }
|
|
4414
4427
|
]
|
|
4415
4428
|
}
|
|
4416
4429
|
),
|
|
@@ -4712,6 +4725,77 @@ var API_NAV_SECTIONS = [
|
|
|
4712
4725
|
{ id: "webhook-verification", label: "Signature Verification" },
|
|
4713
4726
|
{ id: "webhook-retries", label: "Retry Policy" }
|
|
4714
4727
|
] },
|
|
4728
|
+
{ id: "resolutions", label: "Resolutions", children: [
|
|
4729
|
+
{ id: "list-resolutions", label: "List Resolutions" },
|
|
4730
|
+
{ id: "create-resolution", label: "Create Resolution" },
|
|
4731
|
+
{ id: "get-resolution", label: "Get Resolution" },
|
|
4732
|
+
{ id: "get-resolution-results", label: "Get Results" },
|
|
4733
|
+
{ id: "execute-resolution", label: "Execute Resolution" },
|
|
4734
|
+
{ id: "delete-resolution", label: "Delete Resolution" }
|
|
4735
|
+
] },
|
|
4736
|
+
{ id: "linking", label: "Linking", children: [
|
|
4737
|
+
{ id: "list-link-keys", label: "Link Keys" },
|
|
4738
|
+
{ id: "get-document-links", label: "Document Links" },
|
|
4739
|
+
{ id: "get-linking-graph", label: "Full Graph" },
|
|
4740
|
+
{ id: "get-document-graph", label: "Document Graph" },
|
|
4741
|
+
{ id: "classify-link-keys", label: "Classify" },
|
|
4742
|
+
{ id: "backfill-linking", label: "Backfill" },
|
|
4743
|
+
{ id: "backfill-progress", label: "Backfill Progress" },
|
|
4744
|
+
{ id: "document-case-map", label: "Document-Case Map" }
|
|
4745
|
+
] },
|
|
4746
|
+
{ id: "nshot", label: "N-Shot", children: [
|
|
4747
|
+
{ id: "nshot-summary", label: "Summary" },
|
|
4748
|
+
{ id: "nshot-comparisons", label: "Comparisons" },
|
|
4749
|
+
{ id: "nshot-comparison", label: "Single Comparison" },
|
|
4750
|
+
{ id: "nshot-override", label: "Override" },
|
|
4751
|
+
{ id: "nshot-judge-decision", label: "Judge Decision" }
|
|
4752
|
+
] },
|
|
4753
|
+
{ id: "schema-graph", label: "Schema Graph", children: [
|
|
4754
|
+
{ id: "list-schema-graph-classes", label: "List Classes" },
|
|
4755
|
+
{ id: "get-schema-graph-class", label: "Get Class" },
|
|
4756
|
+
{ id: "list-class-versions", label: "List Versions" },
|
|
4757
|
+
{ id: "get-class-version", label: "Get Version" },
|
|
4758
|
+
{ id: "list-schema-graph-diffs", label: "List Diffs" },
|
|
4759
|
+
{ id: "approve-diff", label: "Approve Diff" },
|
|
4760
|
+
{ id: "reject-diff", label: "Reject Diff" },
|
|
4761
|
+
{ id: "list-schema-graph-edges", label: "Edges" },
|
|
4762
|
+
{ id: "list-schema-graph-aliases", label: "Aliases" },
|
|
4763
|
+
{ id: "visualize-schema-graph", label: "Visualize" }
|
|
4764
|
+
] },
|
|
4765
|
+
{ id: "structuring", label: "Structuring", children: [
|
|
4766
|
+
{ id: "list-structuring-checks", label: "List Checks" },
|
|
4767
|
+
{ id: "create-structuring-check", label: "Create Check" },
|
|
4768
|
+
{ id: "get-structuring-check", label: "Get / Update / Delete Check" },
|
|
4769
|
+
{ id: "list-structuring-gates", label: "List Gates" },
|
|
4770
|
+
{ id: "create-structuring-gate", label: "Create Gate" },
|
|
4771
|
+
{ id: "get-structuring-gate", label: "Get / Update / Delete Gate" },
|
|
4772
|
+
{ id: "gate-rules", label: "Gate Rules" },
|
|
4773
|
+
{ id: "result-checks", label: "Result Checks" },
|
|
4774
|
+
{ id: "pending-approvals", label: "Pending Approvals" },
|
|
4775
|
+
{ id: "approve-reject-result", label: "Approve / Reject Result" },
|
|
4776
|
+
{ id: "trigger-delivery", label: "Trigger Delivery" }
|
|
4777
|
+
] },
|
|
4778
|
+
{ id: "telemetry", label: "Telemetry", children: [
|
|
4779
|
+
{ id: "schema-telemetry-summary", label: "Schema Summary" },
|
|
4780
|
+
{ id: "schema-telemetry-trend", label: "Schema Trend" },
|
|
4781
|
+
{ id: "schema-telemetry-fields", label: "Schema Fields" },
|
|
4782
|
+
{ id: "run-telemetry-summary", label: "Run Summary" }
|
|
4783
|
+
] },
|
|
4784
|
+
{ id: "validation", label: "Validation", children: [
|
|
4785
|
+
{ id: "list-golden-samples", label: "List Golden Samples" },
|
|
4786
|
+
{ id: "get-golden-sample", label: "Get / Delete Golden Sample" },
|
|
4787
|
+
{ id: "list-validation-runs", label: "List Validation Runs" },
|
|
4788
|
+
{ id: "create-validation-run", label: "Create Validation Run" },
|
|
4789
|
+
{ id: "get-validation-run", label: "Get / Delete Validation Run" },
|
|
4790
|
+
{ id: "get-validation-results", label: "Validation Results" }
|
|
4791
|
+
] },
|
|
4792
|
+
{ id: "credits", label: "Credits", children: [
|
|
4793
|
+
{ id: "credits-balance", label: "Balance" },
|
|
4794
|
+
{ id: "credits-history", label: "History" },
|
|
4795
|
+
{ id: "credits-usage", label: "Usage Summary" },
|
|
4796
|
+
{ id: "credits-usage-daily", label: "Daily Usage" },
|
|
4797
|
+
{ id: "credits-usage-log", label: "Usage Log" }
|
|
4798
|
+
] },
|
|
4715
4799
|
{ id: "errors-rate-limits", label: "Errors & Rate Limits", children: [
|
|
4716
4800
|
{ id: "error-format", label: "Error Format" },
|
|
4717
4801
|
{ id: "error-codes", label: "Error Codes" },
|
|
@@ -4811,6 +4895,13 @@ var API_SECTION_META = [
|
|
|
4811
4895
|
{ id: "sources", title: "Inputs API", description: "Manage document sources for programmatic ingestion. Each source has its own API key and supports batch processing." },
|
|
4812
4896
|
{ id: "filter-search", title: "Filter & Search API", description: "Field autocomplete, document filtering with composable conditions, global omnisearch, and saved filter management." },
|
|
4813
4897
|
{ id: "webhooks", title: "Webhooks", description: "Real-time event notifications with HMAC-SHA256 signed payloads, delivery tracking, and exponential backoff retries." },
|
|
4898
|
+
{ id: "resolutions", title: "Resolutions API", description: "Resolution runs \u2014 apply field normalization, transforms, and lookup cascades to extracted data. List, create, execute, and delete resolution runs." },
|
|
4899
|
+
{ id: "linking", title: "Linking API", description: "Document linking graph \u2014 link keys, document links, entity graph, classification, backfill operations, and document-case mapping." },
|
|
4900
|
+
{ id: "nshot", title: "N-Shot API", description: "N-Shot comparison endpoints for job runs \u2014 summary, field comparisons, overrides, and AI/human judge decisions." },
|
|
4901
|
+
{ id: "schema-graph", title: "Schema Graph API", description: "Schema class ontology \u2014 versioned classes, diffs with approval/rejection workflow, inter-class edges, aliases, and D3-compatible visualization." },
|
|
4902
|
+
{ id: "structuring", title: "Structuring API", description: "Validation checks CRUD, approval gates with configurable rules, result check outcomes, pending approvals queue, and delivery triggers." },
|
|
4903
|
+
{ id: "validation", title: "Validation API", description: "Golden sample management and validation runs for measuring extraction accuracy against ground truth datasets." },
|
|
4904
|
+
{ id: "credits", title: "Credits API", description: "Credit balance, transaction history, aggregate usage summaries, daily usage breakdown, and per-request usage log." },
|
|
4814
4905
|
{ id: "errors-rate-limits", title: "Errors & Rate Limits", description: "Error response format, error codes, rate limit tiers by plan, and rate limit headers." }
|
|
4815
4906
|
];
|
|
4816
4907
|
var PLATFORM_SECTION_META = [
|
|
@@ -4927,6 +5018,265 @@ var OPENAPI_SPEC = {
|
|
|
4927
5018
|
"/v1/sources/{id}/documents": {
|
|
4928
5019
|
get: { operationId: "listSourceDocuments", summary: "List documents in a source", tags: ["Sources"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Paginated documents" } } },
|
|
4929
5020
|
post: { operationId: "ingestDocument", summary: "Ingest a document into a source", tags: ["Sources"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Ingested document" } } }
|
|
5021
|
+
},
|
|
5022
|
+
// Resolutions
|
|
5023
|
+
"/v1/resolutions": {
|
|
5024
|
+
get: { operationId: "listResolutions", summary: "List resolution runs", tags: ["Resolutions"], responses: { "200": { description: "Paginated list of resolution runs" } } },
|
|
5025
|
+
post: { operationId: "createResolution", summary: "Create a resolution run", tags: ["Resolutions"], responses: { "201": { description: "Resolution run created" } } }
|
|
5026
|
+
},
|
|
5027
|
+
"/v1/resolutions/{id}": {
|
|
5028
|
+
get: { operationId: "getResolution", summary: "Get a resolution run", tags: ["Resolutions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Resolution run detail" } } },
|
|
5029
|
+
delete: { operationId: "deleteResolution", summary: "Delete a resolution run", tags: ["Resolutions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Resolution run deleted" } } }
|
|
5030
|
+
},
|
|
5031
|
+
"/v1/resolutions/{id}/results": {
|
|
5032
|
+
get: { operationId: "getResolutionResults", summary: "Get resolution run results", tags: ["Resolutions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Resolution results" } } }
|
|
5033
|
+
},
|
|
5034
|
+
"/v1/resolutions/{id}/execute": {
|
|
5035
|
+
post: { operationId: "executeResolution", summary: "Execute a resolution run", tags: ["Resolutions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Resolution execution started" } } }
|
|
5036
|
+
},
|
|
5037
|
+
// Linking
|
|
5038
|
+
"/v1/linking/link-keys": {
|
|
5039
|
+
get: { operationId: "listLinkKeys", summary: "List link keys", tags: ["Linking"], responses: { "200": { description: "List of link keys" } } }
|
|
5040
|
+
},
|
|
5041
|
+
"/v1/linking/documents/{id}/links": {
|
|
5042
|
+
get: { operationId: "getDocumentLinks", summary: "Get links for a document", tags: ["Linking"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Document links" } } }
|
|
5043
|
+
},
|
|
5044
|
+
"/v1/linking/graph": {
|
|
5045
|
+
get: { operationId: "getLinkingGraph", summary: "Get the full linking graph", tags: ["Linking"], responses: { "200": { description: "Full linking graph" } } }
|
|
5046
|
+
},
|
|
5047
|
+
"/v1/linking/graph/documents/{id}": {
|
|
5048
|
+
get: { operationId: "getDocumentGraph", summary: "Get graph neighbourhood for a document", tags: ["Linking"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Document-centric subgraph" } } }
|
|
5049
|
+
},
|
|
5050
|
+
"/v1/linking/classify": {
|
|
5051
|
+
post: { operationId: "classifyLinkKeys", summary: "Classify link keys", tags: ["Linking"], responses: { "200": { description: "Classification results" } } }
|
|
5052
|
+
},
|
|
5053
|
+
"/v1/linking/backfill": {
|
|
5054
|
+
post: { operationId: "backfillLinking", summary: "Backfill linking data", tags: ["Linking"], responses: { "202": { description: "Backfill started" } } }
|
|
5055
|
+
},
|
|
5056
|
+
"/v1/linking/backfill/progress": {
|
|
5057
|
+
get: { operationId: "getBackfillProgress", summary: "Get backfill progress", tags: ["Linking"], responses: { "200": { description: "Backfill progress" } } }
|
|
5058
|
+
},
|
|
5059
|
+
"/v1/linking/document-case-map": {
|
|
5060
|
+
get: { operationId: "getDocumentCaseMap", summary: "Get document-to-case mapping", tags: ["Linking"], responses: { "200": { description: "Document-case mapping" } } }
|
|
5061
|
+
},
|
|
5062
|
+
// N-Shot
|
|
5063
|
+
"/v1/jobs/runs/{runId}/nshot/summary": {
|
|
5064
|
+
get: { operationId: "getNshotSummary", summary: "Get N-Shot summary for a run", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "N-Shot summary" } } }
|
|
5065
|
+
},
|
|
5066
|
+
"/v1/jobs/runs/{runId}/nshot/comparisons": {
|
|
5067
|
+
get: { operationId: "listNshotComparisons", summary: "List N-Shot comparisons", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "List of comparisons" } } }
|
|
5068
|
+
},
|
|
5069
|
+
"/v1/jobs/runs/{runId}/nshot/comparison": {
|
|
5070
|
+
get: { operationId: "getNshotComparison", summary: "Get a specific N-Shot comparison", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Single comparison result" } } }
|
|
5071
|
+
},
|
|
5072
|
+
"/v1/jobs/runs/{runId}/nshot/override": {
|
|
5073
|
+
post: { operationId: "nshotOverride", summary: "Override an N-Shot value", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Override applied" } } }
|
|
5074
|
+
},
|
|
5075
|
+
"/v1/jobs/runs/{runId}/nshot/judge-decision": {
|
|
5076
|
+
post: { operationId: "nshotJudgeDecision", summary: "Submit a judge decision for N-Shot", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Judge decision recorded" } } }
|
|
5077
|
+
},
|
|
5078
|
+
// Schema Graph
|
|
5079
|
+
"/v1/schema-graph/classes": {
|
|
5080
|
+
get: { operationId: "listSchemaGraphClasses", summary: "List schema graph classes", tags: ["Schema Graph"], responses: { "200": { description: "List of schema graph classes" } } }
|
|
5081
|
+
},
|
|
5082
|
+
"/v1/schema-graph/classes/{id}": {
|
|
5083
|
+
get: { operationId: "getSchemaGraphClass", summary: "Get a schema graph class", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Schema graph class detail" } } }
|
|
5084
|
+
},
|
|
5085
|
+
"/v1/schema-graph/classes/{id}/versions": {
|
|
5086
|
+
get: { operationId: "listSchemaGraphClassVersions", summary: "List versions of a schema graph class", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "List of class versions" } } }
|
|
5087
|
+
},
|
|
5088
|
+
"/v1/schema-graph/classes/{id}/versions/{version}": {
|
|
5089
|
+
get: { operationId: "getSchemaGraphClassVersion", summary: "Get a specific class version", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }, { name: "version", in: "path", required: true, schema: { type: "integer" } }], responses: { "200": { description: "Class version detail" } } }
|
|
5090
|
+
},
|
|
5091
|
+
"/v1/schema-graph/diffs": {
|
|
5092
|
+
get: { operationId: "listSchemaGraphDiffs", summary: "List schema graph diffs", tags: ["Schema Graph"], responses: { "200": { description: "List of diffs" } } }
|
|
5093
|
+
},
|
|
5094
|
+
"/v1/schema-graph/diffs/{id}/approve": {
|
|
5095
|
+
post: { operationId: "approveSchemaGraphDiff", summary: "Approve a schema graph diff", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Diff approved" } } }
|
|
5096
|
+
},
|
|
5097
|
+
"/v1/schema-graph/diffs/{id}/reject": {
|
|
5098
|
+
post: { operationId: "rejectSchemaGraphDiff", summary: "Reject a schema graph diff", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Diff rejected" } } }
|
|
5099
|
+
},
|
|
5100
|
+
"/v1/schema-graph/edges": {
|
|
5101
|
+
get: { operationId: "listSchemaGraphEdges", summary: "List schema graph edges", tags: ["Schema Graph"], responses: { "200": { description: "List of edges" } } }
|
|
5102
|
+
},
|
|
5103
|
+
"/v1/schema-graph/aliases": {
|
|
5104
|
+
get: { operationId: "listSchemaGraphAliases", summary: "List schema graph aliases", tags: ["Schema Graph"], responses: { "200": { description: "List of aliases" } } }
|
|
5105
|
+
},
|
|
5106
|
+
"/v1/schema-graph/visualize": {
|
|
5107
|
+
get: { operationId: "visualizeSchemaGraph", summary: "Get schema graph visualization data", tags: ["Schema Graph"], responses: { "200": { description: "Visualization data" } } }
|
|
5108
|
+
},
|
|
5109
|
+
// Structuring
|
|
5110
|
+
"/v1/structuring/checks": {
|
|
5111
|
+
get: { operationId: "listStructuringChecks", summary: "List structuring checks", tags: ["Structuring"], responses: { "200": { description: "Paginated list of structuring checks" } } },
|
|
5112
|
+
post: { operationId: "createStructuringCheck", summary: "Create a structuring check", tags: ["Structuring"], responses: { "201": { description: "Structuring check created" } } }
|
|
5113
|
+
},
|
|
5114
|
+
"/v1/structuring/checks/{id}": {
|
|
5115
|
+
get: { operationId: "getStructuringCheck", summary: "Get a structuring check", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Structuring check detail" } } },
|
|
5116
|
+
put: { operationId: "updateStructuringCheck", summary: "Update a structuring check", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Structuring check updated" } } },
|
|
5117
|
+
delete: { operationId: "deleteStructuringCheck", summary: "Delete a structuring check", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Structuring check deleted" } } }
|
|
5118
|
+
},
|
|
5119
|
+
"/v1/structuring/gates": {
|
|
5120
|
+
get: { operationId: "listStructuringGates", summary: "List approval gates", tags: ["Structuring"], responses: { "200": { description: "Paginated list of approval gates" } } },
|
|
5121
|
+
post: { operationId: "createStructuringGate", summary: "Create an approval gate", tags: ["Structuring"], responses: { "201": { description: "Approval gate created" } } }
|
|
5122
|
+
},
|
|
5123
|
+
"/v1/structuring/gates/{id}": {
|
|
5124
|
+
get: { operationId: "getStructuringGate", summary: "Get an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Approval gate detail" } } },
|
|
5125
|
+
put: { operationId: "updateStructuringGate", summary: "Update an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Approval gate updated" } } },
|
|
5126
|
+
delete: { operationId: "deleteStructuringGate", summary: "Delete an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Approval gate deleted" } } }
|
|
5127
|
+
},
|
|
5128
|
+
"/v1/structuring/gates/{id}/rules": {
|
|
5129
|
+
post: { operationId: "addStructuringGateRule", summary: "Add a rule to an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "201": { description: "Rule added" } } },
|
|
5130
|
+
delete: { operationId: "deleteStructuringGateRule", summary: "Remove a rule from an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Rule removed" } } }
|
|
5131
|
+
},
|
|
5132
|
+
"/v1/structuring/results/{id}/checks": {
|
|
5133
|
+
get: { operationId: "getStructuringResultChecks", summary: "Get check results for a structuring result", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Check results" } } }
|
|
5134
|
+
},
|
|
5135
|
+
"/v1/structuring/approvals/pending": {
|
|
5136
|
+
get: { operationId: "listPendingApprovals", summary: "List pending approvals", tags: ["Structuring"], responses: { "200": { description: "Paginated list of pending approvals" } } }
|
|
5137
|
+
},
|
|
5138
|
+
"/v1/structuring/approvals/{id}/approve": {
|
|
5139
|
+
post: { operationId: "approveStructuringResult", summary: "Approve a structuring result", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Result approved" } } }
|
|
5140
|
+
},
|
|
5141
|
+
"/v1/structuring/approvals/{id}/reject": {
|
|
5142
|
+
post: { operationId: "rejectStructuringResult", summary: "Reject a structuring result", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Result rejected" } } }
|
|
5143
|
+
},
|
|
5144
|
+
"/v1/structuring/delivery/{runId}": {
|
|
5145
|
+
post: { operationId: "triggerStructuringDelivery", summary: "Trigger delivery for a structuring run", tags: ["Structuring"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Delivery triggered" } } }
|
|
5146
|
+
},
|
|
5147
|
+
// Telemetry
|
|
5148
|
+
"/v1/telemetry/schemas/{id}/summary": {
|
|
5149
|
+
get: { operationId: "getTelemetrySchemaSummary", summary: "Get telemetry summary for a schema", tags: ["Telemetry"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Schema telemetry summary" } } }
|
|
5150
|
+
},
|
|
5151
|
+
"/v1/telemetry/schemas/{id}/trend": {
|
|
5152
|
+
get: { operationId: "getTelemetrySchemaTrend", summary: "Get telemetry trend for a schema", tags: ["Telemetry"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Schema telemetry trend" } } }
|
|
5153
|
+
},
|
|
5154
|
+
"/v1/telemetry/schemas/{id}/fields": {
|
|
5155
|
+
get: { operationId: "getTelemetrySchemaFields", summary: "Get per-field telemetry for a schema", tags: ["Telemetry"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Per-field telemetry" } } }
|
|
5156
|
+
},
|
|
5157
|
+
"/v1/telemetry/runs/{id}/summary": {
|
|
5158
|
+
get: { operationId: "getTelemetryRunSummary", summary: "Get telemetry summary for a run", tags: ["Telemetry"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Run telemetry summary" } } }
|
|
5159
|
+
},
|
|
5160
|
+
// Validation
|
|
5161
|
+
"/v1/validation/golden-samples": {
|
|
5162
|
+
get: { operationId: "listGoldenSamples", summary: "List golden samples", tags: ["Validation"], responses: { "200": { description: "Paginated list of golden samples" } } }
|
|
5163
|
+
},
|
|
5164
|
+
"/v1/validation/golden-samples/{id}": {
|
|
5165
|
+
get: { operationId: "getGoldenSample", summary: "Get a golden sample", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Golden sample detail" } } },
|
|
5166
|
+
delete: { operationId: "deleteGoldenSample", summary: "Delete a golden sample", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Golden sample deleted" } } }
|
|
5167
|
+
},
|
|
5168
|
+
"/v1/validation/runs": {
|
|
5169
|
+
get: { operationId: "listValidationRuns", summary: "List validation runs", tags: ["Validation"], responses: { "200": { description: "Paginated list of validation runs" } } },
|
|
5170
|
+
post: { operationId: "createValidationRun", summary: "Create a validation run", tags: ["Validation"], responses: { "201": { description: "Validation run created" } } }
|
|
5171
|
+
},
|
|
5172
|
+
"/v1/validation/runs/{id}": {
|
|
5173
|
+
get: { operationId: "getValidationRun", summary: "Get a validation run", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Validation run detail" } } },
|
|
5174
|
+
delete: { operationId: "deleteValidationRun", summary: "Delete a validation run", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Validation run deleted" } } }
|
|
5175
|
+
},
|
|
5176
|
+
"/v1/validation/runs/{id}/results": {
|
|
5177
|
+
get: { operationId: "getValidationRunResults", summary: "Get validation run results", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Validation run results" } } }
|
|
5178
|
+
},
|
|
5179
|
+
// Credits
|
|
5180
|
+
"/v1/credits/balance": {
|
|
5181
|
+
get: { operationId: "getCreditsBalance", summary: "Get credit balance", tags: ["Credits"], responses: { "200": { description: "Credit balance" } } }
|
|
5182
|
+
},
|
|
5183
|
+
"/v1/credits/history": {
|
|
5184
|
+
get: { operationId: "getCreditsHistory", summary: "Get credit history", tags: ["Credits"], responses: { "200": { description: "Paginated credit history" } } }
|
|
5185
|
+
},
|
|
5186
|
+
"/v1/credits/usage": {
|
|
5187
|
+
get: { operationId: "getCreditsUsage", summary: "Get credit usage summary", tags: ["Credits"], responses: { "200": { description: "Credit usage summary" } } }
|
|
5188
|
+
},
|
|
5189
|
+
"/v1/credits/usage/daily": {
|
|
5190
|
+
get: { operationId: "getCreditsUsageDaily", summary: "Get daily credit usage", tags: ["Credits"], responses: { "200": { description: "Daily credit usage" } } }
|
|
5191
|
+
},
|
|
5192
|
+
"/v1/credits/usage/log": {
|
|
5193
|
+
get: { operationId: "getCreditsUsageLog", summary: "Get credit usage log", tags: ["Credits"], responses: { "200": { description: "Paginated usage log" } } }
|
|
5194
|
+
},
|
|
5195
|
+
// Expanded: Cases
|
|
5196
|
+
"/v1/cases/{key}/status": {
|
|
5197
|
+
patch: { operationId: "updateCaseStatus", summary: "Update case status", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Case status updated" } } }
|
|
5198
|
+
},
|
|
5199
|
+
"/v1/cases/{key}/edges": {
|
|
5200
|
+
get: { operationId: "getCaseEdges", summary: "Get case edges", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Case edges" } } }
|
|
5201
|
+
},
|
|
5202
|
+
"/v1/cases/edges/confirm": {
|
|
5203
|
+
post: { operationId: "confirmCaseEdge", summary: "Confirm a case edge", tags: ["Cases"], responses: { "200": { description: "Edge confirmed" } } }
|
|
5204
|
+
},
|
|
5205
|
+
"/v1/cases/edges/reject": {
|
|
5206
|
+
post: { operationId: "rejectCaseEdge", summary: "Reject a case edge", tags: ["Cases"], responses: { "200": { description: "Edge rejected" } } }
|
|
5207
|
+
},
|
|
5208
|
+
"/v1/cases/{key}/split": {
|
|
5209
|
+
post: { operationId: "splitCase", summary: "Split a case", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Case split" } } }
|
|
5210
|
+
},
|
|
5211
|
+
"/v1/cases/{key}/merge": {
|
|
5212
|
+
post: { operationId: "mergeCases", summary: "Merge cases", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Cases merged" } } }
|
|
5213
|
+
},
|
|
5214
|
+
"/v1/cases/{key}/completeness": {
|
|
5215
|
+
get: { operationId: "getCaseCompleteness", summary: "Get case completeness", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Completeness assessment" } } }
|
|
5216
|
+
},
|
|
5217
|
+
"/v1/cases/{key}/pin": {
|
|
5218
|
+
post: { operationId: "pinCaseDocuments", summary: "Pin documents to a case", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Documents pinned" } } }
|
|
5219
|
+
},
|
|
5220
|
+
"/v1/cases/{key}/documents": {
|
|
5221
|
+
delete: { operationId: "removeCaseDocuments", summary: "Remove documents from a case", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Documents removed" } } }
|
|
5222
|
+
},
|
|
5223
|
+
// Expanded: Batches
|
|
5224
|
+
"/v1/batches/{id}/sync": {
|
|
5225
|
+
post: { operationId: "syncBatch", summary: "Sync batch status with provider", tags: ["Batches"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Batch synced" } } }
|
|
5226
|
+
},
|
|
5227
|
+
"/v1/batches/{id}/cancel": {
|
|
5228
|
+
post: { operationId: "cancelBatch", summary: "Cancel a batch inference run", tags: ["Batches"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Batch cancelled" } } }
|
|
5229
|
+
},
|
|
5230
|
+
// Expanded: Matching
|
|
5231
|
+
"/v1/matching/smart-run": {
|
|
5232
|
+
post: { operationId: "triggerSmartMatchingRun", summary: "Trigger a smart matching run", tags: ["Matching"], responses: { "201": { description: "Smart matching run queued" } } }
|
|
5233
|
+
},
|
|
5234
|
+
"/v1/matching/ai-resolve": {
|
|
5235
|
+
post: { operationId: "aiResolveMatching", summary: "AI-resolve ambiguous matches", tags: ["Matching"], responses: { "200": { description: "AI resolution results" } } }
|
|
5236
|
+
},
|
|
5237
|
+
"/v1/matching/strategies": {
|
|
5238
|
+
get: { operationId: "listMatchingStrategies", summary: "List matching strategies", tags: ["Matching"], responses: { "200": { description: "List of matching strategies" } } },
|
|
5239
|
+
post: { operationId: "createMatchingStrategy", summary: "Create a matching strategy", tags: ["Matching"], responses: { "201": { description: "Matching strategy created" } } }
|
|
5240
|
+
},
|
|
5241
|
+
"/v1/matching/strategies/{id}": {
|
|
5242
|
+
get: { operationId: "getMatchingStrategy", summary: "Get a matching strategy", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching strategy detail" } } },
|
|
5243
|
+
put: { operationId: "updateMatchingStrategy", summary: "Update a matching strategy", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching strategy updated" } } },
|
|
5244
|
+
delete: { operationId: "deleteMatchingStrategy", summary: "Delete a matching strategy", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching strategy deleted" } } }
|
|
5245
|
+
},
|
|
5246
|
+
"/v1/matching/runs/{id}/results": {
|
|
5247
|
+
get: { operationId: "getMatchingRunResults", summary: "Get matching run results", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching run results" } } }
|
|
5248
|
+
},
|
|
5249
|
+
"/v1/matching/runs/{id}/progress": {
|
|
5250
|
+
get: { operationId: "getMatchingRunProgress", summary: "Get matching run progress", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching run progress" } } }
|
|
5251
|
+
},
|
|
5252
|
+
"/v1/matching/review": {
|
|
5253
|
+
post: { operationId: "submitMatchingReview", summary: "Submit matching review decisions", tags: ["Matching"], responses: { "200": { description: "Review decisions applied" } } }
|
|
5254
|
+
},
|
|
5255
|
+
// Expanded: Review
|
|
5256
|
+
"/v1/review/assign": {
|
|
5257
|
+
post: { operationId: "assignReview", summary: "Assign review records", tags: ["Review"], responses: { "200": { description: "Records assigned" } } }
|
|
5258
|
+
},
|
|
5259
|
+
"/v1/review/stats": {
|
|
5260
|
+
get: { operationId: "getReviewStats", summary: "Get review queue statistics", tags: ["Review"], responses: { "200": { description: "Review statistics" } } }
|
|
5261
|
+
},
|
|
5262
|
+
// Expanded: Quality
|
|
5263
|
+
"/v1/quality/ground-truth/{id}/entries": {
|
|
5264
|
+
get: { operationId: "listGroundTruthEntries", summary: "List ground truth entries", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Paginated list of entries" } } },
|
|
5265
|
+
post: { operationId: "createGroundTruthEntry", summary: "Add a ground truth entry", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "201": { description: "Entry created" } } }
|
|
5266
|
+
},
|
|
5267
|
+
"/v1/quality/ground-truth/{id}/entries/{entryId}": {
|
|
5268
|
+
put: { operationId: "updateGroundTruthEntry", summary: "Update a ground truth entry", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }, { name: "entryId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Entry updated" } } },
|
|
5269
|
+
delete: { operationId: "deleteGroundTruthEntry", summary: "Delete a ground truth entry", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }, { name: "entryId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Entry deleted" } } }
|
|
5270
|
+
},
|
|
5271
|
+
"/v1/quality/benchmarks/{id}/results": {
|
|
5272
|
+
get: { operationId: "getBenchmarkResults", summary: "Get benchmark results", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Benchmark results" } } }
|
|
5273
|
+
},
|
|
5274
|
+
"/v1/quality/benchmarks/{id}/compare": {
|
|
5275
|
+
get: { operationId: "compareBenchmarks", summary: "Compare two benchmark runs", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Benchmark comparison" } } }
|
|
5276
|
+
},
|
|
5277
|
+
// Expanded: Reference Data
|
|
5278
|
+
"/v1/reference-data/create": {
|
|
5279
|
+
post: { operationId: "createReferenceDataJson", summary: "Create reference data from JSON", tags: ["Reference Data"], responses: { "201": { description: "Reference dataset created" } } }
|
|
4930
5280
|
}
|
|
4931
5281
|
}
|
|
4932
5282
|
};
|
|
@@ -5056,9 +5406,22 @@ Key endpoints:
|
|
|
5056
5406
|
- GET /v1/documents \u2014 List with cursor pagination; GET /v1/documents/:id/markdown for OCR text
|
|
5057
5407
|
- GET /v1/extractions \u2014 Query results and field corrections
|
|
5058
5408
|
- POST /v1/schemas \u2014 Create/manage extraction schemas
|
|
5059
|
-
- GET /v1/jobs \u2014 Track async jobs and results
|
|
5409
|
+
- GET /v1/jobs \u2014 Track async jobs and results; N-Shot comparisons, overrides, judge decisions
|
|
5060
5410
|
- POST /v1/sources \u2014 Manage API sources and document ingest
|
|
5061
5411
|
- POST /v1/webhooks \u2014 Configure webhook endpoints
|
|
5412
|
+
- /v1/resolutions \u2014 Resolution runs: list, create, get, execute, delete, results
|
|
5413
|
+
- /v1/linking \u2014 Link keys, document links, entity graph, classify, backfill, document-case map
|
|
5414
|
+
- /v1/schema-graph \u2014 Schema classes, versions, diffs (approve/reject), edges, aliases, visualize
|
|
5415
|
+
- /v1/structuring \u2014 Validation checks CRUD, approval gates CRUD with rules, result checks, pending approvals, approve/reject, delivery trigger
|
|
5416
|
+
- /v1/telemetry \u2014 Per-schema and per-run summaries, trends, field-level breakdowns
|
|
5417
|
+
- /v1/validation \u2014 Golden samples (list, get, delete), validation runs (list, create, get, delete, results)
|
|
5418
|
+
- /v1/credits \u2014 Balance, history, usage summary, daily usage, per-request usage log
|
|
5419
|
+
- /v1/cases \u2014 Status updates, edges, edge confirm/reject, split/merge, completeness, pin/remove documents
|
|
5420
|
+
- /v1/batches \u2014 Sync with provider, cancel
|
|
5421
|
+
- /v1/matching \u2014 Smart run, AI resolve, strategies CRUD, run results/progress, review
|
|
5422
|
+
- /v1/review \u2014 Assign, stats
|
|
5423
|
+
- /v1/quality \u2014 Ground truth entries CRUD, benchmark results, benchmark comparison
|
|
5424
|
+
- /v1/reference-data \u2014 JSON upload (POST create)
|
|
5062
5425
|
|
|
5063
5426
|
Webhook events: extraction.completed, job.completed, export.completed, validation.completed. All HMAC-SHA256 signed with retry on failure.
|
|
5064
5427
|
|