@talonic/docs 0.20.20 → 0.20.22

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
@@ -28908,6 +28908,7 @@ var sections_default2 = [
28908
28908
  items: [
28909
28909
  "You need details about a specific document already extracted or uploaded.",
28910
28910
  "You have a `document_id` from a previous extract or search and want more context.",
28911
+ "You called `talonic_request_upload` and need to poll until the user has uploaded the file.",
28911
28912
  "The user asks 'tell me about document X'."
28912
28913
  ]
28913
28914
  },
@@ -28953,6 +28954,26 @@ var sections_default2 = [
28953
28954
  title: "Example response",
28954
28955
  code: '{\n "id": "d_abc123",\n "filename": "invoice.pdf",\n "documentType": "invoice",\n "language": "en",\n "pageCount": 2,\n "processingLog": [...],\n "links": {\n "self": "https://api.talonic.com/v1/documents/d_abc123",\n "extractions": "https://api.talonic.com/v1/documents/d_abc123/extractions",\n "dashboard": "https://app.talonic.com/documents/d_abc123"\n }\n}'
28955
28956
  },
28957
+ {
28958
+ type: "heading",
28959
+ level: 3,
28960
+ text: "Status values"
28961
+ },
28962
+ {
28963
+ type: "paragraph",
28964
+ text: "The `status` field on the response indicates where the document is in its lifecycle. When polling after `talonic_request_upload`, wait for `status` to reach `completed` before calling `talonic_extract`."
28965
+ },
28966
+ {
28967
+ type: "list",
28968
+ ordered: false,
28969
+ items: [
28970
+ "`pending_upload` \u2014 document slot reserved via `talonic_request_upload`, file not yet received. Poll at ~5 s intervals. The slot expires after 15 min; past `expires_at` from the request, the user did not upload in time.",
28971
+ "`queued` / `extracting` \u2014 file received, OCR and exhaustive extraction in progress. Keep polling.",
28972
+ "`completed` \u2014 extraction is done. This is the state to wait for before calling `talonic_extract` with a schema or schema_id \u2014 the schema-specific LLM pass runs off the cached OCR'd text.",
28973
+ "`uploaded` \u2014 file received but the extraction queue could not be enqueued (rare, e.g. Redis unavailable). `talonic_extract` will trigger processing inline if called.",
28974
+ "`error` / `ocr_failed` / `extraction_failed` \u2014 terminal failures. See `processing_log` for the reason."
28975
+ ]
28976
+ },
28956
28977
  {
28957
28978
  type: "heading",
28958
28979
  level: 3,
@@ -29528,10 +29549,16 @@ var sections_default2 = [
29528
29549
  "Call `talonic_request_upload` with the filename. You receive a `document_id`, an `upload_url`, and an `expires_at` timestamp.",
29529
29550
  "Show the `upload_url` to the user and ask them to open it in their browser.",
29530
29551
  "The user drops the file on the upload page. The browser uploads directly to Talonic \u2014 no tool-call size cap, no sandbox restriction.",
29531
- "Poll with `talonic_get_document` using the `document_id` until `status` is `uploaded`.",
29552
+ "Poll with `talonic_get_document` using the `document_id` until `status` is `completed` (the file has been received, OCR'd, and is ready for schema-specific extraction).",
29532
29553
  "Call `talonic_extract` with the `document_id` and a schema to extract structured data."
29533
29554
  ]
29534
29555
  },
29556
+ {
29557
+ type: "callout",
29558
+ variant: "warning",
29559
+ title: "Don't trust the user's 'done' message \u2014 poll instead",
29560
+ text: "When the user types 'uploaded', 'done', or 'I dropped it', that only confirms the browser-side upload completed. Server-side OCR and exhaustive extraction take another 10\u201330 seconds. Calling `talonic_extract` before `talonic_get_document` reports `status: 'completed'` may return errors. Always poll, regardless of what the user says."
29561
+ },
29535
29562
  {
29536
29563
  type: "heading",
29537
29564
  level: 3,
@@ -29602,7 +29629,7 @@ var sections_default2 = [
29602
29629
  faq: [
29603
29630
  {
29604
29631
  question: "How do I upload a file through Claude.ai to Talonic?",
29605
- answer: "Call talonic_request_upload with the filename. Show the returned upload_url to the user. They open it in their browser and drop the file. Poll talonic_get_document until status is 'uploaded', then call talonic_extract with the document_id."
29632
+ answer: "Call talonic_request_upload with the filename. Show the returned upload_url to the user. They open it in their browser and drop the file. Poll talonic_get_document until status is 'completed' (the document has been received and processed), then call talonic_extract with the document_id and a schema."
29606
29633
  },
29607
29634
  {
29608
29635
  question: "Why can't I just send the file through file_data on Claude.ai?",
@@ -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 };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@talonic/docs",
3
- "version": "0.20.20",
3
+ "version": "0.20.22",
4
4
  "description": "Talonic documentation components — API Reference & Platform Guide",
5
5
  "license": "UNLICENSED",
6
6
  "private": false,