pulse-ts-sdk 1.0.7 → 1.0.9
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/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +6 -0
- package/dist/cjs/Client.js +18 -2
- package/dist/cjs/api/client/requests/ExtractAsyncRequest.d.ts +13 -2
- package/dist/cjs/api/client/requests/ExtractRequest.d.ts +13 -2
- package/dist/cjs/api/errors/GoneError.d.ts +6 -0
- package/dist/cjs/api/errors/GoneError.js +54 -0
- package/dist/cjs/api/errors/index.d.ts +1 -0
- package/dist/cjs/api/errors/index.js +1 -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/largeResults/client/Client.d.ts +35 -0
- package/dist/cjs/api/resources/largeResults/client/Client.js +121 -0
- package/dist/cjs/api/resources/largeResults/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/largeResults/client/index.js +17 -0
- package/dist/cjs/api/resources/largeResults/client/requests/GetLargeResultLargeResultsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/largeResults/client/requests/GetLargeResultLargeResultsRequest.js +3 -0
- package/dist/cjs/api/resources/largeResults/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/largeResults/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/largeResults/index.d.ts +1 -0
- package/dist/cjs/api/resources/largeResults/index.js +17 -0
- package/dist/cjs/api/resources/pipeline/client/Client.d.ts +55 -0
- package/dist/cjs/api/resources/pipeline/client/Client.js +145 -0
- package/dist/cjs/api/resources/pipeline/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/pipeline/client/index.js +17 -0
- package/dist/cjs/api/resources/pipeline/client/requests/PipelineExecuteInput.d.ts +17 -0
- package/dist/cjs/api/resources/pipeline/client/requests/PipelineExecuteInput.js +3 -0
- package/dist/cjs/api/resources/pipeline/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/pipeline/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/pipeline/index.d.ts +1 -0
- package/dist/cjs/api/resources/pipeline/index.js +17 -0
- package/dist/cjs/api/types/AsyncSubmissionResponse.d.ts +2 -0
- package/dist/cjs/api/types/BatchFileUpload.d.ts +6 -0
- package/dist/cjs/api/types/BatchFileUpload.js +3 -0
- package/dist/cjs/api/types/BatchInputSource.d.ts +4 -3
- package/dist/cjs/api/types/ExtractInput.d.ts +13 -2
- package/dist/cjs/api/types/ExtractLargeResultResponse.d.ts +25 -0
- package/dist/cjs/api/types/ExtractLargeResultResponse.js +3 -0
- package/dist/cjs/api/types/ExtractOptions.d.ts +13 -2
- package/dist/cjs/api/types/ExtractResponse.d.ts +3 -3
- package/dist/cjs/api/types/ExtractResultCore.d.ts +112 -0
- package/dist/cjs/api/types/ExtractResultCore.js +3 -0
- package/dist/cjs/api/types/GoneErrorBody.d.ts +9 -0
- package/dist/cjs/api/types/GoneErrorBody.js +3 -0
- package/dist/cjs/api/types/JobStatusResponse.d.ts +1 -1
- package/dist/cjs/api/types/PipelineBatchExtractResult.d.ts +13 -0
- package/dist/cjs/api/types/PipelineBatchExtractResult.js +3 -0
- package/dist/cjs/api/types/PipelineExecuteMultipartInput.d.ts +13 -0
- package/dist/cjs/api/types/PipelineExecuteMultipartInput.js +3 -0
- package/dist/cjs/api/types/PipelineExecuteResponse.d.ts +21 -0
- package/dist/cjs/api/types/PipelineExecuteResponse.js +11 -0
- package/dist/cjs/api/types/PipelineExtractResult.d.ts +118 -0
- package/dist/cjs/api/types/PipelineExtractResult.js +3 -0
- package/dist/cjs/api/types/PipelineResults.d.ts +14 -0
- package/dist/cjs/api/types/PipelineResults.js +3 -0
- package/dist/cjs/api/types/PipelineSchemaResult.d.ts +14 -0
- package/dist/cjs/api/types/PipelineSchemaResult.js +3 -0
- package/dist/cjs/api/types/PipelineSplitResult.d.ts +18 -0
- package/dist/cjs/api/types/PipelineSplitResult.js +3 -0
- package/dist/cjs/api/types/PipelineStepBatchExtractConfig.d.ts +146 -0
- package/dist/cjs/api/types/PipelineStepBatchExtractConfig.js +26 -0
- package/dist/cjs/api/types/PipelineSteps.d.ts +14 -0
- package/dist/cjs/api/types/PipelineSteps.js +3 -0
- package/dist/cjs/api/types/SingleSchemaResponse.d.ts +2 -0
- package/dist/cjs/api/types/SplitResponse.d.ts +1 -6
- package/dist/cjs/api/types/SplitResultCore.d.ts +12 -0
- package/dist/cjs/api/types/SplitResultCore.js +3 -0
- package/dist/cjs/api/types/SplitSchemaResponse.d.ts +2 -0
- package/dist/cjs/api/types/TablesConfig.d.ts +2 -0
- package/dist/cjs/api/types/TablesResponse.d.ts +2 -0
- package/dist/cjs/api/types/index.d.ts +14 -0
- package/dist/cjs/api/types/index.js +14 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +6 -0
- package/dist/esm/Client.mjs +16 -0
- package/dist/esm/api/client/requests/ExtractAsyncRequest.d.mts +13 -2
- package/dist/esm/api/client/requests/ExtractRequest.d.mts +13 -2
- package/dist/esm/api/errors/GoneError.d.mts +6 -0
- package/dist/esm/api/errors/GoneError.mjs +17 -0
- package/dist/esm/api/errors/index.d.mts +1 -0
- package/dist/esm/api/errors/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/largeResults/client/Client.d.mts +35 -0
- package/dist/esm/api/resources/largeResults/client/Client.mjs +84 -0
- package/dist/esm/api/resources/largeResults/client/index.d.mts +1 -0
- package/dist/esm/api/resources/largeResults/client/index.mjs +1 -0
- package/dist/esm/api/resources/largeResults/client/requests/GetLargeResultLargeResultsRequest.d.mts +10 -0
- package/dist/esm/api/resources/largeResults/client/requests/GetLargeResultLargeResultsRequest.mjs +2 -0
- package/dist/esm/api/resources/largeResults/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/largeResults/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/largeResults/index.d.mts +1 -0
- package/dist/esm/api/resources/largeResults/index.mjs +1 -0
- package/dist/esm/api/resources/pipeline/client/Client.d.mts +55 -0
- package/dist/esm/api/resources/pipeline/client/Client.mjs +108 -0
- package/dist/esm/api/resources/pipeline/client/index.d.mts +1 -0
- package/dist/esm/api/resources/pipeline/client/index.mjs +1 -0
- package/dist/esm/api/resources/pipeline/client/requests/PipelineExecuteInput.d.mts +17 -0
- package/dist/esm/api/resources/pipeline/client/requests/PipelineExecuteInput.mjs +2 -0
- package/dist/esm/api/resources/pipeline/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/pipeline/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/pipeline/index.d.mts +1 -0
- package/dist/esm/api/resources/pipeline/index.mjs +1 -0
- package/dist/esm/api/types/AsyncSubmissionResponse.d.mts +2 -0
- package/dist/esm/api/types/BatchFileUpload.d.mts +6 -0
- package/dist/esm/api/types/BatchFileUpload.mjs +2 -0
- package/dist/esm/api/types/BatchInputSource.d.mts +4 -3
- package/dist/esm/api/types/ExtractInput.d.mts +13 -2
- package/dist/esm/api/types/ExtractLargeResultResponse.d.mts +25 -0
- package/dist/esm/api/types/ExtractLargeResultResponse.mjs +2 -0
- package/dist/esm/api/types/ExtractOptions.d.mts +13 -2
- package/dist/esm/api/types/ExtractResponse.d.mts +3 -3
- package/dist/esm/api/types/ExtractResultCore.d.mts +112 -0
- package/dist/esm/api/types/ExtractResultCore.mjs +2 -0
- package/dist/esm/api/types/GoneErrorBody.d.mts +9 -0
- package/dist/esm/api/types/GoneErrorBody.mjs +2 -0
- package/dist/esm/api/types/JobStatusResponse.d.mts +1 -1
- package/dist/esm/api/types/PipelineBatchExtractResult.d.mts +13 -0
- package/dist/esm/api/types/PipelineBatchExtractResult.mjs +2 -0
- package/dist/esm/api/types/PipelineExecuteMultipartInput.d.mts +13 -0
- package/dist/esm/api/types/PipelineExecuteMultipartInput.mjs +2 -0
- package/dist/esm/api/types/PipelineExecuteResponse.d.mts +21 -0
- package/dist/esm/api/types/PipelineExecuteResponse.mjs +8 -0
- package/dist/esm/api/types/PipelineExtractResult.d.mts +118 -0
- package/dist/esm/api/types/PipelineExtractResult.mjs +2 -0
- package/dist/esm/api/types/PipelineResults.d.mts +14 -0
- package/dist/esm/api/types/PipelineResults.mjs +2 -0
- package/dist/esm/api/types/PipelineSchemaResult.d.mts +14 -0
- package/dist/esm/api/types/PipelineSchemaResult.mjs +2 -0
- package/dist/esm/api/types/PipelineSplitResult.d.mts +18 -0
- package/dist/esm/api/types/PipelineSplitResult.mjs +2 -0
- package/dist/esm/api/types/PipelineStepBatchExtractConfig.d.mts +146 -0
- package/dist/esm/api/types/PipelineStepBatchExtractConfig.mjs +23 -0
- package/dist/esm/api/types/PipelineSteps.d.mts +14 -0
- package/dist/esm/api/types/PipelineSteps.mjs +2 -0
- package/dist/esm/api/types/SingleSchemaResponse.d.mts +2 -0
- package/dist/esm/api/types/SplitResponse.d.mts +1 -6
- package/dist/esm/api/types/SplitResultCore.d.mts +12 -0
- package/dist/esm/api/types/SplitResultCore.mjs +2 -0
- package/dist/esm/api/types/SplitSchemaResponse.d.mts +2 -0
- package/dist/esm/api/types/TablesConfig.d.mts +2 -0
- package/dist/esm/api/types/TablesResponse.d.mts +2 -0
- package/dist/esm/api/types/index.d.mts +14 -0
- package/dist/esm/api/types/index.mjs +14 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +161 -0
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Result from the extract step in a pipeline. Inherits all core extraction fields and adds pipeline-specific timing.
|
|
3
|
+
*/
|
|
4
|
+
export interface PipelineExtractResult {
|
|
5
|
+
/** Primary markdown content extracted from the document. Always present in the new format. */
|
|
6
|
+
markdown?: string;
|
|
7
|
+
/** Output from enabled extensions. Each key corresponds to an extension that was enabled in the request under `extensions.*`. Only keys for enabled extensions are present. */
|
|
8
|
+
extensions?: PipelineExtractResult.Extensions;
|
|
9
|
+
/** Positional bounding-box data for text, titles, headers, footers, images, and tables. Used by the frontend for annotation overlays. */
|
|
10
|
+
bounding_boxes?: Record<string, unknown>;
|
|
11
|
+
/** Persisted extraction ID. Present when storage is enabled (default). Use this ID with `/split` and `/schema` endpoints. */
|
|
12
|
+
extraction_id?: string;
|
|
13
|
+
/** URL to view the extraction on the Pulse platform. Present when storage is enabled. */
|
|
14
|
+
extraction_url?: string;
|
|
15
|
+
/** Number of pages processed. */
|
|
16
|
+
page_count?: number;
|
|
17
|
+
/** Billing tier and usage information. */
|
|
18
|
+
plan_info?: PipelineExtractResult.PlanInfo;
|
|
19
|
+
/** Non-fatal warnings generated during extraction. Includes deprecation notices when legacy input parameters are used, as well as processing warnings (e.g. word-level bounding box limitations). */
|
|
20
|
+
warnings?: string[];
|
|
21
|
+
/** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
|
|
22
|
+
credits_used?: number | null;
|
|
23
|
+
/** Number of pages processed. Convenience alias for `page_count`. */
|
|
24
|
+
pages?: number;
|
|
25
|
+
/** Step execution time in seconds. */
|
|
26
|
+
latency?: number;
|
|
27
|
+
/** Accepts any additional properties */
|
|
28
|
+
[key: string]: any;
|
|
29
|
+
}
|
|
30
|
+
export declare namespace PipelineExtractResult {
|
|
31
|
+
/**
|
|
32
|
+
* Output from enabled extensions. Each key corresponds to an extension that was enabled in the request under `extensions.*`. Only keys for enabled extensions are present.
|
|
33
|
+
*/
|
|
34
|
+
interface Extensions {
|
|
35
|
+
/** Chunk results by strategy. Present when `extensions.chunking` was provided in the request. */
|
|
36
|
+
chunking?: Extensions.Chunking;
|
|
37
|
+
/** List of detected footnotes with their in-text references. Present when `extensions.footnoteReferences` was enabled. Each item links a footnote paragraph to the body-text paragraphs that reference it, using bounding-box text IDs. */
|
|
38
|
+
footnoteReferences?: Extensions.FootnoteReferences.Item[];
|
|
39
|
+
/** Alternate output formats. Each key corresponds to an enabled alt output. */
|
|
40
|
+
altOutputs?: Extensions.AltOutputs;
|
|
41
|
+
}
|
|
42
|
+
namespace Extensions {
|
|
43
|
+
/**
|
|
44
|
+
* Chunk results by strategy. Present when `extensions.chunking` was provided in the request.
|
|
45
|
+
*/
|
|
46
|
+
interface Chunking {
|
|
47
|
+
/** Semantically-segmented chunks. */
|
|
48
|
+
semantic?: string[];
|
|
49
|
+
/** Chunks split by document headers/headings. */
|
|
50
|
+
header?: string[];
|
|
51
|
+
/** One chunk per page. */
|
|
52
|
+
page?: string[];
|
|
53
|
+
/** Recursively-split chunks respecting size limits. */
|
|
54
|
+
recursive?: string[];
|
|
55
|
+
}
|
|
56
|
+
type FootnoteReferences = FootnoteReferences.Item[];
|
|
57
|
+
namespace FootnoteReferences {
|
|
58
|
+
interface Item {
|
|
59
|
+
/** The footnote marker symbol (e.g. "*", "†", "1", "#"). */
|
|
60
|
+
symbol?: string;
|
|
61
|
+
/** The bounding-box text ID (e.g. "txt-15") of the footnote explanation paragraph. */
|
|
62
|
+
footnoteTextId?: string;
|
|
63
|
+
/** Bounding-box text IDs of body-text paragraphs that contain a reference to this footnote marker. */
|
|
64
|
+
referenceTextIds?: string[];
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Alternate output formats. Each key corresponds to an enabled alt output.
|
|
69
|
+
*/
|
|
70
|
+
interface AltOutputs {
|
|
71
|
+
/** Word-level bounding box data. Present when `extensions.altOutputs.wlbb` was enabled and input is a PDF. */
|
|
72
|
+
wlbb?: AltOutputs.Wlbb;
|
|
73
|
+
/** HTML representation of the document. Present when `extensions.altOutputs.returnHtml` was enabled. */
|
|
74
|
+
html?: string;
|
|
75
|
+
/** XML representation of the document. Present when `extensions.altOutputs.returnXml` was enabled. (WIP) */
|
|
76
|
+
xml?: string;
|
|
77
|
+
}
|
|
78
|
+
namespace AltOutputs {
|
|
79
|
+
/**
|
|
80
|
+
* Word-level bounding box data. Present when `extensions.altOutputs.wlbb` was enabled and input is a PDF.
|
|
81
|
+
*/
|
|
82
|
+
interface Wlbb {
|
|
83
|
+
/** List of detected words with their positions. */
|
|
84
|
+
words?: Wlbb.Words.Item[];
|
|
85
|
+
/** Error message if word-level extraction failed. */
|
|
86
|
+
error?: string;
|
|
87
|
+
}
|
|
88
|
+
namespace Wlbb {
|
|
89
|
+
type Words = Words.Item[];
|
|
90
|
+
namespace Words {
|
|
91
|
+
interface Item {
|
|
92
|
+
/** Unique identifier for the word (e.g. "w-1", "w-2", …). */
|
|
93
|
+
id?: string;
|
|
94
|
+
/** The recognised word text. */
|
|
95
|
+
text?: string;
|
|
96
|
+
/** 1-indexed page number in the original document. */
|
|
97
|
+
page_number?: number;
|
|
98
|
+
/** Flat 4-corner polygon: [x1,y1, x2,y2, x3,y3, x4,y4]. All coordinates normalised to 0–1 range. */
|
|
99
|
+
bounding_box?: number[];
|
|
100
|
+
/** Recognition confidence score (0–1). */
|
|
101
|
+
average_word_confidence?: number;
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Billing tier and usage information.
|
|
109
|
+
*/
|
|
110
|
+
interface PlanInfo {
|
|
111
|
+
/** Current plan tier name. */
|
|
112
|
+
tier?: string;
|
|
113
|
+
/** Cumulative pages used after this extraction. */
|
|
114
|
+
pages_used?: number;
|
|
115
|
+
/** Human-readable plan note. */
|
|
116
|
+
note?: string;
|
|
117
|
+
}
|
|
118
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type * as Pulse from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Results from each pipeline step, keyed by step name. Only steps that were executed are present.
|
|
4
|
+
*/
|
|
5
|
+
export interface PipelineResults {
|
|
6
|
+
/** Extract step result. */
|
|
7
|
+
extract?: Pulse.PipelineExtractResult;
|
|
8
|
+
/** Batch extract step result. */
|
|
9
|
+
batch_extract?: Pulse.PipelineBatchExtractResult;
|
|
10
|
+
/** Schema step result. */
|
|
11
|
+
schema?: Pulse.PipelineSchemaResult;
|
|
12
|
+
/** Split step result. */
|
|
13
|
+
split?: Pulse.PipelineSplitResult;
|
|
14
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type * as Pulse from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Result from the schema step in a pipeline.
|
|
4
|
+
*/
|
|
5
|
+
export interface PipelineSchemaResult {
|
|
6
|
+
/** Persisted schema version ID. */
|
|
7
|
+
schema_id?: string;
|
|
8
|
+
/** Extracted values and citations. */
|
|
9
|
+
schema_output?: Pulse.StructuredOutputResult;
|
|
10
|
+
/** Step execution time in seconds. */
|
|
11
|
+
latency?: number;
|
|
12
|
+
/** Accepts any additional properties */
|
|
13
|
+
[key: string]: any;
|
|
14
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type * as Pulse from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Result from the split step in a pipeline. Inherits all core split fields and adds pipeline-specific timing and input echo.
|
|
4
|
+
*/
|
|
5
|
+
export interface PipelineSplitResult {
|
|
6
|
+
/** Unique identifier for this split result. Use this ID with the `/schema` endpoint (split mode) to apply schemas to specific page groups. */
|
|
7
|
+
split_id?: string;
|
|
8
|
+
/** Page assignments per topic. */
|
|
9
|
+
split_output?: Pulse.SplitOutput;
|
|
10
|
+
/** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
|
|
11
|
+
credits_used?: number | null;
|
|
12
|
+
/** Echo of the topic definitions used. */
|
|
13
|
+
split_input?: Pulse.TopicDefinition[];
|
|
14
|
+
/** Step execution time in seconds. */
|
|
15
|
+
latency?: number;
|
|
16
|
+
/** Accepts any additional properties */
|
|
17
|
+
[key: string]: any;
|
|
18
|
+
}
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import type * as Pulse from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Configuration for the batch_extract step. Same extract options as `POST /extract` (applied to every file) plus file inputs and a `workers` field for parallelism. Provide files via `file_urls` (URL list) or `files` (base64 inline uploads).
|
|
4
|
+
*/
|
|
5
|
+
export interface PipelineStepBatchExtractConfig {
|
|
6
|
+
/** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
|
|
7
|
+
model?: PipelineStepBatchExtractConfig.Model;
|
|
8
|
+
/** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
|
|
9
|
+
pages?: string;
|
|
10
|
+
/** 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. */
|
|
11
|
+
figureProcessing?: PipelineStepBatchExtractConfig.FigureProcessing;
|
|
12
|
+
/** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
|
|
13
|
+
extensions?: PipelineStepBatchExtractConfig.Extensions;
|
|
14
|
+
/** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names. */
|
|
15
|
+
spreadsheet?: PipelineStepBatchExtractConfig.Spreadsheet;
|
|
16
|
+
/** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
|
|
17
|
+
storage?: PipelineStepBatchExtractConfig.Storage;
|
|
18
|
+
/** If true, returns immediately with a job_id for polling via GET /job/{jobId}. Otherwise processes synchronously. */
|
|
19
|
+
async?: boolean;
|
|
20
|
+
/** **⚠️ DEPRECATED** — Use the `/schema` endpoint after extraction instead. Pass the `extraction_id` from the extract response to `/schema` with your `schema_config`. This parameter still works for backward compatibility but will be removed in a future version. */
|
|
21
|
+
structuredOutput?: PipelineStepBatchExtractConfig.StructuredOutput;
|
|
22
|
+
/** (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation. */
|
|
23
|
+
schema?: PipelineStepBatchExtractConfig.Schema;
|
|
24
|
+
/** (Deprecated) Natural language prompt for schema-guided extraction. Use structuredOutput.schemaPrompt instead. */
|
|
25
|
+
schemaPrompt?: string;
|
|
26
|
+
/** (Deprecated) Custom instructions that augment the default extraction behaviour. Use `figureProcessing` or `extensions` instead. */
|
|
27
|
+
customPrompt?: string;
|
|
28
|
+
/** **⚠️ DEPRECATED** — Use `extensions.chunking.chunkTypes` instead. Comma-separated list of chunking strategies to apply (for example `semantic,header,page,recursive`). Still accepted for backward compatibility. */
|
|
29
|
+
chunking?: string;
|
|
30
|
+
/** **⚠️ DEPRECATED** — Use `extensions.chunking.chunkSize` instead. Override for maximum characters per chunk when chunking is enabled. */
|
|
31
|
+
chunkSize?: number;
|
|
32
|
+
/** **⚠️ DEPRECATED** — Toggle to enable figure extraction in results. */
|
|
33
|
+
extractFigure?: boolean;
|
|
34
|
+
/** **⚠️ DEPRECATED** — Use `figureProcessing.description` instead. Toggle to generate descriptive captions for extracted figures. */
|
|
35
|
+
figureDescription?: boolean;
|
|
36
|
+
/** **⚠️ DEPRECATED** — Use `figureProcessing.showImages` instead. Embed base64-encoded images inline in figure tags in the output. Increases response size. */
|
|
37
|
+
showImages?: boolean;
|
|
38
|
+
/** **⚠️ DEPRECATED** — Use `extensions.altOutputs.returnHtml` instead. Whether to include HTML representation alongside markdown in the response. */
|
|
39
|
+
returnHtml?: boolean;
|
|
40
|
+
/** (Deprecated) Enables expanded rationale output for debugging. */
|
|
41
|
+
thinking?: boolean;
|
|
42
|
+
/** List of document URLs to process in parallel. */
|
|
43
|
+
file_urls?: string[];
|
|
44
|
+
/** Inline file uploads. Each entry contains a filename and base64-encoded file content. Use instead of `file_urls` when you have local files. */
|
|
45
|
+
files?: Pulse.BatchFileUpload[];
|
|
46
|
+
/** Number of parallel workers. */
|
|
47
|
+
workers?: number;
|
|
48
|
+
}
|
|
49
|
+
export declare namespace PipelineStepBatchExtractConfig {
|
|
50
|
+
/** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
|
|
51
|
+
const Model: {
|
|
52
|
+
readonly EnterprisePreview: "enterprise-preview";
|
|
53
|
+
};
|
|
54
|
+
type Model = (typeof Model)[keyof typeof Model];
|
|
55
|
+
/**
|
|
56
|
+
* 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.
|
|
57
|
+
*/
|
|
58
|
+
interface FigureProcessing {
|
|
59
|
+
/** Generate descriptive captions for extracted figures. */
|
|
60
|
+
description?: boolean;
|
|
61
|
+
/** Embed base64-encoded images inline in figure tags in the output. Increases response size. */
|
|
62
|
+
showImages?: boolean;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`.
|
|
66
|
+
*/
|
|
67
|
+
interface Extensions {
|
|
68
|
+
/** Link footnote markers to their corresponding footnote text. */
|
|
69
|
+
footnoteReferences?: boolean;
|
|
70
|
+
/** Chunking configuration. When provided, the document is split into chunks using the specified strategies. Results appear in `response.extensions.chunking`. */
|
|
71
|
+
chunking?: Extensions.Chunking;
|
|
72
|
+
/** Alternate output format options. Each enabled format produces a corresponding field under `response.extensions.altOutputs`. */
|
|
73
|
+
altOutputs?: Extensions.AltOutputs;
|
|
74
|
+
}
|
|
75
|
+
namespace Extensions {
|
|
76
|
+
/**
|
|
77
|
+
* Chunking configuration. When provided, the document is split into chunks using the specified strategies. Results appear in `response.extensions.chunking`.
|
|
78
|
+
*/
|
|
79
|
+
interface Chunking {
|
|
80
|
+
/** List of chunking strategies to apply (e.g. `["semantic", "header", "page", "recursive"]`). */
|
|
81
|
+
chunkTypes?: Chunking.ChunkTypes.Item[];
|
|
82
|
+
/** Maximum characters per chunk. */
|
|
83
|
+
chunkSize?: number;
|
|
84
|
+
}
|
|
85
|
+
namespace Chunking {
|
|
86
|
+
type ChunkTypes = ChunkTypes.Item[];
|
|
87
|
+
namespace ChunkTypes {
|
|
88
|
+
const Item: {
|
|
89
|
+
readonly Semantic: "semantic";
|
|
90
|
+
readonly Header: "header";
|
|
91
|
+
readonly Page: "page";
|
|
92
|
+
readonly Recursive: "recursive";
|
|
93
|
+
};
|
|
94
|
+
type Item = (typeof Item)[keyof typeof Item];
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Alternate output format options. Each enabled format produces a corresponding field under `response.extensions.altOutputs`.
|
|
99
|
+
*/
|
|
100
|
+
interface AltOutputs {
|
|
101
|
+
/** Enable word-level bounding boxes. Runs an additional OCR model to derive bounding boxes for each word. Only applies to PDFs. Results in `response.extensions.altOutputs.wlbb`. */
|
|
102
|
+
wlbb?: boolean;
|
|
103
|
+
/** Include an HTML representation of the document. When enabled, `response.markdown` is still present and the HTML is available at `response.extensions.altOutputs.html`. */
|
|
104
|
+
returnHtml?: boolean;
|
|
105
|
+
/** Include an XML representation of the document. Results in `response.extensions.altOutputs.xml`. (Work in progress.) */
|
|
106
|
+
returnXml?: boolean;
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names.
|
|
111
|
+
*/
|
|
112
|
+
interface Spreadsheet {
|
|
113
|
+
/** Include rows that are hidden in the Excel workbook. */
|
|
114
|
+
includeHiddenRows?: boolean;
|
|
115
|
+
/** Include columns that are hidden in the Excel workbook. */
|
|
116
|
+
includeHiddenCols?: boolean;
|
|
117
|
+
/** Include sheets that are hidden in the Excel workbook. */
|
|
118
|
+
includeHiddenSheets?: boolean;
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
|
|
122
|
+
*/
|
|
123
|
+
interface Storage {
|
|
124
|
+
/** Whether to persist extraction artifacts. Set to false for temporary extractions with no storage or database record. */
|
|
125
|
+
enabled?: boolean;
|
|
126
|
+
/** Target folder name to save the extraction to. Creates the folder if it doesn't exist. */
|
|
127
|
+
folderName?: string;
|
|
128
|
+
/** Target folder ID to save the extraction to. Takes precedence over folderName if both are provided. */
|
|
129
|
+
folderId?: string;
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* **⚠️ DEPRECATED** — Use the `/schema` endpoint after extraction instead. Pass the `extraction_id` from the extract response to `/schema` with your `schema_config`. This parameter still works for backward compatibility but will be removed in a future version.
|
|
133
|
+
*/
|
|
134
|
+
interface StructuredOutput {
|
|
135
|
+
/** JSON schema describing the structured data to extract. */
|
|
136
|
+
schema?: Record<string, unknown>;
|
|
137
|
+
/** Natural language prompt with additional extraction instructions. */
|
|
138
|
+
schemaPrompt?: string;
|
|
139
|
+
/** Use higher quality model for better results. When true, uses a more capable model at the cost of higher latency. */
|
|
140
|
+
effort?: boolean;
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation.
|
|
144
|
+
*/
|
|
145
|
+
type Schema = Record<string, unknown> | string;
|
|
146
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.PipelineStepBatchExtractConfig = void 0;
|
|
5
|
+
var PipelineStepBatchExtractConfig;
|
|
6
|
+
(function (PipelineStepBatchExtractConfig) {
|
|
7
|
+
/** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
|
|
8
|
+
PipelineStepBatchExtractConfig.Model = {
|
|
9
|
+
EnterprisePreview: "enterprise-preview",
|
|
10
|
+
};
|
|
11
|
+
let Extensions;
|
|
12
|
+
(function (Extensions) {
|
|
13
|
+
let Chunking;
|
|
14
|
+
(function (Chunking) {
|
|
15
|
+
let ChunkTypes;
|
|
16
|
+
(function (ChunkTypes) {
|
|
17
|
+
ChunkTypes.Item = {
|
|
18
|
+
Semantic: "semantic",
|
|
19
|
+
Header: "header",
|
|
20
|
+
Page: "page",
|
|
21
|
+
Recursive: "recursive",
|
|
22
|
+
};
|
|
23
|
+
})(ChunkTypes = Chunking.ChunkTypes || (Chunking.ChunkTypes = {}));
|
|
24
|
+
})(Chunking = Extensions.Chunking || (Extensions.Chunking = {}));
|
|
25
|
+
})(Extensions = PipelineStepBatchExtractConfig.Extensions || (PipelineStepBatchExtractConfig.Extensions = {}));
|
|
26
|
+
})(PipelineStepBatchExtractConfig || (exports.PipelineStepBatchExtractConfig = PipelineStepBatchExtractConfig = {}));
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type * as Pulse from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Ordered step definitions. Key order determines execution order. Use `extract` for single-file or `batch_extract` for multi-file pipelines — they are mutually exclusive. Each step accepts the same configuration as its standalone endpoint.
|
|
4
|
+
*/
|
|
5
|
+
export interface PipelineSteps {
|
|
6
|
+
/** Single-document extraction step. Same options as `POST /extract`. */
|
|
7
|
+
extract?: Pulse.ExtractOptions;
|
|
8
|
+
/** Multi-document parallel extraction step. Provide `file_urls` at the top level and optional `workers` here. */
|
|
9
|
+
batch_extract?: Pulse.PipelineStepBatchExtractConfig;
|
|
10
|
+
/** Structured data extraction step. Same config as `schema_config` in `POST /schema`. Requires `extract` or `batch_extract` before it. */
|
|
11
|
+
schema?: Pulse.SchemaConfig;
|
|
12
|
+
/** Topic splitting step. Same config as `split_config` in `POST /split`. Requires `extract` or `batch_extract` before it. */
|
|
13
|
+
split?: Pulse.SplitConfig;
|
|
14
|
+
}
|
|
@@ -13,4 +13,6 @@ export interface SingleSchemaResponse {
|
|
|
13
13
|
extraction_ids?: string[];
|
|
14
14
|
/** API path to download the filled Excel template (e.g. `/schema/{schema_id}/excel`). Requires the same API key authentication. Only present when `excel_template` was provided in the request. */
|
|
15
15
|
excel_output_url?: string;
|
|
16
|
+
/** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
|
|
17
|
+
credits_used?: number | null;
|
|
16
18
|
}
|
|
@@ -2,9 +2,4 @@ import type * as Pulse from "../index.js";
|
|
|
2
2
|
/**
|
|
3
3
|
* Result of document splitting with page assignments.
|
|
4
4
|
*/
|
|
5
|
-
export
|
|
6
|
-
/** Unique identifier for this split result. Use this ID with the `/schema` endpoint (split mode) to apply schemas to specific page groups. */
|
|
7
|
-
split_id: string;
|
|
8
|
-
/** Page assignments per topic. */
|
|
9
|
-
split_output: Pulse.SplitOutput;
|
|
10
|
-
}
|
|
5
|
+
export type SplitResponse = Pulse.SplitResultCore;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type * as Pulse from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Core split result fields shared by the synchronous `/split` endpoint and the pipeline split step.
|
|
4
|
+
*/
|
|
5
|
+
export interface SplitResultCore {
|
|
6
|
+
/** Unique identifier for this split result. Use this ID with the `/schema` endpoint (split mode) to apply schemas to specific page groups. */
|
|
7
|
+
split_id?: string;
|
|
8
|
+
/** Page assignments per topic. */
|
|
9
|
+
split_output?: Pulse.SplitOutput;
|
|
10
|
+
/** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
|
|
11
|
+
credits_used?: number | null;
|
|
12
|
+
}
|
|
@@ -13,4 +13,6 @@ export interface SplitSchemaResponse {
|
|
|
13
13
|
input_schemas?: Record<string, Record<string, unknown>>;
|
|
14
14
|
/** Per-topic errors if any topics failed to process. Keys are topic names, values are error messages. */
|
|
15
15
|
errors?: Record<string, string>;
|
|
16
|
+
/** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
|
|
17
|
+
credits_used?: number | null;
|
|
16
18
|
}
|
|
@@ -6,6 +6,8 @@ export interface TablesConfig {
|
|
|
6
6
|
merge?: boolean;
|
|
7
7
|
/** Output format for table content. Currently only `html` is supported. */
|
|
8
8
|
table_format?: TablesConfig.TableFormat;
|
|
9
|
+
/** Convert figures and charts into tables using LLM processing. Resulting tables have `from_chart: true` in the response. */
|
|
10
|
+
charts_to_tables?: boolean;
|
|
9
11
|
}
|
|
10
12
|
export declare namespace TablesConfig {
|
|
11
13
|
/** Output format for table content. Currently only `html` is supported. */
|
|
@@ -6,6 +6,8 @@ export interface TablesResponse {
|
|
|
6
6
|
tables_id: string;
|
|
7
7
|
/** The extracted tables data. */
|
|
8
8
|
tables_output: TablesResponse.TablesOutput;
|
|
9
|
+
/** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
|
|
10
|
+
credits_used?: number | null;
|
|
9
11
|
}
|
|
10
12
|
export declare namespace TablesResponse {
|
|
11
13
|
/**
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./AsyncSubmissionResponse.js";
|
|
2
2
|
export * from "./BatchExtractionIds.js";
|
|
3
3
|
export * from "./BatchExtractResponse.js";
|
|
4
|
+
export * from "./BatchFileUpload.js";
|
|
4
5
|
export * from "./BatchInputSource.js";
|
|
5
6
|
export * from "./BatchOutputDestination.js";
|
|
6
7
|
export * from "./BatchSchemaResponse.js";
|
|
@@ -8,18 +9,31 @@ export * from "./BatchSplitResponse.js";
|
|
|
8
9
|
export * from "./BatchTablesResponse.js";
|
|
9
10
|
export * from "./ExtractAsyncSubmissionResponse.js";
|
|
10
11
|
export * from "./ExtractInput.js";
|
|
12
|
+
export * from "./ExtractLargeResultResponse.js";
|
|
11
13
|
export * from "./ExtractOptions.js";
|
|
12
14
|
export * from "./ExtractResponse.js";
|
|
15
|
+
export * from "./ExtractResultCore.js";
|
|
13
16
|
export * from "./ExtractSource.js";
|
|
17
|
+
export * from "./GoneErrorBody.js";
|
|
14
18
|
export * from "./JobCancellationResponse.js";
|
|
15
19
|
export * from "./JobStatus.js";
|
|
16
20
|
export * from "./JobStatusResponse.js";
|
|
21
|
+
export * from "./PipelineBatchExtractResult.js";
|
|
22
|
+
export * from "./PipelineExecuteMultipartInput.js";
|
|
23
|
+
export * from "./PipelineExecuteResponse.js";
|
|
24
|
+
export * from "./PipelineExtractResult.js";
|
|
25
|
+
export * from "./PipelineResults.js";
|
|
26
|
+
export * from "./PipelineSchemaResult.js";
|
|
27
|
+
export * from "./PipelineSplitResult.js";
|
|
28
|
+
export * from "./PipelineStepBatchExtractConfig.js";
|
|
29
|
+
export * from "./PipelineSteps.js";
|
|
17
30
|
export * from "./SchemaConfig.js";
|
|
18
31
|
export * from "./SchemaResponse.js";
|
|
19
32
|
export * from "./SingleSchemaResponse.js";
|
|
20
33
|
export * from "./SplitConfig.js";
|
|
21
34
|
export * from "./SplitOutput.js";
|
|
22
35
|
export * from "./SplitResponse.js";
|
|
36
|
+
export * from "./SplitResultCore.js";
|
|
23
37
|
export * from "./SplitSchemaResponse.js";
|
|
24
38
|
export * from "./StructuredOutputConfig.js";
|
|
25
39
|
export * from "./StructuredOutputResult.js";
|
|
@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
17
17
|
__exportStar(require("./AsyncSubmissionResponse.js"), exports);
|
|
18
18
|
__exportStar(require("./BatchExtractionIds.js"), exports);
|
|
19
19
|
__exportStar(require("./BatchExtractResponse.js"), exports);
|
|
20
|
+
__exportStar(require("./BatchFileUpload.js"), exports);
|
|
20
21
|
__exportStar(require("./BatchInputSource.js"), exports);
|
|
21
22
|
__exportStar(require("./BatchOutputDestination.js"), exports);
|
|
22
23
|
__exportStar(require("./BatchSchemaResponse.js"), exports);
|
|
@@ -24,18 +25,31 @@ __exportStar(require("./BatchSplitResponse.js"), exports);
|
|
|
24
25
|
__exportStar(require("./BatchTablesResponse.js"), exports);
|
|
25
26
|
__exportStar(require("./ExtractAsyncSubmissionResponse.js"), exports);
|
|
26
27
|
__exportStar(require("./ExtractInput.js"), exports);
|
|
28
|
+
__exportStar(require("./ExtractLargeResultResponse.js"), exports);
|
|
27
29
|
__exportStar(require("./ExtractOptions.js"), exports);
|
|
28
30
|
__exportStar(require("./ExtractResponse.js"), exports);
|
|
31
|
+
__exportStar(require("./ExtractResultCore.js"), exports);
|
|
29
32
|
__exportStar(require("./ExtractSource.js"), exports);
|
|
33
|
+
__exportStar(require("./GoneErrorBody.js"), exports);
|
|
30
34
|
__exportStar(require("./JobCancellationResponse.js"), exports);
|
|
31
35
|
__exportStar(require("./JobStatus.js"), exports);
|
|
32
36
|
__exportStar(require("./JobStatusResponse.js"), exports);
|
|
37
|
+
__exportStar(require("./PipelineBatchExtractResult.js"), exports);
|
|
38
|
+
__exportStar(require("./PipelineExecuteMultipartInput.js"), exports);
|
|
39
|
+
__exportStar(require("./PipelineExecuteResponse.js"), exports);
|
|
40
|
+
__exportStar(require("./PipelineExtractResult.js"), exports);
|
|
41
|
+
__exportStar(require("./PipelineResults.js"), exports);
|
|
42
|
+
__exportStar(require("./PipelineSchemaResult.js"), exports);
|
|
43
|
+
__exportStar(require("./PipelineSplitResult.js"), exports);
|
|
44
|
+
__exportStar(require("./PipelineStepBatchExtractConfig.js"), exports);
|
|
45
|
+
__exportStar(require("./PipelineSteps.js"), exports);
|
|
33
46
|
__exportStar(require("./SchemaConfig.js"), exports);
|
|
34
47
|
__exportStar(require("./SchemaResponse.js"), exports);
|
|
35
48
|
__exportStar(require("./SingleSchemaResponse.js"), exports);
|
|
36
49
|
__exportStar(require("./SplitConfig.js"), exports);
|
|
37
50
|
__exportStar(require("./SplitOutput.js"), exports);
|
|
38
51
|
__exportStar(require("./SplitResponse.js"), exports);
|
|
52
|
+
__exportStar(require("./SplitResultCore.js"), exports);
|
|
39
53
|
__exportStar(require("./SplitSchemaResponse.js"), exports);
|
|
40
54
|
__exportStar(require("./StructuredOutputConfig.js"), exports);
|
|
41
55
|
__exportStar(require("./StructuredOutputResult.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.0.
|
|
1
|
+
export declare const SDK_VERSION = "1.0.9";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "pulse-ts-sdk",
|
|
9
|
-
"X-Fern-SDK-Version": "1.0.
|
|
10
|
-
"User-Agent": "pulse-ts-sdk/1.0.
|
|
9
|
+
"X-Fern-SDK-Version": "1.0.9",
|
|
10
|
+
"User-Agent": "pulse-ts-sdk/1.0.9",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
package/dist/esm/Client.d.mts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import * as Pulse from "./api/index.mjs";
|
|
2
2
|
import { BatchClient } from "./api/resources/batch/client/Client.mjs";
|
|
3
3
|
import { JobsClient } from "./api/resources/jobs/client/Client.mjs";
|
|
4
|
+
import { LargeResultsClient } from "./api/resources/largeResults/client/Client.mjs";
|
|
5
|
+
import { PipelineClient } from "./api/resources/pipeline/client/Client.mjs";
|
|
4
6
|
import { WebhooksClient } from "./api/resources/webhooks/client/Client.mjs";
|
|
5
7
|
import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.mjs";
|
|
6
8
|
import { type NormalizedClientOptionsWithAuth } from "./BaseClient.mjs";
|
|
@@ -13,11 +15,15 @@ export declare namespace PulseClient {
|
|
|
13
15
|
export declare class PulseClient {
|
|
14
16
|
protected readonly _options: NormalizedClientOptionsWithAuth<PulseClient.Options>;
|
|
15
17
|
protected _batch: BatchClient | undefined;
|
|
18
|
+
protected _pipeline: PipelineClient | undefined;
|
|
16
19
|
protected _jobs: JobsClient | undefined;
|
|
20
|
+
protected _largeResults: LargeResultsClient | undefined;
|
|
17
21
|
protected _webhooks: WebhooksClient | undefined;
|
|
18
22
|
constructor(options?: PulseClient.Options);
|
|
19
23
|
get batch(): BatchClient;
|
|
24
|
+
get pipeline(): PipelineClient;
|
|
20
25
|
get jobs(): JobsClient;
|
|
26
|
+
get largeResults(): LargeResultsClient;
|
|
21
27
|
get webhooks(): WebhooksClient;
|
|
22
28
|
/**
|
|
23
29
|
* The primary endpoint for the Pulse API. Parses uploaded documents or remote
|
package/dist/esm/Client.mjs
CHANGED
|
@@ -11,6 +11,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
11
11
|
import * as Pulse from "./api/index.mjs";
|
|
12
12
|
import { BatchClient } from "./api/resources/batch/client/Client.mjs";
|
|
13
13
|
import { JobsClient } from "./api/resources/jobs/client/Client.mjs";
|
|
14
|
+
import { LargeResultsClient } from "./api/resources/largeResults/client/Client.mjs";
|
|
15
|
+
import { PipelineClient } from "./api/resources/pipeline/client/Client.mjs";
|
|
14
16
|
import { WebhooksClient } from "./api/resources/webhooks/client/Client.mjs";
|
|
15
17
|
import { normalizeClientOptionsWithAuth } from "./BaseClient.mjs";
|
|
16
18
|
import { mergeHeaders, mergeOnlyDefinedHeaders } from "./core/headers.mjs";
|
|
@@ -27,10 +29,18 @@ export class PulseClient {
|
|
|
27
29
|
var _a;
|
|
28
30
|
return ((_a = this._batch) !== null && _a !== void 0 ? _a : (this._batch = new BatchClient(this._options)));
|
|
29
31
|
}
|
|
32
|
+
get pipeline() {
|
|
33
|
+
var _a;
|
|
34
|
+
return ((_a = this._pipeline) !== null && _a !== void 0 ? _a : (this._pipeline = new PipelineClient(this._options)));
|
|
35
|
+
}
|
|
30
36
|
get jobs() {
|
|
31
37
|
var _a;
|
|
32
38
|
return ((_a = this._jobs) !== null && _a !== void 0 ? _a : (this._jobs = new JobsClient(this._options)));
|
|
33
39
|
}
|
|
40
|
+
get largeResults() {
|
|
41
|
+
var _a;
|
|
42
|
+
return ((_a = this._largeResults) !== null && _a !== void 0 ? _a : (this._largeResults = new LargeResultsClient(this._options)));
|
|
43
|
+
}
|
|
34
44
|
get webhooks() {
|
|
35
45
|
var _a;
|
|
36
46
|
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new WebhooksClient(this._options)));
|
|
@@ -82,6 +92,9 @@ export class PulseClient {
|
|
|
82
92
|
if (request.extensions != null) {
|
|
83
93
|
_request.append("extensions", toJson(request.extensions));
|
|
84
94
|
}
|
|
95
|
+
if (request.spreadsheet != null) {
|
|
96
|
+
_request.append("spreadsheet", toJson(request.spreadsheet));
|
|
97
|
+
}
|
|
85
98
|
if (request.storage != null) {
|
|
86
99
|
_request.append("storage", toJson(request.storage));
|
|
87
100
|
}
|
|
@@ -203,6 +216,9 @@ export class PulseClient {
|
|
|
203
216
|
if (request.extensions != null) {
|
|
204
217
|
_request.append("extensions", toJson(request.extensions));
|
|
205
218
|
}
|
|
219
|
+
if (request.spreadsheet != null) {
|
|
220
|
+
_request.append("spreadsheet", toJson(request.spreadsheet));
|
|
221
|
+
}
|
|
206
222
|
if (request.storage != null) {
|
|
207
223
|
_request.append("storage", toJson(request.storage));
|
|
208
224
|
}
|