@talonic/docs 0.19.1 → 0.19.2

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/content.js CHANGED
@@ -1,23 +1,23 @@
1
1
  // src/content/helpers.ts
2
- function deriveBreadcrumbs(sections44, leafId, domain) {
2
+ function deriveBreadcrumbs(sections45, leafId, domain) {
3
3
  const root = {
4
4
  label: domain === "api" ? "API Reference" : "Platform Guide",
5
5
  slug: domain
6
6
  };
7
- for (const group of sections44) {
7
+ for (const group of sections45) {
8
8
  const child = group.children?.find((c) => c.id === leafId);
9
9
  if (child) {
10
10
  return [root, { label: group.label, slug: group.id }, { label: child.label, slug: child.id }];
11
11
  }
12
12
  }
13
- const topLevel = sections44.find((s) => s.id === leafId);
13
+ const topLevel = sections45.find((s) => s.id === leafId);
14
14
  if (topLevel) {
15
15
  return [root, { label: topLevel.label, slug: topLevel.id }];
16
16
  }
17
17
  return [root];
18
18
  }
19
- function derivePrevNext(sections44, leafId) {
20
- const flat = sections44.flatMap(
19
+ function derivePrevNext(sections45, leafId) {
20
+ const flat = sections45.flatMap(
21
21
  (s) => s.children ?? [{ id: s.id, label: s.label }]
22
22
  );
23
23
  const idx = flat.findIndex((c) => c.id === leafId);
@@ -221,6 +221,9 @@ var API_NAV_SECTIONS = [
221
221
  { id: "manage-routing-rule", label: "Manage Rule" },
222
222
  { id: "reorder-routing-rules", label: "Reorder" }
223
223
  ] },
224
+ { id: "registry", label: "Registry", children: [
225
+ { id: "registry-query", label: "Query" }
226
+ ] },
224
227
  { id: "billing", label: "Billing", children: [
225
228
  { id: "billing-settings", label: "Settings" },
226
229
  { id: "billing-topup", label: "Auto Top-Up" },
@@ -10883,8 +10886,121 @@ X-Talonic-Cells-Resolved-AI: 1`
10883
10886
  }
10884
10887
  ];
10885
10888
 
10886
- // src/content/api/errors-rate-limits.ts
10889
+ // src/content/api/registry.ts
10887
10890
  var sections43 = [
10891
+ {
10892
+ slug: "registry-query",
10893
+ parentSlug: "registry",
10894
+ title: "Query the Registry",
10895
+ seoTitle: "Registry Query \u2014 Ingest Once, Query Forever \u2014 Talonic Docs",
10896
+ description: "Query previously-extracted field values across all documents without re-extraction. Zero AI calls. Filter by field values and select which fields to return.",
10897
+ content: [
10898
+ {
10899
+ type: "paragraph",
10900
+ text: "The registry query endpoint searches across **all previously-extracted documents** by field values. No document upload, no re-extraction, no AI calls. Documents ingested days or months ago are queryable immediately."
10901
+ },
10902
+ {
10903
+ type: "endpoint",
10904
+ method: "POST",
10905
+ path: "/v1/registry/query",
10906
+ summary: "Query extracted field values across documents.",
10907
+ description: "Requires read scope. Returns flat rows with one entry per matching document. All `where` conditions are ANDed.",
10908
+ blocks: [
10909
+ {
10910
+ type: "param-table",
10911
+ title: "Body parameters",
10912
+ params: [
10913
+ { name: "where", type: "object", required: true, description: "Field-value conditions. Keys are field names, values are the expected values. All conditions are ANDed." },
10914
+ { name: "select", type: "string[]", description: "Field names to return in results. If omitted, returns all fields referenced in `where`." },
10915
+ { name: "limit", type: "integer", description: "Maximum rows to return (default 100, max 500).", default: "100" }
10916
+ ]
10917
+ },
10918
+ {
10919
+ type: "code",
10920
+ title: "Request",
10921
+ language: "json",
10922
+ code: `{
10923
+ "where": {
10924
+ "vendor_name": "Meridian Energy AG",
10925
+ "contract_year": "2026"
10926
+ },
10927
+ "select": ["contract_value", "auto_renew", "notice_period_days"],
10928
+ "limit": 50
10929
+ }`
10930
+ },
10931
+ {
10932
+ type: "code",
10933
+ title: "Response",
10934
+ language: "json",
10935
+ code: `{
10936
+ "data": [
10937
+ {
10938
+ "document_id": "d7a1b2c3-...",
10939
+ "filename": "meridian-framework-2026.pdf",
10940
+ "document_type": "Framework Agreement",
10941
+ "vendor_name": "Meridian Energy AG",
10942
+ "contract_year": "2026",
10943
+ "contract_value": "450000",
10944
+ "auto_renew": "true",
10945
+ "notice_period_days": "90"
10946
+ },
10947
+ {
10948
+ "document_id": "e8f4a5b6-...",
10949
+ "filename": "meridian-amendment-q2.pdf",
10950
+ "document_type": "Contract Amendment",
10951
+ "vendor_name": "Meridian Energy AG",
10952
+ "contract_year": "2026",
10953
+ "contract_value": "475000",
10954
+ "auto_renew": "true",
10955
+ "notice_period_days": "90"
10956
+ }
10957
+ ],
10958
+ "total": 2
10959
+ }`
10960
+ },
10961
+ {
10962
+ type: "callout",
10963
+ text: "Field names in `where` and `select` are resolved against your workspace's field registry by canonical name (case-insensitive). Unknown field names return an error."
10964
+ },
10965
+ {
10966
+ type: "paragraph",
10967
+ text: "**How it works:** The query searches the `resolved_document_values` table \u2014 materialized field values produced by the extraction and jobs pipeline. Every field extracted from every document is queryable. No LLM calls are made."
10968
+ }
10969
+ ]
10970
+ }
10971
+ ],
10972
+ related: [
10973
+ { label: "Field Registry", slug: "field-registry" },
10974
+ { label: "Filter Documents", slug: "filter-documents" },
10975
+ { label: "POST /v1/extract", slug: "post-extract" }
10976
+ ],
10977
+ faq: [
10978
+ {
10979
+ question: "Does registry query re-extract documents?",
10980
+ answer: "No. It searches previously-extracted field values with zero AI calls. Documents can have been ingested days or months ago."
10981
+ },
10982
+ {
10983
+ question: "What field names can I use in where and select?",
10984
+ answer: "Any canonical field name from your workspace's field registry. Names are resolved case-insensitively. Use GET /v1/fields to discover available field names."
10985
+ },
10986
+ {
10987
+ question: "How is this different from POST /filter/documents?",
10988
+ answer: "Registry query returns flat rows (field name \u2192 value), shaped for agents and programmatic consumption. Filter documents returns document objects with nested field_values, shaped for UI consumption."
10989
+ }
10990
+ ],
10991
+ mentions: [
10992
+ "registry query",
10993
+ "ingest once",
10994
+ "query forever",
10995
+ "field values",
10996
+ "zero re-extraction",
10997
+ "resolved_document_values"
10998
+ ]
10999
+ }
11000
+ ];
11001
+
11002
+ // src/content/api/errors-rate-limits.ts
11003
+ var sections44 = [
10888
11004
  {
10889
11005
  slug: "error-format",
10890
11006
  parentSlug: "errors-rate-limits",
@@ -11037,7 +11153,8 @@ var ALL_API_RAW = [
11037
11153
  ...sections40,
11038
11154
  ...sections41,
11039
11155
  ...sections42,
11040
- ...sections43
11156
+ ...sections43,
11157
+ ...sections44
11041
11158
  ];
11042
11159
  function enrich(raw, navSections, domain) {
11043
11160
  return raw.map((r) => {
package/dist/index.js CHANGED
@@ -6565,6 +6565,9 @@ var API_NAV_SECTIONS = [
6565
6565
  { id: "manage-routing-rule", label: "Manage Rule" },
6566
6566
  { id: "reorder-routing-rules", label: "Reorder" }
6567
6567
  ] },
6568
+ { id: "registry", label: "Registry", children: [
6569
+ { id: "registry-query", label: "Query" }
6570
+ ] },
6568
6571
  { id: "billing", label: "Billing", children: [
6569
6572
  { id: "billing-settings", label: "Settings" },
6570
6573
  { id: "billing-topup", label: "Auto Top-Up" },
@@ -6715,6 +6718,7 @@ var API_SECTION_META = [
6715
6718
  { id: "review", title: "Review API", description: "Review queue for validation records \u2014 list items, stats, take action (approve/reject/flag), batch operations, and assignment." },
6716
6719
  { id: "quality", title: "Quality API", description: "Ground truth datasets, entries management with CSV import, benchmark runs, per-field accuracy results, and benchmark comparison." },
6717
6720
  { id: "routing-rules", title: "Routing Rules API", description: "Document routing rules \u2014 create, manage, and reorder priority-based rules for automatic document workflow assignment." },
6721
+ { 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." },
6718
6722
  { id: "billing", title: "Billing API", description: "Billing settings, auto top-up for AI agents, and cost response headers on extraction requests." },
6719
6723
  { id: "errors-rate-limits", title: "Errors & Rate Limits", description: "Error response format, error codes, rate limit tiers by plan, and rate limit headers." }
6720
6724
  ];