@talonic/docs 0.21.1 → 0.21.3

package/openapi.json

@@ -70,8 +70,8 @@
       "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",
@@ -125,10 +125,6 @@
       "name": "Telemetry",
       "description": "Aggregate structuring metrics — 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."
@@ -5114,7 +5110,7 @@
         "operationId": "listGroundTruthDatasets",
         "summary": "List ground truth datasets",
         "tags": [
-          "Quality"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -5176,7 +5172,7 @@
         "operationId": "createGroundTruthDataset",
         "summary": "Create a ground truth dataset",
         "tags": [
-          "Quality"
+          "Benchmarks"
         ],
         "requestBody": {
           "required": true,
@@ -5227,7 +5223,7 @@
         "summary": "Get a ground truth dataset",
         "description": "Returns the dataset together with its sample entries (curated known-correct values).",
         "tags": [
-          "Quality"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -5262,7 +5258,7 @@
         "operationId": "listBenchmarkRuns",
         "summary": "List benchmark runs",
         "tags": [
-          "Quality"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -5327,7 +5323,7 @@
         "summary": "Get a benchmark run",
         "description": "Returns the benchmark run together with its per-document results.",
         "tags": [
-          "Quality"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -8709,7 +8705,7 @@
         "summary": "List ground-truth datasets",
         "description": "Returns all ground-truth datasets for the customer.",
         "tags": [
-          "Validation"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -8762,7 +8758,7 @@
         "operationId": "getGroundTruth",
         "summary": "Get a ground-truth dataset",
         "tags": [
-          "Validation"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -8795,7 +8791,7 @@
         "operationId": "deleteGroundTruth",
         "summary": "Delete a ground-truth dataset",
         "tags": [
-          "Validation"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -8830,7 +8826,7 @@
         "operationId": "listValidationRuns",
         "summary": "List validation runs",
         "tags": [
-          "Validation"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -8882,7 +8878,7 @@
         "summary": "Create a validation run",
         "description": "Start a new validation run against a ground-truth dataset.",
         "tags": [
-          "Validation"
+          "Benchmarks"
         ],
         "requestBody": {
           "required": true,
@@ -8939,7 +8935,7 @@
         "operationId": "getValidationRun",
         "summary": "Get a validation run",
         "tags": [
-          "Validation"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -8972,7 +8968,7 @@
         "operationId": "deleteValidationRun",
         "summary": "Delete a validation run",
         "tags": [
-          "Validation"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -9008,7 +9004,7 @@
         "summary": "Get validation run results",
         "description": "Returns per-document and per-field accuracy results for the validation run.",
         "tags": [
-          "Validation"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -11746,7 +11742,7 @@
         "operationId": "listGroundTruthEntries",
         "summary": "List entries in a ground truth dataset",
         "tags": [
-          "Quality"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -11800,7 +11796,7 @@
         "operationId": "createGroundTruthEntry",
         "summary": "Add an entry to a ground truth dataset",
         "tags": [
-          "Quality"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -11866,7 +11862,7 @@
         "operationId": "updateGroundTruthEntry",
         "summary": "Update a ground truth entry",
         "tags": [
-          "Quality"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -11930,7 +11926,7 @@
         "operationId": "deleteGroundTruthEntry",
         "summary": "Delete a ground truth entry",
         "tags": [
-          "Quality"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -11977,7 +11973,7 @@
         "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": [
           {
@@ -12051,7 +12047,7 @@
         "summary": "Get benchmark results",
         "description": "Returns per-document accuracy results for a benchmark run.",
         "tags": [
-          "Quality"
+          "Benchmarks"
         ],
         "parameters": [
           {
@@ -12093,7 +12089,8 @@
       "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"
         ],
@@ -12239,7 +12236,8 @@
       "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"
         ],
@@ -16036,7 +16034,8 @@
           "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": [
           {
@@ -16082,6 +16081,58 @@
         }
       }
     },
+    "/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": [
@@ -16581,7 +16632,8 @@
           "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": [
           {
@@ -16595,6 +16647,26 @@
         }
       }
     },
+    "/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": [
@@ -20275,7 +20347,7 @@
             "type": "string",
             "format": "uuid",
             "example": "f0e1d2c3-b4a5-9687-8765-432109876543",
-            "description": "ID of the created document (absent if duplicate)."
+            "description": "ID of the created document. When status is `duplicate`, this is the id of the linked-duplicate row created for this upload (see `existing_document_id` for the canonical document)."
           },
           "filename": {
             "type": "string",
@@ -20307,7 +20379,7 @@
             ],
             "format": "uuid",
             "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
-            "description": "Present when status is `duplicate`."
+            "description": "Present when status is `duplicate` — the canonical document this upload deduplicated to (the linked duplicate reads its extracted data from it). The `document_id` field carries the id of the linked-duplicate row created for this upload."
           },
           "links": {
             "type": "object",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talonic/docs",
-  "version": "0.21.1",
+  "version": "0.21.3",
   "description": "Talonic documentation components — API Reference & Platform Guide",
   "license": "UNLICENSED",
   "private": false,