@talonic/docs 0.20.17 → 0.20.19

package/dist/index.js

@@ -813,6 +813,41 @@ var NAV_SECTIONS = [
       { id: "credits-usage-log", label: "Usage Log" }
     ]
   },
+  {
+    id: "data-products",
+    label: "Data Products",
+    children: [
+      { id: "list-data-products", label: "List Data Products" },
+      { id: "get-data-product", label: "Get Data Product" },
+      { id: "delete-data-product", label: "Delete Data Product" },
+      { id: "get-data-product-results", label: "Get Results" }
+    ]
+  },
+  {
+    id: "data-policies",
+    label: "Data Policies",
+    children: [
+      { id: "list-data-policies", label: "List Policies" },
+      { id: "create-data-policy", label: "Create Policy" },
+      { id: "get-data-policy", label: "Get Policy" },
+      { id: "update-data-policy", label: "Update Policy" },
+      { id: "delete-data-policy", label: "Delete Policy" },
+      { id: "list-data-policy-versions", label: "List Versions" },
+      { id: "list-data-policy-fields", label: "List Fields" },
+      { id: "list-data-policy-rules", label: "List Rules" }
+    ]
+  },
+  {
+    id: "record-sets",
+    label: "Record Sets",
+    children: [
+      { id: "list-record-sets", label: "List Record Sets" },
+      { id: "get-record-set", label: "Get Record Set" },
+      { id: "list-record-set-fields", label: "List Fields" },
+      { id: "list-record-set-records", label: "List Records" },
+      { id: "export-record-set", label: "Export" }
+    ]
+  },
   {
     id: "billing",
     label: "Billing",
@@ -5032,6 +5067,128 @@ function verifyWebhook(payload, signature, secret) {
 }` })
         }
       ) }),
+      /* @__PURE__ */ jsx5(SectionHeading, { id: "data-products", children: "Data Products" }),
+      /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-4", children: "Data products are the final assembled output of the structuring pipeline. They combine extraction results with resolution rules, validation, and approval gates into a deliverable dataset. Use these endpoints to list, inspect, and export your structured data." }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-data-products", children: "List Data Products" }),
+      /* @__PURE__ */ jsxs5(EndpointBlock, { method: "GET", path: "/v1/data-products", summary: "List data products with cursor-based pagination.", children: [
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Query parameters", params: [
+          { name: "status", type: "string", description: "Filter by status (draft, ready, published, archived)." },
+          { name: "limit", type: "integer", default: "20", description: "Items per page (1-100)." },
+          { name: "cursor", type: "string", description: "Opaque pagination cursor." },
+          { name: "order", type: "string", default: "desc", description: "Sort order (asc | desc)." }
+        ] }),
+        /* @__PURE__ */ jsx5(CodeBlock, { title: "curl", children: `curl https://api.talonic.com/v1/data-products?status=ready \\
+  -H "Authorization: Bearer tlnc_YOUR_KEY"` })
+      ] }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "get-data-product", children: "Get Data Product" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/data-products/{id}", summary: "Get a single data product by ID.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Data product UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "delete-data-product", children: "Delete Data Product" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "DELETE", path: "/v1/data-products/{id}", summary: "Delete a data product. Requires write scope.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Data product UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "get-data-product-results", children: "Get Data Product Results" }),
+      /* @__PURE__ */ jsxs5(EndpointBlock, { method: "GET", path: "/v1/data-products/{id}/results", summary: "Get paginated result rows for a data product.", children: [
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+          { name: "id", type: "uuid", required: true, description: "Data product UUID." }
+        ] }),
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Query parameters", params: [
+          { name: "limit", type: "integer", default: "20", description: "Items per page (1-100)." },
+          { name: "cursor", type: "string", description: "Opaque pagination cursor." }
+        ] }),
+        /* @__PURE__ */ jsx5(CodeBlock, { title: "curl", children: `curl https://api.talonic.com/v1/data-products/DP_ID/results \\
+  -H "Authorization: Bearer tlnc_YOUR_KEY"` })
+      ] }),
+      /* @__PURE__ */ jsx5(SectionHeading, { id: "data-policies", children: "Data Policies" }),
+      /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-4", children: "Data policies define transformation rules that normalize and enrich extracted field values. They power the resolution pipeline with lookup cascades, deterministic compute, format constraints, and optional Lua scripting. Policies are versioned \u2014 publish a version to lock it for production use." }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-data-policies", children: "List Policies" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/data-policies", summary: "List all data policies with cursor-based pagination.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Query parameters", params: [
+        { name: "limit", type: "integer", default: "20", description: "Items per page (1-100)." },
+        { name: "cursor", type: "string", description: "Opaque pagination cursor." },
+        { name: "order", type: "string", default: "desc", description: "Sort order (asc | desc)." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "create-data-policy", children: "Create Policy" }),
+      /* @__PURE__ */ jsxs5(EndpointBlock, { method: "POST", path: "/v1/data-policies", summary: "Create a new data policy. Requires write scope.", children: [
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Body parameters", params: [
+          { name: "name", type: "string", required: true, description: "Policy name." },
+          { name: "description", type: "string", description: "Optional description." }
+        ] }),
+        /* @__PURE__ */ jsx5(CodeBlock, { title: "curl", children: `curl -X POST https://api.talonic.com/v1/data-policies \\
+  -H "Authorization: Bearer tlnc_YOUR_KEY" \\
+  -H "Content-Type: application/json" \\
+  -d '{"name": "Invoice Normalization"}'` })
+      ] }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "get-data-policy", children: "Get Policy" }),
+      /* @__PURE__ */ jsxs5(EndpointBlock, { method: "GET", path: "/v1/data-policies/{id}", summary: "Get a policy with its fields and rules inlined.", children: [
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+          { name: "id", type: "uuid", required: true, description: "Policy UUID." }
+        ] }),
+        /* @__PURE__ */ jsxs5(Callout, { type: "info", children: [
+          "The response includes ",
+          /* @__PURE__ */ jsx5(InlineCode, { children: "fields" }),
+          " and ",
+          /* @__PURE__ */ jsx5(InlineCode, { children: "rules" }),
+          " arrays inlined in the policy object for convenience."
+        ] })
+      ] }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "update-data-policy", children: "Update Policy" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "PATCH", path: "/v1/data-policies/{id}", summary: "Update policy name or description. Requires write scope.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Body parameters", params: [
+        { name: "name", type: "string", description: "New policy name." },
+        { name: "description", type: "string", description: "New description." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "delete-data-policy", children: "Delete Policy" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "DELETE", path: "/v1/data-policies/{id}", summary: "Delete a data policy. Requires write scope." }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-data-policy-versions", children: "List Versions" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/data-policies/{id}/versions", summary: "List all published versions of a policy.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Policy UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-data-policy-fields", children: "List Fields" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/data-policies/{id}/fields", summary: "List declared output fields for a policy.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Policy UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-data-policy-rules", children: "List Rules" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/data-policies/{id}/rules", summary: "List transformation rules ordered by execution priority.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Policy UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SectionHeading, { id: "record-sets", children: "Record Sets" }),
+      /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-4", children: "Record sets are the value-plane storage layer \u2014 typed tables that hold cell values with confidence scores and provenance metadata. Each extraction, structuring run, or resolution produces a record set at the appropriate layer (capture, structured, resolved, or product)." }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-record-sets", children: "List Record Sets" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/record-sets", summary: "List record sets with optional layer and source_type filters.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Query parameters", params: [
+        { name: "layer", type: "string", description: "Filter by value layer (capture, structured, resolved, product)." },
+        { name: "source_type", type: "string", description: "Filter by source type (e.g. extraction, job, resolution)." },
+        { name: "limit", type: "integer", default: "20", description: "Items per page (1-100)." },
+        { name: "cursor", type: "string", description: "Opaque pagination cursor." },
+        { name: "order", type: "string", default: "desc", description: "Sort order (asc | desc)." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "get-record-set", children: "Get Record Set" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/record-sets/{id}", summary: "Get a single record set with field and record counts.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Record set UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-record-set-fields", children: "List Fields" }),
+      /* @__PURE__ */ jsx5(EndpointBlock, { method: "GET", path: "/v1/record-sets/{id}/fields", summary: "List the field schema for a record set, ordered by ordinal.", children: /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+        { name: "id", type: "uuid", required: true, description: "Record set UUID." }
+      ] }) }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "list-record-set-records", children: "List Records" }),
+      /* @__PURE__ */ jsxs5(EndpointBlock, { method: "GET", path: "/v1/record-sets/{id}/records", summary: "Get paginated records using offset pagination.", children: [
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Query parameters", params: [
+          { name: "page", type: "integer", default: "1", description: "Page number (1-based)." },
+          { name: "limit", type: "integer", default: "50", description: "Records per page (max 200)." }
+        ] }),
+        /* @__PURE__ */ jsx5(CodeBlock, { title: "curl", children: `curl "https://api.talonic.com/v1/record-sets/RS_ID/records?page=1&limit=50" \\
+  -H "Authorization: Bearer tlnc_YOUR_KEY"` })
+      ] }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "export-record-set", children: "Export" }),
+      /* @__PURE__ */ jsxs5(EndpointBlock, { method: "GET", path: "/v1/record-sets/{id}/export", summary: "Export all records as a JSON array. Best for smaller datasets.", children: [
+        /* @__PURE__ */ jsx5(ParamTable, { title: "Path parameters", params: [
+          { name: "id", type: "uuid", required: true, description: "Record set UUID." }
+        ] }),
+        /* @__PURE__ */ jsxs5(Callout, { type: "warning", children: [
+          "For large record sets (10,000+ records), prefer the paginated ",
+          /* @__PURE__ */ jsx5(InlineCode, { children: "/records" }),
+          " endpoint to avoid timeouts and high memory usage."
+        ] })
+      ] }),
       /* @__PURE__ */ jsx5(SectionHeading, { id: "errors-rate-limits", children: "Errors & Rate Limits" }),
       /* @__PURE__ */ jsx5(SubHeading, { id: "error-format", children: "Error Format" }),
       /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-4", children: "All errors return a consistent JSON structure with a machine-readable code and a human-readable message." }),
@@ -6558,7 +6715,10 @@ var API_NAV_SECTIONS = [
     { id: "webhook-events", label: "Events" },
     { id: "webhook-management", label: "Delivery Format" },
     { id: "webhook-security", label: "Signature Verification" },
-    { id: "webhook-retry", label: "Retry Policy" }
+    { id: "webhook-retry", label: "Retry Policy" },
+    { id: "list-webhook-configs", label: "List Configs" },
+    { id: "create-webhook-config", label: "Create Config" },
+    { id: "manage-webhook-config", label: "Manage Config" }
   ] },
   { id: "resolutions", label: "Resolutions", children: [
     { id: "list-resolutions", label: "List Resolutions" },
@@ -6575,7 +6735,6 @@ var API_NAV_SECTIONS = [
     { id: "list-linked-documents", label: "Full Graph" },
     { id: "list-cases", label: "Backfill" },
     { id: "get-case", label: "Cases" },
-    { id: "get-case-graph", label: "Case Graph" },
     { id: "refresh-cases", label: "Document-Case Map" }
   ] },
   { id: "nshot", label: "N-Shot", children: [
@@ -6642,7 +6801,10 @@ var API_NAV_SECTIONS = [
     { id: "run-matching", label: "Run Matching" },
     { id: "get-matching-run", label: "Get Run" },
     { id: "get-matching-results", label: "Get Results" },
-    { id: "generate-strategy", label: "Generate Strategy" }
+    { id: "generate-strategy", label: "Generate Strategy" },
+    { id: "list-matching-runs", label: "List Runs" },
+    { id: "review-match-result", label: "Review Result" },
+    { id: "manage-matching-strategy", label: "Manage Strategy" }
   ] },
   { id: "delivery", label: "Delivery", children: [
     { id: "list-delivery-destinations", label: "List Destinations" },
@@ -6665,7 +6827,6 @@ var API_NAV_SECTIONS = [
     { id: "list-cases", label: "List Cases" },
     { id: "get-case", label: "Get Case" },
     { id: "case-anomalies", label: "Anomalies" },
-    { id: "case-evidence", label: "Evidence" },
     { id: "case-operations", label: "Operations" },
     { id: "case-edges", label: "Edges" },
     { id: "case-documents", label: "Documents" },
@@ -6694,14 +6855,57 @@ var API_NAV_SECTIONS = [
     { id: "manage-routing-rule", label: "Manage Rule" },
     { id: "reorder-routing-rules", label: "Reorder" }
   ] },
+  { id: "reference-data", label: "Reference Data", children: [
+    { id: "list-reference-data", label: "List & Create" },
+    { id: "get-reference-data", label: "Get & Delete" },
+    { id: "reference-data-rows", label: "Rows & Export" }
+  ] },
+  { id: "dialects", label: "Dialects", children: [
+    { id: "list-dialects", label: "List & Create" },
+    { id: "manage-dialect", label: "Manage Dialect" }
+  ] },
+  { id: "fields", label: "Fields", children: [
+    { id: "list-fields", label: "List Fields" },
+    { id: "field-harmonization", label: "Harmonization" },
+    { id: "get-field", label: "Get Field" }
+  ] },
   { id: "registry", label: "Registry", children: [
     { id: "registry-query", label: "Query" }
   ] },
+  { id: "data-products", label: "Data Products", children: [
+    { id: "list-data-products", label: "List Data Products" },
+    { id: "get-data-product", label: "Get Data Product" },
+    { id: "delete-data-product", label: "Delete Data Product" },
+    { id: "get-data-product-results", label: "Get Results" }
+  ] },
+  { id: "data-policies", label: "Data Policies", children: [
+    { id: "list-data-policies", label: "List Policies" },
+    { id: "create-data-policy", label: "Create Policy" },
+    { id: "get-data-policy", label: "Get Policy" },
+    { id: "update-data-policy", label: "Update Policy" },
+    { id: "delete-data-policy", label: "Delete Policy" },
+    { id: "list-data-policy-versions", label: "List Versions" },
+    { id: "list-data-policy-fields", label: "List Fields" },
+    { id: "list-data-policy-rules", label: "List Rules" }
+  ] },
+  { id: "record-sets", label: "Record Sets", children: [
+    { id: "list-record-sets", label: "List Record Sets" },
+    { id: "get-record-set", label: "Get Record Set" },
+    { id: "list-record-set-fields", label: "List Fields" },
+    { id: "list-record-set-records", label: "List Records" },
+    { id: "export-record-set", label: "Export" }
+  ] },
   { id: "billing", label: "Billing", children: [
     { id: "billing-settings", label: "Settings" },
     { id: "billing-topup", label: "Auto Top-Up" },
     { id: "cost-headers", label: "Cost Headers" }
   ] },
+  { id: "usage", label: "Usage", children: [
+    { id: "usage-overview", label: "Overview" }
+  ] },
+  { id: "document-types", label: "Document Types", children: [
+    { id: "list-document-types", label: "Document Types" }
+  ] },
   { id: "errors-rate-limits", label: "Errors & Rate Limits", children: [
     { id: "error-format", label: "Error Format" },
     { id: "error-codes", label: "Error Codes" },
@@ -6843,10 +7047,14 @@ var API_SECTION_META = [
   { id: "matching", title: "Matching API", description: "Reference data matching \u2014 create configs with weighted field strategies, run matches, get top-5 candidates per document, and AI-generate strategies." },
   { id: "delivery", title: "Delivery API", description: "Outbound delivery pipeline \u2014 destinations, bindings, delivery history, dead letter queue, and catalog discovery for signals, deliverables, serializers, and connectors." },
   { id: "batches", title: "Batches API", description: "Batch extraction processing at 50% cost \u2014 list, get, sync with provider, and cancel batches." },
-  { id: "cases", title: "Cases API", description: "Case management \u2014 list, get, anomalies, evidence, narration, labels, edge confirmation, document pinning, merge and split operations." },
+  { id: "cases", title: "Cases API", description: "Case management \u2014 list, get, anomalies, status lifecycle, edge confirmation, document pinning, merge and split operations." },
   { id: "review", title: "Review API", description: "Review queue for validation records \u2014 list items, stats, take action (approve/reject/flag), batch operations, and assignment." },
   { id: "quality", title: "Quality API", description: "Ground truth datasets, entries management with CSV import, benchmark runs, per-field accuracy results, and benchmark comparison." },
   { id: "routing-rules", title: "Routing Rules API", description: "Document routing rules \u2014 create, manage, and reorder priority-based rules for automatic document workflow assignment." },
+  { id: "reference-data", title: "Reference Data API", description: "Upload, list, and manage reference data tables used as lookup targets for matching configurations. Supports JSON upload, paginated row access, and CSV export." },
+  { id: "fields", title: "Fields API", description: "Read-only access to the field registry \u2014 list fields with filters, cross-schema harmonization analysis, field detail with occurrences, and embedding-based similarity search." },
+  { id: "usage", title: "Usage API", description: "AI token usage tracking \u2014 aggregate stats by operation type and model, per-document usage breakdown with cost estimates." },
+  { id: "document-types", title: "Document Types API", description: "Document type classification \u2014 list workspace document types by frequency and retrieve the 529-type ontology taxonomy." },
   { id: "registry", title: "Registry API", description: "Query previously-extracted field values across all documents \u2014 ingest once, query forever. Zero re-extraction, zero AI calls." },
   { id: "billing", title: "Billing API", description: "Billing settings, auto top-up for AI agents, and cost response headers on extraction requests." },
   { id: "errors-rate-limits", title: "Errors & Rate Limits", description: "Error response format, error codes, rate limit tiers by plan, and rate limit headers." }