@talonic/docs 0.20.6 → 0.20.7
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 +4 -4
- package/dist/tailwind-preset.d.cts +45 -0
- package/dist/tailwind-preset.d.ts +45 -0
- package/package.json +1 -1
package/dist/content.js
CHANGED
|
@@ -18113,8 +18113,8 @@ var sections_default2 = [
|
|
|
18113
18113
|
{ name: "limit", type: "number", description: "Maximum results per entity type. Default: 5. Increase for broader exploration." }
|
|
18114
18114
|
] },
|
|
18115
18115
|
{ type: "heading", level: 3, text: "Response shape" },
|
|
18116
|
-
{ type: "code", language: "json", title: "Example response", code: '{\n "documents": [\n {\n "id": "d_abc123",\n "filename": "acme-invoice-q4.pdf",\n "documentType": "invoice",\n "score": 0.92\n }\n ],\n "fieldMatches": [\n {\n "
|
|
18117
|
-
{ type: "callout", text: "
|
|
18116
|
+
{ type: "code", language: "json", title: "Example response", code: '{\n "documents": [\n {\n "id": "d_abc123",\n "filename": "acme-invoice-q4.pdf",\n "documentType": "invoice",\n "score": 0.92\n }\n ],\n "fieldMatches": [\n {\n "resolvedFieldId": "f_ghi789",\n "displayName": "Vendor Name",\n "matchedValue": "Acme Corp",\n "documentCount": 3,\n "filterable": true\n }\n ],\n "sources": [],\n "schemas": [\n {\n "id": "sch_def456",\n "name": "Standard Invoice"\n }\n ],\n "fields": [\n {\n "id": "f_ghi789",\n "canonicalName": "vendor.name",\n "displayName": "Vendor Name",\n "documentCount": 12,\n "filterable": true\n }\n ]\n}' },
|
|
18117
|
+
{ type: "callout", text: "Only `fields[]` entries with `filterable: true` can be used with `talonic_filter`. These have extracted data in the workspace. Fields with `filterable: false` exist in a schema definition but have no extracted data yet \u2014 they become filterable after documents are processed against their schema." },
|
|
18118
18118
|
{ type: "heading", level: 3, text: "Cost" },
|
|
18119
18119
|
{ type: "paragraph", text: "Search calls are **free** \u2014 they do not consume extraction credits. Use search liberally to explore before extracting." },
|
|
18120
18120
|
{ type: "heading", level: 3, text: "Errors" },
|
|
@@ -18189,7 +18189,7 @@ var sections_default2 = [
|
|
|
18189
18189
|
{ type: "heading", level: 3, text: "Errors" },
|
|
18190
18190
|
{ type: "param-table", title: "Common errors", params: [
|
|
18191
18191
|
{ name: "unauthorized", type: "401", description: "Invalid or missing API key." },
|
|
18192
|
-
{ name: "no_field_match", type: "422", description: "
|
|
18192
|
+
{ name: "no_field_match", type: "422", description: "No filterable field matches name. The field may exist in a schema but has no extracted data yet. Use `talonic_search` and look for fields with `filterable: true`." },
|
|
18193
18193
|
{ name: "validation_error", type: "422", description: "Missing conditions array, invalid operator, or missing `value` for operators that require it." }
|
|
18194
18194
|
] }
|
|
18195
18195
|
],
|
|
@@ -18199,7 +18199,7 @@ var sections_default2 = [
|
|
|
18199
18199
|
],
|
|
18200
18200
|
faq: [
|
|
18201
18201
|
{ question: "Does talonic_filter cost credits?", answer: "No. Filter queries already-extracted data and is free." },
|
|
18202
|
-
{ question: "How do I find field names for filtering?", answer: "Call talonic_search first.
|
|
18202
|
+
{ question: "How do I find field names for filtering?", answer: "Call talonic_search first. Use fields[] entries where filterable is true \u2014 their canonicalName values are what you pass as the field parameter in filter conditions. Fields with filterable: false have no extracted data yet and cannot be filtered." }
|
|
18203
18203
|
],
|
|
18204
18204
|
mentions: ["talonic_filter", "filter", "conditions", "operators", "canonical field name"]
|
|
18205
18205
|
},
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Tailwind CSS preset for @talonic/docs consumers.
|
|
3
|
+
* Adds the Void design system color tokens and font families
|
|
4
|
+
* so doc components render correctly in any host app.
|
|
5
|
+
*/
|
|
6
|
+
declare const voidDocsPreset: {
|
|
7
|
+
darkMode: "class";
|
|
8
|
+
theme: {
|
|
9
|
+
extend: {
|
|
10
|
+
colors: {
|
|
11
|
+
'void-bg': string;
|
|
12
|
+
'void-bg-elevated': string;
|
|
13
|
+
'void-surface': string;
|
|
14
|
+
'void-surface-2': string;
|
|
15
|
+
'void-surface-3': string;
|
|
16
|
+
'void-border': string;
|
|
17
|
+
'void-border-hover': string;
|
|
18
|
+
'void-text-primary': string;
|
|
19
|
+
'void-text-secondary': string;
|
|
20
|
+
'void-text-muted': string;
|
|
21
|
+
'void-text-tertiary': string;
|
|
22
|
+
'void-accent': string;
|
|
23
|
+
'void-accent-hover': string;
|
|
24
|
+
'void-accent-dim': string;
|
|
25
|
+
'void-accent-tint': string;
|
|
26
|
+
'void-danger': string;
|
|
27
|
+
'void-danger-solid': string;
|
|
28
|
+
'void-divider': string;
|
|
29
|
+
'void-warning': string;
|
|
30
|
+
'void-warning-dim': string;
|
|
31
|
+
'void-tier-1': string;
|
|
32
|
+
'void-tier-2': string;
|
|
33
|
+
'void-tier-3': string;
|
|
34
|
+
};
|
|
35
|
+
fontFamily: {
|
|
36
|
+
space: string[];
|
|
37
|
+
body: string[];
|
|
38
|
+
mono: string[];
|
|
39
|
+
};
|
|
40
|
+
};
|
|
41
|
+
};
|
|
42
|
+
plugins: never[];
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
export { voidDocsPreset as default };
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Tailwind CSS preset for @talonic/docs consumers.
|
|
3
|
+
* Adds the Void design system color tokens and font families
|
|
4
|
+
* so doc components render correctly in any host app.
|
|
5
|
+
*/
|
|
6
|
+
declare const voidDocsPreset: {
|
|
7
|
+
darkMode: "class";
|
|
8
|
+
theme: {
|
|
9
|
+
extend: {
|
|
10
|
+
colors: {
|
|
11
|
+
'void-bg': string;
|
|
12
|
+
'void-bg-elevated': string;
|
|
13
|
+
'void-surface': string;
|
|
14
|
+
'void-surface-2': string;
|
|
15
|
+
'void-surface-3': string;
|
|
16
|
+
'void-border': string;
|
|
17
|
+
'void-border-hover': string;
|
|
18
|
+
'void-text-primary': string;
|
|
19
|
+
'void-text-secondary': string;
|
|
20
|
+
'void-text-muted': string;
|
|
21
|
+
'void-text-tertiary': string;
|
|
22
|
+
'void-accent': string;
|
|
23
|
+
'void-accent-hover': string;
|
|
24
|
+
'void-accent-dim': string;
|
|
25
|
+
'void-accent-tint': string;
|
|
26
|
+
'void-danger': string;
|
|
27
|
+
'void-danger-solid': string;
|
|
28
|
+
'void-divider': string;
|
|
29
|
+
'void-warning': string;
|
|
30
|
+
'void-warning-dim': string;
|
|
31
|
+
'void-tier-1': string;
|
|
32
|
+
'void-tier-2': string;
|
|
33
|
+
'void-tier-3': string;
|
|
34
|
+
};
|
|
35
|
+
fontFamily: {
|
|
36
|
+
space: string[];
|
|
37
|
+
body: string[];
|
|
38
|
+
mono: string[];
|
|
39
|
+
};
|
|
40
|
+
};
|
|
41
|
+
};
|
|
42
|
+
plugins: never[];
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
export { voidDocsPreset as default };
|