@talonic/docs 0.20.22 → 0.20.25

package/dist/content.js

@@ -13250,14 +13250,27 @@ var sections25 = [
     parentSlug: "webhooks",
     title: "Events",
     seoTitle: "Webhook Events \u2014 Talonic Docs",
-    description: "Receive real-time notifications for extraction events including extraction.complete, extraction.failed, and document.ingested via webhook URLs.",
+    description: "Receive real-time notifications for extraction events including extraction.complete, extraction.failed, and document.uploaded via webhook URLs.",
     content: [
       { type: "paragraph", text: "Receive real-time notifications when extraction events occur. Configure webhook URLs per-source or per-extraction via the `webhook_url` option." },
       { type: "paragraph", text: "Available webhook events:" },
       { type: "list", items: [
-        "`extraction.complete` \u2014 Extraction finished successfully. Payload includes the full extraction result.",
-        "`extraction.failed` \u2014 Extraction failed. Payload includes the error details.",
-        "`document.ingested` \u2014 A new document has been processed and is ready for extraction."
+        "`document.uploaded` \u2014 A new document has been uploaded and queued for processing.",
+        "`document.processing` \u2014 Document OCR and classification has started.",
+        "`document.classified` \u2014 Document type and language have been detected.",
+        "`extraction.started` \u2014 AI data extraction has begun on the document.",
+        "`extraction.complete` \u2014 Data extraction finished successfully. Extracted fields are available.",
+        "`extraction.failed` \u2014 Data extraction failed after all retry attempts.",
+        "`job.created` \u2014 A new structuring job has been created.",
+        "`job.started` \u2014 Job processing has begun.",
+        "`job.phase_complete` \u2014 A job phase (resolve, extract, normalize, or transform) has completed.",
+        "`job.complete` \u2014 All job phases finished. Structured results are available.",
+        "`job.failed` \u2014 Job processing failed.",
+        "`review.approved` \u2014 A validation record has been approved.",
+        "`delivery.sent` \u2014 An outbound delivery was sent successfully.",
+        "`delivery.failed` \u2014 An outbound delivery failed after all retry attempts.",
+        "`process.completed` \u2014 A document processing run finished all steps and the result is available.",
+        "`process.failed` \u2014 A document processing run failed. The error payload includes the step name and error detail."
       ] },
       { type: "paragraph", text: "Most integrations subscribe to `extraction.complete` to trigger downstream processing (e.g. writing structured data to a database or notifying a user). A typical workflow is to pass `webhook_url` on `POST /v1/extract`, then handle the callback payload in your server without polling." },
       { type: "paragraph", text: "The `extraction.complete` payload includes the `extraction_id`, `document_id`, `schema_id`, `status`, and `confidence` score. Use the `extraction_id` to fetch the full result via `GET /v1/extractions/:id` if the payload does not contain all the fields you need." },
@@ -13269,7 +13282,7 @@ var sections25 = [
       { label: "Retry Policy", slug: "webhook-retry" }
     ],
     faq: [
-      { question: "What webhook events does Talonic send?", answer: "Three events: extraction.complete, extraction.failed, and document.ingested." }
+      { question: "What webhook events does Talonic send?", answer: "Sixteen events spanning the document lifecycle: document.uploaded, document.processing, document.classified, extraction.started, extraction.complete, extraction.failed, job.created, job.started, job.phase_complete, job.complete, job.failed, review.approved, delivery.sent, delivery.failed, process.completed, and process.failed." }
     ],
     mentions: ["webhook", "real-time notifications"]
   },
@@ -13528,7 +13541,7 @@ echo -n '{"event":"extraction.complete","delivery_id":"dlv_test123","timestamp":
             code: `{
   "url": "https://api.example.com/webhooks/talonic",
   "secret": "whsec_my_production_secret",
-  "events": ["extraction.complete", "extraction.failed", "document.ingested"],
+  "events": ["extraction.complete", "extraction.failed", "document.uploaded"],
   "is_active": true
 }`
           }
