@retab/node 1.0.82 → 1.0.84

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.
Files changed (10) hide show
  1. package/dist/api/documents/client.d.ts +5 -3
  2. package/dist/api/documents/client.d.ts.map +1 -1
  3. package/dist/api/documents/client.js +5 -3
  4. package/dist/generated_types.d.ts +196 -26
  5. package/dist/generated_types.d.ts.map +1 -1
  6. package/dist/generated_types.js +21 -5
  7. package/dist/types.d.ts +16 -3
  8. package/dist/types.d.ts.map +1 -1
  9. package/dist/types.js +1 -0
  10. package/package.json +1 -1
package/dist/api/documents/client.d.ts CHANGED
@@ -39,7 +39,7 @@ export default class APIDocuments extends CompositionClient {
39
39
  * - categories: Array of categories with 'name' and 'description'
40
40
  * - model: LLM model for inference (e.g., "retab-small")
41
41
  * @param options - Optional request options
42
- * @returns SplitResponse containing splits array with name, start_page, and end_page for each section
42
+ * @returns SplitResponse containing splits array with name and pages for each section
43
43
  *
44
44
  * @example
45
45
  * ```typescript
@@ -53,7 +53,7 @@ export default class APIDocuments extends CompositionClient {
53
53
  * ]
54
54
  * });
55
55
  * for (const split of response.splits) {
56
- * console.log(`${split.name}: pages ${split.start_page}-${split.end_page}`);
56
+ * console.log(`${split.name}: pages ${split.pages.join(', ')}`);
57
57
  * }
58
58
  * ```
59
59
  */
@@ -69,6 +69,7 @@ export default class APIDocuments extends CompositionClient {
69
69
  * - document: MIMEData object, file path, Buffer, or Readable stream
70
70
  * - categories: Array of categories with 'name' and 'description'
71
71
  * - model: LLM model for inference (e.g., "retab-small")
72
+ * - first_n_pages: (optional) Only use the first N pages for classification. Useful for large documents.
72
73
  * @param options - Optional request options
73
74
  * @returns ClassifyResponse containing result with reasoning and classification
74
75
  *
@@ -81,7 +82,8 @@ export default class APIDocuments extends CompositionClient {
81
82
  * { name: "invoice", description: "Invoice documents with billing information" },
82
83
  * { name: "receipt", description: "Receipt documents for payments" },
83
84
  * { name: "contract", description: "Legal contract documents" },
84
- * ]
85
+ * ],
86
+ * first_n_pages: 3 // Optional: only use first 3 pages
85
87
  * });
86
88
  * console.log(`Classification: ${response.result.classification}`);
87
89
  * console.log(`Reasoning: ${response.result.reasoning}`);
package/dist/api/documents/client.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/documents/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAA2B,sBAAsB,EAAE,yBAAyB,EAA8B,YAAY,EAAE,WAAW,EAA+B,4BAA4B,EAAE,eAAe,EAAmD,0BAA0B,EAA+B,8BAA8B,EAAmC,WAAW,EAAE,YAAY,EAA+B,YAAY,EAAiC,eAAe,EAAuC,MAAM,gBAAgB,CAAC;AACrjB,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAGhF,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,iBAAiB;gBAC3C,MAAM,EAAE,iBAAiB;IAG/B,OAAO,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAUrG,cAAc,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;IAUjI,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAS3E,eAAe,CAAC,MAAM,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IASzG,aAAa,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAS3G;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAShF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IASnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAS/F"}
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/documents/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAA2B,sBAAsB,EAAE,yBAAyB,EAA8B,YAAY,EAAE,WAAW,EAA+B,4BAA4B,EAAE,eAAe,EAAmD,0BAA0B,EAA+B,8BAA8B,EAAmC,WAAW,EAAE,YAAY,EAA+B,YAAY,EAAiC,eAAe,EAAuC,MAAM,gBAAgB,CAAC;AACrjB,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAGhF,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,iBAAiB;gBAC3C,MAAM,EAAE,iBAAiB;IAG/B,OAAO,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAUrG,cAAc,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;IAUjI,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAS3E,eAAe,CAAC,MAAM,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IASzG,aAAa,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAS3G;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAShF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IASnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAS/F"}
package/dist/api/documents/client.js CHANGED
@@ -90,7 +90,7 @@ export default class APIDocuments extends CompositionClient {
90
90
  * - categories: Array of categories with 'name' and 'description'
91
91
  * - model: LLM model for inference (e.g., "retab-small")
92
92
  * @param options - Optional request options
93
- * @returns SplitResponse containing splits array with name, start_page, and end_page for each section
93
+ * @returns SplitResponse containing splits array with name and pages for each section
94
94
  *
95
95
  * @example
96
96
  * ```typescript
@@ -104,7 +104,7 @@ export default class APIDocuments extends CompositionClient {
104
104
  * ]
105
105
  * });
106
106
  * for (const split of response.splits) {
107
- * console.log(`${split.name}: pages ${split.start_page}-${split.end_page}`);
107
+ * console.log(`${split.name}: pages ${split.pages.join(', ')}`);
108
108
  * }
109
109
  * ```
110
110
  */
@@ -128,6 +128,7 @@ export default class APIDocuments extends CompositionClient {
128
128
  * - document: MIMEData object, file path, Buffer, or Readable stream
129
129
  * - categories: Array of categories with 'name' and 'description'
130
130
  * - model: LLM model for inference (e.g., "retab-small")
131
+ * - first_n_pages: (optional) Only use the first N pages for classification. Useful for large documents.
131
132
  * @param options - Optional request options
132
133
  * @returns ClassifyResponse containing result with reasoning and classification
133
134
  *
@@ -140,7 +141,8 @@ export default class APIDocuments extends CompositionClient {
140
141
  * { name: "invoice", description: "Invoice documents with billing information" },
141
142
  * { name: "receipt", description: "Receipt documents for payments" },
142
143
  * { name: "contract", description: "Legal contract documents" },
143
- * ]
144
+ * ],
145
+ * first_n_pages: 3 // Optional: only use first 3 pages
144
146
  * });
145
147
  * console.log(`Classification: ${response.result.classification}`);
146
148
  * console.log(`Reasoning: ${response.result.reasoning}`);