@talonic/docs 0.17.0 → 0.18.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.js CHANGED
@@ -5052,6 +5052,7 @@ var NAV_SECTIONS2 = [
5052
5052
  { id: "field-registry", label: "Field Registry" },
5053
5053
  { id: "tier-system", label: "Tier System" },
5054
5054
  { id: "semantic-clusters", label: "Semantic Clusters" },
5055
+ { id: "field-resolution", label: "Field Resolution" },
5055
5056
  { id: "master-instructions", label: "Master Instructions" }
5056
5057
  ]
5057
5058
  },
@@ -5115,13 +5116,22 @@ var NAV_SECTIONS2 = [
5115
5116
  { id: "document-graph", label: "Document Graph" }
5116
5117
  ]
5117
5118
  },
5119
+ {
5120
+ id: "data-products",
5121
+ label: "Data Products",
5122
+ children: [
5123
+ { id: "dataset-templates", label: "Dataset Templates" },
5124
+ { id: "assemblies", label: "Assemblies" }
5125
+ ]
5126
+ },
5118
5127
  {
5119
5128
  id: "validation-quality",
5120
5129
  label: "Validation & Quality",
5121
5130
  children: [
5122
5131
  { id: "validation-checks", label: "Validation Checks" },
5123
5132
  { id: "ground-truth", label: "Golden Samples" },
5124
- { id: "approval-gates", label: "Approval Gates" }
5133
+ { id: "approval-gates", label: "Approval Gates" },
5134
+ { id: "approval-queue", label: "Approval Queue" }
5125
5135
  ]
5126
5136
  },
5127
5137
  {
@@ -5530,6 +5540,25 @@ function PlatformGuide({ LinkComponent }) {
5530
5540
  ] }),
5531
5541
  /* @__PURE__ */ jsx6(SubHeading, { id: "semantic-clusters", children: "Semantic Clusters" }),
5532
5542
  /* @__PURE__ */ jsx6(P, { children: 'Fields with similar meanings are automatically grouped using AI embeddings. For example, "Vendor Name", "Supplier Name", and "Company Name" cluster together. You can manually merge or split clusters from the Field Map view.' }),
5543
+ /* @__PURE__ */ jsx6(SubHeading, { id: "field-resolution", children: "Field Resolution" }),
5544
+ /* @__PURE__ */ jsx6(P, { children: "When a document is processed, each extracted field is resolved against the registry using a three-band matching model. The bands determine whether a match is accepted automatically, flagged for confirmation, or treated as a new field." }),
5545
+ /* @__PURE__ */ jsx6(
5546
+ ParamTable,
5547
+ {
5548
+ params: [
5549
+ { name: "Auto band", type: "\u2265 0.80 similarity", description: "High-confidence match. The field is linked to the existing registry entry and its occurrence count is incremented." },
5550
+ { name: "Confirm band", type: "0.50 \u2013 0.79", description: "Candidate match. The field is linked but flagged for manual review in the reconciliation queue." },
5551
+ { name: "New band", type: "< 0.50", description: "No match found. A new Tier 3 field and cluster are created in the registry." }
5552
+ ]
5553
+ }
5554
+ ),
5555
+ /* @__PURE__ */ jsx6(P, { children: "Resolution runs concurrently across documents. Each document\u2019s fields are resolved in an isolated transaction to prevent lock contention. Occurrence rates are updated after each transaction commits, keeping the registry eventually consistent without blocking concurrent ingestion." }),
5556
+ /* @__PURE__ */ jsxs6(Callout, { children: [
5557
+ "Pending confirmations from the confirm band appear in",
5558
+ " ",
5559
+ /* @__PURE__ */ jsx6("strong", { children: "Resolution \u2192 Pending Confirmations" }),
5560
+ ". Accept to merge into an existing cluster, or reject to create a new field."
5561
+ ] }),
5533
5562
  /* @__PURE__ */ jsx6(SubHeading, { id: "master-instructions", children: "Master Instructions" }),
