pulse-ts-sdk 1.0.8 → 1.0.10
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 +22 -22
- package/dist/cjs/BaseClient.js +3 -2
- package/dist/cjs/Client.d.ts +12 -0
- package/dist/cjs/Client.js +78 -28
- package/dist/cjs/api/client/requests/ExtractAsyncRequest.d.ts +17 -5
- package/dist/cjs/api/client/requests/ExtractAsyncRequest.js +3 -2
- package/dist/cjs/api/client/requests/ExtractRequest.d.ts +17 -5
- package/dist/cjs/api/client/requests/ExtractRequest.js +3 -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/batch/client/Client.js +32 -16
- package/dist/cjs/api/resources/form/client/Client.d.ts +148 -0
- package/dist/cjs/api/resources/form/client/Client.js +350 -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/FormClearJsonInput.d.ts +19 -0
- package/dist/cjs/api/resources/form/client/requests/FormClearJsonInput.js +3 -0
- package/dist/cjs/api/resources/form/client/requests/FormDetectJsonInput.d.ts +14 -0
- package/dist/cjs/api/resources/form/client/requests/FormDetectJsonInput.js +3 -0
- package/dist/cjs/api/resources/form/client/requests/FormFillJsonInput.d.ts +21 -0
- package/dist/cjs/api/resources/form/client/requests/FormFillJsonInput.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 +8 -0
- package/dist/cjs/api/resources/index.js +9 -1
- package/dist/cjs/api/resources/jobs/client/Client.js +16 -8
- package/dist/cjs/api/resources/largeResults/client/Client.d.ts +41 -0
- package/dist/cjs/api/resources/largeResults/client/Client.js +131 -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 +57 -0
- package/dist/cjs/api/resources/pipeline/client/Client.js +151 -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/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/AsyncSubmissionResponse.d.ts +2 -0
- package/dist/cjs/api/types/ExtractInput.d.ts +17 -5
- package/dist/cjs/api/types/ExtractInput.js +3 -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 +17 -5
- package/dist/cjs/api/types/ExtractOptions.js +3 -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/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/FormClearMultipartInput.d.ts +21 -0
- package/dist/cjs/api/types/FormClearMultipartInput.js +3 -0
- package/dist/cjs/api/types/FormDetectMultipartInput.d.ts +16 -0
- package/dist/cjs/api/types/FormDetectMultipartInput.js +3 -0
- package/dist/cjs/api/types/FormFillMultipartInput.d.ts +21 -0
- package/dist/cjs/api/types/FormFillMultipartInput.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/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 +16 -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 +147 -0
- package/dist/cjs/api/types/PipelineStepBatchExtractConfig.js +27 -0
- package/dist/cjs/api/types/PipelineSteps.d.ts +16 -0
- package/dist/cjs/api/types/PipelineSteps.js +3 -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/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 +5 -2
- package/dist/cjs/api/types/TablesConfig.js +2 -1
- package/dist/cjs/api/types/TablesResponse.d.ts +4 -2
- package/dist/cjs/api/types/index.d.ts +23 -0
- package/dist/cjs/api/types/index.js +23 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +3 -2
- package/dist/esm/Client.d.mts +12 -0
- package/dist/esm/Client.mjs +74 -24
- package/dist/esm/api/client/requests/ExtractAsyncRequest.d.mts +17 -5
- package/dist/esm/api/client/requests/ExtractAsyncRequest.mjs +3 -2
- package/dist/esm/api/client/requests/ExtractRequest.d.mts +17 -5
- package/dist/esm/api/client/requests/ExtractRequest.mjs +3 -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/batch/client/Client.mjs +32 -16
- package/dist/esm/api/resources/form/client/Client.d.mts +148 -0
- package/dist/esm/api/resources/form/client/Client.mjs +313 -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/FormClearJsonInput.d.mts +19 -0
- package/dist/esm/api/resources/form/client/requests/FormClearJsonInput.mjs +2 -0
- package/dist/esm/api/resources/form/client/requests/FormDetectJsonInput.d.mts +14 -0
- package/dist/esm/api/resources/form/client/requests/FormDetectJsonInput.mjs +2 -0
- package/dist/esm/api/resources/form/client/requests/FormFillJsonInput.d.mts +21 -0
- package/dist/esm/api/resources/form/client/requests/FormFillJsonInput.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 +8 -0
- package/dist/esm/api/resources/index.mjs +8 -0
- package/dist/esm/api/resources/jobs/client/Client.mjs +16 -8
- package/dist/esm/api/resources/largeResults/client/Client.d.mts +41 -0
- package/dist/esm/api/resources/largeResults/client/Client.mjs +94 -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 +57 -0
- package/dist/esm/api/resources/pipeline/client/Client.mjs +114 -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/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/AsyncSubmissionResponse.d.mts +2 -0
- package/dist/esm/api/types/ExtractInput.d.mts +17 -5
- package/dist/esm/api/types/ExtractInput.mjs +3 -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 +17 -5
- package/dist/esm/api/types/ExtractOptions.mjs +3 -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/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/FormClearMultipartInput.d.mts +21 -0
- package/dist/esm/api/types/FormClearMultipartInput.mjs +2 -0
- package/dist/esm/api/types/FormDetectMultipartInput.d.mts +16 -0
- package/dist/esm/api/types/FormDetectMultipartInput.mjs +2 -0
- package/dist/esm/api/types/FormFillMultipartInput.d.mts +21 -0
- package/dist/esm/api/types/FormFillMultipartInput.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/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 +16 -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 +147 -0
- package/dist/esm/api/types/PipelineStepBatchExtractConfig.mjs +24 -0
- package/dist/esm/api/types/PipelineSteps.d.mts +16 -0
- package/dist/esm/api/types/PipelineSteps.mjs +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/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 +5 -2
- package/dist/esm/api/types/TablesConfig.mjs +2 -1
- package/dist/esm/api/types/TablesResponse.d.mts +4 -2
- package/dist/esm/api/types/index.d.mts +23 -0
- package/dist/esm/api/types/index.mjs +23 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +513 -0
|
@@ -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
|
/**
|
|
@@ -19,8 +21,8 @@ export declare namespace TablesResponse {
|
|
|
19
21
|
type Tables = Tables.Item[];
|
|
20
22
|
namespace Tables {
|
|
21
23
|
interface Item {
|
|
22
|
-
/** The table content
|
|
23
|
-
table_content?:
|
|
24
|
+
/** The table content. When `table_format` is `html` (default), this is an HTML string. When `json`, this is an object with `headers` (array of column names) and `rows` (array of objects keyed by header name). */
|
|
25
|
+
table_content?: unknown;
|
|
24
26
|
/** Bounding box table IDs indicating where this table was found (e.g. "tbl-1"). Merged tables list all source IDs. */
|
|
25
27
|
citations?: string[];
|
|
26
28
|
/** Whether this table was extracted from a chart or figure rather than a native table. */
|
|
@@ -9,18 +9,41 @@ export * from "./BatchSplitResponse.js";
|
|
|
9
9
|
export * from "./BatchTablesResponse.js";
|
|
10
10
|
export * from "./ExtractAsyncSubmissionResponse.js";
|
|
11
11
|
export * from "./ExtractInput.js";
|
|
12
|
+
export * from "./ExtractLargeResultResponse.js";
|
|
12
13
|
export * from "./ExtractOptions.js";
|
|
13
14
|
export * from "./ExtractResponse.js";
|
|
15
|
+
export * from "./ExtractResultCore.js";
|
|
14
16
|
export * from "./ExtractSource.js";
|
|
17
|
+
export * from "./FormCell.js";
|
|
18
|
+
export * from "./FormCheckboxDetail.js";
|
|
19
|
+
export * from "./FormClearMultipartInput.js";
|
|
20
|
+
export * from "./FormDetectMultipartInput.js";
|
|
21
|
+
export * from "./FormFillMultipartInput.js";
|
|
22
|
+
export * from "./FormFillSharedOptions.js";
|
|
23
|
+
export * from "./FormPlanInfo.js";
|
|
24
|
+
export * from "./FormResult.js";
|
|
25
|
+
export * from "./FormSharedOptions.js";
|
|
26
|
+
export * from "./GoneErrorBody.js";
|
|
15
27
|
export * from "./JobCancellationResponse.js";
|
|
16
28
|
export * from "./JobStatus.js";
|
|
17
29
|
export * from "./JobStatusResponse.js";
|
|
30
|
+
export * from "./PipelineBatchExtractResult.js";
|
|
31
|
+
export * from "./PipelineExecuteMultipartInput.js";
|
|
32
|
+
export * from "./PipelineExecuteResponse.js";
|
|
33
|
+
export * from "./PipelineExtractResult.js";
|
|
34
|
+
export * from "./PipelineResults.js";
|
|
35
|
+
export * from "./PipelineSchemaResult.js";
|
|
36
|
+
export * from "./PipelineSplitResult.js";
|
|
37
|
+
export * from "./PipelineStepBatchExtractConfig.js";
|
|
38
|
+
export * from "./PipelineSteps.js";
|
|
39
|
+
export * from "./PipelineTablesResult.js";
|
|
18
40
|
export * from "./SchemaConfig.js";
|
|
19
41
|
export * from "./SchemaResponse.js";
|
|
20
42
|
export * from "./SingleSchemaResponse.js";
|
|
21
43
|
export * from "./SplitConfig.js";
|
|
22
44
|
export * from "./SplitOutput.js";
|
|
23
45
|
export * from "./SplitResponse.js";
|
|
46
|
+
export * from "./SplitResultCore.js";
|
|
24
47
|
export * from "./SplitSchemaResponse.js";
|
|
25
48
|
export * from "./StructuredOutputConfig.js";
|
|
26
49
|
export * from "./StructuredOutputResult.js";
|
|
@@ -25,18 +25,41 @@ __exportStar(require("./BatchSplitResponse.js"), exports);
|
|
|
25
25
|
__exportStar(require("./BatchTablesResponse.js"), exports);
|
|
26
26
|
__exportStar(require("./ExtractAsyncSubmissionResponse.js"), exports);
|
|
27
27
|
__exportStar(require("./ExtractInput.js"), exports);
|
|
28
|
+
__exportStar(require("./ExtractLargeResultResponse.js"), exports);
|
|
28
29
|
__exportStar(require("./ExtractOptions.js"), exports);
|
|
29
30
|
__exportStar(require("./ExtractResponse.js"), exports);
|
|
31
|
+
__exportStar(require("./ExtractResultCore.js"), exports);
|
|
30
32
|
__exportStar(require("./ExtractSource.js"), exports);
|
|
33
|
+
__exportStar(require("./FormCell.js"), exports);
|
|
34
|
+
__exportStar(require("./FormCheckboxDetail.js"), exports);
|
|
35
|
+
__exportStar(require("./FormClearMultipartInput.js"), exports);
|
|
36
|
+
__exportStar(require("./FormDetectMultipartInput.js"), exports);
|
|
37
|
+
__exportStar(require("./FormFillMultipartInput.js"), exports);
|
|
38
|
+
__exportStar(require("./FormFillSharedOptions.js"), exports);
|
|
39
|
+
__exportStar(require("./FormPlanInfo.js"), exports);
|
|
40
|
+
__exportStar(require("./FormResult.js"), exports);
|
|
41
|
+
__exportStar(require("./FormSharedOptions.js"), exports);
|
|
42
|
+
__exportStar(require("./GoneErrorBody.js"), exports);
|
|
31
43
|
__exportStar(require("./JobCancellationResponse.js"), exports);
|
|
32
44
|
__exportStar(require("./JobStatus.js"), exports);
|
|
33
45
|
__exportStar(require("./JobStatusResponse.js"), exports);
|
|
46
|
+
__exportStar(require("./PipelineBatchExtractResult.js"), exports);
|
|
47
|
+
__exportStar(require("./PipelineExecuteMultipartInput.js"), exports);
|
|
48
|
+
__exportStar(require("./PipelineExecuteResponse.js"), exports);
|
|
49
|
+
__exportStar(require("./PipelineExtractResult.js"), exports);
|
|
50
|
+
__exportStar(require("./PipelineResults.js"), exports);
|
|
51
|
+
__exportStar(require("./PipelineSchemaResult.js"), exports);
|
|
52
|
+
__exportStar(require("./PipelineSplitResult.js"), exports);
|
|
53
|
+
__exportStar(require("./PipelineStepBatchExtractConfig.js"), exports);
|
|
54
|
+
__exportStar(require("./PipelineSteps.js"), exports);
|
|
55
|
+
__exportStar(require("./PipelineTablesResult.js"), exports);
|
|
34
56
|
__exportStar(require("./SchemaConfig.js"), exports);
|
|
35
57
|
__exportStar(require("./SchemaResponse.js"), exports);
|
|
36
58
|
__exportStar(require("./SingleSchemaResponse.js"), exports);
|
|
37
59
|
__exportStar(require("./SplitConfig.js"), exports);
|
|
38
60
|
__exportStar(require("./SplitOutput.js"), exports);
|
|
39
61
|
__exportStar(require("./SplitResponse.js"), exports);
|
|
62
|
+
__exportStar(require("./SplitResultCore.js"), exports);
|
|
40
63
|
__exportStar(require("./SplitSchemaResponse.js"), exports);
|
|
41
64
|
__exportStar(require("./StructuredOutputConfig.js"), exports);
|
|
42
65
|
__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.10";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,10 +6,11 @@ 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
|
+
"X-Pulse-Source": "sdk-typescript",
|
|
13
14
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
14
15
|
return Object.assign(Object.assign({}, options), { logging: core.logging.createLogger(options === null || options === void 0 ? void 0 : options.logging), headers });
|
|
15
16
|
}
|
package/dist/esm/Client.d.mts
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import * as Pulse from "./api/index.mjs";
|
|
2
2
|
import { BatchClient } from "./api/resources/batch/client/Client.mjs";
|
|
3
|
+
import { FormClient } from "./api/resources/form/client/Client.mjs";
|
|
3
4
|
import { JobsClient } from "./api/resources/jobs/client/Client.mjs";
|
|
5
|
+
import { LargeResultsClient } from "./api/resources/largeResults/client/Client.mjs";
|
|
6
|
+
import { PipelineClient } from "./api/resources/pipeline/client/Client.mjs";
|
|
7
|
+
import { ResultsClient } from "./api/resources/results/client/Client.mjs";
|
|
4
8
|
import { WebhooksClient } from "./api/resources/webhooks/client/Client.mjs";
|
|
5
9
|
import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.mjs";
|
|
6
10
|
import { type NormalizedClientOptionsWithAuth } from "./BaseClient.mjs";
|
|
@@ -12,12 +16,20 @@ export declare namespace PulseClient {
|
|
|
12
16
|
}
|
|
13
17
|
export declare class PulseClient {
|
|
14
18
|
protected readonly _options: NormalizedClientOptionsWithAuth<PulseClient.Options>;
|
|
19
|
+
protected _form: FormClient | undefined;
|
|
15
20
|
protected _batch: BatchClient | undefined;
|
|
21
|
+
protected _pipeline: PipelineClient | undefined;
|
|
16
22
|
protected _jobs: JobsClient | undefined;
|
|
23
|
+
protected _results: ResultsClient | undefined;
|
|
24
|
+
protected _largeResults: LargeResultsClient | undefined;
|
|
17
25
|
protected _webhooks: WebhooksClient | undefined;
|
|
18
26
|
constructor(options?: PulseClient.Options);
|
|
27
|
+
get form(): FormClient;
|
|
19
28
|
get batch(): BatchClient;
|
|
29
|
+
get pipeline(): PipelineClient;
|
|
20
30
|
get jobs(): JobsClient;
|
|
31
|
+
get results(): ResultsClient;
|
|
32
|
+
get largeResults(): LargeResultsClient;
|
|
21
33
|
get webhooks(): WebhooksClient;
|
|
22
34
|
/**
|
|
23
35
|
* The primary endpoint for the Pulse API. Parses uploaded documents or remote
|
package/dist/esm/Client.mjs
CHANGED
|
@@ -10,7 +10,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
10
10
|
};
|
|
11
11
|
import * as Pulse from "./api/index.mjs";
|
|
12
12
|
import { BatchClient } from "./api/resources/batch/client/Client.mjs";
|
|
13
|
+
import { FormClient } from "./api/resources/form/client/Client.mjs";
|
|
13
14
|
import { JobsClient } from "./api/resources/jobs/client/Client.mjs";
|
|
15
|
+
import { LargeResultsClient } from "./api/resources/largeResults/client/Client.mjs";
|
|
16
|
+
import { PipelineClient } from "./api/resources/pipeline/client/Client.mjs";
|
|
17
|
+
import { ResultsClient } from "./api/resources/results/client/Client.mjs";
|
|
14
18
|
import { WebhooksClient } from "./api/resources/webhooks/client/Client.mjs";
|
|
15
19
|
import { normalizeClientOptionsWithAuth } from "./BaseClient.mjs";
|
|
16
20
|
import { mergeHeaders, mergeOnlyDefinedHeaders } from "./core/headers.mjs";
|
|
@@ -23,14 +27,30 @@ export class PulseClient {
|
|
|
23
27
|
constructor(options = {}) {
|
|
24
28
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
25
29
|
}
|
|
30
|
+
get form() {
|
|
31
|
+
var _a;
|
|
32
|
+
return ((_a = this._form) !== null && _a !== void 0 ? _a : (this._form = new FormClient(this._options)));
|
|
33
|
+
}
|
|
26
34
|
get batch() {
|
|
27
35
|
var _a;
|
|
28
36
|
return ((_a = this._batch) !== null && _a !== void 0 ? _a : (this._batch = new BatchClient(this._options)));
|
|
29
37
|
}
|
|
38
|
+
get pipeline() {
|
|
39
|
+
var _a;
|
|
40
|
+
return ((_a = this._pipeline) !== null && _a !== void 0 ? _a : (this._pipeline = new PipelineClient(this._options)));
|
|
41
|
+
}
|
|
30
42
|
get jobs() {
|
|
31
43
|
var _a;
|
|
32
44
|
return ((_a = this._jobs) !== null && _a !== void 0 ? _a : (this._jobs = new JobsClient(this._options)));
|
|
33
45
|
}
|
|
46
|
+
get results() {
|
|
47
|
+
var _a;
|
|
48
|
+
return ((_a = this._results) !== null && _a !== void 0 ? _a : (this._results = new ResultsClient(this._options)));
|
|
49
|
+
}
|
|
50
|
+
get largeResults() {
|
|
51
|
+
var _a;
|
|
52
|
+
return ((_a = this._largeResults) !== null && _a !== void 0 ? _a : (this._largeResults = new LargeResultsClient(this._options)));
|
|
53
|
+
}
|
|
34
54
|
get webhooks() {
|
|
35
55
|
var _a;
|
|
36
56
|
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new WebhooksClient(this._options)));
|
|
@@ -62,7 +82,7 @@ export class PulseClient {
|
|
|
62
82
|
}
|
|
63
83
|
__extract(request, requestOptions) {
|
|
64
84
|
return __awaiter(this, void 0, void 0, function* () {
|
|
65
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
85
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
66
86
|
const _request = yield core.newFormData();
|
|
67
87
|
if (request.file != null) {
|
|
68
88
|
yield _request.appendFile("file", request.file);
|
|
@@ -82,6 +102,9 @@ export class PulseClient {
|
|
|
82
102
|
if (request.extensions != null) {
|
|
83
103
|
_request.append("extensions", toJson(request.extensions));
|
|
84
104
|
}
|
|
105
|
+
if (request.spreadsheet != null) {
|
|
106
|
+
_request.append("spreadsheet", toJson(request.spreadsheet));
|
|
107
|
+
}
|
|
85
108
|
if (request.storage != null) {
|
|
86
109
|
_request.append("storage", toJson(request.storage));
|
|
87
110
|
}
|
|
@@ -132,10 +155,14 @@ export class PulseClient {
|
|
|
132
155
|
requestType: "file",
|
|
133
156
|
duplex: _maybeEncodedRequest.duplex,
|
|
134
157
|
body: _maybeEncodedRequest.body,
|
|
135
|
-
timeoutMs: (
|
|
136
|
-
|
|
158
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
159
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
160
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
161
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
162
|
+
: undefined,
|
|
163
|
+
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,
|
|
137
164
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
138
|
-
fetchFn: (
|
|
165
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
139
166
|
logging: this._options.logging,
|
|
140
167
|
});
|
|
141
168
|
if (_response.ok) {
|
|
@@ -183,7 +210,7 @@ export class PulseClient {
|
|
|
183
210
|
}
|
|
184
211
|
__extractAsync(request, requestOptions) {
|
|
185
212
|
return __awaiter(this, void 0, void 0, function* () {
|
|
186
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
213
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
187
214
|
const _request = yield core.newFormData();
|
|
188
215
|
if (request.file != null) {
|
|
189
216
|
yield _request.appendFile("file", request.file);
|
|
@@ -203,6 +230,9 @@ export class PulseClient {
|
|
|
203
230
|
if (request.extensions != null) {
|
|
204
231
|
_request.append("extensions", toJson(request.extensions));
|
|
205
232
|
}
|
|
233
|
+
if (request.spreadsheet != null) {
|
|
234
|
+
_request.append("spreadsheet", toJson(request.spreadsheet));
|
|
235
|
+
}
|
|
206
236
|
if (request.storage != null) {
|
|
207
237
|
_request.append("storage", toJson(request.storage));
|
|
208
238
|
}
|
|
@@ -253,10 +283,14 @@ export class PulseClient {
|
|
|
253
283
|
requestType: "file",
|
|
254
284
|
duplex: _maybeEncodedRequest.duplex,
|
|
255
285
|
body: _maybeEncodedRequest.body,
|
|
256
|
-
timeoutMs: (
|
|
257
|
-
|
|
286
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
287
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
288
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
289
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
290
|
+
: undefined,
|
|
291
|
+
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,
|
|
258
292
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
259
|
-
fetchFn: (
|
|
293
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
260
294
|
logging: this._options.logging,
|
|
261
295
|
});
|
|
262
296
|
if (_response.ok) {
|
|
@@ -314,7 +348,7 @@ export class PulseClient {
|
|
|
314
348
|
}
|
|
315
349
|
__split(request, requestOptions) {
|
|
316
350
|
return __awaiter(this, void 0, void 0, function* () {
|
|
317
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
351
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
318
352
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
319
353
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
320
354
|
const _response = yield core.fetcher({
|
|
@@ -325,10 +359,14 @@ export class PulseClient {
|
|
|
325
359
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
326
360
|
requestType: "json",
|
|
327
361
|
body: request,
|
|
328
|
-
timeoutMs: (
|
|
329
|
-
|
|
362
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
363
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
364
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
365
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
366
|
+
: undefined,
|
|
367
|
+
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,
|
|
330
368
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
331
|
-
fetchFn: (
|
|
369
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
332
370
|
logging: this._options.logging,
|
|
333
371
|
});
|
|
334
372
|
if (_response.ok) {
|
|
@@ -402,7 +440,7 @@ export class PulseClient {
|
|
|
402
440
|
}
|
|
403
441
|
__schema() {
|
|
404
442
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
405
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
443
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
406
444
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
407
445
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
408
446
|
const _response = yield core.fetcher({
|
|
@@ -413,10 +451,14 @@ export class PulseClient {
|
|
|
413
451
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
414
452
|
requestType: "json",
|
|
415
453
|
body: request,
|
|
416
|
-
timeoutMs: (
|
|
417
|
-
|
|
454
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
455
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
456
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
457
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
458
|
+
: undefined,
|
|
459
|
+
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,
|
|
418
460
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
419
|
-
fetchFn: (
|
|
461
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
420
462
|
logging: this._options.logging,
|
|
421
463
|
});
|
|
422
464
|
if (_response.ok) {
|
|
@@ -458,7 +500,7 @@ export class PulseClient {
|
|
|
458
500
|
}
|
|
459
501
|
__downloadSchemaExcel(request, requestOptions) {
|
|
460
502
|
return __awaiter(this, void 0, void 0, function* () {
|
|
461
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
503
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
462
504
|
const { schemaId } = request;
|
|
463
505
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
464
506
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -468,10 +510,14 @@ export class PulseClient {
|
|
|
468
510
|
headers: _headers,
|
|
469
511
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
470
512
|
responseType: "binary-response",
|
|
471
|
-
timeoutMs: (
|
|
472
|
-
|
|
513
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
514
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
515
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
516
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
517
|
+
: undefined,
|
|
518
|
+
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,
|
|
473
519
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
474
|
-
fetchFn: (
|
|
520
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
475
521
|
logging: this._options.logging,
|
|
476
522
|
});
|
|
477
523
|
if (_response.ok) {
|
|
@@ -528,7 +574,7 @@ export class PulseClient {
|
|
|
528
574
|
}
|
|
529
575
|
__tables(request, requestOptions) {
|
|
530
576
|
return __awaiter(this, void 0, void 0, function* () {
|
|
531
|
-
var _a, _b, _c, _d, _e, _f, _g, _h
|
|
577
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
532
578
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
533
579
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
534
580
|
const _response = yield core.fetcher({
|
|
@@ -539,10 +585,14 @@ export class PulseClient {
|
|
|
539
585
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
540
586
|
requestType: "json",
|
|
541
587
|
body: request,
|
|
542
|
-
timeoutMs: (
|
|
543
|
-
|
|
588
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
|
|
589
|
+
? requestOptions.timeoutInSeconds * 1000
|
|
590
|
+
: ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
|
|
591
|
+
? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
|
|
592
|
+
: undefined,
|
|
593
|
+
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,
|
|
544
594
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
545
|
-
fetchFn: (
|
|
595
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
546
596
|
logging: this._options.logging,
|
|
547
597
|
});
|
|
548
598
|
if (_response.ok) {
|
|
@@ -8,7 +8,7 @@ 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
13
|
/** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
|
|
14
14
|
pages?: string;
|
|
@@ -16,6 +16,8 @@ export interface ExtractAsyncRequest {
|
|
|
16
16
|
figureProcessing?: ExtractAsyncRequest.FigureProcessing;
|
|
17
17
|
/** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
|
|
18
18
|
extensions?: ExtractAsyncRequest.Extensions;
|
|
19
|
+
/** 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. */
|
|
20
|
+
spreadsheet?: ExtractAsyncRequest.Spreadsheet;
|
|
19
21
|
/** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
|
|
20
22
|
storage?: ExtractAsyncRequest.Storage;
|
|
21
23
|
/** If true, returns immediately with a job_id for polling via GET /job/{jobId}. Otherwise processes synchronously. */
|
|
@@ -44,9 +46,10 @@ export interface ExtractAsyncRequest {
|
|
|
44
46
|
thinking?: boolean;
|
|
45
47
|
}
|
|
46
48
|
export declare namespace ExtractAsyncRequest {
|
|
47
|
-
/** Extraction model to use. When set to `
|
|
49
|
+
/** 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. */
|
|
48
50
|
const Model: {
|
|
49
|
-
readonly
|
|
51
|
+
readonly Default: "default";
|
|
52
|
+
readonly PulseUltra2: "pulse-ultra-2";
|
|
50
53
|
};
|
|
51
54
|
type Model = (typeof Model)[keyof typeof Model];
|
|
52
55
|
/**
|
|
@@ -62,8 +65,6 @@ export declare namespace ExtractAsyncRequest {
|
|
|
62
65
|
* Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`.
|
|
63
66
|
*/
|
|
64
67
|
interface Extensions {
|
|
65
|
-
/** Merge tables that span multiple pages into a single table. */
|
|
66
|
-
mergeTables?: boolean;
|
|
67
68
|
/** Link footnote markers to their corresponding footnote text. */
|
|
68
69
|
footnoteReferences?: boolean;
|
|
69
70
|
/** Chunking configuration. When provided, the document is split into chunks using the specified strategies. Results appear in `response.extensions.chunking`. */
|
|
@@ -105,6 +106,17 @@ export declare namespace ExtractAsyncRequest {
|
|
|
105
106
|
returnXml?: boolean;
|
|
106
107
|
}
|
|
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
|
+
}
|
|
108
120
|
/**
|
|
109
121
|
* Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
|
|
110
122
|
*/
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
2
|
export var ExtractAsyncRequest;
|
|
3
3
|
(function (ExtractAsyncRequest) {
|
|
4
|
-
/** Extraction model to use. When set to `
|
|
4
|
+
/** 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. */
|
|
5
5
|
ExtractAsyncRequest.Model = {
|
|
6
|
-
|
|
6
|
+
Default: "default",
|
|
7
|
+
PulseUltra2: "pulse-ultra-2",
|
|
7
8
|
};
|
|
8
9
|
let Extensions;
|
|
9
10
|
(function (Extensions) {
|
|
@@ -8,7 +8,7 @@ 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
13
|
/** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
|
|
14
14
|
pages?: string;
|
|
@@ -16,6 +16,8 @@ export interface ExtractRequest {
|
|
|
16
16
|
figureProcessing?: ExtractRequest.FigureProcessing;
|
|
17
17
|
/** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
|
|
18
18
|
extensions?: ExtractRequest.Extensions;
|
|
19
|
+
/** 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. */
|
|
20
|
+
spreadsheet?: ExtractRequest.Spreadsheet;
|
|
19
21
|
/** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
|
|
20
22
|
storage?: ExtractRequest.Storage;
|
|
21
23
|
/** If true, returns immediately with a job_id for polling via GET /job/{jobId}. Otherwise processes synchronously. */
|
|
@@ -44,9 +46,10 @@ export interface ExtractRequest {
|
|
|
44
46
|
thinking?: boolean;
|
|
45
47
|
}
|
|
46
48
|
export declare namespace ExtractRequest {
|
|
47
|
-
/** Extraction model to use. When set to `
|
|
49
|
+
/** 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. */
|
|
48
50
|
const Model: {
|
|
49
|
-
readonly
|
|
51
|
+
readonly Default: "default";
|
|
52
|
+
readonly PulseUltra2: "pulse-ultra-2";
|
|
50
53
|
};
|
|
51
54
|
type Model = (typeof Model)[keyof typeof Model];
|
|
52
55
|
/**
|
|
@@ -62,8 +65,6 @@ export declare namespace ExtractRequest {
|
|
|
62
65
|
* Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`.
|
|
63
66
|
*/
|
|
64
67
|
interface Extensions {
|
|
65
|
-
/** Merge tables that span multiple pages into a single table. */
|
|
66
|
-
mergeTables?: boolean;
|
|
67
68
|
/** Link footnote markers to their corresponding footnote text. */
|
|
68
69
|
footnoteReferences?: boolean;
|
|
69
70
|
/** Chunking configuration. When provided, the document is split into chunks using the specified strategies. Results appear in `response.extensions.chunking`. */
|
|
@@ -105,6 +106,17 @@ export declare namespace ExtractRequest {
|
|
|
105
106
|
returnXml?: boolean;
|
|
106
107
|
}
|
|
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
|
+
}
|
|
108
120
|
/**
|
|
109
121
|
* Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
|
|
110
122
|
*/
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
2
|
export var ExtractRequest;
|
|
3
3
|
(function (ExtractRequest) {
|
|
4
|
-
/** Extraction model to use. When set to `
|
|
4
|
+
/** 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. */
|
|
5
5
|
ExtractRequest.Model = {
|
|
6
|
-
|
|
6
|
+
Default: "default",
|
|
7
|
+
PulseUltra2: "pulse-ultra-2",
|
|
7
8
|
};
|
|
8
9
|
let Extensions;
|
|
9
10
|
(function (Extensions) {
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type * as core from "../../core/index.mjs";
|
|
2
|
+
import * as errors from "../../errors/index.mjs";
|
|
3
|
+
import type * as Pulse from "../index.mjs";
|
|
4
|
+
export declare class GoneError extends errors.PulseError {
|
|
5
|
+
constructor(body: Pulse.GoneErrorBody, rawResponse?: core.RawResponse);
|
|
6
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as errors from "../../errors/index.mjs";
|
|
3
|
+
export class GoneError extends errors.PulseError {
|
|
4
|
+
constructor(body, rawResponse) {
|
|
5
|
+
super({
|
|
6
|
+
message: "GoneError",
|
|
7
|
+
statusCode: 410,
|
|
8
|
+
body: body,
|
|
9
|
+
rawResponse: rawResponse,
|
|
10
|
+
});
|
|
11
|
+
Object.setPrototypeOf(this, new.target.prototype);
|
|
12
|
+
if (Error.captureStackTrace) {
|
|
13
|
+
Error.captureStackTrace(this, this.constructor);
|
|
14
|
+
}
|
|
15
|
+
this.name = this.constructor.name;
|
|
16
|
+
}
|
|
17
|
+
}
|