@talonic/docs 0.21.1 → 0.21.2

package/dist/seo.js

@@ -71,8 +71,8 @@ var openapi_default = {
       description: "Queue of validation records requiring human review; supports single- and batch-action approvals/rejections."
     },
     {
-      name: "Quality",
-      description: "Ground truth datasets and benchmark runs for measuring extraction accuracy."
+      name: "Benchmarks",
+      description: "Ground-truth datasets and benchmark runs measuring extraction accuracy."
     },
     {
       name: "Batches",
@@ -126,10 +126,6 @@ var openapi_default = {
       name: "Telemetry",
       description: "Aggregate structuring metrics \u2014 capture hit rate, synthesize rate, strategy distribution, and tier funnel breakdowns per schema or run."
     },
-    {
-      name: "Validation",
-      description: "Ground-truth dataset management and validation runs for measuring extraction accuracy."
-    },
     {
       name: "Credits",
       description: "Credit balance, usage history, daily breakdown, and per-request usage log."
@@ -5134,7 +5130,7 @@ var openapi_default = {
         operationId: "listGroundTruthDatasets",
         summary: "List ground truth datasets",
         tags: [
-          "Quality"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -5196,7 +5192,7 @@ var openapi_default = {
         operationId: "createGroundTruthDataset",
         summary: "Create a ground truth dataset",
         tags: [
-          "Quality"
+          "Benchmarks"
         ],
         requestBody: {
           required: true,
@@ -5247,7 +5243,7 @@ var openapi_default = {
         summary: "Get a ground truth dataset",
         description: "Returns the dataset together with its sample entries (curated known-correct values).",
         tags: [
-          "Quality"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -5282,7 +5278,7 @@ var openapi_default = {
         operationId: "listBenchmarkRuns",
         summary: "List benchmark runs",
         tags: [
-          "Quality"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -5347,7 +5343,7 @@ var openapi_default = {
         summary: "Get a benchmark run",
         description: "Returns the benchmark run together with its per-document results.",
         tags: [
-          "Quality"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -8729,7 +8725,7 @@ var openapi_default = {
         summary: "List ground-truth datasets",
         description: "Returns all ground-truth datasets for the customer.",
         tags: [
-          "Validation"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -8782,7 +8778,7 @@ var openapi_default = {
         operationId: "getGroundTruth",
         summary: "Get a ground-truth dataset",
         tags: [
-          "Validation"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -8815,7 +8811,7 @@ var openapi_default = {
         operationId: "deleteGroundTruth",
         summary: "Delete a ground-truth dataset",
         tags: [
-          "Validation"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -8850,7 +8846,7 @@ var openapi_default = {
         operationId: "listValidationRuns",
         summary: "List validation runs",
         tags: [
-          "Validation"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -8902,7 +8898,7 @@ var openapi_default = {
         summary: "Create a validation run",
         description: "Start a new validation run against a ground-truth dataset.",
         tags: [
-          "Validation"
+          "Benchmarks"
         ],
         requestBody: {
           required: true,
@@ -8959,7 +8955,7 @@ var openapi_default = {
         operationId: "getValidationRun",
         summary: "Get a validation run",
         tags: [
-          "Validation"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -8992,7 +8988,7 @@ var openapi_default = {
         operationId: "deleteValidationRun",
         summary: "Delete a validation run",
         tags: [
-          "Validation"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -9028,7 +9024,7 @@ var openapi_default = {
         summary: "Get validation run results",
         description: "Returns per-document and per-field accuracy results for the validation run.",
         tags: [
-          "Validation"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -11766,7 +11762,7 @@ var openapi_default = {
         operationId: "listGroundTruthEntries",
         summary: "List entries in a ground truth dataset",
         tags: [
-          "Quality"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -11820,7 +11816,7 @@ var openapi_default = {
         operationId: "createGroundTruthEntry",
         summary: "Add an entry to a ground truth dataset",
         tags: [
-          "Quality"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -11886,7 +11882,7 @@ var openapi_default = {
         operationId: "updateGroundTruthEntry",
         summary: "Update a ground truth entry",
         tags: [
-          "Quality"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -11950,7 +11946,7 @@ var openapi_default = {
         operationId: "deleteGroundTruthEntry",
         summary: "Delete a ground truth entry",
         tags: [
-          "Quality"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -11997,7 +11993,7 @@ var openapi_default = {
         summary: "Compare two benchmark runs",
         description: "Returns both benchmark runs side by side together with the overall accuracy delta (run_a minus run_b). The delta is null when either run has not yet produced an overall accuracy score.",
         tags: [
-          "Quality"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -12071,7 +12067,7 @@ var openapi_default = {
         summary: "Get benchmark results",
         description: "Returns per-document accuracy results for a benchmark run.",
         tags: [
-          "Quality"
+          "Benchmarks"
         ],
         parameters: [
           {
@@ -12113,7 +12109,8 @@ var openapi_default = {
       post: {
         operationId: "submitProcess",
         summary: "Submit a document for processing",
-        description: "Upload a document and trigger a configured processing pipeline.\nAlways returns 202. Results delivered via `process.completed` webhook.\n\nIdempotency is automatic: the same (config_id, batch_id, file) combination\nreturns the existing run without re-processing. If batch_id is absent,\ndedup applies within a 24-hour window.\n",
+        deprecated: true,
+        description: "Deprecated: prefer `/v1/pipelines` for new integrations; this endpoint remains supported.\n\nUpload a document and trigger a configured processing pipeline.\nAlways returns 202. Results delivered via `process.completed` webhook.\n\nIdempotency is automatic: the same (config_id, batch_id, file) combination\nreturns the existing run without re-processing. If batch_id is absent,\ndedup applies within a 24-hour window.\n",
         tags: [
           "Process"
         ],
@@ -12259,7 +12256,8 @@ var openapi_default = {
       get: {
         operationId: "listConfigs",
         summary: "List available processing configs",
-        description: "Returns all processing configurations available to your organization.",
+        deprecated: true,
+        description: "Deprecated: prefer `/v1/pipelines` for new integrations; this endpoint remains supported. Returns all processing configurations available to your organization.\n",
         tags: [
           "Process"
         ],
@@ -16056,7 +16054,8 @@ var openapi_default = {
           "Fields"
         ],
         summary: "Query the field registry by field values",
-        description: "Returns documents whose captured field values match the `where` map (values matched via ILIKE). A read operation that takes a POST body. Requires the `read` scope. An unknown `where` field returns a 200 body `{ error: 'unknown_field' }`.\n",
+        deprecated: true,
+        description: "Deprecated: moved under `/v1/fields/registry/*`; use `POST /v1/fields/registry/query`. This path remains supported and serves the same handler. Returns documents whose captured field values match the `where` map (values matched via ILIKE). A read operation that takes a POST body. Requires the `read` scope. An unknown `where` field returns a 200 body `{ error: 'unknown_field' }`.\n",
         operationId: "queryRegistry",
         security: [
           {
@@ -16102,6 +16101,58 @@ var openapi_default = {
         }
       }
     },
+    "/v1/fields/registry/query": {
+      post: {
+        tags: [
+          "Fields"
+        ],
+        summary: "Query the field registry by field values",
+        description: "The canonical home of the registry query going forward (alias of the deprecated `POST /v1/registry/query`; both serve the same handler). Returns documents whose captured field values match the `where` map (values matched via ILIKE). A read operation that takes a POST body. Requires the `read` scope. An unknown `where` field returns a 200 body `{ error: 'unknown_field' }`.\n",
+        operationId: "queryFieldsRegistry",
+        security: [
+          {
+            BearerAuth: []
+          }
+        ],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                required: [
+                  "where"
+                ],
+                properties: {
+                  where: {
+                    type: "object",
+                    minProperties: 1,
+                    additionalProperties: true
+                  },
+                  select: {
+                    type: "array",
+                    items: {
+                      type: "string"
+                    }
+                  },
+                  limit: {
+                    type: "integer",
+                    minimum: 1,
+                    default: 100,
+                    maximum: 500
+                  }
+                }
+              }
+            }
+          }
+        },
+        responses: {
+          "200": {
+            description: "{ data: row[], total }"
+          }
+        }
+      }
+    },
     "/v1/matching/packages/configs": {
       get: {
         tags: [
@@ -16601,7 +16652,8 @@ var openapi_default = {
           "Fields"
         ],
         summary: "Field-registry health snapshot (read-only)",
-        description: "Tier + admission counts, singleton/weak-name rates, occurrence and resolution stats, transfer hit rate, and coherence/atomicity metrics for the tenant's field registry. The same view the in-app registry dashboard reads; no lifecycle or cleanup actions are exposed.\n",
+        deprecated: true,
+        description: "Deprecated: moved under `/v1/fields/registry/*`; use `GET /v1/fields/registry/health`. This path remains supported and serves the same handler. Tier + admission counts, singleton/weak-name rates, occurrence and resolution stats, transfer hit rate, and coherence/atomicity metrics for the tenant's field registry. The same view the in-app registry dashboard reads; no lifecycle or cleanup actions are exposed.\n",
         operationId: "getRegistryHealth",
         security: [
           {
@@ -16615,6 +16667,26 @@ var openapi_default = {
         }
       }
     },
+    "/v1/fields/registry/health": {
+      get: {
+        tags: [
+          "Fields"
+        ],
+        summary: "Field-registry health snapshot (read-only)",
+        description: "The canonical home of the registry health snapshot going forward (alias of the deprecated `GET /v1/registry/health`; both serve the same handler). Tier + admission counts, singleton/weak-name rates, occurrence and resolution stats, transfer hit rate, and coherence/atomicity metrics for the tenant's field registry. The same view the in-app registry dashboard reads; no lifecycle or cleanup actions are exposed.\n",
+        operationId: "getFieldsRegistryHealth",
+        security: [
+          {
+            BearerAuth: []
+          }
+        ],
+        responses: {
+          "200": {
+            description: "Registry health snapshot"
+          }
+        }
+      }
+    },
     "/v1/customer-ontologies": {
       get: {
         tags: [
@@ -24875,8 +24947,8 @@ var API_NAV_SECTIONS = [
     { id: "get-job", label: "Get Job" }
   ] },
   { id: "sources", label: "Sources", children: [
-    { id: "list-sources", label: "List Inputs" },
-    { id: "create-source", label: "Create Input" },
+    { id: "list-sources", label: "List Sources" },
+    { id: "create-source", label: "Create Source" },
     { id: "get-source", label: "Get / Update / Delete" },
     { id: "update-source", label: "Source Documents" },
     { id: "ingest-source-document", label: "Ingest a Document" }
@@ -24948,7 +25020,7 @@ var API_NAV_SECTIONS = [
     { id: "get-structuring-gate", label: "Get / Update / Delete Gate" },
     { id: "gate-rules", label: "Gate Rules" },
     { id: "result-checks", label: "Result Checks" },
-    { id: "pending-approvals", label: "Pending Approvals" },
+    { id: "pending-approvals", label: "Pending Reviews" },
     { id: "approve-reject-result", label: "Approve / Reject Result" },
     { id: "trigger-delivery", label: "Trigger Delivery" }
   ] },
@@ -25026,7 +25098,7 @@ var API_NAV_SECTIONS = [
     { id: "review-batch", label: "Batch Action" },
     { id: "review-assign", label: "Assign" }
   ] },
-  { id: "quality", label: "Quality", children: [
+  { id: "quality", label: "Benchmarks", children: [
     { id: "list-quality-datasets", label: "List Datasets" },
     { id: "create-quality-dataset", label: "Create Dataset" },
     { id: "get-quality-dataset", label: "Get / Delete Dataset" },
@@ -25176,6 +25248,7 @@ var PLATFORM_NAV_SECTIONS = [
   { id: "overview", label: "Overview", children: [
     { id: "introduction", label: "Introduction" },
     { id: "core-concepts", label: "Core Concepts" },
+    { id: "glossary", label: "Glossary" },
     { id: "platform-flow", label: "Platform Flow" },
     { id: "getting-started", label: "Getting Started" }
   ] },
@@ -25184,7 +25257,7 @@ var PLATFORM_NAV_SECTIONS = [
     { id: "agent-impact", label: "Impact Levels" },
     { id: "agent-dashboard", label: "Dashboard" }
   ] },
-  { id: "sources-docs", label: "Inputs & Documents", children: [
+  { id: "sources-docs", label: "Sources & Documents", children: [
     { id: "uploading", label: "Uploading Documents" },
     { id: "supported-formats", label: "Supported Formats" },
     { id: "document-processing", label: "Document Processing" },
@@ -25195,7 +25268,7 @@ var PLATFORM_NAV_SECTIONS = [
   ] },
   { id: "field-intelligence", label: "Field Intelligence", children: [
     { id: "field-registry", label: "Field Registry" },
-    { id: "tier-system", label: "Tier System" },
+    { id: "tier-system", label: "Maturity Levels" },
     { id: "semantic-clusters", label: "Semantic Clusters" },
     { id: "field-resolution", label: "Field Resolution" },
     { id: "master-instructions", label: "Master Instructions" }
@@ -25223,8 +25296,8 @@ var PLATFORM_NAV_SECTIONS = [
     { id: "confidence-provenance", label: "Confidence & Provenance" },
     { id: "corrections", label: "Corrections" }
   ] },
-  { id: "pipelines", label: "Structure Pipeline", children: [
-    { id: "spec-pipeline", label: "The Spec & One Engine" },
+  { id: "pipelines", label: "Pipelines", children: [
+    { id: "spec-pipeline", label: "The Spec & the Engine" },
     { id: "pipeline-rail", label: "Composing the Rail" },
     { id: "running-a-pipeline", label: "Running a Pipeline" },
     { id: "validation-checkpoints", label: "Validation Checkpoints" },
@@ -25256,11 +25329,11 @@ var PLATFORM_NAV_SECTIONS = [
     { id: "id-dispensers", label: "ID Dispensers" },
     { id: "data-product-sharing", label: "Sharing & Export" }
   ] },
-  { id: "validation-quality", label: "Validation & Quality", children: [
+  { id: "validation-quality", label: "Validation & Benchmarks", children: [
     { id: "validation-checks", label: "Validation Checks" },
-    { id: "ground-truth", label: "Golden Samples" },
-    { id: "approval-gates", label: "Approval Gates" },
-    { id: "approval-queue", label: "Approval Queue" }
+    { id: "ground-truth", label: "Ground Truth" },
+    { id: "approval-gates", label: "Review Gates" },
+    { id: "approval-queue", label: "Field Review" }
   ] },
   { id: "delivery", label: "Outputs", children: [
     { id: "delivery-pipeline", label: "How Delivery Works" },
@@ -25285,7 +25358,7 @@ var PLATFORM_NAV_SECTIONS = [
   ] },
   { id: "team-admin", label: "Team & Admin", children: [
     { id: "team-management", label: "Team Management" },
-    { id: "usage-registry", label: "Usage & Registry" },
+    { id: "usage-registry", label: "Usage" },
     { id: "admin-panel", label: "Admin Panel" },
     { id: "shortcuts", label: "Keyboard Shortcuts" }
   ] }
@@ -25301,15 +25374,15 @@ var API_SECTION_META = [
   { id: "telemetry", title: "Telemetry API", description: "Aggregate structuring metrics \u2014 capture hit rate, synthesize rate, strategy distribution, and tier funnel breakdowns per schema or run." },
   { id: "provenance", title: "Provenance API", description: "Per-cell audit trails showing tier, strategy, sub-move, confidence score, and reasoning trace for every value in a record." },
   { id: "jobs", title: "Jobs API", description: "Track asynchronous extraction jobs with progress, phase status, and grid fill rate statistics." },
-  { id: "sources", title: "Inputs API", description: "Manage document sources for programmatic ingestion. Each source has its own API key and supports batch processing." },
+  { id: "sources", title: "Sources API", description: "Manage document sources for programmatic ingestion. Each source has its own API key and supports batch processing." },
   { id: "filter-search", title: "Filter & Search API", description: "Field autocomplete, document filtering with composable conditions, global omnisearch, and saved filter management." },
   { id: "webhooks", title: "Webhooks", description: "Real-time event notifications with HMAC-SHA256 signed payloads, delivery tracking, and exponential backoff retries." },
   { 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." },
   { id: "linking", title: "Linking API", description: "Document linking graph \u2014 link keys, document links, entity graph, classification, backfill operations, and document-case mapping." },
   { id: "nshot", title: "N-Shot API", description: "N-Shot comparison endpoints for job runs \u2014 summary, field comparisons, overrides, and AI/human judge decisions." },
   { 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." },
-  { id: "structuring", title: "Structuring API", description: "Validation checks CRUD, approval gates with configurable rules, result check outcomes, pending approvals queue, and delivery triggers." },
-  { id: "validation", title: "Validation API", description: "Golden sample management and validation runs for measuring extraction accuracy against ground truth datasets." },
+  { id: "structuring", title: "Structuring API", description: "Validation checks CRUD, review gates with configurable rules, result check outcomes, pending review queue, and delivery triggers." },
+  { id: "validation", title: "Benchmarks API (validation namespace)", description: "Ground Truth management and benchmark runs for measuring extraction accuracy against ground truth datasets." },
   { id: "credits", title: "Credits API", description: "Credit balance, transaction history, aggregate usage summaries, daily usage breakdown, and per-request usage log." },
   { id: "agent", title: "Agent API", description: "Workspace context snapshot and agent tool discovery endpoints for programmatic access to embedded AI assistant capabilities." },
   { 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." },
@@ -25317,7 +25390,7 @@ var API_SECTION_META = [
   { 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, 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: "quality", title: "Benchmarks 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." },
@@ -25331,17 +25404,17 @@ var API_SECTION_META = [
 var PLATFORM_SECTION_META = [
   { id: "overview", title: "Platform Overview", description: "Core concepts, platform flow, and getting started guide for the Talonic document structuring platform." },
   { id: "agent", title: "AI Agent", description: "Embedded AI assistant accessible via Cmd+I from any page. Inspects schemas, searches documents, analyzes extraction quality, explores cases, and builds schemas through natural language." },
-  { id: "sources-docs", title: "Inputs & Documents", description: "Upload documents via drag-and-drop, API, or connectors. 25+ formats supported with automatic OCR and classification." },
+  { id: "sources-docs", title: "Sources & Documents", description: "Upload documents via drag-and-drop, API, or connectors. 25+ formats supported with automatic OCR and classification." },
   { id: "field-intelligence", title: "Field Intelligence", description: "Unified field registry with tier system, semantic clustering, and AI-synthesized master extraction instructions." },
   { id: "schemas-templates", title: "Schemas & Templates", description: "AI-generated schemas per document type and user-defined templates with field matching, reference tables, and versioning." },
   { id: "structuring", title: "Structuring", description: "Vocabulary-driven structuring system with seven field strategies, four processing tiers, capture sub-moves, modifiers, constraints, and synthesize fallback." },
   { id: "extraction-jobs", title: "Extraction Jobs", description: "The 4-phase pipeline: Resolve, Agent, Validation, Re-read. Progressive grid filling with per-cell provenance and confidence." },
-  { id: "pipelines", title: "Structure Pipeline", description: "The Spec and One Engine: compose a rail over one schema, run it as a per-document pipeline through transfer, extraction, resolution, and validation checkpoints, with a review queue and assembly." },
+  { id: "pipelines", title: "Pipelines", description: "The Spec and the engine: compose a rail over one schema, run it as a per-document pipeline through transfer, extraction, resolution, and validation checkpoints, with a review queue and assembly." },
   { id: "linking-cases", title: "Linking & Cases", description: "Document linking discovers relationships through shared entities. Related documents grouped into cases with evidence chains." },
   { id: "batch-inference", title: "Batch Inference", description: "Batch processing mode defers Claude extraction to the provider batch API at 50% cost with 48-hour delivery. Monitor batch progress and results." },
   { id: "matching", title: "Smart Matching", description: "Upload reference datasets and configure weighted field-to-field matching strategies. Run matches asynchronously and review top-5 candidates per document." },
   { id: "data-products", title: "Data Products", description: "Dataset templates for reusable output specifications and assemblies for combining multi-source documents into structured datasets." },
-  { id: "validation-quality", title: "Validation & Quality", description: "Automated validation checks, golden sample benchmarking, configurable approval gates, and a manual review queue for flagged results." },
+  { id: "validation-quality", title: "Validation & Benchmarks", description: "Automated validation checks, Ground Truth benchmarking, configurable review gates, and Record Review for flagged results." },
   { id: "delivery", title: "Outputs & Delivery", description: "Push structured data to webhooks, REST APIs, SFTP, email, or cloud storage with field mappings, triggers, delivery configuration, and telemetry." },
   { id: "workspace-settings", title: "Workspace Settings", description: "Shared dialects for output formatting, reference primitives for lookup tables, and change review governance for production workspaces." },
   { id: "search-filtering", title: "Search & Filtering", description: "Global omnisearch (Cmd+K) and advanced document filtering by extracted field values with saved presets." },