5534
5563
  /* @__PURE__ */ jsxs6(P, { children: [
5535
5564
  "As the same field is extracted from many documents, AI synthesizes a ",
@@ -5876,6 +5905,23 @@ function PlatformGuide({ LinkComponent }) {
5876
5905
  /* @__PURE__ */ jsx6(P, { children: "Each case detail page shows: documents, shared entities, evidence chain (which field keys produced each connection), timeline, and auto-generated AI narration." }),
5877
5906
  /* @__PURE__ */ jsx6(SubHeading, { id: "document-graph", children: "Document Graph" }),
5878
5907
  /* @__PURE__ */ jsx6(P, { children: "The Document Graph provides a visual D3-force layout of the bipartite graph. Toggle between graph and list views from the Cases page. Case templates are auto-discovered after 3+ cases form \u2014 they identify recurring document type patterns." }),
5908
+ /* @__PURE__ */ jsx6(SectionHeading, { id: "data-products", children: "Data Products" }),
5909
+ /* @__PURE__ */ jsx6(P, { children: "Data Products package your extraction and resolution outputs into reusable, shareable artifacts. Dataset Templates define the shape; Assemblies combine sources into a single structured dataset." }),
5910
+ /* @__PURE__ */ jsx6(SubHeading, { id: "dataset-templates", children: "Dataset Templates" }),
5911
+ /* @__PURE__ */ jsx6(P, { children: "A dataset template defines a reusable output specification: which schema to use, which document types to include, column mappings, and default transforms. Templates ensure consistent data product generation across teams and time periods." }),
5912
+ /* @__PURE__ */ jsxs6(P, { children: [
5913
+ "Navigate to ",
5914
+ /* @__PURE__ */ jsx6("strong", { children: "Data Products \u2192 Dataset Templates" }),
5915
+ " to manage templates. Each template is linked to a user schema and can be versioned independently. When creating a new job, select a template instead of configuring the output from scratch."
5916
+ ] }),
5917
+ /* @__PURE__ */ jsx6(SubHeading, { id: "assemblies", children: "Assemblies" }),
5918
+ /* @__PURE__ */ jsx6(P, { children: "An assembly combines documents from one or more sources into a single structured dataset based on a template. Assemblies track their constituent documents, source counts, and processing status." }),
5919
+ /* @__PURE__ */ jsxs6(P, { children: [
5920
+ "Navigate to ",
5921
+ /* @__PURE__ */ jsx6("strong", { children: "Data Products \u2192 Assemblies" }),
5922
+ " to view and create assemblies. Each assembly shows its document count, linked schema, processing status, and the date it was created."
5923
+ ] }),
5924
+ /* @__PURE__ */ jsx6(Callout, { children: "Assemblies are the recommended way to produce production datasets. They provide a single audit trail from source documents through extraction, resolution, and validation to the final output." }),
5879
5925
  /* @__PURE__ */ jsx6(SectionHeading, { id: "validation-quality", children: "Validation & Quality" }),
5880
5926
  /* @__PURE__ */ jsx6(P, { children: "Multiple layers of quality assurance: automated validation checks, ground truth benchmarking, and configurable approval gates." }),
5881
5927
  /* @__PURE__ */ jsx6(SubHeading, { id: "validation-checks", children: "Validation Checks" }),
@@ -5895,6 +5941,13 @@ function PlatformGuide({ LinkComponent }) {
5895
5941
  /* @__PURE__ */ jsx6(InlineCode, { children: "result.approved" }),
5896
5942
  " signal to a destination to only ship approved rows to your downstream systems."
5897
5943
  ] }),
5944
+ /* @__PURE__ */ jsx6(SubHeading, { id: "approval-queue", children: "Approval Queue" }),
5945
+ /* @__PURE__ */ jsxs6(P, { children: [
5946
+ "Results that do not meet auto-approval thresholds are routed to the Approval Queue. Navigate to ",
5947
+ /* @__PURE__ */ jsx6("strong", { children: "Review \u2192 Approval Queue" }),
5948
+ " to see all pending items. Each row shows the source document, schema, confidence score, and whether the result has been flagged by a validation rule."
5949
+ ] }),
5950
+ /* @__PURE__ */ jsx6(P, { children: "Filter the queue by status (pending, flagged), schema, or confidence range. Click \u201CReview\u201D on any row to inspect the extracted values, provenance trails, and validation check results before approving or rejecting." }),
5898
5951
  /* @__PURE__ */ jsx6(SectionHeading, { id: "delivery", children: "Delivery" }),
5899
5952
  /* @__PURE__ */ jsx6(P, { children: "Push extracted, resolved, and reviewed data to any downstream system. Delivery is a typed, at-least-once pipeline with idempotency keys on the wire, append-only history, and a dead-letter queue for terminal failures." }),
5900
5953
  /* @__PURE__ */ jsx6(SubHeading, { id: "delivery-pipeline", children: "How Delivery Works" }),
@@ -6330,8 +6383,8 @@ var API_NAV_SECTIONS = [
6330
6383
  { id: "extract", label: "Extract", children: [
6331
6384
  { id: "post-extract", label: "POST /v1/extract" },
6332
6385
  { id: "extract-schemas", label: "Schema Formats" },
6333
- { id: "extract-options", label: "Options" },
6334
- { id: "extract-responses", label: "Responses" }
6386
+ { id: "extract-include-markdown", label: "Options" },
6387
+ { id: "extract-processing-mode", label: "Responses" }
6335
6388
  ] },
6336
6389
  { id: "documents", label: "Documents", children: [
6337
6390
  { id: "list-documents", label: "List Documents" },
@@ -6341,8 +6394,8 @@ var API_NAV_SECTIONS = [
6341
6394
  { id: "extractions", label: "Extractions", children: [
6342
6395
  { id: "list-extractions", label: "List Extractions" },
6343
6396
  { id: "get-extraction", label: "Get Extraction" },
6344
- { id: "get-extraction-data", label: "Get Extraction Data" },
6345
- { id: "patch-extraction-data", label: "Correct Fields" }
6397
+ { id: "get-extraction-fields", label: "Get Extraction Data" },
6398
+ { id: "get-extraction-markdown", label: "Correct Fields" }
6346
6399
  ] },
6347
6400
  { id: "schemas", label: "Schemas", children: [
6348
6401
  { id: "list-schemas", label: "List Schemas" },
@@ -6353,30 +6406,30 @@ var API_NAV_SECTIONS = [
6353
6406
  ] },
6354
6407
  { id: "jobs", label: "Jobs", children: [
6355
6408
  { id: "list-jobs", label: "List Jobs" },
6356
- { id: "get-job", label: "Get Job" },
6357
- { id: "cancel-job", label: "Cancel Job" }
6409
+ { id: "create-job", label: "Create Job" },
6410
+ { id: "get-job", label: "Get Job" }
6358
6411
  ] },
6359
6412
  { id: "sources", label: "Sources", children: [
6360
6413
  { id: "list-sources", label: "List Inputs" },
6361
6414
  { id: "create-source", label: "Create Input" },
6362
- { id: "manage-source", label: "Get / Update / Delete" },
6363
- { id: "source-documents", label: "Source Documents" }
6415
+ { id: "get-source", label: "Get / Update / Delete" },
6416
+ { id: "update-source", label: "Source Documents" }
6364
6417
  ] },
6365
6418
  { id: "filter-search", label: "Filter & Search", children: [
6366
6419
  { id: "field-autocomplete", label: "Field Autocomplete" },
6367
6420
  { id: "field-values", label: "Field Values" },
6368
6421
  { id: "filter-documents", label: "Filter Documents" },
6369
- { id: "omnisearch", label: "Omnisearch" },
6370
- { id: "list-saved-filters", label: "List Saved Filters" },
6371
- { id: "create-saved-filter", label: "Create Saved Filter" },
6372
- { id: "delete-saved-filter", label: "Delete Saved Filter" },
6373
- { id: "materialize", label: "Materialize" }
6422
+ { id: "filter-documents-export", label: "Omnisearch" },
6423
+ { id: "omnisearch", label: "Saved Filters" },
6424
+ { id: "saved-filters", label: "Document Counts" },
6425
+ { id: "document-counts", label: "Materialize" },
6426
+ { id: "materialized-index", label: "Materialized Index" }
6374
6427
  ] },
6375
6428
  { id: "webhooks", label: "Webhooks", children: [
6376
6429
  { id: "webhook-events", label: "Events" },
6377
- { id: "webhook-delivery", label: "Delivery Format" },
6378
- { id: "webhook-verification", label: "Signature Verification" },
6379
- { id: "webhook-retries", label: "Retry Policy" }
6430
+ { id: "webhook-management", label: "Delivery Format" },
6431
+ { id: "webhook-security", label: "Signature Verification" },
6432
+ { id: "webhook-retry", label: "Retry Policy" }
6380
6433
  ] },
6381
6434
  { id: "resolutions", label: "Resolutions", children: [
6382
6435
  { id: "list-resolutions", label: "List Resolutions" },
@@ -6384,23 +6437,23 @@ var API_NAV_SECTIONS = [
6384
6437
  { id: "get-resolution", label: "Get Resolution" },
6385
6438
  { id: "get-resolution-results", label: "Get Results" },
6386
6439
  { id: "execute-resolution", label: "Execute Resolution" },
6387
- { id: "delete-resolution", label: "Delete Resolution" }
6440
+ { id: "cancel-resolution", label: "Delete Resolution" }
6388
6441
  ] },
6389
6442
  { id: "linking", label: "Linking", children: [
6390
6443
  { id: "list-link-keys", label: "Link Keys" },
6391
- { id: "get-document-links", label: "Document Links" },
6392
- { id: "get-linking-graph", label: "Full Graph" },
6393
- { id: "get-document-graph", label: "Document Graph" },
6394
- { id: "classify-link-keys", label: "Classify" },
6395
- { id: "backfill-linking", label: "Backfill" },
6396
- { id: "backfill-progress", label: "Backfill Progress" },
6397
- { id: "document-case-map", label: "Document-Case Map" }
6444
+ { id: "reclassify-link-key", label: "Classify" },
6445
+ { id: "list-entities", label: "Document Links" },
6446
+ { id: "list-linked-documents", label: "Full Graph" },
6447
+ { id: "list-cases", label: "Backfill" },
6448
+ { id: "get-case", label: "Cases" },
6449
+ { id: "get-case-graph", label: "Case Graph" },
6450
+ { id: "refresh-cases", label: "Document-Case Map" }
6398
6451
  ] },
6399
6452
  { id: "nshot", label: "N-Shot", children: [
6400
6453
  { id: "nshot-summary", label: "Summary" },
6401
- { id: "nshot-comparisons", label: "Comparisons" },
6402
- { id: "nshot-comparison", label: "Single Comparison" },
6403
- { id: "nshot-override", label: "Override" },
6454
+ { id: "nshot-list-shots", label: "Comparisons" },
6455
+ { id: "nshot-compare", label: "Single Comparison" },
6456
+ { id: "nshot-select", label: "Override" },
6404
6457
  { id: "nshot-judge-decision", label: "Judge Decision" }
6405
6458
  ] },
6406
6459
  { id: "schema-graph", label: "Schema Graph", children: [
@@ -6483,15 +6536,20 @@ var PLATFORM_NAV_SECTIONS = [
6483
6536
  { id: "field-registry", label: "Field Registry" },
6484
6537
  { id: "tier-system", label: "Tier System" },
6485
6538
  { id: "semantic-clusters", label: "Semantic Clusters" },
6539
+ { id: "field-resolution", label: "Field Resolution" },
6486
6540
  { id: "master-instructions", label: "Master Instructions" }
6487
6541
  ] },
6488
6542
  { id: "schemas-templates", label: "Schemas & Templates", children: [
6489
6543
  { id: "generated-schemas", label: "Generated Schemas" },
6490
6544
  { id: "user-templates", label: "User Templates" },
6545
+ { id: "schema-features", label: "Schema Features Reference" },
6491
6546
  { id: "field-matching", label: "Field Matching" },
6492
6547
  { id: "reference-tables", label: "Reference Tables" },
6493
6548
  { id: "versioning-drafts", label: "Versioning & Drafts" },
6494
- { id: "test-extraction", label: "Test Extraction" }
6549
+ { id: "test-extraction", label: "Test Extraction" },
6550
+ { id: "dialects", label: "Dialects" },
6551
+ { id: "bypass-strategies", label: "Bypass Strategies" },
6552
+ { id: "format-constraints", label: "Format Constraints" }
6495
6553
  ] },
6496
6554
  { id: "extraction-jobs", label: "Extraction Jobs", children: [
6497
6555
  { id: "creating-job", label: "Creating a Job" },
@@ -6510,17 +6568,33 @@ var PLATFORM_NAV_SECTIONS = [
6510
6568
  { id: "cases", label: "Cases" },
6511
6569
  { id: "document-graph", label: "Document Graph" }
6512
6570
  ] },
6571
+ { id: "batch-inference", label: "Batch Inference", children: [
6572
+ { id: "batch-overview", label: "Overview" },
6573
+ { id: "batch-processing", label: "Batch Processing Mode" },
6574
+ { id: "batch-monitoring", label: "Monitoring Batches" }
6575
+ ] },
6576
+ { id: "matching", label: "Smart Matching", children: [
6577
+ { id: "reference-data", label: "Reference Data" },
6578
+ { id: "matching-configs", label: "Matching Configurations" },
6579
+ { id: "matching-runs", label: "Running Matches" },
6580
+ { id: "matching-results", label: "Match Results" }
6581
+ ] },
6582
+ { id: "data-products", label: "Data Products", children: [
6583
+ { id: "dataset-templates", label: "Dataset Templates" },
6584
+ { id: "assemblies", label: "Assemblies" }
6585
+ ] },
6513
6586
  { id: "validation-quality", label: "Validation & Quality", children: [
6514
6587
  { id: "validation-checks", label: "Validation Checks" },
6515
6588
  { id: "ground-truth", label: "Golden Samples" },
6516
- { id: "approval-gates", label: "Approval Gates" }
6589
+ { id: "approval-gates", label: "Approval Gates" },
6590
+ { id: "approval-queue", label: "Approval Queue" }
6517
6591
  ] },
6518
6592
  { id: "delivery", label: "Outputs", children: [
6593
+ { id: "delivery-pipeline", label: "How Delivery Works" },
6519
6594
  { id: "destinations", label: "Destinations" },
6520
- { id: "field-mappings", label: "Field Mappings" },
6521
- { id: "export-triggers", label: "Triggers" },
6522
- { id: "delivery-configuration", label: "Delivery Configuration" },
6523
- { id: "telemetry", label: "Telemetry" }
6595
+ { id: "bindings", label: "Bindings" },
6596
+ { id: "signals-catalog", label: "Signals & Catalog" },
6597
+ { id: "delivery-history", label: "History & DLQ" }
6524
6598
  ] },
6525
6599
  { id: "workspace-settings", label: "Workspace Settings", children: [
6526
6600
  { id: "shared-dialects", label: "Shared Dialects" },
@@ -6538,7 +6612,7 @@ var PLATFORM_NAV_SECTIONS = [
6538
6612
  ] },
6539
6613
  { id: "team-admin", label: "Team & Admin", children: [
6540
6614
  { id: "team-management", label: "Team Management" },
6541
- { id: "credits", label: "Credits & Usage" },
6615
+ { id: "usage-registry", label: "Usage & Registry" },
6542
6616
  { id: "admin-panel", label: "Admin Panel" },
6543
6617
  { id: "shortcuts", label: "Keyboard Shortcuts" }
6544
6618
  ] }
@@ -6576,7 +6650,10 @@ var PLATFORM_SECTION_META = [
6576
6650
  { id: "structuring", title: "Structuring", description: "Vocabulary-driven structuring system with seven field strategies, four processing tiers, capture sub-moves, modifiers, constraints, and synthesize fallback." },
6577
6651
  { 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." },
6578
6652
  { id: "linking-cases", title: "Linking & Cases", description: "Document linking discovers relationships through shared entities. Related documents grouped into cases with evidence chains." },
6579
- { id: "validation-quality", title: "Validation & Quality", description: "Automated validation checks, golden sample benchmarking, and configurable approval gates for quality assurance." },
6653
+ { 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." },
6654
+ { 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." },
6655
+ { id: "data-products", title: "Data Products", description: "Dataset templates for reusable output specifications and assemblies for combining multi-source documents into structured datasets." },
6656
+ { id: "validation-quality", title: "Validation & Quality", description: "Automated validation checks, golden sample benchmarking, configurable approval gates, and a manual review queue for flagged results." },
6580
6657
  { 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." },
6581
6658
  { id: "workspace-settings", title: "Workspace Settings", description: "Shared dialects for output formatting, reference primitives for lookup tables, and change review governance for production workspaces." },
6582
6659
  { id: "search-filtering", title: "Search & Filtering", description: "Global omnisearch (Cmd+K) and advanced document filtering by extracted field values with saved presets." },