pulse-ts-sdk 1.0.9 → 1.0.11
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/README.md +23 -23
- package/dist/cjs/BaseClient.js +1 -0
- package/dist/cjs/Client.d.ts +6 -0
- package/dist/cjs/Client.js +74 -34
- package/dist/cjs/api/client/requests/ExtractAsyncRequest.d.ts +6 -3
- package/dist/cjs/api/client/requests/ExtractAsyncRequest.js +3 -2
- package/dist/cjs/api/client/requests/ExtractRequest.d.ts +6 -3
- package/dist/cjs/api/client/requests/ExtractRequest.js +3 -2
- package/dist/cjs/api/resources/batch/client/Client.js +32 -16
- package/dist/cjs/api/resources/form/client/Client.d.ts +171 -0
- package/dist/cjs/api/resources/form/client/Client.js +434 -0
- package/dist/cjs/api/resources/form/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/form/client/index.js +17 -0
- package/dist/cjs/api/resources/form/client/requests/FormClearMultipartInput.d.ts +21 -0
- package/dist/cjs/api/resources/form/client/requests/FormClearMultipartInput.js +3 -0
- package/dist/cjs/api/resources/form/client/requests/FormDetectMultipartInput.d.ts +17 -0
- package/dist/cjs/api/resources/form/client/requests/FormDetectMultipartInput.js +3 -0
- package/dist/cjs/api/resources/form/client/requests/FormFillMultipartInput.d.ts +23 -0
- package/dist/cjs/api/resources/form/client/requests/FormFillMultipartInput.js +3 -0
- package/dist/cjs/api/resources/form/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/form/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/form/index.d.ts +1 -0
- package/dist/cjs/api/resources/form/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/index.js +5 -1
- package/dist/cjs/api/resources/jobs/client/Client.js +16 -8
- package/dist/cjs/api/resources/largeResults/client/Client.d.ts +11 -5
- package/dist/cjs/api/resources/largeResults/client/Client.js +19 -9
- package/dist/cjs/api/resources/pipeline/client/Client.d.ts +4 -2
- package/dist/cjs/api/resources/pipeline/client/Client.js +12 -6
- package/dist/cjs/api/resources/results/client/Client.d.ts +27 -0
- package/dist/cjs/api/resources/results/client/Client.js +116 -0
- package/dist/cjs/api/resources/results/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/results/client/index.js +17 -0
- package/dist/cjs/api/resources/results/client/requests/GetPdfResultsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/results/client/requests/GetPdfResultsRequest.js +3 -0
- package/dist/cjs/api/resources/results/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/results/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/results/index.d.ts +1 -0
- package/dist/cjs/api/resources/results/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/Client.js +8 -4
- package/dist/cjs/api/types/ExtractInput.d.ts +6 -3
- package/dist/cjs/api/types/ExtractInput.js +3 -2
- package/dist/cjs/api/types/ExtractOptions.d.ts +6 -3
- package/dist/cjs/api/types/ExtractOptions.js +3 -2
- package/dist/cjs/api/types/FormCell.d.ts +40 -0
- package/dist/cjs/api/types/FormCell.js +13 -0
- package/dist/cjs/api/types/FormCheckboxDetail.d.ts +11 -0
- package/dist/cjs/api/types/FormCheckboxDetail.js +3 -0
- package/dist/cjs/api/types/FormClearJsonInput.d.ts +19 -0
- package/dist/cjs/api/types/FormClearJsonInput.js +3 -0
- package/dist/cjs/api/types/FormDetectJsonInput.d.ts +14 -0
- package/dist/cjs/api/types/FormDetectJsonInput.js +3 -0
- package/dist/cjs/api/types/FormFillJsonInput.d.ts +19 -0
- package/dist/cjs/api/types/FormFillJsonInput.js +3 -0
- package/dist/cjs/api/types/FormFillSharedOptions.d.ts +12 -0
- package/dist/cjs/api/types/FormFillSharedOptions.js +3 -0
- package/dist/cjs/api/types/FormPlanInfo.d.ts +11 -0
- package/dist/cjs/api/types/FormPlanInfo.js +3 -0
- package/dist/cjs/api/types/FormResult.d.ts +24 -0
- package/dist/cjs/api/types/FormResult.js +3 -0
- package/dist/cjs/api/types/FormSharedOptions.d.ts +9 -0
- package/dist/cjs/api/types/FormSharedOptions.js +3 -0
- package/dist/cjs/api/types/PipelineResults.d.ts +2 -0
- package/dist/cjs/api/types/PipelineStepBatchExtractConfig.d.ts +6 -3
- package/dist/cjs/api/types/PipelineStepBatchExtractConfig.js +3 -2
- package/dist/cjs/api/types/PipelineSteps.d.ts +2 -0
- package/dist/cjs/api/types/PipelineTablesResult.d.ts +33 -0
- package/dist/cjs/api/types/PipelineTablesResult.js +3 -0
- package/dist/cjs/api/types/TablesConfig.d.ts +3 -2
- package/dist/cjs/api/types/TablesConfig.js +2 -1
- package/dist/cjs/api/types/TablesResponse.d.ts +2 -2
- package/dist/cjs/api/types/index.d.ts +10 -0
- package/dist/cjs/api/types/index.js +10 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +1 -0
- package/dist/esm/Client.d.mts +6 -0
- package/dist/esm/Client.mjs +66 -26
- package/dist/esm/api/client/requests/ExtractAsyncRequest.d.mts +6 -3
- package/dist/esm/api/client/requests/ExtractAsyncRequest.mjs +3 -2
- package/dist/esm/api/client/requests/ExtractRequest.d.mts +6 -3
- package/dist/esm/api/client/requests/ExtractRequest.mjs +3 -2
- package/dist/esm/api/resources/batch/client/Client.mjs +32 -16
- package/dist/esm/api/resources/form/client/Client.d.mts +171 -0
- package/dist/esm/api/resources/form/client/Client.mjs +397 -0
- package/dist/esm/api/resources/form/client/index.d.mts +1 -0
- package/dist/esm/api/resources/form/client/index.mjs +1 -0
- package/dist/esm/api/resources/form/client/requests/FormClearMultipartInput.d.mts +21 -0
- package/dist/esm/api/resources/form/client/requests/FormClearMultipartInput.mjs +2 -0
- package/dist/esm/api/resources/form/client/requests/FormDetectMultipartInput.d.mts +17 -0
- package/dist/esm/api/resources/form/client/requests/FormDetectMultipartInput.mjs +2 -0
- package/dist/esm/api/resources/form/client/requests/FormFillMultipartInput.d.mts +23 -0
- package/dist/esm/api/resources/form/client/requests/FormFillMultipartInput.mjs +2 -0
- package/dist/esm/api/resources/form/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/form/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/form/index.d.mts +1 -0
- package/dist/esm/api/resources/form/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/index.mjs +4 -0
- package/dist/esm/api/resources/jobs/client/Client.mjs +16 -8
- package/dist/esm/api/resources/largeResults/client/Client.d.mts +11 -5
- package/dist/esm/api/resources/largeResults/client/Client.mjs +19 -9
- package/dist/esm/api/resources/pipeline/client/Client.d.mts +4 -2
- package/dist/esm/api/resources/pipeline/client/Client.mjs +12 -6
- package/dist/esm/api/resources/results/client/Client.d.mts +27 -0
- package/dist/esm/api/resources/results/client/Client.mjs +79 -0
- package/dist/esm/api/resources/results/client/index.d.mts +1 -0
- package/dist/esm/api/resources/results/client/index.mjs +1 -0
- package/dist/esm/api/resources/results/client/requests/GetPdfResultsRequest.d.mts +10 -0
- package/dist/esm/api/resources/results/client/requests/GetPdfResultsRequest.mjs +2 -0
- package/dist/esm/api/resources/results/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/results/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/results/index.d.mts +1 -0
- package/dist/esm/api/resources/results/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.mjs +8 -4
- package/dist/esm/api/types/ExtractInput.d.mts +6 -3
- package/dist/esm/api/types/ExtractInput.mjs +3 -2
- package/dist/esm/api/types/ExtractOptions.d.mts +6 -3
- package/dist/esm/api/types/ExtractOptions.mjs +3 -2
- package/dist/esm/api/types/FormCell.d.mts +40 -0
- package/dist/esm/api/types/FormCell.mjs +10 -0
- package/dist/esm/api/types/FormCheckboxDetail.d.mts +11 -0
- package/dist/esm/api/types/FormCheckboxDetail.mjs +2 -0
- package/dist/esm/api/types/FormClearJsonInput.d.mts +19 -0
- package/dist/esm/api/types/FormClearJsonInput.mjs +2 -0
- package/dist/esm/api/types/FormDetectJsonInput.d.mts +14 -0
- package/dist/esm/api/types/FormDetectJsonInput.mjs +2 -0
- package/dist/esm/api/types/FormFillJsonInput.d.mts +19 -0
- package/dist/esm/api/types/FormFillJsonInput.mjs +2 -0
- package/dist/esm/api/types/FormFillSharedOptions.d.mts +12 -0
- package/dist/esm/api/types/FormFillSharedOptions.mjs +2 -0
- package/dist/esm/api/types/FormPlanInfo.d.mts +11 -0
- package/dist/esm/api/types/FormPlanInfo.mjs +2 -0
- package/dist/esm/api/types/FormResult.d.mts +24 -0
- package/dist/esm/api/types/FormResult.mjs +2 -0
- package/dist/esm/api/types/FormSharedOptions.d.mts +9 -0
- package/dist/esm/api/types/FormSharedOptions.mjs +2 -0
- package/dist/esm/api/types/PipelineResults.d.mts +2 -0
- package/dist/esm/api/types/PipelineStepBatchExtractConfig.d.mts +6 -3
- package/dist/esm/api/types/PipelineStepBatchExtractConfig.mjs +3 -2
- package/dist/esm/api/types/PipelineSteps.d.mts +2 -0
- package/dist/esm/api/types/PipelineTablesResult.d.mts +33 -0
- package/dist/esm/api/types/PipelineTablesResult.mjs +2 -0
- package/dist/esm/api/types/TablesConfig.d.mts +3 -2
- package/dist/esm/api/types/TablesConfig.mjs +2 -1
- package/dist/esm/api/types/TablesResponse.d.mts +2 -2
- package/dist/esm/api/types/index.d.mts +10 -0
- package/dist/esm/api/types/index.mjs +10 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +379 -7
package/README.md
CHANGED
|
@@ -55,7 +55,7 @@ following namespace:
|
|
|
55
55
|
```typescript
|
|
56
56
|
import { Pulse } from "pulse-ts-sdk";
|
|
57
57
|
|
|
58
|
-
const request: Pulse.
|
|
58
|
+
const request: Pulse.FormDetectMultipartInput = {
|
|
59
59
|
...
|
|
60
60
|
};
|
|
61
61
|
```
|
|
@@ -89,7 +89,7 @@ import { createReadStream } from "fs";
|
|
|
89
89
|
import { PulseClient } from "pulse-ts-sdk";
|
|
90
90
|
|
|
91
91
|
const client = new PulseClient({ apiKey: "YOUR_API_KEY" });
|
|
92
|
-
await client.
|
|
92
|
+
await client.form.detect({});
|
|
93
93
|
```
|
|
94
94
|
The client accepts a variety of types for file upload parameters:
|
|
95
95
|
* Stream types: `fs.ReadStream`, `stream.Readable`, and `ReadableStream`
|
|
@@ -126,7 +126,7 @@ For example, `fs.ReadStream` has a `path` property which the SDK uses to retriev
|
|
|
126
126
|
You can consume binary data from endpoints using the `BinaryResponse` type which lets you choose how to consume the data:
|
|
127
127
|
|
|
128
128
|
```typescript
|
|
129
|
-
const response = await client.
|
|
129
|
+
const response = await client.results.getPdf(...);
|
|
130
130
|
const stream: ReadableStream<Uint8Array> = response.stream();
|
|
131
131
|
// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
|
|
132
132
|
// const blob: Blob = response.blob();
|
|
@@ -151,7 +151,7 @@ import { createWriteStream } from 'fs';
|
|
|
151
151
|
import { Readable } from 'stream';
|
|
152
152
|
import { pipeline } from 'stream/promises';
|
|
153
153
|
|
|
154
|
-
const response = await client.
|
|
154
|
+
const response = await client.results.getPdf(...);
|
|
155
155
|
|
|
156
156
|
const stream = response.stream();
|
|
157
157
|
const nodeStream = Readable.fromWeb(stream);
|
|
@@ -170,7 +170,7 @@ await pipeline(nodeStream, writeStream);
|
|
|
170
170
|
```ts
|
|
171
171
|
import { writeFile } from 'fs/promises';
|
|
172
172
|
|
|
173
|
-
const response = await client.
|
|
173
|
+
const response = await client.results.getPdf(...);
|
|
174
174
|
|
|
175
175
|
const arrayBuffer = await response.arrayBuffer();
|
|
176
176
|
await writeFile('path/to/file', Buffer.from(arrayBuffer));
|
|
@@ -186,7 +186,7 @@ await writeFile('path/to/file', Buffer.from(arrayBuffer));
|
|
|
186
186
|
```ts
|
|
187
187
|
import { writeFile } from 'fs/promises';
|
|
188
188
|
|
|
189
|
-
const response = await client.
|
|
189
|
+
const response = await client.results.getPdf(...);
|
|
190
190
|
|
|
191
191
|
const blob = await response.blob();
|
|
192
192
|
const arrayBuffer = await blob.arrayBuffer();
|
|
@@ -203,7 +203,7 @@ await writeFile('output.bin', Buffer.from(arrayBuffer));
|
|
|
203
203
|
```ts
|
|
204
204
|
import { writeFile } from 'fs/promises';
|
|
205
205
|
|
|
206
|
-
const response = await client.
|
|
206
|
+
const response = await client.results.getPdf(...);
|
|
207
207
|
|
|
208
208
|
const bytes = await response.bytes();
|
|
209
209
|
await writeFile('path/to/file', bytes);
|
|
@@ -224,7 +224,7 @@ await writeFile('path/to/file', bytes);
|
|
|
224
224
|
<summary>ReadableStream (most-efficient)</summary>
|
|
225
225
|
|
|
226
226
|
```ts
|
|
227
|
-
const response = await client.
|
|
227
|
+
const response = await client.results.getPdf(...);
|
|
228
228
|
|
|
229
229
|
const stream = response.stream();
|
|
230
230
|
await Bun.write('path/to/file', stream);
|
|
@@ -238,7 +238,7 @@ await Bun.write('path/to/file', stream);
|
|
|
238
238
|
<summary>ArrayBuffer</summary>
|
|
239
239
|
|
|
240
240
|
```ts
|
|
241
|
-
const response = await client.
|
|
241
|
+
const response = await client.results.getPdf(...);
|
|
242
242
|
|
|
243
243
|
const arrayBuffer = await response.arrayBuffer();
|
|
244
244
|
await Bun.write('path/to/file', arrayBuffer);
|
|
@@ -252,7 +252,7 @@ await Bun.write('path/to/file', arrayBuffer);
|
|
|
252
252
|
<summary>Blob</summary>
|
|
253
253
|
|
|
254
254
|
```ts
|
|
255
|
-
const response = await client.
|
|
255
|
+
const response = await client.results.getPdf(...);
|
|
256
256
|
|
|
257
257
|
const blob = await response.blob();
|
|
258
258
|
await Bun.write('path/to/file', blob);
|
|
@@ -266,7 +266,7 @@ await Bun.write('path/to/file', blob);
|
|
|
266
266
|
<summary>Bytes (UIntArray8)</summary>
|
|
267
267
|
|
|
268
268
|
```ts
|
|
269
|
-
const response = await client.
|
|
269
|
+
const response = await client.results.getPdf(...);
|
|
270
270
|
|
|
271
271
|
const bytes = await response.bytes();
|
|
272
272
|
await Bun.write('path/to/file', bytes);
|
|
@@ -287,7 +287,7 @@ await Bun.write('path/to/file', bytes);
|
|
|
287
287
|
<summary>ReadableStream (most-efficient)</summary>
|
|
288
288
|
|
|
289
289
|
```ts
|
|
290
|
-
const response = await client.
|
|
290
|
+
const response = await client.results.getPdf(...);
|
|
291
291
|
|
|
292
292
|
const stream = response.stream();
|
|
293
293
|
const file = await Deno.open('path/to/file', { write: true, create: true });
|
|
@@ -302,7 +302,7 @@ await stream.pipeTo(file.writable);
|
|
|
302
302
|
<summary>ArrayBuffer</summary>
|
|
303
303
|
|
|
304
304
|
```ts
|
|
305
|
-
const response = await client.
|
|
305
|
+
const response = await client.results.getPdf(...);
|
|
306
306
|
|
|
307
307
|
const arrayBuffer = await response.arrayBuffer();
|
|
308
308
|
await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
|
|
@@ -316,7 +316,7 @@ await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
|
|
|
316
316
|
<summary>Blob</summary>
|
|
317
317
|
|
|
318
318
|
```ts
|
|
319
|
-
const response = await client.
|
|
319
|
+
const response = await client.results.getPdf(...);
|
|
320
320
|
|
|
321
321
|
const blob = await response.blob();
|
|
322
322
|
const arrayBuffer = await blob.arrayBuffer();
|
|
@@ -331,7 +331,7 @@ await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
|
|
|
331
331
|
<summary>Bytes (UIntArray8)</summary>
|
|
332
332
|
|
|
333
333
|
```ts
|
|
334
|
-
const response = await client.
|
|
334
|
+
const response = await client.results.getPdf(...);
|
|
335
335
|
|
|
336
336
|
const bytes = await response.bytes();
|
|
337
337
|
await Deno.writeFile('path/to/file', bytes);
|
|
@@ -352,7 +352,7 @@ await Deno.writeFile('path/to/file', bytes);
|
|
|
352
352
|
<summary>Blob (most-efficient)</summary>
|
|
353
353
|
|
|
354
354
|
```ts
|
|
355
|
-
const response = await client.
|
|
355
|
+
const response = await client.results.getPdf(...);
|
|
356
356
|
|
|
357
357
|
const blob = await response.blob();
|
|
358
358
|
const url = URL.createObjectURL(blob);
|
|
@@ -373,7 +373,7 @@ URL.revokeObjectURL(url);
|
|
|
373
373
|
<summary>ReadableStream</summary>
|
|
374
374
|
|
|
375
375
|
```ts
|
|
376
|
-
const response = await client.
|
|
376
|
+
const response = await client.results.getPdf(...);
|
|
377
377
|
|
|
378
378
|
const stream = response.stream();
|
|
379
379
|
const reader = stream.getReader();
|
|
@@ -404,7 +404,7 @@ URL.revokeObjectURL(url);
|
|
|
404
404
|
<summary>ArrayBuffer</summary>
|
|
405
405
|
|
|
406
406
|
```ts
|
|
407
|
-
const response = await client.
|
|
407
|
+
const response = await client.results.getPdf(...);
|
|
408
408
|
|
|
409
409
|
const arrayBuffer = await response.arrayBuffer();
|
|
410
410
|
const blob = new Blob([arrayBuffer]);
|
|
@@ -426,7 +426,7 @@ URL.revokeObjectURL(url);
|
|
|
426
426
|
<summary>Bytes (UIntArray8)</summary>
|
|
427
427
|
|
|
428
428
|
```ts
|
|
429
|
-
const response = await client.
|
|
429
|
+
const response = await client.results.getPdf(...);
|
|
430
430
|
|
|
431
431
|
const bytes = await response.bytes();
|
|
432
432
|
const blob = new Blob([bytes]);
|
|
@@ -457,7 +457,7 @@ URL.revokeObjectURL(url);
|
|
|
457
457
|
<summary>ReadableStream</summary>
|
|
458
458
|
|
|
459
459
|
```ts
|
|
460
|
-
const response = await client.
|
|
460
|
+
const response = await client.results.getPdf(...);
|
|
461
461
|
|
|
462
462
|
const stream = response.stream();
|
|
463
463
|
const text = await new Response(stream).text();
|
|
@@ -471,7 +471,7 @@ const text = await new Response(stream).text();
|
|
|
471
471
|
<summary>ArrayBuffer</summary>
|
|
472
472
|
|
|
473
473
|
```ts
|
|
474
|
-
const response = await client.
|
|
474
|
+
const response = await client.results.getPdf(...);
|
|
475
475
|
|
|
476
476
|
const arrayBuffer = await response.arrayBuffer();
|
|
477
477
|
const text = new TextDecoder().decode(arrayBuffer);
|
|
@@ -485,7 +485,7 @@ const text = new TextDecoder().decode(arrayBuffer);
|
|
|
485
485
|
<summary>Blob</summary>
|
|
486
486
|
|
|
487
487
|
```ts
|
|
488
|
-
const response = await client.
|
|
488
|
+
const response = await client.results.getPdf(...);
|
|
489
489
|
|
|
490
490
|
const blob = await response.blob();
|
|
491
491
|
const text = await blob.text();
|
|
@@ -499,7 +499,7 @@ const text = await blob.text();
|
|
|
499
499
|
<summary>Bytes (UIntArray8)</summary>
|
|
500
500
|
|
|
501
501
|
```ts
|
|
502
|
-
const response = await client.
|
|
502
|
+
const response = await client.results.getPdf(...);
|
|
503
503
|
|
|
504
504
|
const bytes = await response.bytes();
|
|
505
505
|
const text = new TextDecoder().decode(bytes);
|
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -47,6 +47,7 @@ function normalizeClientOptions(options) {
|
|
|
47
47
|
"User-Agent": "pulse-ts-sdk/1.0.9",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
|
+
"X-Pulse-Source": "sdk-typescript",
|
|
50
51
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
51
52
|
return Object.assign(Object.assign({}, options), { logging: core.logging.createLogger(options === null || options === void 0 ? void 0 : options.logging), headers });
|
|
52
53
|
}
|
package/dist/cjs/Client.d.ts
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
import * as Pulse from "./api/index.js";
|
|
2
2
|
import { BatchClient } from "./api/resources/batch/client/Client.js";
|
|
3
|
+
import { FormClient } from "./api/resources/form/client/Client.js";
|
|
3
4
|
import { JobsClient } from "./api/resources/jobs/client/Client.js";
|
|
4
5
|
import { LargeResultsClient } from "./api/resources/largeResults/client/Client.js";
|
|
5
6
|
import { PipelineClient } from "./api/resources/pipeline/client/Client.js";
|
|
7
|
+
import { ResultsClient } from "./api/resources/results/client/Client.js";
|
|
6
8
|
import { WebhooksClient } from "./api/resources/webhooks/client/Client.js";
|
|
7
9
|
import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
|
|
8
10
|
import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
|
|
@@ -14,15 +16,19 @@ export declare namespace PulseClient {
|
|
|
14
16
|
}
|
|
15
17
|
export declare class PulseClient {
|
|
16
18
|
protected readonly _options: NormalizedClientOptionsWithAuth<PulseClient.Options>;
|
|
19
|
+
protected _form: FormClient | undefined;
|
|
17
20
|
protected _batch: BatchClient | undefined;
|
|
18
21
|
protected _pipeline: PipelineClient | undefined;
|
|
19
22
|
protected _jobs: JobsClient | undefined;
|
|
23
|
+
protected _results: ResultsClient | undefined;
|
|
20
24
|
protected _largeResults: LargeResultsClient | undefined;
|
|
21
25
|
protected _webhooks: WebhooksClient | undefined;
|
|
22
26
|
constructor(options?: PulseClient.Options);
|
|
27
|
+
get form(): FormClient;
|
|
23
28
|
get batch(): BatchClient;
|
|
24
29
|
get pipeline(): PipelineClient;
|
|
25
30
|
get jobs(): JobsClient;
|
|
31
|
+
get results(): ResultsClient;
|
|
26
32
|
get largeResults(): LargeResultsClient;
|
|
27
33
|
get webhooks(): WebhooksClient;
|
|
28
34
|
/**
|
package/dist/cjs/Client.js
CHANGED
|
@@ -46,10 +46,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
46
46
|
exports.PulseClient = void 0;
|
|
47
47
|
const Pulse = __importStar(require("./api/index.js"));
|
|
48
48
|
const Client_js_1 = require("./api/resources/batch/client/Client.js");
|
|
49
|
-
const Client_js_2 = require("./api/resources/
|
|
50
|
-
const Client_js_3 = require("./api/resources/
|
|
51
|
-
const Client_js_4 = require("./api/resources/
|
|
52
|
-
const Client_js_5 = require("./api/resources/
|
|
49
|
+
const Client_js_2 = require("./api/resources/form/client/Client.js");
|
|
50
|
+
const Client_js_3 = require("./api/resources/jobs/client/Client.js");
|
|
51
|
+
const Client_js_4 = require("./api/resources/largeResults/client/Client.js");
|
|
52
|
+
const Client_js_5 = require("./api/resources/pipeline/client/Client.js");
|
|
53
|
+
const Client_js_6 = require("./api/resources/results/client/Client.js");
|
|
54
|
+
const Client_js_7 = require("./api/resources/webhooks/client/Client.js");
|
|
53
55
|
const BaseClient_js_1 = require("./BaseClient.js");
|
|
54
56
|
const headers_js_1 = require("./core/headers.js");
|
|
55
57
|
const core = __importStar(require("./core/index.js"));
|
|
@@ -61,25 +63,33 @@ class PulseClient {
|
|
|
61
63
|
constructor(options = {}) {
|
|
62
64
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
63
65
|
}
|
|
66
|
+
get form() {
|
|
67
|
+
var _a;
|
|
68
|
+
return ((_a = this._form) !== null && _a !== void 0 ? _a : (this._form = new Client_js_2.FormClient(this._options)));
|
|
69
|
+
}
|
|
64
70
|
get batch() {
|
|
65
71
|
var _a;
|
|
66
72
|
return ((_a = this._batch) !== null && _a !== void 0 ? _a : (this._batch = new Client_js_1.BatchClient(this._options)));
|
|
67
73
|
}
|
|
68
74
|
get pipeline() {
|
|
69
75
|
var _a;
|
|
70
|
-
return ((_a = this._pipeline) !== null && _a !== void 0 ? _a : (this._pipeline = new
|
|
76
|
+
return ((_a = this._pipeline) !== null && _a !== void 0 ? _a : (this._pipeline = new Client_js_5.PipelineClient(this._options)));
|
|
71
77
|
}
|
|
72
78
|
get jobs() {
|
|
73
79
|
var _a;
|
|
74
|
-
return ((_a = this._jobs) !== null && _a !== void 0 ? _a : (this._jobs = new
|
|
80
|
+
return ((_a = this._jobs) !== null && _a !== void 0 ? _a : (this._jobs = new Client_js_3.JobsClient(this._options)));
|
|
81
|
+
}
|
|
82
|
+
get results() {
|
|
83
|
+
var _a;
|
|
84
|
+
return ((_a = this._results) !== null && _a !== void 0 ? _a : (this._results = new Client_js_6.ResultsClient(this._options)));
|
|
75
85
|
}
|
|
76
86
|
get largeResults() {
|
|
77
87
|
var _a;
|
|
78
|
-
return ((_a = this._largeResults) !== null && _a !== void 0 ? _a : (this._largeResults = new
|
|
88
|
+
return ((_a = this._largeResults) !== null && _a !== void 0 ? _a : (this._largeResults = new Client_js_4.LargeResultsClient(this._options)));
|
|
79
89
|
}
|
|
80
90
|
get webhooks() {
|
|
81
91
|
var _a;
|
|
82
|
-
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new
|
|
92
|
+
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_7.WebhooksClient(this._options)));
|
|
83
93
|
}
|
|
84
94
|
/**
|
|
85
95
|
* The primary endpoint for the Pulse API. Parses uploaded documents or remote
|
|
@@ -108,7 +118,7 @@ class PulseClient {
|
|
|
108
118
|
}
|
|
109
119
|
__extract(request, requestOptions) {
|
|
110
120
|
return __awaiter(this, void 0, void 0, function* () {
|
|
111
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
121
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
112
122
|
const _request = yield core.newFormData();
|
|
113
123
|
if (request.file != null) {
|
|
114
124
|
yield _request.appendFile("file", request.file);
|
|
@@ -119,6 +129,9 @@ class PulseClient {
|
|
|
119
129
|
if (request.model != null) {
|
|
120
130
|
_request.append("model", request.model);
|
|
121
131
|
}
|
|
132
|
+
if (request.extractionConfigId != null) {
|
|
133
|
+
_request.append("extractionConfigId", request.extractionConfigId);
|
|
134
|
+
}
|
|
122
135
|
if (request.pages != null) {
|
|
123
136
|
_request.append("pages", request.pages);
|
|
124
137
|
}
|
|
@@ -141,7 +154,7 @@ class PulseClient {
|
|
|
141
154
|
_request.append("structuredOutput", (0, json_js_1.toJson)(request.structuredOutput));
|
|
142
155
|
}
|
|
143
156
|
if (request.schema != null) {
|
|
144
|
-
_request.append("schema",
|
|
157
|
+
_request.append("schema", (0, json_js_1.toJson)(request.schema));
|
|
145
158
|
}
|
|
146
159
|
if (request.schemaPrompt != null) {
|
|
147
160
|
_request.append("schemaPrompt", request.schemaPrompt);
|
|
@@ -181,10 +194,14 @@ class PulseClient {
|
|
|
181
194
|
requestType: "file",
|
|
182
195
|
duplex: _maybeEncodedRequest.duplex,
|
|
183
196
|
body: _maybeEncodedRequest.body,
|
|
184
|
-
timeoutMs: (
|
|
185
|
-
|
|
197
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
198
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
199
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
200
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
201
|
+
: undefined,
|
|
202
|
+
maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
|
|
186
203
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
187
|
-
fetchFn: (
|
|
204
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
188
205
|
logging: this._options.logging,
|
|
189
206
|
});
|
|
190
207
|
if (_response.ok) {
|
|
@@ -232,7 +249,7 @@ class PulseClient {
|
|
|
232
249
|
}
|
|
233
250
|
__extractAsync(request, requestOptions) {
|
|
234
251
|
return __awaiter(this, void 0, void 0, function* () {
|
|
235
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
252
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
236
253
|
const _request = yield core.newFormData();
|
|
237
254
|
if (request.file != null) {
|
|
238
255
|
yield _request.appendFile("file", request.file);
|
|
@@ -243,6 +260,9 @@ class PulseClient {
|
|
|
243
260
|
if (request.model != null) {
|
|
244
261
|
_request.append("model", request.model);
|
|
245
262
|
}
|
|
263
|
+
if (request.extractionConfigId != null) {
|
|
264
|
+
_request.append("extractionConfigId", request.extractionConfigId);
|
|
265
|
+
}
|
|
246
266
|
if (request.pages != null) {
|
|
247
267
|
_request.append("pages", request.pages);
|
|
248
268
|
}
|
|
@@ -265,7 +285,7 @@ class PulseClient {
|
|
|
265
285
|
_request.append("structuredOutput", (0, json_js_1.toJson)(request.structuredOutput));
|
|
266
286
|
}
|
|
267
287
|
if (request.schema != null) {
|
|
268
|
-
_request.append("schema",
|
|
288
|
+
_request.append("schema", (0, json_js_1.toJson)(request.schema));
|
|
269
289
|
}
|
|
270
290
|
if (request.schemaPrompt != null) {
|
|
271
291
|
_request.append("schemaPrompt", request.schemaPrompt);
|
|
@@ -305,10 +325,14 @@ class PulseClient {
|
|
|
305
325
|
requestType: "file",
|
|
306
326
|
duplex: _maybeEncodedRequest.duplex,
|
|
307
327
|
body: _maybeEncodedRequest.body,
|
|
308
|
-
timeoutMs: (
|
|
309
|
-
|
|
328
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
329
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
330
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
331
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
332
|
+
: undefined,
|
|
333
|
+
maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
|
|
310
334
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
311
|
-
fetchFn: (
|
|
335
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
312
336
|
logging: this._options.logging,
|
|
313
337
|
});
|
|
314
338
|
if (_response.ok) {
|
|
@@ -366,7 +390,7 @@ class PulseClient {
|
|
|
366
390
|
}
|
|
367
391
|
__split(request, requestOptions) {
|
|
368
392
|
return __awaiter(this, void 0, void 0, function* () {
|
|
369
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
393
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
370
394
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
371
395
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
372
396
|
const _response = yield core.fetcher({
|
|
@@ -377,10 +401,14 @@ class PulseClient {
|
|
|
377
401
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
378
402
|
requestType: "json",
|
|
379
403
|
body: request,
|
|
380
|
-
timeoutMs: (
|
|
381
|
-
|
|
404
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
405
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
406
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
407
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
408
|
+
: undefined,
|
|
409
|
+
maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
|
|
382
410
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
383
|
-
fetchFn: (
|
|
411
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
384
412
|
logging: this._options.logging,
|
|
385
413
|
});
|
|
386
414
|
if (_response.ok) {
|
|
@@ -454,7 +482,7 @@ class PulseClient {
|
|
|
454
482
|
}
|
|
455
483
|
__schema() {
|
|
456
484
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
457
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
485
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
458
486
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
459
487
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
460
488
|
const _response = yield core.fetcher({
|
|
@@ -465,10 +493,14 @@ class PulseClient {
|
|
|
465
493
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
466
494
|
requestType: "json",
|
|
467
495
|
body: request,
|
|
468
|
-
timeoutMs: (
|
|
469
|
-
|
|
496
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
497
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
498
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
499
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
500
|
+
: undefined,
|
|
501
|
+
maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
|
|
470
502
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
471
|
-
fetchFn: (
|
|
503
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
472
504
|
logging: this._options.logging,
|
|
473
505
|
});
|
|
474
506
|
if (_response.ok) {
|
|
@@ -510,7 +542,7 @@ class PulseClient {
|
|
|
510
542
|
}
|
|
511
543
|
__downloadSchemaExcel(request, requestOptions) {
|
|
512
544
|
return __awaiter(this, void 0, void 0, function* () {
|
|
513
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
545
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
514
546
|
const { schemaId } = request;
|
|
515
547
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
516
548
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -520,10 +552,14 @@ class PulseClient {
|
|
|
520
552
|
headers: _headers,
|
|
521
553
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
522
554
|
responseType: "binary-response",
|
|
523
|
-
timeoutMs: (
|
|
524
|
-
|
|
555
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
556
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
557
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
558
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
559
|
+
: undefined,
|
|
560
|
+
maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
|
|
525
561
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
526
|
-
fetchFn: (
|
|
562
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
527
563
|
logging: this._options.logging,
|
|
528
564
|
});
|
|
529
565
|
if (_response.ok) {
|
|
@@ -580,7 +616,7 @@ class PulseClient {
|
|
|
580
616
|
}
|
|
581
617
|
__tables(request, requestOptions) {
|
|
582
618
|
return __awaiter(this, void 0, void 0, function* () {
|
|
583
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
619
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
584
620
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
585
621
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
586
622
|
const _response = yield core.fetcher({
|
|
@@ -591,10 +627,14 @@ class PulseClient {
|
|
|
591
627
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
592
628
|
requestType: "json",
|
|
593
629
|
body: request,
|
|
594
|
-
timeoutMs: (
|
|
595
|
-
|
|
630
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
631
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
632
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
633
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
634
|
+
: undefined,
|
|
635
|
+
maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
|
|
596
636
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
597
|
-
fetchFn: (
|
|
637
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
598
638
|
logging: this._options.logging,
|
|
599
639
|
});
|
|
600
640
|
if (_response.ok) {
|
|
@@ -8,8 +8,10 @@ export interface ExtractAsyncRequest {
|
|
|
8
8
|
file?: core.file.Uploadable | undefined;
|
|
9
9
|
/** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */
|
|
10
10
|
fileUrl?: string;
|
|
11
|
-
/** Extraction model to use. When set to `
|
|
11
|
+
/** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
|
|
12
12
|
model?: ExtractAsyncRequest.Model;
|
|
13
|
+
/** UUID of a saved extraction configuration (a "preset"). When provided, the server loads the saved configuration and applies its options on top of any inline parameters supplied in this request. Inline parameters always take precedence over preset values for the same field. Saved configs are managed via the platform UI or the `input_extractions` admin endpoints. */
|
|
14
|
+
extractionConfigId?: string;
|
|
13
15
|
/** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
|
|
14
16
|
pages?: string;
|
|
15
17
|
/** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */
|
|
@@ -46,9 +48,10 @@ export interface ExtractAsyncRequest {
|
|
|
46
48
|
thinking?: boolean;
|
|
47
49
|
}
|
|
48
50
|
export declare namespace ExtractAsyncRequest {
|
|
49
|
-
/** Extraction model to use. When set to `
|
|
51
|
+
/** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
|
|
50
52
|
const Model: {
|
|
51
|
-
readonly
|
|
53
|
+
readonly Default: "default";
|
|
54
|
+
readonly PulseUltra2: "pulse-ultra-2";
|
|
52
55
|
};
|
|
53
56
|
type Model = (typeof Model)[keyof typeof Model];
|
|
54
57
|
/**
|
|
@@ -4,9 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.ExtractAsyncRequest = void 0;
|
|
5
5
|
var ExtractAsyncRequest;
|
|
6
6
|
(function (ExtractAsyncRequest) {
|
|
7
|
-
/** Extraction model to use. When set to `
|
|
7
|
+
/** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
|
|
8
8
|
ExtractAsyncRequest.Model = {
|
|
9
|
-
|
|
9
|
+
Default: "default",
|
|
10
|
+
PulseUltra2: "pulse-ultra-2",
|
|
10
11
|
};
|
|
11
12
|
let Extensions;
|
|
12
13
|
(function (Extensions) {
|
|
@@ -8,8 +8,10 @@ export interface ExtractRequest {
|
|
|
8
8
|
file?: core.file.Uploadable | undefined;
|
|
9
9
|
/** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */
|
|
10
10
|
fileUrl?: string;
|
|
11
|
-
/** Extraction model to use. When set to `
|
|
11
|
+
/** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
|
|
12
12
|
model?: ExtractRequest.Model;
|
|
13
|
+
/** UUID of a saved extraction configuration (a "preset"). When provided, the server loads the saved configuration and applies its options on top of any inline parameters supplied in this request. Inline parameters always take precedence over preset values for the same field. Saved configs are managed via the platform UI or the `input_extractions` admin endpoints. */
|
|
14
|
+
extractionConfigId?: string;
|
|
13
15
|
/** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
|
|
14
16
|
pages?: string;
|
|
15
17
|
/** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */
|
|
@@ -46,9 +48,10 @@ export interface ExtractRequest {
|
|
|
46
48
|
thinking?: boolean;
|
|
47
49
|
}
|
|
48
50
|
export declare namespace ExtractRequest {
|
|
49
|
-
/** Extraction model to use. When set to `
|
|
51
|
+
/** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
|
|
50
52
|
const Model: {
|
|
51
|
-
readonly
|
|
53
|
+
readonly Default: "default";
|
|
54
|
+
readonly PulseUltra2: "pulse-ultra-2";
|
|
52
55
|
};
|
|
53
56
|
type Model = (typeof Model)[keyof typeof Model];
|
|
54
57
|
/**
|
|
@@ -4,9 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.ExtractRequest = void 0;
|
|
5
5
|
var ExtractRequest;
|
|
6
6
|
(function (ExtractRequest) {
|
|
7
|
-
/** Extraction model to use. When set to `
|
|
7
|
+
/** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
|
|
8
8
|
ExtractRequest.Model = {
|
|
9
|
-
|
|
9
|
+
Default: "default",
|
|
10
|
+
PulseUltra2: "pulse-ultra-2",
|
|
10
11
|
};
|
|
11
12
|
let Extensions;
|
|
12
13
|
(function (Extensions) {
|