@@ -13541,7 +13554,7 @@ echo -n '{"event":"extraction.complete","delivery_id":"dlv_test123","timestamp":
         code: `{
   "id": "wh_b2c3d4e5-f6a7-8901-bcde-f12345678901",
   "url": "https://api.example.com/webhooks/talonic",
-  "events": ["extraction.complete", "extraction.failed", "document.ingested"],
+  "events": ["extraction.complete", "extraction.failed", "document.uploaded"],
   "is_active": true,
   "source_connection_id": null,
   "created_at": "2024-10-05T12:00:00.000Z",
@@ -27712,7 +27725,7 @@ var sections_default2 = [
       },
       {
         type: "paragraph",
-        text: "With this MCP server installed, the agent has a `talonic_extract` tool that returns schema-validated JSON with per-field confidence scores, a detected document type, and stable IDs for follow-up calls. The other eight tools cover the rest of the workflow: searching the workspace, filtering by extracted field values, fetching document metadata, getting OCR markdown, listing saved schemas, saving new ones, and reading the workspace credit balance for budget-aware behaviour."
+        text: "With this MCP server installed, the agent has a `talonic_extract` tool that returns schema-validated JSON with per-field confidence scores, a detected document type, and stable IDs for follow-up calls. The other eight tools cover the rest of the workflow: requesting a browser upload link for files too large to pass through a hosted connector, searching the workspace, filtering by extracted field values, fetching document metadata, getting OCR markdown, listing saved schemas, saving new ones, and reading the workspace credit balance for budget-aware behaviour."
       },
       {
         type: "callout",
@@ -27768,7 +27781,7 @@ var sections_default2 = [
       },
       {
         type: "paragraph",
-        text: "Connect from Claude.ai's custom-connector flow. The connector authenticates against `app.talonic.com` using OAuth 2.1 with PKCE and Dynamic Client Registration, so no API key is pasted into the connector config. Once authorised, all eight Talonic tools and both resources are available to Claude.ai's agent."
+        text: "Connect from Claude.ai's custom-connector flow. The connector authenticates against `app.talonic.com` using OAuth 2.1 with PKCE and Dynamic Client Registration, so no API key is pasted into the connector config. Once authorised, all nine Talonic tools and both resources are available to Claude.ai's agent."
       },
       {
         type: "list",
@@ -27823,7 +27836,7 @@ var sections_default2 = [
       },
       {
         type: "paragraph",
-        text: "All three install paths expose the same eight tools and two resources."
+        text: "All three install paths expose the same nine tools and two resources."
       }
     ],
     related: [
@@ -27987,7 +28000,7 @@ var sections_default2 = [
       },
       {
         type: "paragraph",
-        text: "Fully restart Claude Desktop (Cmd+Q on macOS, not just close the window). Talonic appears in the connected servers list with all eight tools and two resources."
+        text: "Fully restart Claude Desktop (Cmd+Q on macOS, not just close the window). Talonic appears in the connected servers list with all nine tools and two resources."
       }
     ],
     related: [
@@ -28283,7 +28296,7 @@ var sections_default2 = [
           {
             name: "file_data",
             type: "string",
-            description: "Base64-encoded file bytes. **Recommended for local-stdio installs** (Claude Desktop, Cursor, Cline, Continue, Cowork). Pair with `filename` for MIME type inference. **Warning for Claude.ai hosted connector:** Claude.ai imposes a hard size limit on tool-call arguments (effectively under ~1 KB), so `file_data` cannot carry a real PDF through Claude.ai's pipeline. For files larger than a trivial test, use `file_url` or `document_id` instead when running through Claude.ai."
+            description: "Base64-encoded file bytes. **Recommended for local-stdio installs** (Claude Desktop, Cursor, Cline, Continue, Cowork), which have no size cap. Pair with `filename` for MIME type inference. **Warning for the Claude.ai hosted connector:** Claude.ai caps tool-call arguments at ~32 KB decoded, so `file_data` cannot carry a real PDF \u2014 it is silently truncated. Use `talonic_request_upload` (browser-handoff upload), `file_url`, or a pre-uploaded `document_id` instead when running through Claude.ai."
           },
           {
             name: "filename",
@@ -29060,7 +29073,7 @@ var sections_default2 = [
           {
             name: "file_data",
             type: "string",
-            description: "Base64-encoded file bytes. **Recommended for local-stdio installs** (Claude Desktop, Cursor, Cline, Continue, Cowork). Pair with `filename`. Consumes one extraction credit (auto-ingests the file first). **Warning for Claude.ai hosted connector:** Claude.ai imposes a hard size limit on tool-call arguments (effectively under ~1 KB), so `file_data` cannot carry a real PDF through the Claude.ai pipeline. Use `file_url` or `document_id` instead when running through Claude.ai."
+            description: "Base64-encoded file bytes. **Recommended for local-stdio installs** (Claude Desktop, Cursor, Cline, Continue, Cowork), which have no size cap. Pair with `filename`. Consumes one extraction credit (auto-ingests the file first). **Warning for the Claude.ai hosted connector:** Claude.ai caps tool-call arguments at ~32 KB decoded, so `file_data` cannot carry a real PDF \u2014 it is silently truncated. Use `talonic_request_upload` (browser-handoff upload), `file_url`, or a pre-uploaded `document_id` instead when running through Claude.ai."
           },
           {
             name: "filename",

package/dist/index.js

@@ -636,7 +636,8 @@ var NAV_SECTIONS = [
       { id: "list-benchmarks", label: "Benchmarks" },
       { id: "add-ground-truth-entry", label: "Add Ground-Truth Entry" },
       { id: "delete-ground-truth-entry", label: "Delete Ground-Truth Entry" },
-      { id: "benchmark-results", label: "Benchmark Results" }
+      { id: "benchmark-results", label: "Benchmark Results" },
+      { id: "compare-benchmarks", label: "Compare Benchmarks" }
     ]
   },
   {
@@ -3165,6 +3166,44 @@ function ApiReference({ LinkComponent }) {
 }` })
         }
       ) }),
+      /* @__PURE__ */ jsx5("div", { id: "compare-benchmarks", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
+        EndpointBlock,
+        {
+          method: "GET",
+          path: "/v1/quality/benchmarks/compare",
+          summary: "Compare two benchmark runs.",
+          description: "Returns both benchmark runs side by side along with the overall accuracy delta (run_a minus run_b). The delta is null when either run has no overall accuracy score yet.",
+          children: [
+            /* @__PURE__ */ jsx5(
+              ParamTable,
+              {
+                title: "Query parameters",
+                params: [
+                  { name: "run_a", type: "uuid", required: true, description: "ID of the first benchmark run." },
+                  { name: "run_b", type: "uuid", required: true, description: "ID of the second benchmark run to compare against." }
+                ]
+              }
+            ),
+            /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
+  "run_a": {
+    "id": "bench_9x2k4m",
+    "name": "Invoices v2",
+    "status": "completed",
+    "accuracy_overall": 0.94,
+    "accuracy_by_field": { "vendor_name": 0.98, "total": 0.9 }
+  },
+  "run_b": {
+    "id": "bench_7p1j5q",
+    "name": "Invoices v1",
+    "status": "completed",
+    "accuracy_overall": 0.89,
+    "accuracy_by_field": { "vendor_name": 0.95, "total": 0.83 }
+  },
+  "accuracy_delta": 0.05
+}` })
+          ]
+        }
+      ) }),
       /* @__PURE__ */ jsx5(SectionHeading, { id: "matching", children: "Matching" }),
       /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "Match extracted data against reference datasets using configurable field-level matching strategies (exact, fuzzy, date range, numeric range)." }),
       /* @__PURE__ */ jsx5("div", { id: "list-matching-configs", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
@@ -3901,16 +3940,68 @@ function ApiReference({ LinkComponent }) {
         ] }) }),
         /* @__PURE__ */ jsxs5("tbody", { children: [
           /* @__PURE__ */ jsxs5("tr", { children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "document.uploaded" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "A new document has been uploaded and queued for processing." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "document.processing" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "Document OCR and classification has started." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "document.classified" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "Document type and language have been detected." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "extraction.started" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "AI data extraction has begun on the document." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
             /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "extraction.complete" }),
-            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "Extraction finished successfully. Payload includes the full extraction result." })
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "Data extraction finished successfully. Extracted fields are available." })
           ] }),
           /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
             /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "extraction.failed" }),
-            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "Extraction failed. Payload includes the error details." })
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "Data extraction failed after all retry attempts." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "job.created" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "A new structuring job has been created." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "job.started" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "Job processing has begun." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "job.phase_complete" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "A job phase (resolve, extract, normalize, or transform) has completed." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "job.complete" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "All job phases finished. Structured results are available." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "job.failed" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "Job processing failed." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "review.approved" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "A validation record has been approved." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "delivery.sent" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "An outbound delivery was sent successfully." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "delivery.failed" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "An outbound delivery failed after all retry attempts." })
+          ] }),
+          /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "process.completed" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "A document processing run finished all steps and the result is available." })
           ] }),
           /* @__PURE__ */ jsxs5("tr", { className: "border-t border-void-border", children: [
-            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "document.ingested" }),
-            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "A new document has been processed and is ready for extraction." })
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 font-mono text-[13px]", children: "process.failed" }),
+            /* @__PURE__ */ jsx5("td", { className: "px-4 py-3 text-void-text-secondary text-[13px]", children: "A document processing run failed. The error payload includes the step name and error detail." })
           ] })
         ] })
       ] }) }),